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