Skip To ContentArcGIS for DevelopersSign In Dashboard

BuildingLevel

Class: esri/widgets/BuildingExplorer/BuildingLevel
Since: ArcGIS API for JavaScript 4.16

Provides information for the building level filter, such as the value selected by the user or the minimum and maximum allowed values.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Number[]

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

more details
more detailsBuildingLevel
Boolean

Whether the filter is enabled.

more details
more detailsBuildingLevel
Boolean

Whether the next value can be selected.

more details
more detailsBuildingLevel
Boolean

Whether the previous value can be selected.

more details
more detailsBuildingLevel
Number

The maximum value allowed for the filter.

more details
more detailsBuildingLevel
Number

The minimum value allowed for the filter.

more details
more detailsBuildingLevel
Number

The value which is currently set on the filter.

more details
more detailsBuildingLevel

Property Details

allowedValues Number[]readonly

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

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

NameReturn TypeSummaryClass

Removes the filter by setting enabled to false.

more details
more detailsBuildingLevel
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.

more details
more detailsBuildingLevel

Selects the next value, if available.

more details
more detailsBuildingLevel

Selects the previous value, if available.

more details
more detailsBuildingLevel

Selects the specified value for the filter.

more details
more detailsBuildingLevel

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:
TypeDescription
String | nullThe label corresponding to the filter value.

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

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.

API Reference search results

NameTypeModule
Loading...