A condition which monitors the dynamic elements of the geotrigger feed for enter/exit against the fences defined by the Fence Parameters.
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
-
new FenceGeotrigger(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
String | The rule that determines whether a fence polygon has been entered or exited by the geometry from a feed. more details | FenceGeotrigger | |
DeviceLocationFeed | The feed for this Geotrigger. more details | FenceGeotrigger | |
String | Indicates how the geotrigger will use accuracy information from a feed. more details | FenceGeotrigger | |
String | Indicates the type of event that will trigger notifications for the Fence Geotrigger. more details | FenceGeotrigger | |
FeatureFenceParameters | An object defining the fences to use for this Geotrigger. more details | FenceGeotrigger | |
String | The name for this Geotrigger. more details | FenceGeotrigger | |
GeotriggerNotificationOptions | Options that control the notification information sent to a client app when a Geotrigger condition is met. more details | FenceGeotrigger | |
String | String indicating the Geotrigger condition type. more details | FenceGeotrigger |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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 touse-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 DeviceLocationFeed
-
The feed for this Geotrigger.
- Default Value:null
-
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 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 FeatureFenceParameters
-
An object defining the fences to use for this Geotrigger.
- Default Value:null
-
name String
-
The name for this Geotrigger.
- Default Value:null
-
notificationOptions GeotriggerNotificationOptions
-
Options that control the notification information sent to a client app when a Geotrigger condition is met.
- Default Value:null
-
type Stringreadonly
-
String indicating the Geotrigger condition type.
For FenceGeotrigger the type is always "fence".
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");