offapi/com/sun/star/chart/ChartDataRowProperties.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: ChartDataRowProperties.idl,v $
  10  * $Revision: 1.14 $
  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_ChartDataRowProperties_idl__
  31 #define __com_sun_star_chart_ChartDataRowProperties_idl__
  32
  33 #ifndef __com_sun_star_chart_ChartDataPointProperties_idl__
  34 #include <com/sun/star/chart/ChartDataPointProperties.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_chart_ChartStatistics_idl__
  38 #include <com/sun/star/chart/ChartStatistics.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_XPropertySet_idl__
  42 #include <com/sun/star/beans/XPropertySet.idl>
  43 #endif
  44
  45 #ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
  46 #include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51  module com {  module sun {  module star {  module chart {
  52
  53 //=============================================================================
  54
  55 /** specifies the properties for a group of graphic elements which
  56     belong to a data row (also known as data series).
  57
  58     <p>For this service, the properties supported by
  59     <type>ChartDataPointProperties</type> are applied to all data
  60     point elements contained in this group.  They serve as a template;
  61     thus, when changing a data point property afterwards</p>
  62
  63     @see ChartDataPointProperties
  64  */
  65 published service ChartDataRowProperties
  66 {
  67     service com::sun::star::chart::ChartDataPointProperties;
  68     /** Statistical properties are not available for all types of
  69         diagrams.
  70     */
  71     [optional] service com::sun::star::chart::ChartStatistics;
  72
  73     /** If <type>ChartDataRowProperties</type> may be stored as XML
  74         file, this service should be supported in order to preserve
  75         unparsed XML attributes.
  76
  77     @since OOo 1.1.2
  78      */
  79     [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;
  80
  81     interface com::sun::star::beans::XPropertySet;
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** determines to which axis the data row is assigned.
  86
  87         <p>The axis must be a primary or secondary y-axis</p>
  88
  89         @see ChartAxisAssign
  90         @see ChartAxisYSupplier
  91         @see ChartTwoAxisYSupplier
  92      */
  93     [property] long Axis;
  94
  95     //-------------------------------------------------------------------------
  96
  97     /** holds the properties of the regression line, if such one is
  98         enabled.
  99
 100         @see ChartLine
 101         @see ChartStatistics
 102      */
 103     [optional, readonly, property] com::sun::star::beans::XPropertySet DataRegressionProperties;
 104
 105     //-------------------------------------------------------------------------
 106
 107     /** holds the properties of the error markers, if those are
 108         enabled.
 109
 110         @see ChartLine
 111         @see ChartStatistics
 112      */
 113     [optional, readonly, property] com::sun::star::beans::XPropertySet DataErrorProperties;
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** holds the properties of the average line, if such one is
 118         enabled.
 119
 120         @see ChartLine
 121         @see ChartStatistics
 122      */
 123     [optional, readonly, property] com::sun::star::beans::XPropertySet DataMeanValueProperties;
 124 };
 125
 126 //=============================================================================
 127
 128 }; }; }; };
 129
 130 #endif