require(["esri/widgets/BuildingExplorer/BuildingExplorerViewModel"], (BuildingExplorerViewModel) => { /* code goes here */ });
import BuildingExplorerViewModel from "@arcgis/core/widgets/BuildingExplorer/BuildingExplorerViewModel.js";
esri/widgets/BuildingExplorer/BuildingExplorerViewModel
Provides the logic for the BuildingExplorer widget.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
A collection of layers of type BuildingSceneLayer that are added to the widget for exploration. | BuildingExplorerViewModel | ||
Contains information about the level filter, such as the value selected by the user in the Level element or the minimum and maximum allowed values. | BuildingExplorerViewModel | ||
Contains information about the construction phase filter, such as the value selected by the user in the Construction phases element and the minimum and maximum allowed values. | BuildingExplorerViewModel | ||
The current state of the view model that can be used for rendering the UI of the widget. | BuildingExplorerViewModel | ||
The view in which the BuildingExplorer is used. | BuildingExplorerViewModel |
Property Details
-
layers
layers Collection<BuildingSceneLayer>
-
A collection of layers of type BuildingSceneLayer that are added to the widget for exploration. The widget is only displayed when this property is set. In case of multiple layers, the widget will display and apply the filters on all layers.
-
level
level BuildingLevelreadonly
-
Contains information about the level filter, such as the value selected by the user in the Level element or the minimum and maximum allowed values.
-
phase
phase BuildingPhasereadonly
-
Contains information about the construction phase filter, such as the value selected by the user in the Construction phases element and the minimum and maximum allowed values.
-
state
state Stringreadonly
-
The current state of the view model that can be used for rendering the UI of the widget.
Value Description disabled widget is being created loading layers and statistics are loading ready widget is ready failed widget failed to load data Possible Values:"disabled" |"loading" |"ready" |"failed"
- Default Value:"disabled"
-
view
view SceneView
-
The view in which the BuildingExplorer is used.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
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.
-
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"); }
-
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");