offapi/com/sun/star/chart/BarDiagram.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_BarDiagram_idl__
  20 #define __com_sun_star_chart_BarDiagram_idl__
  21
  22 #include <com/sun/star/chart/Diagram.idl>
  23 #include <com/sun/star/chart/ChartStatistics.idl>
  24 #include <com/sun/star/chart/ChartAxisXSupplier.idl>
  25 #include <com/sun/star/chart/ChartTwoAxisYSupplier.idl>
  26 #include <com/sun/star/chart/ChartAxisZSupplier.idl>
  27 #include <com/sun/star/chart/Dim3DDiagram.idl>
  28 #include <com/sun/star/chart/StackableDiagram.idl>
  29
  30
  31
  32  module com {  module sun {  module star {  module chart {
  33
  34
  35 /**This is a service for bar and column diagrams.
  36  */
  37 published service BarDiagram
  38 {
  39     service com::sun::star::chart::Diagram;
  40     service com::sun::star::chart::ChartStatistics;
  41     service com::sun::star::chart::ChartAxisXSupplier;
  42     service com::sun::star::chart::ChartTwoAxisYSupplier;
  43     service com::sun::star::chart::ChartAxisZSupplier;
  44     service com::sun::star::chart::Dim3DDiagram;
  45     service com::sun::star::chart::StackableDiagram;
  46
  47
  48     /** Determines if the bars of a chart are drawn vertically or
  49         horizontally.  Default is vertical.
  50
  51         <p>If Vertical is `FALSE` you get a column chart rather than
  52         a bar chart.</p>
  53      */
  54     [property] boolean Vertical;
  55
  56
  57     /** If `TRUE`, determines that in a three-dimensional bar chart
  58         the bars of each series are arranged behind each other in the
  59         z-direction.  If `FALSE` the arrangement of bars is like in
  60         two-dimensional bar charts.
  61      */
  62     [optional, property] boolean Deep;
  63
  64
  65     /** determines if, in a stacked chart, there are connecting lines
  66         between corresponding bars. Currently, bar charts with
  67         horizontal bars do not support this property.
  68      */
  69     [optional, property] boolean StackedBarsConnected;
  70
  71
  72     /** If bars of a bar or column chart are attached to different
  73         axis, this property determines how to display those.  If
  74         `TRUE`, the bars are grouped together in one block for each
  75         axis, thus they are painted one group over the other.
  76
  77         <p>If `FALSE`, the bars are displayed side-by-side, as if
  78         they were all attached to the same axis.</p>
  79
  80         <p>If all data series of a bar or column chart are attached to
  81         only one axis, this property has no effect.</p>
  82     */
  83     [optional, property] boolean GroupBarsPerAxis;
  84
  85
  86
  87     /** Determines how many data rows are displayed as lines rather than
  88         bars.
  89
  90         <p>If this property differs from zero the last
  91         BarDiagram::NumberOfLines data rows are shown as lines. It is
  92         currently supported by two dimensional vertical bar charts only. </p>
  93
  94         @deprecated
  95      */
  96     [property] long NumberOfLines;
  97 };
  98
  99
 100 }; }; }; };
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */