offapi/com/sun/star/chart/BarDiagram.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: BarDiagram.idl,v $
  10  * $Revision: 1.13 $
  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_BarDiagram_idl__
  31 #define __com_sun_star_chart_BarDiagram_idl__
  32
  33 #ifndef __com_sun_star_chart_Diagram_idl__
  34 #include <com/sun/star/chart/Diagram.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_chart_ChartStatistics_idl__
  38 #include <com/sun/star/chart/ChartStatistics.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_chart_ChartAxisXSupplier_idl__
  42 #include <com/sun/star/chart/ChartAxisXSupplier.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_chart_ChartTwoAxisYSupplier_idl__
  46 #include <com/sun/star/chart/ChartTwoAxisYSupplier.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_chart_ChartAxisZSupplier_idl__
  50 #include <com/sun/star/chart/ChartAxisZSupplier.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_chart_Dim3DDiagram_idl__
  54 #include <com/sun/star/chart/Dim3DDiagram.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_chart_StackableDiagram_idl__
  58 #include <com/sun/star/chart/StackableDiagram.idl>
  59 #endif
  60
  61
  62 //=============================================================================
  63
  64  module com {  module sun {  module star {  module chart {
  65
  66 //=============================================================================
  67
  68 /**This is a service for bar and column diagrams.
  69  */
  70 published service BarDiagram
  71 {
  72     service com::sun::star::chart::Diagram;
  73     service com::sun::star::chart::ChartStatistics;
  74     service com::sun::star::chart::ChartAxisXSupplier;
  75     service com::sun::star::chart::ChartTwoAxisYSupplier;
  76     service com::sun::star::chart::ChartAxisZSupplier;
  77     service com::sun::star::chart::Dim3DDiagram;
  78     service com::sun::star::chart::StackableDiagram;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** Determines if the bars of a chart are drawn vertically or
  83         horizontally.  Default is vertical.
  84
  85         <p>If Vertical is <FALSE/> you get a column chart rather than
  86         a bar chart.</p>
  87      */
  88     [property] boolean Vertical;
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** If <TRUE/>, determines that in a three-dimensional bar chart
  93         the bars of each series are arranged behind each other in the
  94         z-direction.  If <FALSE/> the arrangement of bars is like in
  95         two-dimensional bar charts.
  96      */
  97     [optional, property] boolean Deep;
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** determines if, in a stacked chart, there are connecting lines
 102         between corresponding bars. Currently, bar charts with
 103         horizontal bars do not support this property.
 104      */
 105     [optional, property] boolean StackedBarsConnected;
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** If bars of a bar or column chart are attached to different
 110         axis, this property determines how to display those.  If
 111         <TRUE/>, the bars are grouped together in one block for each
 112         axis, thus they are painted one group over the other.
 113
 114         <p>If <FALSE/>, the bars are displayed side-by-side, as if
 115         they were all attached to the same axis.</p>
 116
 117         <p>If all data series of a bar or column chart are attached to
 118         only one axis, this property has no effect.</p>
 119     */
 120     [optional, property] boolean GroupBarsPerAxis;
 121
 122     //-------------------------------------------------------------------------
 123
 124
 125     /** Determines how many data rows are displayed as lines rather than
 126         bars.
 127
 128         <p>If this property differs from zero the last
 129         <member>BarDiagram::NumberOfLines</member> data rows are shown as lines. It is
 130         currently supported by two dimensional vertical bar charts only. </p>
 131
 132         @deprecated
 133      */
 134     [property] long NumberOfLines;
 135 };
 136
 137 //=============================================================================
 138
 139 }; }; }; };
 140
 141 #endif