FeatureLayerSource

AMD: require(["esri/webdoc/geotriggersInfo/FeatureLayerSource"], (FeatureLayerSource) => { /* code goes here */ });
ESM: import FeatureLayerSource from "@arcgis/core/webdoc/geotriggersInfo/FeatureLayerSource";
Class: esri/webdoc/geotriggersInfo/FeatureLayerSource
Inheritance: FeatureLayerSource Accessor
Since: ArcGIS API for JavaScript 4.24

The source for a feature layer to be used as fences for Geotriggers.

Example:
let source = new FeatureLayerSource({
  // If layerUrl is present, layerId is unnecessary (and vice-versa)
  layerUrl: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Recreation/MapServer/0"
})

Constructors

new FeatureLayerSource(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

A unique identifying string that must match the id property of a feature layer in an associated map.

more detailsFeatureLayerSource
Stringmore details

A URL to a service that will be used for all queries against the layer.

more detailsFeatureLayerSource
Stringmore details

String indicating the type of source.

more detailsFeatureLayerSource

Property Details

declaredClass Stringreadonly inherited

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

layerId String

A unique identifying string that must match the id property of a feature layer in an associated map. The fence parameters will use the same underlying data as the feature layer in the map.

Default Value:null
layerUrl String

A URL to a service that will be used for all queries against the layer.

Default Value:null
type Stringreadonly

String indicating the type of source.

For FeatureLayerSource the type is always "feature-layer".

Method Overview

Name Return Type Summary Class
thismore details

Creates a deep clone of this object.

more detailsFeatureLayerSource
*more details

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

more detailsFeatureLayerSource
Objectmore details

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

more detailsFeatureLayerSource

Method Details

clone(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns:
Type Description
this A deep clone of the class instance that invoked this method.
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.