summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/chart/ChartDataRowProperties.idl
blob: 0d43c3ac65c81d0922e2b0d966b6704c56eefbac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: ChartDataRowProperties.idl,v $
 * $Revision: 1.14 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_chart_ChartDataRowProperties_idl__
#define __com_sun_star_chart_ChartDataRowProperties_idl__

#ifndef __com_sun_star_chart_ChartDataPointProperties_idl__
#include <com/sun/star/chart/ChartDataPointProperties.idl>
#endif

#ifndef __com_sun_star_chart_ChartStatistics_idl__
#include <com/sun/star/chart/ChartStatistics.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
#include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module chart {

//=============================================================================

/** specifies the properties for a group of graphic elements which
    belong to a data row (also known as data series).

    <p>For this service, the properties supported by
    <type>ChartDataPointProperties</type> are applied to all data
    point elements contained in this group.  They serve as a template;
    thus, when changing a data point property afterwards</p>

    @see ChartDataPointProperties
 */
published service ChartDataRowProperties
{
    service com::sun::star::chart::ChartDataPointProperties;
    /** Statistical properties are not available for all types of
        diagrams.
    */
    [optional] service com::sun::star::chart::ChartStatistics;

    /** If <type>ChartDataRowProperties</type> may be stored as XML
        file, this service should be supported in order to preserve
        unparsed XML attributes.

    @since OOo 1.1.2
     */
    [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;

    interface com::sun::star::beans::XPropertySet;

    //-------------------------------------------------------------------------

    /** determines to which axis the data row is assigned.

        <p>The axis must be a primary or secondary y-axis</p>

        @see ChartAxisAssign
        @see ChartAxisYSupplier
        @see ChartTwoAxisYSupplier
     */
    [property] long Axis;

    //-------------------------------------------------------------------------

    /** holds the properties of the regression line, if such one is
        enabled.

        @see ChartLine
        @see ChartStatistics
     */
    [optional, readonly, property] com::sun::star::beans::XPropertySet DataRegressionProperties;

    //-------------------------------------------------------------------------

    /** holds the properties of the error markers, if those are
        enabled.

        @see ChartLine
        @see ChartStatistics
     */
    [optional, readonly, property] com::sun::star::beans::XPropertySet DataErrorProperties;

    //-------------------------------------------------------------------------

    /** holds the properties of the average line, if such one is
        enabled.

        @see ChartLine
        @see ChartStatistics
     */
    [optional, readonly, property] com::sun::star::beans::XPropertySet DataMeanValueProperties;
};

//=============================================================================

}; }; }; };

#endif