offapi/com/sun/star/chart2/data/DataSequenceRole.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef com_sun_star_chart2_data_DataSequenceRole_idl
  29 #define com_sun_star_chart2_data_DataSequenceRole_idl
  30
  31 module com
  32 {
  33 module sun
  34 {
  35 module star
  36 {
  37 module chart2
  38 {
  39 module data
  40 {
  41
  42 /** a string that states in what way a <type>DataSequence</type>
  43     should be used.  If this property is an empty string, no
  44     proposition about usage is made.
  45
  46     <p>The strings can have any value.  However some values are
  47     predefined and should always be interpreted in the same way.</p>
  48
  49     <dl>
  50      <dt>label</dt>
  51        <dd>values are used as a label for a series.  Usually, you
  52            will have just one cell containing a string.</dd>
  53      <dt>values-x</dt>
  54        <dd>values are used as x-values in an XY- or bubble
  55            diagram</dd>
  56      <dt>values-y</dt>
  57        <dd>values are used as y-values in an XY-Diagram or as values
  58            in a bar, line, etc. chart</dd>
  59      <dt>values-z</dt>
  60        <dd>values may be used as z-values in a three-dimensional
  61            XYZ-Diagram or a surface-chart</dd>
  62      <dt>sizes</dt>
  63        <dd>values are used as radius of the bubbles in a
  64            Bubble-Diagram</dd>
  65      <dt>error-bars-x-positive</dt>
  66        <dd>values are used as error-information in positive x-direction for
  67            displaying error-bars</dd>
  68      <dt>error-bars-x-negative</dt>
  69        <dd>values are used as error-information in negative x-direction for
  70            displaying error-bars</dd>
  71      <dt>error-bars-y-positive</dt>
  72        <dd>values are used as error-information in positive y-direction for
  73            displaying error-bars</dd>
  74      <dt>error-bars-y-negative</dt>
  75        <dd>values are used as error-information in negative y-direction for
  76            displaying error-bars</dd>
  77      <dt>categories</dt>
  78        <dd>values are used for categories in the diagram</dd>
  79     </dl>
  80
  81     <p>In a candle-stick chart you have the following roles:</p>
  82
  83     <dl>
  84      <dt>values-first</dt>
  85       <dd>the first value of a series of values.  In a stock-chart this
  86           would be the opening course.</dd>
  87      <dt>values-last</dt>
  88       <dd>the last value of a series of values.  In a stock-chart this
  89           would be the closing course.</dd>
  90      <dt>values-min</dt>
  91       <dd>the minimum value of a series of values.  In a stock-chart
  92           this would be the lowest course that occurred during
  93           trading.</dd>
  94      <dt>values-max</dt>
  95       <dd>the maximum value of a series of values.  In a stock-chart
  96           this would be the highest course that occurred during
  97           trading.</dd>
  98     </dl>
  99  */
 100 typedef string DataSequenceRole;
 101
 102 } ; // data
 103 } ; // chart2
 104 } ; // com
 105 } ; // sun
 106 } ; // star
 107
 108
 109 #endif
 110
 111 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */