GroupingColumn Class
Contains methods for describing fields that are used for
column grouping.
Namespace
The GroupingColumn class provides basic information about column grouping fields. The GroupingInfo class includes additional methods for describing and updating grouping fields.
GroupingColumn Methods
The following are methods for GroupingColumn. All are instance methods.
getName()
Returns the unique API name of the field or bucket field
that is used for column grouping.
Syntax
public String getName()
Return Value
Type: String
getLabel()
Returns the localized display name of the field that is
used for column grouping.
Syntax
public String getLabel()
Return Value
Type: String
getDataType()
Returns the data type of the field that is used for column
grouping.
Syntax
public Reports.ColumnDataType getDataType()
Return Value
Type: Reports.ColumnDataType
getGroupingLevel()
Returns the level of grouping for the column.
Syntax
public Integer getGroupingLevel()
Return Value
Type: Integer
Usage
- In a summary report, 0, 1, or 2 indicates grouping at the first, second, or third row level.
- In a matrix report, 0 or 1 indicates grouping at the first or second row or column level.