summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/chart/XChartDataArray.idl
blob: 4e75198643823e8eb58b3cf59e06897d3e6a71d3 (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
/*************************************************************************
 *
 * 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_XChartDataArray_idl__
#define __com_sun_star_chart_XChartDataArray_idl__

#ifndef __com_sun_star_chart_XChartData_idl__
#include <com/sun/star/chart/XChartData.idl>
#endif

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

 module com {  module sun {  module star {  module chart {

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

/** gives access to data represented as an array of rows.

    <p>Can be obtained from interface <type>XChartDocument</type> via method getData().</p>

    <p>If used for an <type>XYDiagram</type>, the row number 0
    represents the <i>x</i>-values.</p>
 */
published interface XChartDataArray: XChartData
{
    //-------------------------------------------------------------------------

    /** retrieves the numerical data as a nested sequence of values.

        @returns
            the values as a sequence of sequences.  The inner sequence
            represents rows.
    */
    sequence< sequence< double > > getData();

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

    /** sets the chart data as an array of numbers.

        @param aData
            the values as a sequence of sequences.  The inner sequence
            represents rows.
     */
    void setData( [in] sequence< sequence< double > > aData );

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

    /** retrieves the description texts for all rows.

        @returns
            a sequence of strings, each representing the description
            of a row.
     */
    sequence< string > getRowDescriptions();

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

    /** sets the description texts for all rows.

        @param aRowDescriptions
            a sequence of strings which represent a description for
            each row.
    */
    void setRowDescriptions( [in] sequence< string > aRowDescriptions );

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

    /** retrieves the description texts for all columns.

        @returns
            a sequence of strings, each representing the description
            of a column.
     */
    sequence< string > getColumnDescriptions();

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

    /** sets the description texts for all columns.

        @param aColumnDescriptions
            a sequence of strings which represent a description for
            each column.
     */
    void setColumnDescriptions( [in] sequence< string > aColumnDescriptions );
};

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

}; }; }; };

#endif