LayerFloorInfo

AMD: require(["esri/layers/support/LayerFloorInfo"], (LayerFloorInfo) => { /* code goes here */ });
ESM: import LayerFloorInfo from "@arcgis/core/layers/support/LayerFloorInfo";
Class: esri/layers/support/LayerFloorInfo
Inheritance: LayerFloorInfo Accessor
Since: ArcGIS API for JavaScript 4.19

LayerFloorInfo contains properties that allow a layer to be floor-aware. These properties are used to filter the levels, or floors, of a facility that are displayed.

Known Limitations

  • Floor-aware maps are only supported in ArcGIS Online. Support for publishing floor-aware maps to ArcGIS Enterprise is coming soon.
  • The FloorFilter widget currently supports FeatureLayers and SceneLayers. A future release will support floor filtering of MapImageLayers (map services).
See also:

Constructors

new LayerFloorInfo(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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The field name derived from a floor-aware layer and used to filter features by floor level.

more detailsLayerFloorInfo

Property Details

declaredClass Stringreadonly inherited

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

floorField String

The field name derived from a floor-aware layer and used to filter features by floor level.

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsLayerFloorInfo
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsLayerFloorInfo

Method Details

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.
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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.