pivotTableMenuForCapabilities()
Home > @gooddata/sdk-ui-pivot > pivotTableMenuForCapabilities
pivotTableMenuForCapabilities() function
Given analytical backend capabilities and the desired aggregations menu config.
Signature:
export declare function pivotTableMenuForCapabilities(capabilities: IBackendCapabilities, desiredMenu?: IMenu): IMenu;
Parameters
| Parameter | Type | Description |
|---|---|---|
| capabilities | IBackendCapabilities | Backend capabilities |
| desiredMenu | IMenu | (Optional) Aggregation menu configuration desired by the client |
Returns:
Remarks
This function will correct the menu configuration so that it fits the capabilities.
The function will explicitly set the options regardless of what is the (current) default value of the option if it is not present in the menu. The backend capabilities are a hard stop for features.
Note: the PivotTable will use this function out of the box to ensure the effective menu configuration matches the backend capabilities. You don't need to use when creating a PivotTable.