require(["esri/layers/support/FacilityLayerInfo"], (FacilityLayerInfo) => { /* code goes here */ });
import FacilityLayerInfo from "@arcgis/core/layers/support/FacilityLayerInfo.js";
esri/layers/support/FacilityLayerInfo
The FacilityLayerInfo describes the footprints of managed buildings and other structures. Facilities are used by the FloorFilter widget to provide a list of floors specific to one facility. A facility can represent any occupiable structure, such as an office or campus building, retail setting, warehouse, generator or pump house, silo, or any industrial structure. Facilities features should be contained within a Sites feature.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
The name of the class. | Accessor | ||
The field name from the layer that defines the facility unique ID for a feature. | FacilityLayerInfo | ||
Identifies an operational layer in a map. | FacilityLayerInfo | ||
The field name from the layer that defines the facility name for a feature. | FacilityLayerInfo | ||
The field name from the layer that records the unique ID of a feature's associated site and can be used to identify a feature's associated site feature in floor-aware maps. | FacilityLayerInfo | ||
This value references the numeric ID of the sublayer if the Facility layer is a map service sublayer instead of a feature layer. | FacilityLayerInfo |
Property Details
-
facilityIdField
PropertyfacilityIdField String -
The field name from the layer that defines the facility unique ID for a feature.
-
layerId
PropertylayerId String -
Identifies an operational layer in a map. It allows FacilityLayerInfo to refer to an operational layer that contains facility 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 FeatureLayer or SceneLayer.
-
nameField
PropertynameField String -
The field name from the layer that defines the facility name for a feature.
-
siteIdField
PropertysiteIdField String -
The field name from the layer that records the unique ID of a feature's associated site and can be used to identify a feature's associated site feature in floor-aware maps. A feature can only be related to a single site using this property.
-
sublayerId
PropertysublayerId Number -
This value references the numeric ID of the sublayer if the Facility layer is a map service sublayer instead of a feature layer.
Method Overview
| Name | 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. | FacilityLayerInfo | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | FacilityLayerInfo |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
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
jsonparameter 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.