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