BuildingExplorerViewModel

AMD: require(["esri/widgets/BuildingExplorer/BuildingExplorerViewModel"], (BuildingExplorerViewModel) => { /* code goes here */ });
ESM: import BuildingExplorerViewModel from "@arcgis/core/widgets/BuildingExplorer/BuildingExplorerViewModel";
Class: esri/widgets/BuildingExplorer/BuildingExplorerViewModel
Inheritance: BuildingExplorerViewModel Accessor
Since: ArcGIS API for JavaScript 4.16

Provides the logic for the BuildingExplorer widget.

See also

Constructors

new BuildingExplorerViewModel(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
Collection<BuildingSceneLayer>

A collection of layers of type BuildingSceneLayer that are added to the widget for exploration.

more details
BuildingExplorerViewModel
BuildingLevel

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.

more details
BuildingExplorerViewModel
BuildingPhase

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.

more details
BuildingExplorerViewModel
String

The current state of the view model that can be used for rendering the UI of the widget.

more details
BuildingExplorerViewModel
SceneView

The view in which the BuildingExplorer is used.

more details
BuildingExplorerViewModel

Property Details

declaredClass Stringreadonly inherited

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

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 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 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 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 SceneView

The view in which the BuildingExplorer is used.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.