saveFilterView()

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

saveFilterView() 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 ISaveFilterView command.

Signature:

export declare function saveFilterView(name: string, isDefault: boolean, correlationId?: string): ISaveFilterView;

Parameters

Parameter	Type	Description
name	string	name of the filter view under which it will be listed in UI.
isDefault	boolean	determine if new filter view should be set as a default.
correlationId	string	(Optional) specify correlation id. It will be included in all events that will be emitted during the command processing.

Returns:

ISaveFilterView

save filter view command

Remarks

Dispatching this command will result into snapshotting of the current dashboard filter context into a filter view that will be persisted. User can later apply it to the filter context to restore it to the saved state.