import FloorFilter from "@arcgis/core/webdoc/widgets/FloorFilter.js";const FloorFilter = await $arcgis.import("@arcgis/core/webdoc/widgets/FloorFilter.js");- Inheritance
- FloorFilter→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Floor filtering is controlled by a configurable floor filter. Those configurations are saved to the web map as a Floor Filter widget.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| readonly inherited | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| |
enabled
- Type
- boolean
Indicates whether the FloorFilter is active and filtering the displayed content according to the FloorFilter selection.
- Default value
- false
facility
Contains the facility ID for the initially selected FloorFilter.facility in the floor filter.
floorVisibilityMode
- 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.
- Default value
- "selectedOnly"
longNames
- Type
- boolean
Indicates whether the levels list is showing the long names from FloorFilter.
- Default value
- false
minimized
- Type
- boolean
Indicates whether the floor filter has been minimized to show only the levels list.
- Default value
- false
pinnedLevels
- Type
- boolean
Indicates whether the levels portion of the floor filter has been pinned to show the levels list.
- Default value
- false
site
Contains the site ID for the initially selected FloorFilter.site in the floor filter.
useVerticalOrder
- Type
- boolean
Indicates whether the floor filter should use vertical order for floor filtering across multiple facilities.
- Default value
- false
Methods
| Method | Signature | Class |
|---|---|---|
| inherited static | fromJSON(json: any): any | |
| inherited | toJSON(): any |
fromJSON
- Signature
-
fromJSON (json: any): any
Creates a new instance of this class and initializes it with values from a JSON object
generated from an ArcGIS product. The object passed into the input json
parameter often comes from a response to a query operation in the REST API or a
toJSON()
method from another ArcGIS product. See the Using fromJSON()
topic in the Guide for details and examples of when and how to use this function.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects. | |
- Returns
- any
Returns a new instance of this class.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.