summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/chart/Diagram.idl
blob: b57fc88f3804e97f75a9d65e9092d34700511339 (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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_Diagram_idl__
#define __com_sun_star_chart_Diagram_idl__

#ifndef __com_sun_star_chart_XDiagram_idl__
#include <com/sun/star/chart/XDiagram.idl>
#endif

#ifndef __com_sun_star_chart_XDiagramPositioning_idl__
#include <com/sun/star/chart/XDiagramPositioning.idl>
#endif

#ifndef __com_sun_star_chart_XSecondAxisTitleSupplier_idl__
#include <com/sun/star/chart/XSecondAxisTitleSupplier.idl>
#endif

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

#ifndef __com_sun_star_chart_ChartDataRowSource_idl__
#include <com/sun/star/chart/ChartDataRowSource.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 {

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

/** the base service for the diagram of the chart document.

    <p>The diagram is the object that contains the actual plot.</p>

    <p>Different Diagram Types, e.g., <type>PieDiagram</type> or
    <type>LineDiagram</type>, can be instantiated by the
    <type scope="com::sun::star::lang">XMultiServiceFactory</type> of
    the <type>XChartDocument</type>.</p>

 */
published service Diagram
{

    interface com::sun::star::chart::XDiagram;

    /** Provides access to the titles of the secondary X axis and Y axis.

        @since OOo 3.0
     */
    [optional] interface com::sun::star::chart::XSecondAxisTitleSupplier;

    /**
    @since OOo 3.3
     */
    [optional] interface com::sun::star::chart::XDiagramPositioning;

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

    /** If this property is <TRUE/> the position is calculated by the application automatically.
        Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
        to set a concrete position (note <type scope="com::sun::star::chart">XDiagram</type> is derived from <type scope="com::sun::star::drawing">XShape</type>).
     */
    [optional, property] boolean AutomaticPosition;

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

    /** If this property is <TRUE/> the size is calculated by the application automatically.
        Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
        to set a concrete size (note <type scope="com::sun::star::chart">XDiagram</type> is derived from <type scope="com::sun::star::drawing">XShape</type>).
     */
    [optional, property] boolean AutomaticSize;

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

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

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

    /** If a <type>Diagram</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;

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

    /** determines if the data for a data row is contained in the
        columns or in the rows of the data array.

        @see ChartDataRowSource
        @see ChartDataArray
     */
    [property] com::sun::star::chart::ChartDataRowSource DataRowSource;

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

    /** specifies how the caption of data points is displayed.

        @see ChartDataCaption
     */
    [property] long DataCaption;

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

    /** specifies how empty or invalid cells in the provided data should be handled when displayed

        @see MissingValueTreatment
     */
    [optional, property] long MissingValueTreatment;

};

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

}; }; }; };

#endif