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