FloorFilterViewModel | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Provides the logic for the FloorFilter widget.

See also

Constructors

FloorFilterViewModel Constructor new FloorFilterViewModel(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

Type	Summary	Class
String	The name of the class.	Accessor
String	The currently selected facility.	FloorFilterViewModel
GoToOverride	This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.	FloorFilterViewModel
String	The currently selected level.	FloorFilterViewModel
Boolean	Determines if the widget is expanded or collapsed.	FloorFilterViewModel
String	The currently selected site.	FloorFilterViewModel
MapView\|SceneView	A reference to the MapView or SceneView.	FloorFilterViewModel

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

facility Property facility String

The currently selected facility.

Default Value:undefined

goToOverride Property goToOverride GoToOverride

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

See also

esri/views/MapView#goTo
SceneView

Example

// The following snippet uses the Search widget but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options = {
    duration: updatedDuration
  };
  return view.goTo(goToParams.target, goToParams.options);
};

level Property level String

The currently selected level.

Default Value:undefined

longNames Property longNames Boolean

Determines if the widget is expanded or collapsed. If the value is true, the widget is expanded and the long names appear. Otherwise, short names are used and icons appear alone on buttons.

Default Value:false

site Property site String

The currently selected site.

Default Value:undefined

view Property view MapView |SceneView

A reference to the MapView or SceneView. If this property is set, the FloorFilter widget will update the view's floors property whenever the floor filter is manipulated or updated programmatically. This property will affect any floor-aware layer in the view.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();

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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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");