FenceGeotrigger

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

A condition which monitors the dynamic elements of the geotrigger feed for enter/exit against the fences defined by the Fence Parameters.

Example
let fenceGeotrigger = new FenceGeotrigger({
  name: "Example Geotrigger - Notify when I am within 50m of my target areas.",
  enterExitRule: "enter-intersects-and-exit-does-not-intersect",
  feed: {
    filterExpression: {
      title: "Location filter",
      expression: "return $locationupdate.horizontalaccuracy <= 20"
    }
  },
  fenceNotificationRule: "enter",
  feedAccuracyMode: "use-geometry-with-accuracy",
  fenceParameters: {
    bufferDistance: 50,
    fenceSource: {
      layerUrl: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Recreation/MapServer/0"
    },
  },
  notificationOptions: {
    expressionInfo: {
      "title": "Expression",
      "expression": "'You have entered' + $fencefeature.AREA_NAME"
    }
  }
})

Constructors

FenceGeotrigger

Constructor
new FenceGeotrigger(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
String

The name of the class.

Accessor
String

The rule that determines whether a fence polygon has been entered or exited by the geometry from a feed.

FenceGeotrigger
DeviceLocationFeed

The feed for this Geotrigger.

FenceGeotrigger
String

Indicates how the geotrigger will use accuracy information from a feed.

FenceGeotrigger
String

Indicates the type of event that will trigger notifications for the Fence Geotrigger.

FenceGeotrigger
FeatureFenceParameters

An object defining the fences to use for this Geotrigger.

FenceGeotrigger
String

The name for this Geotrigger.

FenceGeotrigger
GeotriggerNotificationOptions

Options that control the notification information sent to a client app when a Geotrigger condition is met.

FenceGeotrigger
String

String indicating the Geotrigger condition type.

FenceGeotrigger

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

enterExitRule

Property
enterExitRule String

The rule that determines whether a fence polygon has been entered or exited by the geometry from a feed. The feedAccuracyMode must be set to use-geometry-with-accuracy for this property to have an effect.

Enter exit rule Description
enter-intersects-and-exit-does-not-intersect A fence polygon is entered when it intersects a feed geometry and exited when it no longer intersects.
enter-contains-and-exit-does-not-contain A fence polygon is entered when it contains a feed geometry and exited when it is no longer contained.
enter-contains-and-exit-does-not-intersect A fence polygon is entered when it contains a feed geometry and exited when it no longer intersects.

Possible Values:"enter-contains-and-exit-does-not-contain"|"enter-contains-and-exit-does-not-intersect"|"enter-intersects-and-exit-does-not-intersect"

Default Value:enter-contains-and-exit-does-not-intersect

feed

Property
feed DeviceLocationFeed

The feed for this Geotrigger.

Default Value:null

feedAccuracyMode

Property
feedAccuracyMode String

Indicates how the geotrigger will use accuracy information from a feed.

Feed accuracy mode Description
use-geometry The reported geometry from a feed will be used.
use-geometry-with-accuracy The feed geometry will be used in conjunction with accuracy information.

Possible Values:"use-geometry"|"use-geometry-with-accuracy"

Default Value:use-geometry

fenceNotificationRule

Property
fenceNotificationRule String

Indicates the type of event that will trigger notifications for the Fence Geotrigger. For example, a value of enter will result in notifications when the geometry of the feed enters a fence polygon.

Possible Values:"enter"|"enter-or-exit"|"exit"

Default Value:null

fenceParameters

Property
fenceParameters FeatureFenceParameters

An object defining the fences to use for this Geotrigger.

Default Value:null

name

Property
name String

The name for this Geotrigger.

Default Value:null

notificationOptions

Property
notificationOptions GeotriggerNotificationOptions

Options that control the notification information sent to a client app when a Geotrigger condition is met.

Default Value:null

type

Property
type Stringreadonly

String indicating the Geotrigger condition type.

For FenceGeotrigger the type is always "fence".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor
this

Creates a deep clone of this object.

FenceGeotrigger
*

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

FenceGeotrigger
Boolean

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor
Object

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

FenceGeotrigger

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone

Method
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

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.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON

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