MapFloorInfo

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

Floor-aware maps facilitate visualizing, editing, and analyzing indoor data and they allow for fast navigation of buildings in maps and scenes. To visualize your data based on a site, facility, or level, your map must contain the related floor plan layers, with features linked together in a floor plan hierarchy as done in the ArcGIS Indoors Information Model. Once you define the properties to make your map floor-aware, you can use the FloorFilter widget to explore the floor-aware data based on the configured site, facility, and level layers. The floor filter allows you to filter the floor plan data that is displayed in your MapView or SceneView, to a site, a facility in the site, or a level in the facility.

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 MapFloorInfo(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
FacilityLayerInfomore details

Contains the facility features of a floor plan, which describe the footprints of managed buildings and other structures.

more detailsMapFloorInfo
LevelLayerInfomore details

Contains the level features of a floor plan, which describe the footprint of each occupiable floor contained in a managed facility.

more detailsMapFloorInfo
SiteLayerInfomore details

Contains the site features of a floor plan, which describe the boundaries of managed sites and is used for visualization in mapmaking.

more detailsMapFloorInfo

Property Details

declaredClass Stringreadonly inherited

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

Contains the facility features of a floor plan, which describe the footprints of managed buildings and other structures. The FloorFilter widget uses this property to identify what facilities exist in your map to use for navigation and filtering.

Contains the level features of a floor plan, which describe the footprint of each occupiable floor contained in a managed facility. The FloorFilter widget uses this property to identify what levels exist in your map to use for filtering.

Contains the site features of a floor plan, which describe the boundaries of managed sites and is used for visualization in mapmaking. The FloorFilter widget uses this property to identify the sites in your map to use for navigation and filtering.

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 detailsMapFloorInfo
Objectmore details

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

more detailsMapFloorInfo

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.