setFilterViewAsDefault()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Creates the ISetFilterViewAsDefault command.
export declare function setFilterViewAsDefault(ref: ObjRef, isDefault: boolean, correlationId?: string): ISetFilterViewAsDefault;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | 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
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.