View on GitHub Sample viewer app

Create a notification every time a given location data source has entered and/or exited a set of features or graphics.

Use case

Geotriggers can be used to notify users when they have entered or exited a geofence by monitoring a given set of features or graphics. They could be used to display contextual information to museum visitors about nearby exhibits, notify hikers when they have wandered off their desired trail, notify dispatchers when service workers arrive at a scene, or more.

How to use the sample

Observe a virtual walking tour of the Santa Barbara Botanic Garden. Information about the user’s current Garden Section, as well as information about nearby points of interest within 10 meters will display or be removed from the UI when the user enters or exits the buffer of each feature.

How it works

  1. Create a GeotriggerFeed with a LocationDataSource class (in this case, a SimulatedLocationDataSource).
  2. Create a FeatureFenceParameters with a ServiceFeatureTable and a buffer distance at which to monitor each feature.
  3. Create a FenceGeotrigger with the geotrigger feed, a FenceRuleType, the fence parameters, an Arcade Expression, and a name for the specific geotrigger.
  4. Create a GeotriggerMonitor with the fence geotrigger and call GeotriggerMonitor::startAsync() to begin listening for events that meet the FenceRuleType.
  5. When a GeotriggerMonitor::geotriggerNotification emits, capture the GeotriggerNotificationInfo.
  6. For more information about the feature that triggered the notification, cast the GeotriggerNotificationInfo to a FenceGeotriggerNotificationInfo and call FenceGeotriggerNotificationInfo::fenceGeoElement().
  7. Depending on the FenceGeotriggerNotificationInfo::fenceNotificationType() display or hide information on the UI from the GeoElement’s attributes.

Relevant API

  • ArcadeExpression
  • FeatureFenceParameters
  • FenceGeotrigger
  • FenceGeotriggerNotificationInfo
  • FenceRuleType
  • GeoElement
  • Geotrigger
  • GeotriggerFeed
  • GeotriggerMonitor
  • GeotriggerNotificationInfo
  • ServiceFeatureTable
  • SimulatedLocationDataSource

About the data

This sample uses the Santa Barbara Botanic Garden Geotriggers Sample ArcGIS Online Web Map which includes a georeferenced map of the garden as well as select polygon and point features to denote garden sections and points of interest. Description text and attachment images in the feature layers were provided by the Santa Barbara Botanic Garden and more information can be found on the Garden Sections & Displays portion of their website. All assets are used with permission from the Santa Barbara Botanic Garden. For more information, visit the Santa Barbara Botanic Garden website.

Tags

alert, arcade, fence, geofence, geotrigger, location, navigation, notification, notify, routing, trigger

Sample Code

FeatureInfoPane.qml FeatureInfoPane.qml Geotriggers.cpp Geotriggers.h Geotriggers.qml main.cpp main.qml
// [WriteFile Name=Geotriggers, Category=Analysis]
// [Legal]
// Copyright 2021 Esri.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]
import QtQuick
import QtQuick.Controls
Pane {
id: aboutFeaturePane
property var featureName: ""
property var description: ""
property var imageSourceUrl: ""
anchors {
top: parent.top
right: parent.right
}
width: parent.width < 300 ? parent.width : 300
height: parent.height
visible: false
clip: true
background: Rectangle {
color: "white"
border.color: "black"
}
contentItem: ScrollView {
id: scrollViewComponent
anchors {
verticalCenter: parent.verticalCenter
horizontalCenter: parent.horizontalCenter
}
Column {
id: sectionInfoColumn
spacing: 20
Image {
id: img
source: imageSourceUrl
fillMode: Image.PreserveAspectFit
width: scrollViewComponent.width
}
Text {
id: sectionNameTextBox
anchors.horizontalCenter: parent.horizontalCenter
horizontalAlignment: Text.AlignHCenter
width: scrollViewComponent.width
text: featureName
font {
bold: true
pointSize: 20
}
color: "#3B4E1E"
wrapMode: Text.WordWrap
}
Text {
id: descriptionTextBox
anchors.horizontalCenter: parent.horizontalCenter
horizontalAlignment: Text.AlignLeft
verticalAlignment: Text.AlignTop
width: scrollViewComponent.width
text: description
textFormat: Text.RichText
wrapMode: Text.WordWrap
}
Button {
id: closeButton
anchors.horizontalCenter: parent.horizontalCenter
width: parent.width
Text {
anchors.centerIn: parent
verticalAlignment: Text.AlignVCenter
horizontalAlignment: Text.AlignHCenter
text: "Close"
}
onClicked: {
aboutFeaturePane.visible = false
}
}
}
}
}