SiteLayerInfo | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: SiteLayerInfo→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.19

The SiteLayerInfo class describes the boundaries of managed sites and is used for visualizing groups of facilities. Sites are used by the FloorFilter widget to provide context when browsing for a facility.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`SiteLayerInfoProperties`

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

layerId

Property

Type: string | null | undefined

The id for an operational layer in a map. This allows SiteLayerInfo to refer to an operational layer that contains Site 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 a FeatureLayer or SceneLayer.

nameField

Property

Type: string | null | undefined

The field name from the layer that defines the site name of a feature.

siteIdField

Property

Type: string | null | undefined

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

sublayerId

Property

Type: number | null | undefined

This value references the numeric ID of the sublayer if the Site 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.