offapi/com/sun/star/chart/ChartDataCaption.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_ChartDataCaption_idl__
  20 #define __com_sun_star_chart_ChartDataCaption_idl__
  21
  22
  23
  24  module com {  module sun {  module star {  module chart {
  25
  26
  27 /** These values specify how the captions of data points are displayed.
  28  */
  29 published constants ChartDataCaption
  30 {
  31
  32     /** No captions are displayed.
  33      */
  34     const long NONE = 0;
  35
  36
  37     /** The caption contains the value of the data point in the number
  38         format of the axis that is attached to the respective data
  39         series.
  40      */
  41     const long VALUE = 1;
  42
  43
  44     /** The caption contains the value of the data point in percent of
  45         all data points of one category.
  46
  47         <p>That means, if a data point is the first one of a series,
  48         the percentage is calculated by using the first data points of
  49         all available series.</p>
  50      */
  51     const long PERCENT = 2;
  52
  53
  54     /** The caption contains the category name of the category to
  55         which a data point belongs.
  56      */
  57     const long TEXT = 4;
  58
  59
  60     /** The number formatter is always used for displaying the value
  61         as value.  So this setting is deprecated.
  62
  63         @deprecated
  64      */
  65     const long FORMAT = 8;
  66
  67
  68     /** The symbol of data column/row is additionally displayed in the caption.
  69      */
  70     const long SYMBOL = 16;
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */