xref: /aoo42x/main/offapi/com/sun/star/chart2/XDiagram.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef com_sun_star_chart2_XDiagram_idl
28#define com_sun_star_chart2_XDiagram_idl
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#include <com/sun/star/beans/XPropertySet.idl>
35#include <com/sun/star/beans/PropertyValue.idl>
36#include <com/sun/star/chart2/XLegend.idl>
37#include <com/sun/star/chart2/XColorScheme.idl>
38#include <com/sun/star/chart2/data/XDataSource.idl>
39#include <com/sun/star/chart2/data/XLabeledDataSequence.idl>
40
41module com
42{
43module sun
44{
45module star
46{
47module chart2
48{
49
50interface XDiagram : ::com::sun::star::uno::XInterface
51{
52    /** returns the property set that determines the visual appearance
53        of the wall.
54
55        <p>The wall is the area behind the union of all
56        coordinate systems used in a diagram.</p>
57     */
58    com::sun::star::beans::XPropertySet getWall();
59
60    /** returns the property set that determines the visual appearance
61        of the floor if any.
62
63        <p>The floor is the bottom of a 3D diagram.
64        For a 2D diagram NULL is returned.</p>
65     */
66    com::sun::star::beans::XPropertySet getFloor();
67
68    /** returns the legend, which may represent data series and other
69        information about a diagram in a separate box.
70     */
71    XLegend getLegend();
72
73    /** sets a new legend.
74     */
75    void setLegend( [in] XLegend xLegend );
76
77    /** returns an <type>XColorScheme</type> that defines the default
78        colors for data series (or data points) in the diagram.
79     */
80    XColorScheme   getDefaultColorScheme();
81
82    /** sets an <type>XColorScheme</type> that defines the default
83        colors for data series (or data points) in the diagram.
84     */
85    void setDefaultColorScheme( [in] XColorScheme xColorScheme );
86
87    /** sets new data to the diagram.
88
89        @param xDataSource
90            This data source will be interpreted in a chart-type
91            specific way and the <type>DataSeries</type> found in
92            <code>xDiagram</code> will be adapted to the new data.
93            Missing data series will be created and unused ones will
94            be deleted.
95
96        @param aArguments
97            Arguments tells how to slice the given data.
98
99            <p>For standard parameters that may be used, see the
100            service <type>StandardDiagramCreationParameters</type>.
101            </p>
102     */
103    void setDiagramData( [in] data::XDataSource xDataSource,
104        [in] sequence< com::sun::star::beans::PropertyValue > aArguments );
105};
106
107} ; // chart2
108} ; // com
109} ; // sun
110} ; // star
111
112#endif
113