applyFilterView()
Home > @gooddata/sdk-ui-dashboard > applyFilterView
applyFilterView() 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 IApplyFilterView command.
Signature:
export declare function applyFilterView(ref: ObjRef, correlationId?: string): IApplyFilterView;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
ref |
ref of the filter view that must be applied to the filter context. | |
|
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 application of the persisted filter view.