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