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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21  module com {  module sun {  module star {  module chart {
  22
  23
  24 /** gives access to data represented as an array of rows.
  25
  26     <p>Can be obtained from interface XChartDocument via method getData().</p>
  27
  28     <p>If used for an XYDiagram, the row number 0
  29     represents the <i>x</i>-values.</p>
  30  */
  31 published interface XChartDataArray: XChartData
  32 {
  33
  34     /** retrieves the numerical data as a nested sequence of values.
  35
  36         @returns
  37             the values as a sequence of sequences.  The inner sequence
  38             represents rows.
  39     */
  40     sequence< sequence< double > > getData();
  41
  42
  43     /** sets the chart data as an array of numbers.
  44
  45         @param aData
  46             the values as a sequence of sequences.  The inner sequence
  47             represents rows.
  48      */
  49     void setData( [in] sequence< sequence< double > > aData );
  50
  51
  52     /** retrieves the description texts for all rows.
  53
  54         @returns
  55             a sequence of strings, each representing the description
  56             of a row.
  57      */
  58     sequence< string > getRowDescriptions();
  59
  60
  61     /** sets the description texts for all rows.
  62
  63         @param aRowDescriptions
  64             a sequence of strings which represent a description for
  65             each row.
  66     */
  67     void setRowDescriptions( [in] sequence< string > aRowDescriptions );
  68
  69
  70     /** retrieves the description texts for all columns.
  71
  72         @returns
  73             a sequence of strings, each representing the description
  74             of a column.
  75      */
  76     sequence< string > getColumnDescriptions();
  77
  78
  79     /** sets the description texts for all columns.
  80
  81         @param aColumnDescriptions
  82             a sequence of strings which represent a description for
  83             each column.
  84      */
  85     void setColumnDescriptions( [in] sequence< string > aColumnDescriptions );
  86 };
  87
  88
  89 }; }; }; };
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */