How to perform a search

Geocoding, also known as address search, is the process of converting text for an address or place to a complete address with a location. You can use the geocoding service to search for an address or a place, find candidate matches, and return complete addresses with a location.

With the service, you can build applications to:

  • Find the location of an address.
  • Convert address text to a complete address.
  • Provide a list of address candidates for an incomplete address.

How to access the geocoding service

There is no direct integration with CesiumJS to access the geocoding service. Instead, you use the geocoding and request packages from ArcGIS REST JS.

To access the service with ArcGIS REST JS, you typically perform the following steps:

  1. Reference the appropriate package.
  2. Set the API key to authenticate the request.
  3. Define parameters to pass to the service.
  4. Call the service and handle the results.

Example

Search for an address

This example shows how to search for an address using the geocode operation from ArcGIS REST JS.

Use dark colors for code blocksCopy
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
<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="initial-scale=1, maximum-scale=1, user-scalable=no" />
    <title>CesiumJS: Search for an address</title>

    <script src="https://cesium.com/downloads/cesiumjs/releases/1.121/Build/Cesium/Cesium.js"></script>
    <link href="https://cesium.com/downloads/cesiumjs/releases/1.121/Build/Cesium/Widgets/widgets.css" rel="stylesheet">

    <script src="https://unpkg.com/@esri/arcgis-rest-request@4/dist/bundled/request.umd.js"></script>
    <script src="https://unpkg.com/@esri/arcgis-rest-geocoding@4/dist/bundled/geocoding.umd.js"></script>

</head>

<body>
    <div id="cesiumContainer"></div>

    <script type="module">

        const accessToken = "YOUR_ACCESS_TOKEN";

        Cesium.ArcGisMapService.defaultAccessToken = accessToken;

        const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);

        const arcGisImagery = Cesium.ArcGisMapServerImageryProvider.fromBasemapType(Cesium.ArcGisBaseMapType.SATELLITE, {
            enablePickFeatures:false
        });

        const viewer = new Cesium.Viewer("cesiumContainer", {

            baseLayer: Cesium.ImageryLayer.fromProviderAsync(arcGisImagery),

            terrain: Cesium.Terrain.fromWorldTerrain(),
            timeline: false,
            animation: false,
            geocoder:false

        });

        viewer.camera.setView({

            destination: Cesium.Cartesian3.fromDegrees(-122.4117, 37.769, 5000),
            orientation: {
                pitch: Cesium.Math.toRadians(-70)
            }

        })

        function findAddress(query) {

            const cameraPos = Cesium.Cartographic.fromCartesian(viewer.camera.position);
            const center = [Cesium.Math.toDegrees(cameraPos.longitude),Cesium.Math.toDegrees(cameraPos.latitude)]

            arcgisRest
            .geocode({
                singleLine: query,
                authentication,
                params: {
                    outFields: "*",
                    location: center.join(",")
                }
            })

            .then((response) => {
                const result = response.candidates[0];
                if (!result === 0) {
                    alert("That query didn't match any geocoding results.");
                    return;
                }

            })

            .catch((error) => {
                alert("There was a problem using the geocoder. See the console for details.");
                console.error(error);
            });

        }

        findAddress("Conservatory of Flowers, San Francisco")

    </script>

  </body>

Tutorials

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