Extends L.esri.
L.esri.
is an abstraction for submitting requests for geocoding suggestions. You can find more information and the source code for this plugin here.
Constructor
Constructor | Description |
---|---|
L.esri. | Creates a new Suggest task |
You can pass any options you can pass to L.esri.Task. The url
will be the ArcGIS geocoding service by default but a custom geocoding service can also be used.
Methods
Method | Returns | Description |
---|---|---|
text( | this | The text to get suggestions for. |
category( | this | The optional category to search for. A list of valid categories can be found here. |
within( | this | A bounding box used to filter results. |
nearby( | this | Increase the match score of candidates close to a location passed within the request. |
run( | XML | Executes the request chain and accepts the response callback. |
Examples
L.esri.Geocoding.suggest()
.text('trea')
.nearby([45, -121], 5000)
.run(function (error, response) {
/* response syntax is documented here:
https://developers.arcgis.com/rest/geocode/suggest/#response-details
*/
});