• esri/support

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 FloorFilter widget currently supports FeatureLayers, SceneLayers and MapImageLayers (map services). 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.

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
String

The name of the class.

more details
Accessor
FacilityLayerInfo

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

more details
MapFloorInfo
LevelLayerInfo

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

more details
MapFloorInfo
SiteLayerInfo

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

more details
MapFloorInfo

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
*

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

more details
MapFloorInfo
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
MapFloorInfo

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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(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(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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(groupKey)inherited
Since: ArcGIS API for JavaScript 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(){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.