:: 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 representred by a column of the range and is named using the topmost cell of the column.

Developers Guide
Exported Interfaces
::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.
::com::sun::star::sheet::XDataPilotField
Usage Restrictions
optional
::com::sun::star::sheet::XDataPilotFieldGrouping
Usage Restrictions
optional
Properties' Summary
::com::sun::star::sheet::DataPilotFieldOrientation
Orientation
specifies the orientation of the field.  
::com::sun::star::sheet::GeneralFunction
Function
specifies the function used to calculate results 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.  
::com::sun::star::sheet::DataPilotFieldSortInfo
SortInfo
[ OPTIONAL ]
controls how the field's items are sorted.  
boolean
HasLayoutInfo
[ OPTIONAL ]
specifies whether this field has layout information.  
::com::sun::star::sheet::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.  
::com::sun::star::sheet::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.  
::com::sun::star::sheet::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.  
::com::sun::star::sheet::DataPilotFieldGroupInfo
GroupInfo
[ OPTIONAL ]
contains the grouping information of the Field  
boolean
ShowEmpty
[ OPTIONAL ]
specifies whether to show this field also if it is empty or not.  
Properties' Details
Orientation
::com::sun::star::sheet::DataPilotFieldOrientation Orientation;
Description
specifies the orientation of the field.
Function
::com::sun::star::sheet::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.

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
::com::sun::star::sheet::DataPilotSourceHierarchies
HasSortInfo
boolean HasSortInfo;
Usage Restrictions
optional
Description
specifies whether this field has sorting information.
SortInfo
::com::sun::star::sheet::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
::com::sun::star::sheet::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
::com::sun::star::sheet::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
::com::sun::star::sheet::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
::com::sun::star::sheet::DataPilotFieldGroupInfo GroupInfo;
Usage Restrictions
optional
Description
contains the grouping information of the Field
ShowEmpty
boolean ShowEmpty;
Usage Restrictions
optional
Description
specifies whether to show this field also if it is empty or not.

 
Top of Page