Overview | Module | Use | Devguide | Index

Services' Summary | Interfaces' Summary | Properties' Summary | Services' Details | Interfaces' Details | Properties' Details

:: com :: sun :: star :: sheet ::
service DataPilotField
Description represents a single field in a data pilot table. If the data pilot table is based on a spreadsheet cell range, a field is represented by a column of the range and is named using the topmost cell of the column. Developers Guide Spreadsheets - Creating a New DataPilot Table

Exported Interfaces - Summary
::com::sun::star::container::XNamed | provides access to the name of the data pilot field.
::com::sun::star::beans::XPropertySet | provides access to the properties.
XDataPilotField |
XDataPilotFieldGrouping |

Properties' Summary
DataPilotFieldOrientation Orientation | specifies the orientation of the field.
GeneralFunction Function | specifies the function used to calculate results for this field.
sequence< GeneralFunction > Subtotals | [ OPTIONAL ] specifies the functions used to calculate subtotals for this field.
string SelectedPage | [ OPTIONAL ] specifies the selected page which is used to filter the data pilot.
boolean UseSelectedPage | [ OPTIONAL ] specifies whether to use the selected page to filter the data pilot or show all.
string UsedHierarchy | [ OPTIONAL ] specifies which hierarchy of the dimension is used.
boolean HasSortInfo | [ OPTIONAL ] specifies whether this field has sorting information.
DataPilotFieldSortInfo SortInfo | [ OPTIONAL ] controls how the field's items are sorted.
boolean HasLayoutInfo | [ OPTIONAL ] specifies whether this field has layout information.
DataPilotFieldLayoutInfo LayoutInfo | [ OPTIONAL ] controls how the field's items are laid out in the result table.
boolean HasAutoShowInfo | [ OPTIONAL ] specifies whether this field has auto show information.
DataPilotFieldAutoShowInfo AutoShowInfo | [ OPTIONAL ] enables the automatic inclusion of only a number of items with the highest or lowest result values.
boolean HasReference | [ OPTIONAL ] specifies whether this field has a reference.
DataPilotFieldReference Reference | [ OPTIONAL ] controls how the results are shown in relation to a selected reference result.
boolean IsGroupField | [ OPTIONAL ] specifies whether this field is a group field.
DataPilotFieldGroupInfo GroupInfo | [ OPTIONAL ] contains the grouping information of the DataPilot field.
boolean ShowEmpty | [ OPTIONAL ] specifies whether to show this field also if it is empty or not.

Exported Interfaces - Details
::com::sun::star::container::XNamed
Description provides access to the name of the data pilot field.
::com::sun::star::beans::XPropertySet
Description provides access to the properties.
XDataPilotField
Usage Restrictions optional
XDataPilotFieldGrouping
Usage Restrictions optional

Properties' Details
Orientation
DataPilotFieldOrientation Orientation; Description specifies the orientation of the field. If the orientation of a field has been changed using this property, the field will be moved to the last position in the collection of all fields with the specified orientation.
Function
GeneralFunction Function; Description specifies the function used to calculate results for this field. For column and row fields, this is the function for subtotals (GeneralFunction::NONE means no subtotals). For data fields, this is the function shown in the data pilot table.
Subtotals
sequence< GeneralFunction > Subtotals; Usage Restrictions optional Description specifies the functions used to calculate subtotals for this field. This property is supported by column and row fields only. An empty sequence means no subtotals. The same effect can be achieved by setting the property Function to the value GeneralFunction::NONE. If the length of the sequence is greater then 1, then the sequence MUST NOT contain one of the values GeneralFunction::NONE or GeneralFunction::AUTO. The order of the functions in this sequence is reflected in the DataPilot table. Multiple entries of the same function are ignored when setting the property.
SelectedPage
string SelectedPage; Usage Restrictions optional Description specifies the selected page which is used to filter the data pilot.
UseSelectedPage
boolean UseSelectedPage; Usage Restrictions optional Description specifies whether to use the selected page to filter the data pilot or show all.
UsedHierarchy
string UsedHierarchy; Usage Restrictions optional Description specifies which hierarchy of the dimension is used. See also DataPilotSourceHierarchies
HasSortInfo
boolean HasSortInfo; Usage Restrictions optional Description specifies whether this field has sorting information.
SortInfo
DataPilotFieldSortInfo SortInfo; Usage Restrictions optional Description controls how the field's items are sorted.
HasLayoutInfo
boolean HasLayoutInfo; Usage Restrictions optional Description specifies whether this field has layout information.
LayoutInfo
DataPilotFieldLayoutInfo LayoutInfo; Usage Restrictions optional Description controls how the field's items are laid out in the result table.
HasAutoShowInfo
boolean HasAutoShowInfo; Usage Restrictions optional Description specifies whether this field has auto show information.
AutoShowInfo
DataPilotFieldAutoShowInfo AutoShowInfo; Usage Restrictions optional Description enables the automatic inclusion of only a number of items with the highest or lowest result values.
HasReference
boolean HasReference; Usage Restrictions optional Description specifies whether this field has a reference.
Reference
DataPilotFieldReference Reference; Usage Restrictions optional Description controls how the results are shown in relation to a selected reference result.
IsGroupField
boolean IsGroupField; Usage Restrictions optional Description specifies whether this field is a group field.
GroupInfo
DataPilotFieldGroupInfo GroupInfo; Usage Restrictions optional Description contains the grouping information of the DataPilot field. By changing the value of this property it is possible to modify the grouping settings of this field.
ShowEmpty
boolean ShowEmpty; Usage Restrictions optional Description specifies whether to show this field also if it is empty or not.

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.