Property Overview

Property Details

allowedValues Number[]readonly

List of all the values which are allowed for the filter.

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

enabled Booleanreadonly

Whether the filter is enabled. If false, the filter's expression won't be used to filter a BuildingSceneLayer.

Default Value:false

hasNext Booleanreadonly

Whether the next value can be selected.

hasPrevious Booleanreadonly

Whether the previous value can be selected.

max Numberreadonly

The maximum value allowed for the filter.

min Numberreadonly

The minimum value allowed for the filter.

value Numberreadonly

The value which is currently set on the filter.

Method Overview

Method Details

clear()

Removes the filter by setting enabled to false.

getValueLabel(value){String|null}

If the field that is used for filtering has a coded value domain, the label for the value can be used to be displayed in a tooltip or in the widget UI. This method returns the label corresponding to a certain value.

Parameter:

value Number A filter value.

Returns:

Type	Description
String | null	The label corresponding to the filter value.

next()

Selects the next value, if available. If enabled is false, the first allowed value is selected.

previous()

Selects the previous value, if available. If enabled is false, the last allowed value is selected.

select(value)

Selects the specified value for the filter. In case the filter is disabled, this method also enables it by setting enabled to true.

Parameter:

value Number The value which is to be selected.