xref: /aoo4110/main/offapi/com/sun/star/chart/Diagram.idl (revision b1cdbd2c)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_chart_Diagram_idl__
24#define __com_sun_star_chart_Diagram_idl__
25
26#ifndef __com_sun_star_chart_XDiagram_idl__
27#include <com/sun/star/chart/XDiagram.idl>
28#endif
29
30#ifndef __com_sun_star_chart_XAxisSupplier_idl__
31#include <com/sun/star/chart/XAxisSupplier.idl>
32#endif
33
34#ifndef __com_sun_star_chart_XDiagramPositioning_idl__
35#include <com/sun/star/chart/XDiagramPositioning.idl>
36#endif
37
38#ifndef __com_sun_star_chart_XSecondAxisTitleSupplier_idl__
39#include <com/sun/star/chart/XSecondAxisTitleSupplier.idl>
40#endif
41
42#ifndef __com_sun_star_beans_XPropertySet_idl__
43#include <com/sun/star/beans/XPropertySet.idl>
44#endif
45
46#ifndef __com_sun_star_chart_ChartDataRowSource_idl__
47#include <com/sun/star/chart/ChartDataRowSource.idl>
48#endif
49
50#ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
51#include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
52#endif
53
54//=============================================================================
55
56 module com {  module sun {  module star {  module chart {
57
58//=============================================================================
59
60/** the base service for the diagram of the chart document.
61
62    <p>The diagram is the object that contains the actual plot.</p>
63
64    <p>Different Diagram Types, e.g., <type>PieDiagram</type> or
65    <type>LineDiagram</type>, can be instantiated by the
66    <type scope="com::sun::star::lang">XMultiServiceFactory</type> of
67    the <type>XChartDocument</type>.</p>
68
69 */
70published service Diagram
71{
72
73    interface com::sun::star::chart::XDiagram;
74
75    /** Provides easier access to the differnet axes and their sub elements.
76        @since OpenOffice 3.4
77    */
78    [optional] interface com::sun::star::chart::XAxisSupplier;
79
80    /** Provides access to the titles of the secondary X axis and Y axis.
81        @since OpenOffice 3.0
82     */
83    [optional] interface com::sun::star::chart::XSecondAxisTitleSupplier;
84
85    /**
86    @since OpenOffice 3.3
87     */
88    [optional] interface com::sun::star::chart::XDiagramPositioning;
89
90    //-------------------------------------------------------------------------
91
92	/** If this property is <TRUE/> the position is calculated by the application automatically.
93        Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
94        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>).
95	 */
96	[optional, property] boolean AutomaticPosition;
97
98    //-------------------------------------------------------------------------
99
100	/** If this property is <TRUE/> the size is calculated by the application automatically.
101        Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
102        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>).
103	 */
104	[optional, property] boolean AutomaticSize;
105
106    //-------------------------------------------------------------------------
107
108	interface com::sun::star::beans::XPropertySet;
109
110	//-------------------------------------------------------------------------
111
112    /** If a <type>Diagram</type> may be stored as XML file, this
113        service should be supported in order to preserve unparsed XML
114        attributes.
115
116	@since OpenOffice 1.1.2
117     */
118    [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;
119
120    //-------------------------------------------------------------------------
121
122	/** determines if the data for a data row is contained in the
123		columns or in the rows of the data array.
124
125        @see ChartDataRowSource
126        @see ChartDataArray
127	 */
128	[property] com::sun::star::chart::ChartDataRowSource DataRowSource;
129
130	//-------------------------------------------------------------------------
131
132	/** specifies how the caption of data points is displayed.
133
134        @see ChartDataCaption
135	 */
136	[property] long DataCaption;
137
138    //-------------------------------------------------------------------------
139
140    /** specifies how empty or invalid cells in the provided data should be handled when displayed
141
142        @see MissingValueTreatment
143	 */
144    [optional, property] long MissingValueTreatment;
145
146};
147
148//=============================================================================
149
150}; }; }; };
151
152#endif
153