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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XChartDataArray.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_chart_XChartDataArray_idl__
  31 #define __com_sun_star_chart_XChartDataArray_idl__
  32
  33 #ifndef __com_sun_star_chart_XChartData_idl__
  34 #include <com/sun/star/chart/XChartData.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module chart {
  40
  41 //=============================================================================
  42
  43 /** gives access to data represented as an array of rows.
  44
  45     <p>If used for an <type>XYDiagram</type>, the row number 0
  46     represents the <i>x</i>-values.</p>
  47  */
  48 published interface XChartDataArray: XChartData
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     /** retrieves the numerical data as a nested sequence of values.
  53
  54         @returns
  55             the values as a sequence of sequences.  The inner sequence
  56             represents rows.
  57     */
  58     sequence< sequence< double > > getData();
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** sets the chart data as an array of numbers.
  63
  64         @param aData
  65             the values as a sequence of sequences.  The inner sequence
  66             represents rows.
  67      */
  68     void setData( [in] sequence< sequence< double > > aData );
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** retrieves the description texts for all rows.
  73
  74         @returns
  75             a sequence of strings, each representing the description
  76             of a row.
  77      */
  78     sequence< string > getRowDescriptions();
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** sets the description texts for all rows.
  83
  84         @param aRowDescriptions
  85             a sequence of strings which represent a description for
  86             each row.
  87     */
  88     void setRowDescriptions( [in] sequence< string > aRowDescriptions );
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** retrieves the description texts for all columns.
  93
  94         @returns
  95             a sequence of strings, each representing the description
  96             of a column.
  97      */
  98     sequence< string > getColumnDescriptions();
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** sets the description texts for all columns.
 103
 104         @param aColumnDescriptions
 105             a sequence of strings which represent a description for
 106             each column.
 107      */
 108     void setColumnDescriptions( [in] sequence< string > aColumnDescriptions );
 109 };
 110
 111 //=============================================================================
 112
 113 }; }; }; };
 114
 115 #endif