Elements' Summary |
HasAutoStart |
specifies whether the start value for the grouping is taken
automatically from the minimum of the item values.
|
HasAutoEnd |
specifies whether the end value for the grouping is taken
automatically from the maximum of the item values.
|
HasDateValues |
specifies whether date values are grouped by ranges of days.
|
Start |
specifies the start value for the grouping if #HasAutoStart
is set to `FALSE`.
|
End |
specifies the end value for the grouping if #HasAutoEnd
is set to `FALSE`.
|
Step |
specifies the size of the ranges for numeric or day grouping.
|
GroupBy |
specifies the grouping of the date values.
|
SourceField |
contains the source DataPilot field grouping is based on. Will be
`NULL` if this field is not grouped or contains numeric grouping.
|
Groups |
specifies the named groups in this field if there are some.
|
Elements' Details |
HasAutoStart
boolean HasAutoStart;
- Description
- specifies whether the start value for the grouping is taken
automatically from the minimum of the item values.
- If `FALSE` is set, the value from #Start will be
used as start value for the grouping.
- If `TRUE` is set, the start value for the grouping will be
calculated automatically from the minimum of all member values of the
DataPilot field.
|
|
HasAutoEnd
boolean HasAutoEnd;
- Description
- specifies whether the end value for the grouping is taken
automatically from the maximum of the item values.
- If `FALSE` is set, the value from #End will be
used as end value for the grouping.
- If `TRUE` is set, the end value for the grouping will be
calculated automatically from the maximum of all member values of the
DataPilot field.
|
|
HasDateValues
boolean HasDateValues;
- Description
- specifies whether date values are grouped by ranges of days.
- If `FALSE` is set, and #GroupBy contains zero,
grouping is performed inplace on the item values.
- If `FALSE` is set, and #GroupBy contains one or
more flags from DataPilotFieldGroupBy, grouping is
performed on date or time.
- If `TRUE` is set, #Step contains a value greater
than or equal to 1, and #GroupBy set to
DataPilotFieldGroupBy::DAYS, grouping is performed on ranges
of days (see descriptions for
XDataPilotFieldGrouping::createDateGroup() for more details
about day grouping).
|
|
Start
double Start;
- Description
- specifies the start value for the grouping if #HasAutoStart
is set to `FALSE`.
|
|
End
double End;
- Description
- specifies the end value for the grouping if #HasAutoEnd
is set to `FALSE`.
|
|
Step
double Step;
- Description
- 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.
|
|
GroupBy
|
SourceField
XDataPilotField SourceField;
- Description
- contains the source DataPilot field grouping is based on. Will be
`NULL` if this field is not grouped or contains numeric grouping.
- See also
- DataPilotField
|
|
Groups
::com::sun::star::container::XNameAccess Groups;
- Description
- 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.
- See also
- DataPilotField, DataPilotFieldGroups
|
|
Copyright © 2020, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.