offapi/com/sun/star/sheet/DataPilotField.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 {  module sun {  module star {  module sheet {
  22
  23
  24 /** represents a single field in a data pilot table.
  25
  26     <p>If the data pilot table is based on a spreadsheet cell range, a field
  27     is represented by a column of the range and is named using the topmost
  28     cell of the column.</p>
  29  */
  30 published service DataPilotField
  31 {
  32
  33     /** provides access to the name of the data pilot field.
  34      */
  35     interface com::sun::star::container::XNamed;
  36
  37
  38 //!published service PropertySet
  39     /** provides access to the properties.
  40      */
  41     interface com::sun::star::beans::XPropertySet;
  42
  43
  44     [optional] interface XDataPilotField;
  45
  46
  47     [optional] interface XDataPilotFieldGrouping;
  48
  49
  50     /** specifies the orientation of the field.
  51
  52         <p>If the orientation of a field has been changed using this property,
  53         the field will be moved to the last position in the collection of all
  54         fields with the specified orientation.</p>
  55      */
  56     [property] DataPilotFieldOrientation Orientation;
  57
  58
  59     /** specifies the function used to calculate results for this field.
  60
  61         <p>For column and row fields, this is the function for subtotals
  62         (GeneralFunction::NONE means no subtotals).
  63         For data fields, this is the function shown in the data pilot
  64         table.</p>
  65      */
  66     [property] GeneralFunction Function;
  67
  68
  69     /** specifies the functions used to calculate subtotals for this field.
  70
  71         <p>This property is supported by column and row fields only.</p>
  72
  73         <p>An empty sequence means no subtotals. The same effect can be
  74         achieved by setting the property #Function to the
  75         value GeneralFunction::NONE. If the length of the
  76         sequence is greater than 1, then the sequence MUST NOT contain one of
  77         the values GeneralFunction::NONE or
  78         GeneralFunction::AUTO.</p>
  79
  80         <p>The order of the functions in this sequence is reflected in the
  81         DataPilot table. Multiple entries of the same function are ignored
  82         when setting the property.</p>
  83      */
  84     [property, optional] sequence<GeneralFunction> Subtotals;
  85
  86     /** specifies the selected page which is used to filter the data pilot.
  87      */
  88     [property, optional] string SelectedPage;
  89
  90
  91     /** specifies whether to use the selected page to filter the data pilot or
  92         show all.
  93      */
  94     [property, optional] boolean UseSelectedPage;
  95
  96
  97     /** specifies which hierarchy of the dimension is used.
  98
  99     @see com::sun::star::sheet::DataPilotSourceHierarchies
 100      */
 101     [property, optional] string UsedHierarchy;
 102
 103
 104     /** specifies whether this field has sorting information.
 105      */
 106     [property, optional] boolean HasSortInfo;
 107
 108
 109     /** controls how the field's items are sorted.
 110      */
 111     [property, optional] DataPilotFieldSortInfo SortInfo;
 112
 113
 114     /** specifies whether this field has layout information.
 115      */
 116     [property, optional] boolean HasLayoutInfo;
 117
 118
 119     /** controls how the field's items are laid out in the result table.
 120      */
 121     [property, optional] DataPilotFieldLayoutInfo LayoutInfo;
 122
 123
 124     /** specifies whether this field has auto show information.
 125      */
 126     [property, optional] boolean HasAutoShowInfo;
 127
 128
 129     /** enables the automatic inclusion of only a number of items with
 130         the highest or lowest result values.
 131      */
 132     [property, optional] DataPilotFieldAutoShowInfo AutoShowInfo;
 133
 134
 135     /** specifies whether this field has a reference.
 136      */
 137     [property, optional] boolean HasReference;
 138
 139
 140     /** controls how the results are shown in relation to a selected
 141         reference result.
 142      */
 143     [property, optional] DataPilotFieldReference Reference;
 144
 145
 146     /** specifies whether this field is a group field.
 147      */
 148     [property, optional] boolean IsGroupField;
 149
 150
 151     /** contains the grouping information of the DataPilot field.
 152
 153         <p>By changing the value of this property it is possible to modify the
 154         grouping settings of this field.</p>
 155      */
 156     [property, optional] DataPilotFieldGroupInfo GroupInfo;
 157
 158
 159     /** specifies whether to show this field also if it is empty or not.
 160      */
 161     [property, optional] boolean ShowEmpty;
 162
 163     /** specifies the function used to calculate results for this field.
 164
 165         <p>For column and row fields, this is the function for subtotals
 166         (GeneralFunction2::NONE means no subtotals).
 167         For data fields, this is the function shown in the data pilot
 168         table.</p>
 169
 170         @since LibreOffice 5.3
 171      */
 172
 173     [property, optional] short Function2;
 174
 175     /** specifies the functions used to calculate subtotals for this field.
 176
 177         <p>This property is supported by column and row fields only.</p>
 178
 179         <p>An empty sequence means no subtotals. The same effect can be
 180         achieved by setting the property #Function2 to the
 181         value GeneralFunction::NONE. If the length of the
 182         sequence is greater than 1, then the sequence MUST NOT contain one of
 183         the values GeneralFunction2::NONE or
 184         GeneralFunction2::AUTO.</p>
 185
 186         <p>The order of the functions in this sequence is reflected in the
 187         DataPilot table. Multiple entries of the same function are ignored
 188         when setting the property.</p>
 189
 190         @since LibreOffice 5.3
 191      */
 192     [property, optional] sequence<short> Subtotals2;
 193 };
 194
 195
 196 }; }; }; };
 197
 198 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */