Interface: FilterStateModificationApiV1

FilterStateModificationApi.FilterStateModificationApiV1

Description

Contains an API to allow modification of the filter state on the current list

Properties

• updateFilterState

Properties

updateFilterState

• updateFilterState: (filterRequest: FilterNode, action?: FILTER_UPDATE_ACTIONS) => void

Type declaration

• (filterRequest, action?): void

Parameters

Name	Type	Description
filterRequest	FilterNode	The filter node to modify the filters in the Lists app
action?	FILTER_UPDATE_ACTIONS	The (optional) action to take on the given filterRequest Defaults to add as a new filter. Can also be set to modify or remove as an existing filter

Returns

void

Description

Allows the developer to update the filter state with a specified node and action