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