SiteLayerInfo

AMD: require(["esri/layers/support/SiteLayerInfo"], (SiteLayerInfo) => { /* code goes here */ });
ESM: import SiteLayerInfo from "@arcgis/core/layers/support/SiteLayerInfo";
Class: esri/layers/support/SiteLayerInfo
Inheritance: SiteLayerInfo Accessor
Since: ArcGIS API 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

new SiteLayerInfo(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
Stringmore details

The id for an operational layer in a map.

more detailsSiteLayerInfo
Stringmore details

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

more detailsSiteLayerInfo
Stringmore details

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

more detailsSiteLayerInfo

Property Details

declaredClass Stringreadonly inherited

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

layerId String

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 String

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

siteIdField String

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

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

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

more detailsSiteLayerInfo

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.