offapi/com/sun/star/chart2/data/DataSequenceRole.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: DataSequenceRole.idl,v $
  10  * $Revision: 1.4 $
  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_chart2_data_DataSequenceRole_idl
  31 #define com_sun_star_chart2_data_DataSequenceRole_idl
  32
  33 module com
  34 {
  35 module sun
  36 {
  37 module star
  38 {
  39 module chart2
  40 {
  41 module data
  42 {
  43
  44 /** a string that states in what way a <type>DataSequence</type>
  45     should be used.  If this property is an empty string, no
  46     proposition about usage is made.
  47
  48     <p>The strings can have any value.  However some values are
  49     predefined and should always be interpreted in the same way.</p>
  50
  51     <dl>
  52      <dt>label</dt>
  53        <dd>values are used as a label for a series.  Usually, you
  54            will have just one cell containing a string.</dd>
  55      <dt>values-x</dt>
  56        <dd>values are used as x-values in an XY- or bubble
  57            diagram</dd>
  58      <dt>values-y</dt>
  59        <dd>values are used as y-values in an XY-Diagram or as values
  60            in a bar, line, etc. chart</dd>
  61      <dt>values-z</dt>
  62        <dd>values may be used as z-values in a three-dimensional
  63            XYZ-Diagram or a surface-chart</dd>
  64      <dt>sizes</dt>
  65        <dd>values are used as radius of the bubbles in a
  66            Bubble-Diagram</dd>
  67      <dt>error-bars-x-positive</dt>
  68        <dd>values are used as error-information in positive x-direction for
  69            displaying error-bars</dd>
  70      <dt>error-bars-x-negative</dt>
  71        <dd>values are used as error-information in negative x-direction for
  72            displaying error-bars</dd>
  73      <dt>error-bars-y-positive</dt>
  74        <dd>values are used as error-information in positive y-direction for
  75            displaying error-bars</dd>
  76      <dt>error-bars-y-negative</dt>
  77        <dd>values are used as error-information in negative y-direction for
  78            displaying error-bars</dd>
  79      <dt>categories</dt>
  80        <dd>values are used for categories in the diagram</dd>
  81     </dl>
  82
  83     <p>In a candle-stick chart you have the following roles:</p>
  84
  85     <dl>
  86      <dt>values-first</dt>
  87       <dd>the first value of a series of values.  In a stock-chart this
  88           would be the opening course.</dd>
  89      <dt>values-last</dt>
  90       <dd>the last value of a series of values.  In a stock-chart this
  91           would be the closing course.</dd>
  92      <dt>values-min</dt>
  93       <dd>the minimum value of a series of values.  In a stock-chart
  94           this would be the lowest course that occured during
  95           trading.</dd>
  96      <dt>values-max</dt>
  97       <dd>the maximum value of a series of values.  In a stock-chart
  98           this would be the highest course that occured during
  99           trading.</dd>
 100     </dl>
 101  */
 102 typedef string DataSequenceRole;
 103
 104 } ; // data
 105 } ; // chart2
 106 } ; // com
 107 } ; // sun
 108 } ; // star
 109
 110
 111 #endif