require(["esri/widgets/BuildingExplorer/BuildingLevel"], (BuildingLevel) => { /* code goes here */ });
import BuildingLevel from "@arcgis/core/widgets/BuildingExplorer/BuildingLevel.js";
esri/widgets/BuildingExplorer/BuildingLevel
Provides information for the building level filter, such as the value selected by the user or the minimum and maximum allowed values.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
List of all the values which are allowed for the filter. | BuildingLevel | ||
The name of the class. | Accessor | ||
Whether the filter is enabled. | BuildingLevel | ||
Whether the next value can be selected. | BuildingLevel | ||
Whether the previous value can be selected. | BuildingLevel | ||
The maximum value allowed for the filter. | BuildingLevel | ||
The minimum value allowed for the filter. | BuildingLevel | ||
The value which is currently set on the filter. | BuildingLevel |
Property Details
-
List of all the values which are allowed for the filter.
-
enabled
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
hasNext Booleanreadonly
-
Whether the next value can be selected.
-
hasPrevious
hasPrevious Booleanreadonly
-
Whether the previous value can be selected.
-
max
max Numberreadonly
-
The maximum value allowed for the filter.
-
min
min Numberreadonly
-
The minimum value allowed for the filter.
-
value
value Numberreadonly
-
The value which is currently set on the filter.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Removes the filter by setting enabled to | BuildingLevel | ||
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. | BuildingLevel | ||
Returns true if a named group of handles exist. | Accessor | ||
Selects the next value, if available. | BuildingLevel | ||
Selects the previous value, if available. | BuildingLevel | ||
Removes a group of handles owned by the object. | Accessor | ||
Selects the specified value for the filter. | BuildingLevel |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
Removes the filter by setting enabled to
false
.
-
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.
Parametervalue NumberA filter value.
Returns
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
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.
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");