FeatureFenceParameters QML Type

Geotrigger fence data created from features. More...

Import Statement: import Esri.ArcGISRuntime
Since: Esri.ArcGISRuntime 100.12
Inherits:

FenceParameters

Properties

Signals

Detailed Description

The features that create a FeatureFenceParameters provide a set of geometries (and attributes) that define targets for the Geotrigger. For example, if the condition is "notify me when my position comes within meters of one of my target areas", the fence data are "my target areas" and each Feature is one target area.

Create a FeatureFenceParameters using a FeatureTable. The features can have point, line, or polygon geometry. For points and lines, you must also supply a FenceParameters::bufferDistance. Each feature in the table represents a single fence.

You can filter features using attributes or geometry by supplying a where clause. For example, you could further refine "my target areas" to be "my target areas that are open and are in California".

The number of features fetched by querying an online table is limited by the layer's ArcGISFeatureLayerInfo::maxRecordCount. Service feature tables that support pagination (ArcGISFeatureLayerInfo::supportsPagination) are not subject to the maximum feature count limit.

A FenceGeotrigger can also take into account floors within buildings. If the feature table used to create the FeatureFenceParameters is referenced by a FeatureLayer that is FloorAware, and the AbstractLocationDataSource used to create the GeotriggerFeed includes LocationSourcePropertiesKeys::floor information, then fences will only be entered when they are intersected by a Location on the correct floor. If the fence or location data does not include valid floor information, the floor is ignored and the fence is entered when it is intersected by the location.

A floor aware feature layer or table must be part of a GeoModel that includes a valid GeoModelFloorDefinition. All layers and tables that are used by the floor definition are loaded when the GeotriggerMonitor is started.

A Location can contain the floor property as part of Location::additionalSourceProperties. This is populated automatically by IndoorsLocationDataSource, or can be supplied as part of your own implementation.

Property Documentation

areaOfInterest : Geometry

The geometry that can be used to spatially filter fences.

This needs to be either an Envelope or Polygon. Use this to define which features in the FeatureTable are to be used as fences by defining an area of interest. If this property is empty the full extent of the feature table is used.


featureTable : FeatureTable

The FeatureTable that contains the features to use in the FeatureFenceParameters.

This table can be shared with a FeatureLayer::featureTable.

When saving new geotriggers into a web map, ensure all feature layer's are assigned a unique Layer::layerId. This ensures the saved featureTable is associated with the corresponding layer. When the saved Map and GeoModel::geotriggersInfo are loaded, the layer and geotrigger will use the same featureTable.


whereClause : string

A where clause that defines the features from the FeatureTable to use as fences.

The string that is used as the FeatureFenceParameters::whereClause should follow standard SQL syntax similar to what is discussed in the document SQL reference for query expressions used in ArcGIS.

The number of features fetched by querying an online table is limited by the layer's ArcGISFeatureLayerInfo::maxRecordCount. Service feature tables that support pagination (ArcGISFeatureLayerInfo::supportsPagination) are not subject to the maximum feature count limit.


Signal Documentation

areaOfInterestChanged()

Emitted when the areaOfInterest property changes.

Note: The corresponding handler is onAreaOfInterestChanged.


featureTableChanged()

Emitted when the featureTable property changes.

Note: The corresponding handler is onFeatureTableChanged.


whereClauseChanged()

Emitted when the whereClause property changes.

Note: The corresponding handler is onWhereClauseChanged.


Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.