FloorFilterViewModel | References | ArcGIS Maps SDK for JavaScript

import FloorFilterViewModel from "@arcgis/core/widgets/FloorFilter/FloorFilterViewModel.js";

const FloorFilterViewModel = await $arcgis.import("@arcgis/core/widgets/FloorFilter/FloorFilterViewModel.js");

Inheritance: FloorFilterViewModel→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.19

Provides the logic for the FloorFilter widget and component.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	FloorFilterViewModelProperties

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
declaredClass readonly inherited	string	Accessor
facility	string \| null \| undefined
floorVisibilityMode readonly	FloorVisibilityMode
goToOverride inherited	GoToOverride \| null \| undefined	GoTo
level	string \| null \| undefined
longNames	boolean
site	string \| null \| undefined
useVerticalOrder readonly	boolean
view	MapViewOrSceneView \| null \| undefined

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

facility

Property

Type: string | null | undefined

The currently selected facility.

floorVisibilityMode

readonly Property

Type: FloorVisibilityMode

Since: ArcGIS Maps SDK for JavaScript 5.1

Indicates whether the floor filter should display the selected floor and all floors below it or only the selected floor.

Floor Visibility mode is only applicable in web scenes.

goToOverride

inherited Property

Type: GoToOverride | null | undefined

Inherited from: GoTo

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

See also

Example

// The following snippet uses Search 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

Type: string | null | undefined

The currently selected level.

longNames

Property

Type: 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

Type: string | null | undefined

The currently selected site.

useVerticalOrder

readonly Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the floor filter should use vertical order for floor filtering across multiple facilities.

view

Property

Type: MapViewOrSceneView | null | undefined

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