setFilterViewAsDefault()

Home > @gooddata/sdk-backend-spi > IWorkspaceDashboardsService > setFilterViewAsDefault

IWorkspaceDashboardsService.setFilterViewAsDefault() method

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.

Set a filter view identified by the provided ref as the default one. The other filter views for the same dashboard that are marked as default ones will be unmarked.

Signature:

setFilterViewAsDefault(ref: ObjRef, isDefault: boolean): Promise<void>;

Parameters

Parameter	Type	Description
ref	ObjRef	ref of the filter view that must be set as default.
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.

Returns:

Promise<void>