offapi/com/sun/star/chart/XChartDataArray.idl

   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_chart_XChartDataArray_idl__
  28 #define __com_sun_star_chart_XChartDataArray_idl__
  29
  30 #ifndef __com_sun_star_chart_XChartData_idl__
  31 #include <com/sun/star/chart/XChartData.idl>
  32 #endif
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module chart {
  37
  38 //=============================================================================
  39
  40 /** gives access to data represented as an array of rows.
  41
  42     <p>Can be obtained from interface <type>XChartDocument</type> via method getData().</p>
  43
  44     <p>If used for an <type>XYDiagram</type>, the row number 0
  45     represents the <i>x</i>-values.</p>
  46  */
  47 published interface XChartDataArray: XChartData
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     /** retrieves the numerical data as a nested sequence of values.
  52
  53         @returns
  54             the values as a sequence of sequences.  The inner sequence
  55             represents rows.
  56     */
  57     sequence< sequence< double > > getData();
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** sets the chart data as an array of numbers.
  62
  63         @param aData
  64             the values as a sequence of sequences.  The inner sequence
  65             represents rows.
  66      */
  67     void setData( [in] sequence< sequence< double > > aData );
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** retrieves the description texts for all rows.
  72
  73         @returns
  74             a sequence of strings, each representing the description
  75             of a row.
  76      */
  77     sequence< string > getRowDescriptions();
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** sets the description texts for all rows.
  82
  83         @param aRowDescriptions
  84             a sequence of strings which represent a description for
  85             each row.
  86     */
  87     void setRowDescriptions( [in] sequence< string > aRowDescriptions );
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** retrieves the description texts for all columns.
  92
  93         @returns
  94             a sequence of strings, each representing the description
  95             of a column.
  96      */
  97     sequence< string > getColumnDescriptions();
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** sets the description texts for all columns.
 102
 103         @param aColumnDescriptions
 104             a sequence of strings which represent a description for
 105             each column.
 106      */
 107     void setColumnDescriptions( [in] sequence< string > aColumnDescriptions );
 108 };
 109
 110 //=============================================================================
 111
 112 }; }; }; };
 113
 114 #endif