setAttributeFilterDisplayForm()

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

setAttributeFilterDisplayForm() function

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates the ISetAttributeFilterDisplayForm command.

Signature:

export declare function setAttributeFilterDisplayForm(filterLocalId: string, displayForm: ObjRef, isWorkingSelectionChange?: boolean, isResultOfMigration?: boolean): ISetAttributeFilterDisplayForm;

Parameters

Parameter

Type

Description

filterLocalId

string

local identifier of the filter the display form is changed for

displayForm

ObjRef

newly selected display form

isWorkingSelectionChange

boolean

(Optional) determines if command updates working filter context or applied filter context. Applied filter context is default.

isResultOfMigration

boolean

(Optional) internal value, specifies that filter change was caused by displayAsLabel ad-hoc migration, the param will be removed once the usage of displayAsLabel is migrated on database metadata level.

Returns:

ISetAttributeFilterDisplayForm

change filter display form command

Remarks

Dispatching the commands will result into setting provided display form as a selected display form for the attribute filter.

← SetAttributeFilterDependentDateFiltersPayloadsetAttributeFilterLimitingItems() →