Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.geotriggers

Class GraphicsOverlayFenceParameters

java.lang.Object

com.esri.arcgisruntime.geotriggers.FenceParameters

com.esri.arcgisruntime.geotriggers.GraphicsOverlayFenceParameters

public class GraphicsOverlayFenceParameters
extends FenceParameters

Geotrigger fence parameters data created from a GraphicsOverlay.

The GraphicsOverlay used to create a GraphicsOverlayFenceParameters provides a dynamic set of graphics that define targets for a FenceGeotrigger condition. For example, if the condition is "notify me when my position comes within 50 meters of one of my target areas", "my target areas" are the graphics in the overlay. Changes to the GraphicsOverlay will be reflected in the fences tracked by the Geotrigger.

A GraphicsOverlayFenceParameters allows you to track all of the graphics displayed on the GeoView in a GraphicsOverlay. This allows you to track new target areas as they are added to the view and to stop tracking areas that are removed. If you wish to track a subset of the graphics displayed in a GraphicsOverlay, or graphics which are not displayed in a GeoView, use a GraphicFenceParameters.

The graphics can have point, line, or polygon geometry. A FenceParameters.getBufferDistance() must be supplied for points or lines.

Since:

100.12.0

Constructor Summary

Constructors

Constructor	Description
GraphicsOverlayFenceParameters(GraphicsOverlay graphicsOverlay)	Creates a GraphicsOverlayFenceParameters using all of the graphics in the GraphicsOverlay.
GraphicsOverlayFenceParameters(GraphicsOverlay graphicsOverlay, double bufferDistance)	Creates a GraphicsOverlayFenceParameters using all of the graphics in the GraphicsOverlay buffered by the buffer distance.

Method Summary

Modifier and Type	Method	Description
GraphicsOverlay	getGraphicsOverlay()	Gets the GraphicsOverlay to use in the GraphicsOverlayFenceParameters.

Methods inherited from class com.esri.arcgisruntime.geotriggers.FenceParameters

createFromGeoElement, getBufferDistance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GraphicsOverlayFenceParameters

public GraphicsOverlayFenceParameters(GraphicsOverlay graphicsOverlay)

Creates a GraphicsOverlayFenceParameters using all of the graphics in the GraphicsOverlay.

Note that the GraphicsOverlayFenceParameters will respect any changes made to the supplied graphics overlay - for example, if a Graphic is removed or added to the original GraphicsOverlay, it will be added or removed as a fence.

Parameters:

graphicsOverlay - the GraphicsOverlay, to use as the source of graphics for the GraphicFenceParameters

Throws:

IllegalArgumentException - if graphicsOverlay is null

Since:

100.12.0

GraphicsOverlayFenceParameters

public GraphicsOverlayFenceParameters(GraphicsOverlay graphicsOverlay,
 double bufferDistance)

Creates a GraphicsOverlayFenceParameters using all of the graphics in the GraphicsOverlay buffered by the buffer distance.

Note that the GraphicsOverlayFenceParameters will respect any changes made to the supplied graphics overlay - for example, if a Graphic is removed or added to the original GraphicsOverlay, it will be added or removed as a fence.

Parameters:

graphicsOverlay - the GraphicsOverlay, to use as the source of graphics for the GraphicFenceParameters

bufferDistance - a buffer distance in meters to apply to the graphics when checking if a Geotrigger condition is met

Throws:

IllegalArgumentException - if graphicsOverlay is null

Since:

100.12.0

Method Details

getGraphicsOverlay

public GraphicsOverlay getGraphicsOverlay()

Gets the GraphicsOverlay to use in the GraphicsOverlayFenceParameters.

Changes to the GraphicsOverlay will be reflected in the fences tracked by the Geotrigger.

Returns:

the GraphicsOverlay to use in the GraphicsOverlayFenceParameters

Since:

100.12.0