Legacy
Mapbox.js is no longer in active development. To learn more about our newer mapping tools see Mapbox GL JS.
L.mapbox.geocoderControl(id|url, options)
Adds geocoder functionality and a UI element to a map using the Mapbox Geocoding API. For more information about the Geocoding API, including its pricing structure, see the Mapbox Geocoding API documentation.
Options | Value | Description |
---|---|---|
id or url (required) | string | Either a
|
options | object | An options argument with the same options as the L.Control class, as well as:
|
The options
object can also include queryOptions
which are passed to the
geocoder.query
method: see that method for full documentation of those options.
Example:
var map = L.map('map')
.setView([37, -77], 5)
.addControl(L.mapbox.geocoderControl('mapbox.places'));
Returns a L.mapbox.geocoderControl
object.
Class: L.mapbox.GeocoderControl
geocoderControl.setURL(url)
Set the url used for geocoding.
Options | Value | Description |
---|---|---|
url | string | A geocoding url |
Returns: the geocoder control object
geocoderControl.setID(id)
Set the tileset ID used for geocoding.
Options | Value | Description |
---|---|---|
id | string | A tileset ID to geocode from |
Returns: the geocoder control object
geocoderControl.setTileJSON(tilejson)
Set the TileJSON used for geocoding.
Options | Value | Description |
---|---|---|
tilejson | object | A TileJSON object |
Returns: the geocoder object
geocoderControl.on(event, callback)
Bind a listener to an event emitted by the geocoder control. Supported additional events are
Event | Description |
---|---|
found | A successful search. The event's results property contains the raw results. |
notfound | A search request succeeded but didn't find any results. |
error | A network error. The event's error property contains the raw HTTP error. |
select | Fired when the user selects a location from a list of options returned from a geocoding request. The event's feature property contains the selected GeoJSON Feature. |
autoselect | Fired when the control automatically selects the first result of a query that returns only one result, and repositions the map accordingly. The event's feature property contains the selected GeoJSON feature. |