FeatureFenceParameters

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

new FeatureFenceParameters(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
Numbermore details

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

more detailsFeatureFenceParameters
Stringmore details

The name of the class.

more detailsAccessor
FeatureLayerSourcemore details

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

more detailsFeatureFenceParameters
FeatureFiltermore details

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

more detailsFeatureFenceParameters
Stringmore details

String indicating the fence parameters type.

more detailsFeatureFenceParameters

Property Details

bufferDistance Number

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

Default Value:null
declaredClass Stringreadonly inherited

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

fenceSource FeatureLayerSource

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

Default Value:null
filter FeatureFilter

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

Default Value:null
type Stringreadonly

String indicating the fence parameters type.

For FeatureFenceParameters the type is always "features".

Method Overview

Name Return Type Summary Class
thismore details

Creates a deep clone of this object.

more detailsFeatureFenceParameters
*more details

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

more detailsFeatureFenceParameters
Objectmore details

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

more detailsFeatureFenceParameters

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.