require(["esri/widgets/FloorFilter/FloorFilterViewModel"], (FloorFilterViewModel) => { /* code goes here */ });
import FloorFilterViewModel from "@arcgis/core/widgets/FloorFilter/FloorFilterViewModel.js";
esri/widgets/FloorFilter/FloorFilterViewModel
Provides the logic for the FloorFilter 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 |
|---|---|---|---|
| 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 | FloorFilterViewModel |
Property Details
-
facility
Propertyfacility String -
The currently selected facility.
- Default Value:undefined
-
goToOverride
PropertygoToOverride GoToOverride -
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
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
Propertylevel String -
The currently selected level.
- Default Value:undefined
-
longNames
PropertylongNames 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
Propertysite String -
The currently selected site.
- Default Value:undefined
Method Overview
| Name | 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
-
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 trueif 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");