LevelLayerInfo | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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

LevelLayerInfo Constructor new LevelLayerInfo(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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
String	The field name from the layer that defines the unique ID of a feature's associated facility.	LevelLayerInfo
String	The id for an operational layer in the map.	LevelLayerInfo
String	The field name from the layer that defines a unique ID for the feature.	LevelLayerInfo
String	The field name from the layer that defines the level floor number in a particular facility.	LevelLayerInfo
String	The field name from the layer that defines the level name of a feature.	LevelLayerInfo
String	The field name from the layer that defines the level short name of a feature.	LevelLayerInfo
Number	This value references the numeric ID of the sublayer if the Level layer is a map service sublayer instead of a feature layer.	LevelLayerInfo
String	The field name from the layer that defines the order of display and reference to floors in the Indoor Positioning System.	LevelLayerInfo

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.

facilityIdField Property facilityIdField String

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 layerId String

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 levelIdField String

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

levelNumberField Property levelNumberField String

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

longNameField Property longNameField String

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 shortNameField String

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 sublayerId Number

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 verticalOrderField String

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.

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
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	LevelLayerInfo
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	LevelLayerInfo

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.

fromJSON Method fromJSON(json){*}static

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.

Parameter

json Object

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

Type	Description
*	Returns a new instance of this class.

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");

toJSON Method toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.