LibreOffice LibreOffice 25.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
21module com { module sun { module star { module sheet {
22
23
30published service DataPilotField
31{
32
35 interface com::sun::star::container::XNamed;
36
37
39
41 interface com::sun::star::beans::XPropertySet;
42
43
44 [optional] interface XDataPilotField;
45
46
47 [optional] interface XDataPilotFieldGrouping;
48
49
56 [property] DataPilotFieldOrientation Orientation;
57
58
66 [property] GeneralFunction Function;
67
68
84 [property, optional] sequence<GeneralFunction> Subtotals;
85
88 [property, optional] string SelectedPage;
89
90
94 [property, optional] boolean UseSelectedPage;
95
96
101 [property, optional] string UsedHierarchy;
102
103
106 [property, optional] boolean HasSortInfo;
107
108
111 [property, optional] DataPilotFieldSortInfo SortInfo;
112
113
116 [property, optional] boolean HasLayoutInfo;
117
118
121 [property, optional] DataPilotFieldLayoutInfo LayoutInfo;
122
123
126 [property, optional] boolean HasAutoShowInfo;
127
128
132 [property, optional] DataPilotFieldAutoShowInfo AutoShowInfo;
133
134
137 [property, optional] boolean HasReference;
138
139
143 [property, optional] DataPilotFieldReference Reference;
144
145
148 [property, optional] boolean IsGroupField;
149
150
156 [property, optional] DataPilotFieldGroupInfo GroupInfo;
157
158
161 [property, optional] boolean ShowEmpty;
162
173 [property, optional] short Function2;
174
192 [property, optional] sequence<short> Subtotals2;
193};
194
195
196}; }; }; };
197
198/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:46
com::sun::star::container::XNamed
specifies the name of the object.
Definition: XNamed.idl:29
com::sun::star::sheet::XDataPilotFieldGrouping
Provides methods to create new DataPilot fields where some or all items of this DataPilot field are g...
Definition: XDataPilotFieldGrouping.idl:30
com::sun::star::sheet::XDataPilotField
provides methods to control a data pilot field which has already been created.
Definition: XDataPilotField.idl:30
com::sun::star::sheet::DataPilotFieldOrientation
DataPilotFieldOrientation
used to specify where a field in a data pilot table is laid out.
Definition: DataPilotFieldOrientation.idl:27
com::sun::star::sheet::GeneralFunction
GeneralFunction
used to specify a function to be calculated from values.
Definition: GeneralFunction.idl:27
com
Definition: Ambiguous.idl:20
com::sun::star::sheet::DataPilotField
represents a single field in a data pilot table.
Definition: DataPilotField.idl:31
com::sun::star::sheet::DataPilotField::HasAutoShowInfo
boolean HasAutoShowInfo
specifies whether this field has auto show information.
Definition: DataPilotField.idl:126
com::sun::star::sheet::DataPilotField::SelectedPage
string SelectedPage
specifies the selected page which is used to filter the data pilot.
Definition: DataPilotField.idl:88
com::sun::star::sheet::DataPilotField::Function
GeneralFunction Function
specifies the function used to calculate results for this field.
Definition: DataPilotField.idl:66
com::sun::star::sheet::DataPilotField::HasLayoutInfo
boolean HasLayoutInfo
specifies whether this field has layout information.
Definition: DataPilotField.idl:116
com::sun::star::sheet::DataPilotField::IsGroupField
boolean IsGroupField
specifies whether this field is a group field.
Definition: DataPilotField.idl:148
com::sun::star::sheet::DataPilotField::UsedHierarchy
string UsedHierarchy
specifies which hierarchy of the dimension is used.
Definition: DataPilotField.idl:101
com::sun::star::sheet::DataPilotField::HasReference
boolean HasReference
specifies whether this field has a reference.
Definition: DataPilotField.idl:137
com::sun::star::sheet::DataPilotField::Reference
DataPilotFieldReference Reference
controls how the results are shown in relation to a selected reference result.
Definition: DataPilotField.idl:143
com::sun::star::sheet::DataPilotField::Subtotals2
sequence< short > Subtotals2
specifies the functions used to calculate subtotals for this field.
Definition: DataPilotField.idl:192
com::sun::star::sheet::DataPilotField::UseSelectedPage
boolean UseSelectedPage
specifies whether to use the selected page to filter the data pilot or show all.
Definition: DataPilotField.idl:94
com::sun::star::sheet::DataPilotField::HasSortInfo
boolean HasSortInfo
specifies whether this field has sorting information.
Definition: DataPilotField.idl:106
com::sun::star::sheet::DataPilotField::AutoShowInfo
DataPilotFieldAutoShowInfo AutoShowInfo
enables the automatic inclusion of only a number of items with the highest or lowest result values.
Definition: DataPilotField.idl:132
com::sun::star::sheet::DataPilotField::SortInfo
DataPilotFieldSortInfo SortInfo
controls how the field's items are sorted.
Definition: DataPilotField.idl:111
com::sun::star::sheet::DataPilotField::ShowEmpty
boolean ShowEmpty
specifies whether to show this field also if it is empty or not.
Definition: DataPilotField.idl:161
com::sun::star::sheet::DataPilotField::LayoutInfo
DataPilotFieldLayoutInfo LayoutInfo
controls how the field's items are laid out in the result table.
Definition: DataPilotField.idl:121
com::sun::star::sheet::DataPilotField::Orientation
DataPilotFieldOrientation Orientation
specifies the orientation of the field.
Definition: DataPilotField.idl:47
com::sun::star::sheet::DataPilotField::Subtotals
sequence< GeneralFunction > Subtotals
specifies the functions used to calculate subtotals for this field.
Definition: DataPilotField.idl:84
com::sun::star::sheet::DataPilotField::GroupInfo
DataPilotFieldGroupInfo GroupInfo
contains the grouping information of the DataPilot field.
Definition: DataPilotField.idl:156
com::sun::star::sheet::DataPilotField::Function2
short Function2
specifies the function used to calculate results for this field.
Definition: DataPilotField.idl:173
com::sun::star::sheet::DataPilotFieldAutoShowInfo
contains the auto show information of a DataPilotField.
Definition: DataPilotFieldAutoShowInfo.idl:32
com::sun::star::sheet::DataPilotFieldGroupInfo
contains the grouping information of a DataPilotField.
Definition: DataPilotFieldGroupInfo.idl:27
com::sun::star::sheet::DataPilotFieldLayoutInfo
contains the layout information of a DataPilotField.
Definition: DataPilotFieldLayoutInfo.idl:27
com::sun::star::sheet::DataPilotFieldReference
controls how a data pilot field's results are shown in relation to a selected reference result.
Definition: DataPilotFieldReference.idl:30
com::sun::star::sheet::DataPilotFieldSortInfo
describes how to sort a single DataPilotField
Definition: DataPilotFieldSortInfo.idl:26