xref: /aoo42x/main/offapi/com/sun/star/chart2/XDiagram.idl (revision d1766043)
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_chart2_XDiagram_idl
24#define com_sun_star_chart2_XDiagram_idl
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#include <com/sun/star/beans/XPropertySet.idl>
31#include <com/sun/star/beans/PropertyValue.idl>
32#include <com/sun/star/chart2/XLegend.idl>
33#include <com/sun/star/chart2/XColorScheme.idl>
34#include <com/sun/star/chart2/data/XDataSource.idl>
35#include <com/sun/star/chart2/data/XLabeledDataSequence.idl>
36
37module com
38{
39module sun
40{
41module star
42{
43module chart2
44{
45
46interface XDiagram : ::com::sun::star::uno::XInterface
47{
48    /** returns the property set that determines the visual appearance
49        of the wall.
50
51        <p>The wall is the area behind the union of all
52        coordinate systems used in a diagram.</p>
53     */
54    com::sun::star::beans::XPropertySet getWall();
55
56    /** returns the property set that determines the visual appearance
57        of the floor if any.
58
59        <p>The floor is the bottom of a 3D diagram.
60        For a 2D diagram NULL is returned.</p>
61     */
62    com::sun::star::beans::XPropertySet getFloor();
63
64    /** returns the legend, which may represent data series and other
65        information about a diagram in a separate box.
66     */
67    XLegend getLegend();
68
69    /** sets a new legend.
70     */
71    void setLegend( [in] XLegend xLegend );
72
73    /** returns an <type>XColorScheme</type> that defines the default
74        colors for data series (or data points) in the diagram.
75     */
76    XColorScheme   getDefaultColorScheme();
77
78    /** sets an <type>XColorScheme</type> that defines the default
79        colors for data series (or data points) in the diagram.
80     */
81    void setDefaultColorScheme( [in] XColorScheme xColorScheme );
82
83    /** sets new data to the diagram.
84
85        @param xDataSource
86            This data source will be interpreted in a chart-type
87            specific way and the <type>DataSeries</type> found in
88            <code>xDiagram</code> will be adapted to the new data.
89            Missing data series will be created and unused ones will
90            be deleted.
91
92        @param aArguments
93            Arguments tells how to slice the given data.
94
95            <p>For standard parameters that may be used, see the
96            service <type>StandardDiagramCreationParameters</type>.
97            </p>
98     */
99    void setDiagramData( [in] data::XDataSource xDataSource,
100        [in] sequence< com::sun::star::beans::PropertyValue > aArguments );
101};
102
103} ; // chart2
104} ; // com
105} ; // sun
106} ; // star
107
108#endif
109