import BuildingLevel from "@arcgis/core/widgets/BuildingExplorer/BuildingLevel.js";const BuildingLevel = await $arcgis.import("@arcgis/core/widgets/BuildingExplorer/BuildingLevel.js");- Inheritance:
- BuildingLevel→
BuildingNumericFilterViewModel→ Accessor
- Since
- ArcGIS Maps SDK 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
BuildingExplorer widget - Deprecated since 5.0. Use the Building Explorer component instead.
BuildingExplorerViewModel - Deprecated since 5.0. Use the Building Explorer component instead.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
allowedValues inherited | readonly number[] | |
declaredClass readonly inherited | ||
enabled inherited | ||
hasNext readonly inherited | ||
hasPrevious readonly inherited | ||
max readonly inherited | ||
min readonly inherited | ||
value inherited |
allowedValues
- Type
- readonly number[]
List of all the values which are allowed for the filter.
enabled
- Type
- boolean
Whether the filter is enabled. If false, the filter's expression won't be used to filter a BuildingSceneLayer.
- Default value
- false
hasNext
- Type
- boolean
Whether the next value can be selected.
hasPrevious
- Type
- boolean
Whether the previous value can be selected.
max
The maximum value allowed for the filter.
min
The minimum value allowed for the filter.
value
- Type
- number
The value which is currently set on the filter.
Methods
| Method | Signature | Class |
|---|---|---|
clear inherited | clear(): void | |
getValueLabel inherited | getValueLabel(value: number): string | null | undefined | |
next inherited | next(): void | |
previous inherited | previous(): void | |
select inherited | select(value: number): void |
clear
- Signature
-
clear (): void
Removes the filter by setting enabled to false.
- Returns
- void
getValueLabel
- Signature
-
getValueLabel (value: number): string | null | undefined
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.
next
- Signature
-
next (): void
Selects the next value, if available. If enabled is false,
the first allowed value is selected.
- Returns
- void
previous
- Signature
-
previous (): void
Selects the previous value, if available. If enabled is false,
the last allowed value is selected.
- Returns
- void
select
- Signature
-
select (value: number): void
Selects the specified value for the filter. In case the filter is disabled, this
method also enables it by setting enabled to true.