xref: /aoo4110/main/offapi/com/sun/star/chart2/data/DataSequenceRole.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef com_sun_star_chart2_data_DataSequenceRole_idl
#define com_sun_star_chart2_data_DataSequenceRole_idl

module com
{
module sun
{
module star
{
module chart2
{
module data
{

/** a string that states in what way a <type>DataSequence</type>
    should be used.  If this property is an empty string, no
    proposition about usage is made.

    <p>The strings can have any value.  However some values are
    predefined and should always be interpreted in the same way.</p>

    <dl>
     <dt>label</dt>
       <dd>values are used as a label for a series.  Usually, you
           will have just one cell containing a string.</dd>
     <dt>values-x</dt>
       <dd>values are used as x-values in an XY- or bubble
           diagram</dd>
     <dt>values-y</dt>
       <dd>values are used as y-values in an XY-Diagram or as values
           in a bar, line, etc. chart</dd>
     <dt>values-z</dt>
       <dd>values may be used as z-values in a three-dimensional
           XYZ-Diagram or a surface-chart</dd>
     <dt>sizes</dt>
       <dd>values are used as radius of the bubbles in a
           Bubble-Diagram</dd>
     <dt>error-bars-x-positive</dt>
       <dd>values are used as error-information in positive x-direction for
           displaying error-bars</dd>
     <dt>error-bars-x-negative</dt>
       <dd>values are used as error-information in negative x-direction for
           displaying error-bars</dd>
     <dt>error-bars-y-positive</dt>
       <dd>values are used as error-information in positive y-direction for
           displaying error-bars</dd>
     <dt>error-bars-y-negative</dt>
       <dd>values are used as error-information in negative y-direction for
           displaying error-bars</dd>
     <dt>categories</dt>
       <dd>values are used for categories in the diagram</dd>
    </dl>

    <p>In a candle-stick chart you have the following roles:</p>

    <dl>
     <dt>values-first</dt>
      <dd>the first value of a series of values.  In a stock-chart this
          would be the opening course.</dd>
     <dt>values-last</dt>
      <dd>the last value of a series of values.  In a stock-chart this
          would be the closing course.</dd>
     <dt>values-min</dt>
      <dd>the minimum value of a series of values.  In a stock-chart
          this would be the lowest course that occured during
          trading.</dd>
     <dt>values-max</dt>
      <dd>the maximum value of a series of values.  In a stock-chart
          this would be the highest course that occured during
          trading.</dd>
    </dl>
 */
typedef string DataSequenceRole;

} ; // data
} ; // chart2
} ; // com
} ; // sun
} ; // star


#endif