LibreOffice
LibreOffice 7.2 SDK API Reference
DataPilotField.idl
Go to the documentation of this file.
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 #ifndef __com_sun_star_sheet_DataPilotField_idl__
21 #define __com_sun_star_sheet_DataPilotField_idl__
22 
34 
35 
36 module com { module sun { module star { module sheet {
37 
38 
45 published service DataPilotField
46 {
47 
51 
52 
54 
57 
58 
59  [optional] interface XDataPilotField;
60 
61 
62  [optional] interface XDataPilotFieldGrouping;
63 
64 
72 
73 
82 
83 
99  [property, optional] sequence<GeneralFunction> Subtotals;
100 
103  [property, optional] string SelectedPage;
104 
105 
109  [property, optional] boolean UseSelectedPage;
110 
111 
116  [property, optional] string UsedHierarchy;
117 
118 
121  [property, optional] boolean HasSortInfo;
122 
123 
126  [property, optional] DataPilotFieldSortInfo SortInfo;
127 
128 
131  [property, optional] boolean HasLayoutInfo;
132 
133 
136  [property, optional] DataPilotFieldLayoutInfo LayoutInfo;
137 
138 
141  [property, optional] boolean HasAutoShowInfo;
142 
143 
148 
149 
152  [property, optional] boolean HasReference;
153 
154 
158  [property, optional] DataPilotFieldReference Reference;
159 
160 
163  [property, optional] boolean IsGroupField;
164 
165 
171  [property, optional] DataPilotFieldGroupInfo GroupInfo;
172 
173 
176  [property, optional] boolean ShowEmpty;
177 
188  [property, optional] short Function2;
189 
207  [property, optional] sequence<short> Subtotals2;
208 };
209 
210 
211 }; }; }; };
212 
213 #endif
214 
215 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
specifies the name of the object.
Definition: XNamed.idl:33
Provides methods to create new DataPilot fields where some or all items of this DataPilot field are g...
Definition: XDataPilotFieldGrouping.idl:37
provides methods to control a data pilot field which has already been created.
Definition: XDataPilotField.idl:36
DataPilotFieldOrientation
used to specify where a field in a data pilot table is laid out.
Definition: DataPilotFieldOrientation.idl:30
GeneralFunction
used to specify a function to be calculated from values.
Definition: GeneralFunction.idl:30
Definition: Ambiguous.idl:22
represents a single field in a data pilot table.
Definition: DataPilotField.idl:46
boolean HasAutoShowInfo
specifies whether this field has auto show information.
Definition: DataPilotField.idl:141
string SelectedPage
specifies the selected page which is used to filter the data pilot.
Definition: DataPilotField.idl:103
GeneralFunction Function
specifies the function used to calculate results for this field.
Definition: DataPilotField.idl:81
boolean HasLayoutInfo
specifies whether this field has layout information.
Definition: DataPilotField.idl:131
boolean IsGroupField
specifies whether this field is a group field.
Definition: DataPilotField.idl:163
string UsedHierarchy
specifies which hierarchy of the dimension is used.
Definition: DataPilotField.idl:116
boolean HasReference
specifies whether this field has a reference.
Definition: DataPilotField.idl:152
DataPilotFieldReference Reference
controls how the results are shown in relation to a selected reference result.
Definition: DataPilotField.idl:158
sequence< short > Subtotals2
specifies the functions used to calculate subtotals for this field.
Definition: DataPilotField.idl:207
boolean UseSelectedPage
specifies whether to use the selected page to filter the data pilot or show all.
Definition: DataPilotField.idl:109
boolean HasSortInfo
specifies whether this field has sorting information.
Definition: DataPilotField.idl:121
DataPilotFieldAutoShowInfo AutoShowInfo
enables the automatic inclusion of only a number of items with the highest or lowest result values.
Definition: DataPilotField.idl:147
DataPilotFieldSortInfo SortInfo
controls how the field's items are sorted.
Definition: DataPilotField.idl:126
boolean ShowEmpty
specifies whether to show this field also if it is empty or not.
Definition: DataPilotField.idl:176
DataPilotFieldLayoutInfo LayoutInfo
controls how the field's items are laid out in the result table.
Definition: DataPilotField.idl:136
DataPilotFieldOrientation Orientation
specifies the orientation of the field.
Definition: DataPilotField.idl:62
sequence< GeneralFunction > Subtotals
specifies the functions used to calculate subtotals for this field.
Definition: DataPilotField.idl:99
DataPilotFieldGroupInfo GroupInfo
contains the grouping information of the DataPilot field.
Definition: DataPilotField.idl:171
short Function2
specifies the function used to calculate results for this field.
Definition: DataPilotField.idl:188
contains the auto show information of a DataPilotField.
Definition: DataPilotFieldAutoShowInfo.idl:35
contains the grouping information of a DataPilotField.
Definition: DataPilotFieldGroupInfo.idl:33
contains the layout information of a DataPilotField.
Definition: DataPilotFieldLayoutInfo.idl:30
controls how a data pilot field's results are shown in relation to a selected reference result.
Definition: DataPilotFieldReference.idl:35
describes how to sort a single DataPilotField
Definition: DataPilotFieldSortInfo.idl:30