offapi/com/sun/star/chart/StockDiagram.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_chart_StockDiagram_idl__
  20 #define __com_sun_star_chart_StockDiagram_idl__
  21
  22 #include <com/sun/star/chart/XStatisticDisplay.idl>
  23
  24 #include <com/sun/star/chart/ChartStatistics.idl>
  25
  26 #include <com/sun/star/chart/Diagram.idl>
  27
  28 #include <com/sun/star/chart/ChartAxisXSupplier.idl>
  29
  30 #include <com/sun/star/chart/ChartTwoAxisYSupplier.idl>
  31
  32
  33
  34  module com {  module sun {  module star {  module chart {
  35
  36
  37 /** specifies a diagram which can be used for presenting stock quotes.
  38
  39     <p>Note that the data must have a specific structure for stock
  40     diagrams.  Let us assume that data is interpreted, such that
  41     series are taken from columns (see property
  42     Diagram::DataRowSource).  Then you need tables of
  43     the following structures for different types:</p>
  44
  45     <p><strong>
  46      StockDiagram::Volume is `FALSE`<br>
  47      StockDiagram::UpDown is `FALSE`
  48     </strong>
  49     <table border>
  50      <tr><td>Low</td><td>High</td><td>Close</td></tr>
  51      <tr><td>...</td><td>...</td><td>...</td></tr>
  52     </table></p>
  53
  54     <p><strong>
  55      StockDiagram::Volume is `TRUE`<br>
  56      StockDiagram::UpDown is `FALSE`
  57     </strong>
  58     <table border>
  59      <tr><td><strong>Volume</strong></td><td>Low</td><td>High</td><td>Close</td></tr>
  60      <tr><td>...</td><td>...</td><td>...</td><td>...</td></tr>
  61     </table></p>
  62
  63     <p><strong>
  64      StockDiagram::Volume is `FALSE`<br>
  65      StockDiagram::UpDown is `TRUE`
  66     </strong>
  67     <table border>
  68      <tr><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr>
  69      <tr><td>...</td><td>...</td><td>...</td><td>...</td></tr>
  70     </table></p>
  71
  72     <p><strong>
  73      StockDiagram::Volume is `TRUE`<br>
  74      StockDiagram::UpDown is `TRUE`
  75     </strong>
  76     <table border>
  77      <tr><td><strong>Volume</strong></td><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr>
  78      <tr><td>...</td><td>...</td><td>...</td><td>...</td><td>...</td></tr>
  79     </table></p>
  80 */
  81 published service StockDiagram
  82 {
  83     interface com::sun::star::chart::XStatisticDisplay;
  84     service com::sun::star::chart::ChartStatistics;
  85     service com::sun::star::chart::Diagram;
  86     service com::sun::star::chart::ChartAxisXSupplier;
  87     service com::sun::star::chart::ChartTwoAxisYSupplier;
  88
  89
  90     /** indicates if a stock chart contains data representing the
  91         volume of stocks.
  92
  93         <p>The values of the volume are represented as columns like
  94         those of a BarDiagram.</p>
  95
  96         <p>If this property is set to `TRUE`, the values of the first
  97         series of the chart data are interpreted as volume.</p>
  98      */
  99     [property] boolean Volume;
 100
 101
 102     /** indicates if a stock chart contains data representing the
 103         value of stocks on the opening and closing date.
 104
 105         <p>The difference will be indicated by bars.  The color
 106         of the bar will be significant for positive or negative
 107         differences between open and closed data.</p>
 108
 109         <p>If this property is `FALSE`, the values of the first
 110         series (or second if StockDiagram::Volume is
 111         `TRUE`) of the chart data are interpreted as the day's lowest
 112         value.  The next series is interpreted as the day's highest
 113         value, and the last series is interpreted as the closing
 114         value.</p>
 115
 116         <p>If this property is set to `TRUE`, one additional series
 117         is needed with the opening value of the stocks.  It is assumed
 118         as the series before the series with the day's lowest
 119         value.</p>
 120      */
 121     [property] boolean UpDown;
 122
 123 };
 124
 125
 126 }; }; }; };
 127
 128 #endif
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */