FenceGeotrigger | References | ArcGIS Maps SDK for JavaScript

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

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

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	FenceGeotriggerProperties

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
declaredClass readonly inherited	string	Accessor
enterExitRule	EnterExitRule
feed	DeviceLocationFeed \| null \| undefined
feedAccuracyMode	FeedAccuracyMode
fenceNotificationRule	FenceNotificationRule \| null \| undefined
fenceParameters	FeatureFenceParameters \| null \| undefined
name	string \| null \| undefined
notificationOptions	GeotriggerNotificationOptions \| null \| undefined
type readonly	"fence"

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

enterExitRule

Property

Type: EnterExitRule

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.

Default value: "enter-contains-and-exit-does-not-intersect"

feed

autocast Property

Type: DeviceLocationFeed | null | undefined

The feed for this Geotrigger.

feedAccuracyMode

Property

Type: FeedAccuracyMode

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.

Default value: "use-geometry"

fenceNotificationRule

Property

Type: FenceNotificationRule | null | undefined

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.

fenceParameters

autocast Property

Type: FeatureFenceParameters | null | undefined

An object defining the fences to use for this Geotrigger.

name

Property

Type: string | null | undefined

The name for this Geotrigger.

notificationOptions

autocast Property

Type: GeotriggerNotificationOptions | null | undefined

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

type

readonly Property

Type: "fence"

String indicating the Geotrigger condition 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.