FeatureFenceParameters | References | ArcGIS Maps SDK for JavaScript

import FeatureFenceParameters from "@arcgis/core/webdoc/geotriggersInfo/FeatureFenceParameters.js";

const FeatureFenceParameters = await $arcgis.import("@arcgis/core/webdoc/geotriggersInfo/FeatureFenceParameters.js");

Inheritance: FeatureFenceParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.24

Fence parameters for a Geotrigger that uses feature data from an online feature service.

Example

let fenceParameters = new FeatureFenceParameters({
  fenceSource: { // autocasts as new FeatureLayerSource()
    layerUrl: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Recreation/MapServer/0"
  },
  filter: { // autocasts as new FeatureFilter()
    where: "facility = 6",
    geometry: {
      x: 13871520.850500003,
      y: 3910293.086000003,
      spatialReference: {
        wkid: 102100,
        latestWkid: 3857
      }
    }
  },
  bufferDistance: 50 // meters
})

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	FeatureFenceParametersProperties

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
bufferDistance	number \| null \| undefined
declaredClass readonly inherited	string	Accessor
fenceSource	FeatureLayerSource \| null \| undefined
filter	FeatureFilter \| null \| undefined
type readonly	"features"

bufferDistance

Property

Type: number | null | undefined

An optional buffer distance to apply to fence features in meters.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

fenceSource

autocast Property

Type: FeatureLayerSource | null | undefined

An object defining the source for a feature layer to be used as fences.

filter

autocast Property

Type: FeatureFilter | null | undefined

An optional filter to reduce the features used for the parameters.

type

readonly Property

Type: "features"

String indicating the fence parameters type.

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone inherited	clone(): this	ClonableMixin
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.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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

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.