Offline geocode
Geocode addresses to locations and reverse geocode locations to addresses offline.
Use case
You can use an address locator file to geocode addresses and locations. For example, you could provide offline geocoding capabilities to field workers repairing critical infrastructure in a disaster when network availability is limited.
How to use the sample
Type the address in the Search menu option or select from the list to Geocode
the address and view the result on the map. Tap the location you want to reverse geocode. Select the pin to highlight the PictureMarkerSymbol
(i.e. single tap on the pin) and then tap-hold and drag on the map to get real-time geocoding.
How it works
- Use the path of a .loc file to create a
LocatorTask
object. - Set up
GeocodeParameters
and callgeocodeWithParameters
to get geocode results.
Relevant API
- GeocodeParameters
- GeocodeResult
- LocatorTask
- ReverseGeocodeParameters
Offline Data
Read more about how to set up the sample's offline data here.
Link | Local Location |
---|---|
SanDiego tpkx file | <userhome> /ArcGIS/Runtime/Data/tpkx/streetmap_SD.tpkx |
SanDiego loc Files | <userhome> /ArcGIS/Runtime/Data/Locators/SanDiegoStreetAddressLocator/SanDiego_StreetAddress.loc |
Tags
geocode, geocoder, locator, offline, package, query, search
Sample Code
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
// [WriteFile Name=OfflineGeocode, Category=Search]
// [Legal]
// Copyright 2016 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
import QtQuick.Layouts
import Esri.ArcGISExtras
import Esri.ArcGISRuntime
import Esri.ArcGISRuntime.Toolkit
Rectangle {
clip: true
width: 800
height: 600
readonly property url dataPath: {
Qt.platform.os === "ios" ?
System.writableLocationUrl(System.StandardPathsDocumentsLocation) + "/ArcGIS/Runtime/Data" :
System.writableLocationUrl(System.StandardPathsHomeLocation) + "/ArcGIS/Runtime/Data"
}
property Point pinLocation: null
property Point clickedPoint: null
property bool isReverseGeocode: false
property bool isPressAndHold: false
property string errorMessage: ""
// Map view UI presentation at top
MapView {
id: mapView
anchors.fill: parent
Component.onCompleted: {
// Set the focus on MapView to initially enable keyboard navigation
forceActiveFocus();
}
// initialize callout
calloutData {
title: "Address"
}
Map {
// create local tiled layer using tile package
Basemap {
ArcGISTiledLayer {
TileCache {
path: dataPath + "/tpkx/streetmap_SD.tpkx"
}
}
}
// set initial viewpoint
ViewpointCenter {
Point {
x: -13042254.715252
y: 3857970.236806
spatialReference: SpatialReference {
wkid: 3857
}
}
targetScale: 2e4
}
onErrorChanged: errorMessage = error.message;
}
// add a graphics overlay to the mapview
GraphicsOverlay {
id: graphicsOverlay
// pin graphic that will visually display geocoding results
Graphic {
id: pinGraphic
geometry: pinLocation
visible: true
PictureMarkerSymbol {
id: pictureMarker
height: 36
width: 19
url: "qrc:/Samples/Search/OfflineGeocode/red_pin.png"
offsetY: height / 2
}
}
}
Callout {
id: callout
calloutData: parent.calloutData
screenOffsetY: (pictureMarker.height / 2) * -1
accessoryButtonVisible: false
leaderPosition: Callout.LeaderPosition.Automatic
}
// dismiss suggestions and no results notification on mouse press
onMousePressed: {
noResultsRect.visible = false;
suggestionRect.visible = false;
}
onMouseClicked: mouse => {
clickedPoint = mouse.mapPoint;
mapView.identifyGraphicsOverlayWithMaxResults(graphicsOverlay, mouse.x, mouse.y, 5, false, 1);
}
onIdentifyGraphicsOverlayStatusChanged: {
if (identifyGraphicsOverlayStatus === Enums.TaskStatusCompleted){
// if clicked on the pin graphic, display callout.
if (identifyGraphicsOverlayResult.graphics.length > 0)
callout.showCallout();
// otherwise, normal reverse geocode
else if (locatorTask.geocodeStatus !== Enums.TaskStatusInProgress){
isReverseGeocode = true;
locatorTask.reverseGeocodeWithParameters(clickedPoint, reverseGeocodeParams);
}
}
}
// hide suggestion window if viewpoint changes
onViewpointChanged: {
suggestionRect.visible = false;
noResultsRect.visible = false;
}
// When user press and holds, prepare for real-time reverse geocoding
onMousePressedAndHeld: mouse => {
isPressAndHold = true;
isReverseGeocode = true;
if (locatorTask.geocodeStatus !== Enums.TaskStatusInProgress)
locatorTask.reverseGeocodeWithParameters(mouse.mapPoint, reverseGeocodeParams);
}
// real-time reverse geocode if mouse being held down
onMousePositionChanged: mouse => {
if (isPressAndHold && locatorTask.geocodeStatus !== Enums.TaskStatusInProgress)
locatorTask.reverseGeocodeWithParameters(mouse.mapPoint, reverseGeocodeParams);
}
// stop real-time reverse geocoding
onMouseReleased: {
isPressAndHold = false;
isReverseGeocode = false;
}
onErrorChanged: errorMessage = error.message;
}
//! [OfflineGeocode LocatorTask]
LocatorTask {
id: locatorTask
url: dataPath + "/Locators/SanDiegoStreetAddressLocator/SanDiego_StreetAddress.loc"
//! [OfflineGeocode LocatorTask]
suggestions {
// suggestions will update whenever textField's text property changes
searchText: textField.text
suggestTimerThreshold: 250
suggestParameters: SuggestParameters {
maxResults: 5
}
}
GeocodeParameters {
id: geocodeParams
minScore: 75
maxResults: 1
}
ReverseGeocodeParameters {
id: reverseGeocodeParams
maxDistance: 1000
maxResults: 1
}
onGeocodeStatusChanged: {
if (geocodeStatus === Enums.TaskStatusCompleted) {
if(geocodeResults.length > 0) {
callout.dismiss();
// zoom to geocoded location
mapView.setViewpointCenter(geocodeResults[0].displayLocation)
// set pin and edit callout
pinLocation = geocodeResults[0].displayLocation;
mapView.calloutData.geoElement = pinGraphic;
mapView.calloutData.detail = geocodeResults[0].label;
// if it was a reverse geocode, also display callout
if (isReverseGeocode)
callout.showCallout();
// continue reverse geocoding if press and holding mouse
if (!isPressAndHold)
isReverseGeocode = false;
}
// if no result found, inform user
else {
callout.dismiss()
noResultsRect.visible = true;
pinLocation = null;
}
}
}
onErrorChanged: errorMessage = error.message;
}
Column {
anchors {
fill: parent
margins: 10
}
Rectangle {
id: addressSearchRect
anchors {
left: parent.left
right: parent.right
}
height: childrenRect.height
color: "#f7f8fa"
border {
color: "#7B7C7D"
width: 1
}
radius: 2
RowLayout {
width: parent.width
height: childrenRect.height
// search bar for geocoding
TextField {
id: textField
Layout.fillWidth: true
leftPadding: 5
selectByMouse: true
placeholderText: "Enter an Address"
// when user types, make suggestions visible
onTextChanged: {
suggestionRect.visible = true;
}
// when enter or return is presed, begin geocoding with inputted text
onAccepted: {
suggestionRect.visible = false;
if (locatorTask.geocodeStatus !== Enums.TaskStatusInProgress)
locatorTask.geocodeWithParameters(text, geocodeParams);
}
// initial text
Component.onCompleted: {
text = "910 N Harbor Dr, San Diego, CA 92101";
suggestionRect.visible = false;
}
}
// button to open and close suggestions
Rectangle {
Layout.margins: 5
width: height
height: textField.contentHeight
color: "#f7f8fa"
radius: 2
Image {
anchors.fill: parent
source: suggestionRect.visible ? "qrc:/Samples/Search/OfflineGeocode/ic_menu_closeclear_light_d.png" : "qrc:/Samples/Search/OfflineGeocode/ic_menu_collapsedencircled_light_d.png"
MouseArea {
anchors.fill: parent
onClicked: {
suggestionRect.visible = !suggestionRect.visible;
}
}
}
}
}
}
Rectangle {
id: suggestionRect
width: addressSearchRect.width
height: 20 * locatorTask.suggestions.count
color: "#f7f8fa"
opacity: 0.85
ListView {
id: suggestView
model: locatorTask.suggestions
height: parent.height
delegate: Component {
Rectangle {
width: addressSearchRect.width
height: 20
color: "#f7f8fa"
border.color: "darkgray"
Text {
anchors {
verticalCenter: parent.verticalCenter
leftMargin: 5
rightMargin: 5
}
font {
weight: Font.Black
pixelSize: 12
}
width: parent.width
text: label
elide: Text.ElideRight
leftPadding: 5
color: "black"
}
// when user clicks suggestion, geocode with the selected address
MouseArea {
anchors.fill: parent
onClicked: {
if (locatorTask.geocodeStatus !== Enums.TaskStatusInProgress) {
// geocode with the suggestion
locatorTask.geocodeWithParameters(label, geocodeParams);
// change the text label
textField.text = label;
}
// dismiss suggestions
suggestionRect.visible = false;
}
}
}
}
}
}
}
// running when geocoding in progress
BusyIndicator {
id: busyIndicator
anchors.centerIn: parent
running: locatorTask.geocodeStatus === Enums.TaskStatusInProgress
}
Rectangle {
id: noResultsRect
anchors.centerIn: parent
height: 50
width: 200
color: "#f7f8fa"
visible: false
radius: 2
opacity: 0.85
border.color: "black"
Text {
anchors.centerIn: parent
text: "No matching address"
font.pixelSize: 18
}
}
Dialog {
modal: true
x: Math.round(parent.width - width) / 2
y: Math.round(parent.height - height) / 2
standardButtons: Dialog.Ok
visible: text.length > 0
title: "Error"
property alias text : textLabel.text
property alias informativeText : detailsLabel.text
ColumnLayout {
Text {
id: textLabel
text: errorMessage
}
Text {
id: detailsLabel
text: "please consult README.md"
}
}
}
}