represents a single field in a data pilot table.
More...
import"DataPilotField.idl";
|
string | getName () |
|
void | setName ([in] string aName) |
| sets the programmatic name of the object. More...
|
|
any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More...
|
|
void | acquire () |
| increases the reference counter by one. More...
|
|
void | release () |
| decreases the reference counter by one. More...
|
|
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
|
void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
| sets the value of the property with the specified name. More...
|
|
any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
|
void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XPropertyChangeListener to the specified property. More...
|
|
void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XPropertyChangeListener from the listener list. More...
|
|
void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
|
|
void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XVetoableChangeListener from the listener list. More...
|
|
com::sun::star::container::XIndexAccess | getItems () |
| returns the collection of the data pilot items. More...
|
|
XDataPilotField | createNameGroup ([in] sequence< string > aItems) raises ( com::sun::star::lang::IllegalArgumentException ) |
| Creates a new DataPilot field which contains a group containing the given DataPilot field items (members). More...
|
|
XDataPilotField | createDateGroup ([in] DataPilotFieldGroupInfo aInfo) raises ( com::sun::star::lang::IllegalArgumentException ) |
| Groups the members of this field by dates, according to the passed settings. More...
|
|
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
- Spreadsheet Documents - Creating a New DataPilot Table
◆ com::sun::star::beans::XPropertySet
published service PropertySet
provides access to the properties.
◆ com::sun::star::container::XNamed
provides access to the name of the data pilot field.
◆ XDataPilotField
◆ XDataPilotFieldGrouping
◆ AutoShowInfo
enables the automatic inclusion of only a number of items with the highest or lowest result values.
◆ Function
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.
◆ Function2
specifies the function used to calculate results for this field.
For column and row fields, this is the function for subtotals (GeneralFunction2::NONE means no subtotals). For data fields, this is the function shown in the data pilot table.
- Since
- LibreOffice 5.3
◆ GroupInfo
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.
◆ HasAutoShowInfo
specifies whether this field has auto show information.
◆ HasLayoutInfo
specifies whether this field has layout information.
◆ HasReference
specifies whether this field has a reference.
◆ HasSortInfo
specifies whether this field has sorting information.
◆ IsGroupField
specifies whether this field is a group field.
◆ LayoutInfo
controls how the field's items are laid out in the result table.
◆ Orientation
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.
◆ Reference
controls how the results are shown in relation to a selected reference result.
◆ SelectedPage
specifies the selected page which is used to filter the data pilot.
◆ ShowEmpty
specifies whether to show this field also if it is empty or not.
◆ SortInfo
controls how the field's items are sorted.
◆ Subtotals
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 than 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.
◆ Subtotals2
sequence<short> Subtotals2 |
|
optionalproperty |
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 Function2 to the value GeneralFunction::NONE. If the length of the sequence is greater than 1, then the sequence MUST NOT contain one of the values GeneralFunction2::NONE or GeneralFunction2::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.
- Since
- LibreOffice 5.3
◆ UsedHierarchy
◆ UseSelectedPage
specifies whether to use the selected page to filter the data pilot or show all.
The documentation for this service was generated from the following file: