Apex Reference Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
AggregateColumn Class
BucketField Class
BucketFieldValue Class
BucketType Enum
ColumnDataType Enum
ColumnSortOrder Enum
CrossFilter Class
CsfGroupType Enum
DateGranularity Enum
DetailColumn Class
Dimension Class
EvaluatedCondition Class
EvaluatedConditionOperator Enum
FilterOperator Class
FilterValue Class
FormulaType Enum
GroupingColumn Class
GroupingInfo Class
GroupingValue Class
GroupingValue Methods
NotificationAction Interface
NotificationActionContext Class
ReportCsf Class
ReportCurrency Class
ReportDataCell Class
ReportDescribeResult Class
ReportDetailRow Class
ReportDivisionInfo Class
ReportExtendedMetadata Class
ReportFact Class
ReportFactWithDetails Class
ReportFactWithSummaries Class
ReportFilter Class
ReportFormat Enum
ReportFilterType Enum
ReportInstance Class
ReportManager Class
ReportMetadata Class
ReportResults Class
ReportScopeInfo Class
ReportScopeValue Class
ReportType Class
ReportTypeColumn Class
ReportTypeColumnCategory Class
ReportTypeMetadata Class
SortColumn Class
StandardDateFilter Class
StandardDateFilterDuration Class
StandardDateFilterDurationGroup Class
StandardFilter Class
StandardFilterInfo Class
StandardFilterInfoPicklist Class
StandardFilterType Enum
SummaryValue Class
ThresholdInformation Class
TopRows Class
Reports Exceptions
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

GroupingValue Class

Contains grouping values for a row or column, including the key, label, and value.

Namespace

Reports

GroupingValue Methods

The following are methods for GroupingValue. All are instance methods.

getGroupings()

Returns a list of second- or third-level row or column groupings. If there are none, the value is an empty array.

Syntax

public LIST<Reports.GroupingValue> getGroupings()

Return Value

Type: List<Reports.GroupingValue>

getKey()

Returns the unique identifier for a row or column grouping. The identifier is used by the fact map to specify data values within each grouping.

Syntax

public String getKey()

Return Value

Type: String

getLabel()

Returns the localized display name of a row or column grouping. For date and time fields, the label is the localized date or time.

Syntax

public String getLabel()

Return Value

Type: String

getValue()

Returns the value of the field that is used as a row or column grouping.

Syntax

public Object getValue()

Return Value

Type: Object

Usage

The value depends on the field’s data type.

  • Currency fields:
    • amount: Of type currency. A data cell’s value.
    • currency: Of type picklist. The ISO 4217 currency code, if available; for example, USD for US dollars or CNY for Chinese yuan. (If the grouping is on the converted currency, this value is the currency code for the report and not for the record.)
  • Picklist fields: API name. For example, a custom picklist field—Type of Business with values 1, 2, and 3 for Consulting, Services, and Add-On Business respectively—has 1, 2, or 3 as the grouping value.
  • ID fields: API name.
  • Record type fields: API name.
  • Date and time fields: Date or time in ISO-8601 format.
  • Lookup fields: Unique API name. For example, for the Opportunity Owner lookup field, the ID of each opportunity owner’s Chatter profile page can be a grouping value.