Overview | Module | Use | Devguide | Index

Elements' Summary | Elements' Details

:: com :: sun :: star :: sheet ::
struct DataPilotFieldGroupInfo
Description contains the grouping information of a DataPilotField.

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 then 8, and so on.
GroupBy
long GroupBy; Description specifies the grouping of the date values. See also DataPilotFieldGroupBy
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

Top of Page

Copyright © 2000, 2014 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.