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