offapi/com/sun/star/chart/XStatisticDisplay.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 /** gives access to statistical elements for the chart.
  26
  27     <p>Statistical elements are used by a
  28     StockDiagram.</p>
  29
  30     @see XChartDocument
  31     @see StockDiagram
  32  */
  33 published interface XStatisticDisplay: com::sun::star::uno::XInterface
  34 {
  35
  36     /** @returns
  37             the properties of the up bars of a stock chart which has
  38             StockDiagram::UpDown set to `TRUE`.
  39
  40         <p>The <em>UpBar</em> is the box that is drawn between the
  41         open and close value of a stock, when the closing value is
  42         above the opening value, i.e., the stock price rose.</p>
  43
  44         @see ChartArea
  45      */
  46     com::sun::star::beans::XPropertySet getUpBar();
  47
  48
  49     /** @returns
  50             the properties of the down bars of a stock chart which has
  51             StockDiagram::UpDown set to `TRUE`.
  52
  53         <p>The <em>DownBar</em> is the box that is drawn between the
  54         open and close value of a stock, when the closing value is
  55         below the opening value, i.e., the stock price fell.</p>
  56
  57         @see ChartArea
  58      */
  59     com::sun::star::beans::XPropertySet getDownBar();
  60
  61
  62     /** @returns
  63             the properties of the lines that are drawn between the
  64             lowest and highest stock value during a day.
  65
  66         @see ChartLine
  67      */
  68     com::sun::star::beans::XPropertySet getMinMaxLine();
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */