FacilityLayerInfo | References | ArcGIS Maps SDK for JavaScript

import FacilityLayerInfo from "@arcgis/core/layers/support/FacilityLayerInfo.js";

Inheritance:: FacilityLayerInfo→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.19

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`FacilityLayerInfoProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`facilityIdField`	`string \| null \| undefined`
`layerId`	`string \| null \| undefined`
`nameField`	`string \| null \| undefined`
`siteIdField`	`string \| null \| undefined`
`sublayerId`	`number \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

facilityIdField

Property

Type: string | null | undefined

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

layerId

Property

Type: string | null | undefined

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

Property

Type: string | null | undefined

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

siteIdField

Property

Type: string | null | undefined

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

Property

Type: number | null | undefined

This value references the numeric ID of the sublayer if the Facility layer is a map service sublayer instead of a feature layer.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.