setAttributeFilterLimitingItems()

Home > @gooddata/sdk-ui-dashboard > setAttributeFilterLimitingItems

setAttributeFilterLimitingItems() function

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates the ISetAttributeFilterLimitingItems command.

Signature:

export declare function setAttributeFilterLimitingItems(localIdentifier: string, limitingItems: ObjRef[], correlationId?: string): ISetAttributeFilterLimitingItems;

Parameters

Parameter	Type	Description
localIdentifier	string	local identifier of the filter the limiting items are changed for
limitingItems	ObjRef[]	limiting items set to the specified attribute filter.
correlationId	string	(Optional) specify correlation id. It will be included in all events that will be emitted during the command processing.

Returns:

ISetAttributeFilterLimitingItems

change limiting items command

Remarks

Dispatching the commands will result into setting of provided limiting items to a defined attribute filter.