xref: /AOO41X/main/offapi/com/sun/star/chart/XDiagram.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_XDiagram_idl__
24#define __com_sun_star_chart_XDiagram_idl__
25
26#ifndef __com_sun_star_drawing_XShape_idl__
27#include <com/sun/star/drawing/XShape.idl>
28#endif
29
30#ifndef __com_sun_star_beans_XPropertySet_idl__
31#include <com/sun/star/beans/XPropertySet.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
35#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
36#endif
37
38//=============================================================================
39
40 module com {  module sun {  module star {  module chart {
41
42//=============================================================================
43
44/** manages the diagram of the chart document.
45
46    @see XChartDocument
47 */
48published interface XDiagram: com::sun::star::drawing::XShape
49{
50    //-------------------------------------------------------------------------
51
52    /** @returns
53            a string representing the diagram type. This string
54            contains the fully qualified name of the corresponding
55            service.
56     */
57    string getDiagramType();
58
59    //-------------------------------------------------------------------------
60
61    /** @returns
62            the properties of the specified data row (series).
63
64        @param nRow
65            the index of the series (0-based)
66
67        @see ChartDataRowProperties
68     */
69    com::sun::star::beans::XPropertySet getDataRowProperties( [in] long nRow )
70        raises( com::sun::star::lang::IndexOutOfBoundsException );
71
72    //-------------------------------------------------------------------------
73
74    /** @returns
75            the properties of the specified data point.
76
77        @param nCol
78            the index of the data point of a series (0-based).
79        @param nRow
80            the index of a series (0-based).
81
82        @see ChartDataPointProperties
83     */
84    com::sun::star::beans::XPropertySet getDataPointProperties( [in] long nCol,
85                                                                [in] long nRow )
86        raises( com::sun::star::lang::IndexOutOfBoundsException );
87
88};
89
90//=============================================================================
91
92}; }; }; };
93
94#endif
95