offapi/com/sun/star/chart/StackableDiagram.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: StackableDiagram.idl,v $
  10  * $Revision: 1.11 $
  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_StackableDiagram_idl__
  31 #define __com_sun_star_chart_StackableDiagram_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module chart {
  37
  38 //=============================================================================
  39
  40 /**
  41
  42 a helper service for stackable chart types (e.g., charts in
  43     which the data rows may be displayed stacked on each other or in
  44     percent relation).
  45  */
  46 published service StackableDiagram
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** If <TRUE/>, the series of the diagram are stacked and each
  51         category sums up to 100%.
  52      */
  53     [property] boolean Percent;
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** If <TRUE/>, the series of the diagram are stacked.
  58
  59         <p>If you have a stacked bar chart, you can easily determine
  60         the sum of data in each category, by taking the top of the
  61         topmost bar.</p>
  62      */
  63     [property] boolean Stacked;
  64
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif