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