offapi/com/sun/star/chart/ChartSeriesAddress.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: ChartSeriesAddress.idl,v $
  10  * $Revision: 1.10 $
  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_ChartSeriesAddress_idl__
  31 #define __com_sun_star_chart_ChartSeriesAddress_idl__
  32
  33 //=============================================================================
  34
  35  module com {  module sun {  module star {  module chart {
  36
  37 //=============================================================================
  38
  39 /** This structure describes a single data row, specified by its name
  40     and a sequence of data points.
  41
  42     <p>The cell addresses are in the format of the application that
  43     contains this chart.</p>
  44  */
  45 published struct ChartSeriesAddress
  46 {
  47     /** contains the cell range address of the data for this series.
  48      */
  49     string DataRangeAddress;
  50
  51     //-------------------------------------------------------------------------
  52
  53     /** contains the cell address of label (i.e. name) of this series.
  54      */
  55     string LabelAddress;
  56
  57     //-------------------------------------------------------------------------
  58
  59     /** contains cell addresses for each domain of this series.
  60
  61         <p>For XY (scatter) diagrams at least one series has a
  62         domain. Most of the other chart types use an empty sequence
  63         here.</p>
  64      */
  65     sequence< string > DomainRangeAddresses;
  66 };
  67
  68 //=============================================================================
  69
  70 }; }; }; };
  71
  72 #endif