setFilterViewAsDefault()

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

setFilterViewAsDefault() 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 ISetFilterViewAsDefault command.

Signature:

export declare function setFilterViewAsDefault(ref: ObjRef, isDefault: boolean, correlationId?: string): ISetFilterViewAsDefault;

Parameters

Parameter	Type	Description
ref	ObjRef	ref of the filter view that must be set as a default one.
isDefault	boolean	determine if filter view identified by the provided ref should be marked as a default one. If yes, any existing filter view for the same user and dashboard will be marked as non default as only one can be set as default at the same time.
correlationId	string	(Optional) specify correlation id. It will be included in all events that will be emitted during the command processing.

Returns:

ISetFilterViewAsDefault

delete filter view command

Remarks

Dispatching this command will result into setting of the persisted filter view as a default one when dashboard filter context is loaded or unsetting it from being applied automatically on load.