require(["esri/webdoc/geotriggersInfo/FenceGeotrigger"], (FenceGeotrigger) => { /* code goes here */ });
import FenceGeotrigger from "@arcgis/core/webdoc/geotriggersInfo/FenceGeotrigger.js";
esri/webdoc/geotriggersInfo/FenceGeotrigger
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
-
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 |
---|---|---|---|
The name of the class. | Accessor | ||
The rule that determines whether a fence polygon has been entered or exited by the geometry from a feed. | FenceGeotrigger | ||
The feed for this Geotrigger. | FenceGeotrigger | ||
Indicates how the geotrigger will use accuracy information from a feed. | FenceGeotrigger | ||
Indicates the type of event that will trigger notifications for the Fence Geotrigger. | FenceGeotrigger | ||
An object defining the fences to use for this Geotrigger. | FenceGeotrigger | ||
The name for this Geotrigger. | FenceGeotrigger | ||
Options that control the notification information sent to a client app when a Geotrigger condition is met. | FenceGeotrigger | ||
String indicating the Geotrigger condition type. | FenceGeotrigger |
Property Details
-
enterExitRule
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
feed DeviceLocationFeed
-
The feed for this Geotrigger.
- Default Value:null
-
feedAccuracyMode
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
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
fenceParameters FeatureFenceParameters
-
An object defining the fences to use for this Geotrigger.
- Default Value:null
-
name
name String
-
The name for this Geotrigger.
- Default Value:null
-
notificationOptions
notificationOptions GeotriggerNotificationOptions
-
Options that control the notification information sent to a client app when a Geotrigger condition is met.
- Default Value:null
-
type
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. | 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 | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | FenceGeotrigger |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
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.
-
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.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 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");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.