LibreOffice
LibreOffice 25.8 SDK API Reference
|
contains the grouping information of a DataPilotField. More...
import "DataPilotFieldGroupInfo.idl";
Public Attributes | |
boolean | HasAutoStart |
specifies whether the start value for the grouping is taken automatically from the minimum of the item values. | |
boolean | HasAutoEnd |
specifies whether the end value for the grouping is taken automatically from the maximum of the item values. | |
boolean | HasDateValues |
specifies whether date values are grouped by ranges of days. | |
double | Start |
specifies the start value for the grouping if HasAutoStart is set to FALSE. | |
double | End |
specifies the end value for the grouping if HasAutoEnd is set to FALSE. | |
double | Step |
specifies the size of the ranges for numeric or day grouping. | |
long | GroupBy |
specifies the grouping of the date values. | |
XDataPilotField | SourceField |
contains the source DataPilot field grouping is based on. | |
com::sun::star::container::XNameAccess | Groups |
specifies the named groups in this field if there are some. |
contains the grouping information of a DataPilotField.
double End |
specifies the end value for the grouping if HasAutoEnd is set to FALSE.
long GroupBy |
specifies the grouping of the date values.
specifies the named groups in this field if there are some.
The returned object is an instance of DataPilotFieldGroups . The collection of groups can be modified by inserting, removing, replacing, or renaming single groups or item names in the groups. When writing back this struct containing such a changed collection of groups to the DataPilotField::GroupInfo property, the modified grouping settings are applied at the DataPilot field.
boolean HasAutoEnd |
specifies whether the end value for the grouping is taken automatically from the maximum of the item values.
boolean HasAutoStart |
specifies whether the start value for the grouping is taken automatically from the minimum of the item values.
boolean HasDateValues |
specifies whether date values are grouped by ranges of days.
XDataPilotField SourceField |
contains the source DataPilot field grouping is based on.
Will be NULL if this field is not grouped or contains numeric grouping.
double Start |
specifies the start value for the grouping if HasAutoStart is set to FALSE.
double Step |
specifies the size of the ranges for numeric or day grouping.
Example: With HasAutoStart set to FALSE, Start set to 2, and Step set to 3, the first group will contain all values greater than or equal to 2 and less than 5. The second group will contain all values greater than or equal to 5 and less than 8, and so on.