offapi/com/sun/star/chart2/DataPointLabel.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 module com
  22 {
  23 module sun
  24 {
  25 module star
  26 {
  27 module chart2
  28 {
  29
  30 struct DataPointLabel
  31 {
  32     /** if `TRUE`, the value that is represented by a data point is
  33         displayed next to it.
  34
  35         @see #ShowNumberInPercent
  36      */
  37     boolean                     ShowNumber;
  38
  39     /** This is only effective, if #ShowNumber is
  40         `TRUE`.  If this member is also `TRUE`, the numbers are
  41         displayed as percentages of a category.
  42
  43         <p>That means, if a data point is the first one of a series,
  44         the percentage is calculated by using the first data points of
  45         all available series.</p>
  46     */
  47     boolean                     ShowNumberInPercent;
  48
  49     /** The caption contains the category name of the category to
  50         which a data point belongs.
  51      */
  52     boolean                     ShowCategoryName;
  53
  54     /** The symbol of data series is additionally displayed in the
  55         caption.
  56      */
  57     boolean                     ShowLegendSymbol;
  58
  59     /** The caption contains a custom label text, which belongs
  60         to a data point label.
  61
  62         @since LibreOffice 7.1
  63      */
  64     boolean                     ShowCustomLabel;
  65
  66     /** The name of the data series is additionally displayed in the caption.
  67
  68         @since LibreOffice 7.2
  69      */
  70     boolean ShowSeriesName;
  71 };
  72
  73
  74
  75 } ; // chart2
  76 } ; // com
  77 } ; // sun
  78 } ; // star
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */