offapi/com/sun/star/chart/ChartDataPointProperties.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_ChartDataPointProperties_idl__
  28 #define __com_sun_star_chart_ChartDataPointProperties_idl__
  29
  30 #ifndef __com_sun_star_drawing_FillProperties_idl__
  31 #include <com/sun/star/drawing/FillProperties.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_drawing_LineProperties_idl__
  35 #include <com/sun/star/drawing/LineProperties.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_style_CharacterProperties_idl__
  39 #include <com/sun/star/style/CharacterProperties.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_chart_Chart3DBarPropertiesidl__
  43 #include <com/sun/star/chart/Chart3DBarProperties.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_beans_XPropertySet_idl__
  47 #include <com/sun/star/beans/XPropertySet.idl>
  48 #endif
  49
  50 #ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
  51 #include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
  52 #endif
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module chart {
  57
  58 //=============================================================================
  59
  60 /** specifies all the properties for the graphic object of
  61     a data point (e.g., a single bar in a bar chart).
  62
  63     <p>Text properties correlate to the data description of the data
  64     point.  There is a similar service for a group of graphic elements
  65     called <type>ChartDataRowProperties</type> for the properties of
  66     whole data rows.</p>
  67
  68     @see ChartDataRowProperties
  69  */
  70 published service ChartDataPointProperties
  71 {
  72     /** This service has to be supported for data points that can be
  73         filled.
  74      */
  75     [optional] service com::sun::star::drawing::FillProperties;
  76
  77     service com::sun::star::drawing::LineProperties;
  78
  79     /** These properties affect the characters of data captions if
  80         those are displayed.
  81      */
  82     service com::sun::star::style::CharacterProperties;
  83
  84     /** If <type>ChartDataPointProperties</type> may be stored as XML
  85         element, this service should be supported in order to preserve
  86         unparsed XML attributes.
  87
  88     @since OOo 1.1.2
  89      */
  90     [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** is only available if the chart is of type
  95         <type>BarDiagram</type> and <type>Dim3DDiagram</type> and the
  96         property <member>ChartDataPointProperties::Dim3D</member> is
  97         set to <TRUE/>.
  98
  99         @see BarDiagram
 100         @see Dim3DDiagram@see BarDiagram
 101         @see Dim3DDiagram
 102      */
 103     [optional] service com::sun::star::chart::Chart3DBarProperties;
 104
 105     interface com::sun::star::beans::XPropertySet;
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** specifies how the captions of data points are displayed.@see ChartDataCaption
 110      */
 111     [property] long DataCaption;
 112
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** specifies a string that is used to separate the parts of a data label (caption)
 117      */
 118     [optional, property] string LabelSeparator;
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** specifies a number format for the display of the value in the data label
 123      */
 124     [optional, property] long NumberFormat;
 125
 126     //-------------------------------------------------------------------------
 127
 128     /** specifies a number format for the display of the percentage value in the data label
 129      */
 130     [optional, property] long PercentageNumberFormat;
 131
 132     //-------------------------------------------------------------------------
 133
 134     /** specifies a relative position for the data label
 135
 136         @see DataLabelPlacement
 137      */
 138     [optional, property] long LabelPlacement;
 139
 140     //-------------------------------------------------------------------------
 141
 142     /** specifies the type of symbols if the current chart type
 143         supports the usage of symbols.
 144
 145         @see ChartSymbolType
 146      */
 147     [optional, property] long SymbolType;
 148
 149     //-------------------------------------------------------------------------
 150
 151     /** In charts that support symbols, you can set this property to
 152         any valid URL that points to a graphic file.  This graphic is
 153         then used as symbol for each data point.
 154
 155         <p>When you query this value you get an internal URL of the
 156         embedded graphic.</p>
 157
 158         @see ChartSymbolType
 159      */
 160     [optional, property] string SymbolBitmapURL;
 161
 162     /** the offset by which pie segments in a <type>PieDiagram</type>
 163         are dragged outside from the center.  This value is given in
 164         percent of the radius.
 165      */
 166     [optional, property] long SegmentOffset;
 167 };
 168
 169 //=============================================================================
 170
 171 }; }; }; };
 172
 173 #endif