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