Skip to content
import LevelLayerInfo from "@arcgis/core/layers/support/LevelLayerInfo.js";
Inheritance:
LevelLayerInfoAccessor
Since
ArcGIS Maps SDK for JavaScript 4.19

The LevelLayerInfo class describes the footprint of each occupiable floor contained in a managed facility. The FloorFilter widget uses this class to identify what floor levels exist in the layer to use for filtering.

See also

Constructors

Constructor

Constructor
Parameters
ParameterTypeDescriptionRequired
properties
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.

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor

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

facilityIdField

Property
Type
string | null | undefined

The field name from the layer that defines the unique ID of a feature's associated facility. This is used to identify the feature's associated facility feature in floor-aware maps. A feature can only be related to a single facility using this field.

layerId

Property
Type
string | null | undefined

The id for an operational layer in the map. This allows LevelLayerInfo to refer to an operational layer that contains level features. When configuring a floor-aware map manually, as opposed to configuring it in ArcGIS Pro, this value needs to be set with the ID value from the appropriate Layer object, whether a FeatureLayer or SceneLayer.

levelIdField

Property
Type
string | null | undefined

The field name from the layer that defines a unique ID for the feature.

levelNumberField

Property
Type
string | null | undefined

The field name from the layer that defines the level floor number in a particular facility.

longNameField

Property
Type
string | null | undefined

The field name from the layer that defines the level name of a feature. The level name is used to support floor filtering in floor-aware apps.

shortNameField

Property
Type
string | null | undefined

The field name from the layer that defines the level short name of a feature. The level short name supports floor filtering in floor-aware apps. Some floor-aware apps only display a short name in the floor filter, others may use the longNameField or allow toggling between the two.

sublayerId

Property
Type
number | null | undefined

This value references the numeric ID of the sublayer if the Level layer is a map service sublayer instead of a feature layer.

verticalOrderField

Property
Type
string | null | undefined

The field name from the layer that defines the order of display and reference to floors in the Indoor Positioning System. It uses a zero-based ordering system to define the floor order. The ground level of each facility is represented as zero. Positive values represent floors above ground, and negative values represent floors below ground. Values must be continuous and a value in the sequence cannot be skipped.

Methods

MethodSignatureClass
fromJSON
inherited static
fromJSON(json: any): any
toJSON
inherited
toJSON(): any

fromJSON

inheritedstatic Method
Signature
fromJSON (json: any): any
Inherited from: JSONSupportMixin

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
ParameterTypeDescriptionRequired
json
any

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

inherited Method
Signature
toJSON (): any
Inherited from: JSONSupportMixin

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.