addTextAttributeFilter()

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

addTextAttributeFilter() function

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

Creates the AddTextAttributeFilter command. Dispatching this command will result in the addition of a text attribute filter (arbitrary or match) to the dashboard's filter bar, at desired position, or error in case of invalid update (e.g. wrong or duplicated displayForm).

Signature:

export declare function addTextAttributeFilter(filter: DashboardTextAttributeFilter, index: number, correlationId?: string, mode?: DashboardAttributeFilterConfigMode): IAddTextAttributeFilter;

Parameters

Parameter	Type	Description
filter	DashboardTextAttributeFilter	the text attribute filter to add (IDashboardArbitraryAttributeFilter or IDashboardMatchAttributeFilter)
index	number	specify index among the attribute filters at which the new filter should be placed. The index starts at zero and there is convenience that index of -1 would add the filter at the end.
correlationId	string	(Optional) specify correlation id to use for this command
mode	DashboardAttributeFilterConfigMode	(Optional) specify the visibility mode of attribute filter

Returns:

IAddTextAttributeFilter