Search a random text or lat/lon using Jawg Places. -All features are points with properties, more details on our documentation.
-to search using Jawg Places
-promise with the feature collection received from Jawg Places
-Open the result list with the error message. This will trigger JawgPlacesOptions.onError.
+Search a random text or lat/lon using Jawg Places.
+All features are points with properties, more details on our documentation.
+See JawgPlacesOptions.reverse for lat/lon search.
+The text to search using Jawg Places
+A promise with the feature collection received from Jawg Places
+Open the result list with the error message. This will trigger JawgPlacesOptions.onError.
The error to show, can be a string or an object.
-Open the result list with elements from the FeatureCollection. We use the properties.label field of each features.
This will trigger JawgPlacesOptions.onFeatures.
Feature Collection of geocoded points.
-Submit the search using the value of the <input>. This will trigger JawgPlacesOptions.onFeatures.
Generated using TypeDoc
This class will help you to add or use search bar for geocoding with a Leaflet map.
-Adds the control to the given map.
-from Leaflet
-Adds the control to the given map.
+from Leaflet
+Clear created DOM elements and listeners. +
This is the function used by Leaflet when you add a L.Control. +
Search a random text or lat/lon using Jawg Places. -All features are points with properties, more details on our documentation.
-to search using Jawg Places
-promise with the feature collection received from Jawg Places
-Open the result list with the error message. This will trigger JawgPlacesOptions.onError.
+The map from Leaflet
+Search a random text or lat/lon using Jawg Places.
+All features are points with properties, more details on our documentation.
+See JawgPlacesOptions.reverse for lat/lon search.
+The text to search using Jawg Places
+A promise with the feature collection received from Jawg Places
+Open the result list with the error message. This will trigger JawgPlacesOptions.onError.
The error to show, can be a string or an object.
-Open the result list with elements from the FeatureCollection. We use the properties.label field of each features.
This will trigger JawgPlacesOptions.onFeatures.
Feature Collection of geocoded points.
-Submit the search using the value of the <input>. This will trigger JawgPlacesOptions.onFeatures.
Generated using TypeDoc
This class will help you to add or use search bar for geocoding with a MapLibre GL JS map.
-Optional options: JawgPlacesMaplibreOptionsWhen Jawg Places is not used as a control within your map, you will need to call this function.
-Optional options: JawgPlacesMaplibreOptionsClear created DOM elements and listeners. +
This is the function used by MapLibre and Mapbox when you add a maplibre.IControl or mapboxgl.IControl. Adds the control to the given map.
-the generated control container
-Search a random text or lat/lon using Jawg Places. -All features are points with properties, more details on our documentation.
-to search using Jawg Places
-promise with the feature collection received from Jawg Places
-Open the result list with the error message. This will trigger JawgPlacesOptions.onError.
+The generated control container
+Search a random text or lat/lon using Jawg Places.
+All features are points with properties, more details on our documentation.
+See JawgPlacesOptions.reverse for lat/lon search.
+The text to search using Jawg Places
+A promise with the feature collection received from Jawg Places
+Open the result list with the error message. This will trigger JawgPlacesOptions.onError.
The error to show, can be a string or an object.
-Open the result list with elements from the FeatureCollection. We use the properties.label field of each features.
This will trigger JawgPlacesOptions.onFeatures.
Feature Collection of geocoded points.
-Submit the search using the value of the <input>. This will trigger JawgPlacesOptions.onFeatures.
Generated using TypeDoc
This class will help you to add or use search bar for geocoding with a Mapbox GL JS map.
-Optional options: JawgPlacesMaplibreOptionsWhen Jawg Places is not used as a control within your map, you will need to call this function.
-Optional options: JawgPlacesMaplibreOptionsClear created DOM elements and listeners. +
This is the function used by MapLibre and Mapbox when you add a maplibre.IControl or mapboxgl.IControl. Adds the control to the given map.
-the generated control container
-Search a random text or lat/lon using Jawg Places. -All features are points with properties, more details on our documentation.
-to search using Jawg Places
-promise with the feature collection received from Jawg Places
-Open the result list with the error message. This will trigger JawgPlacesOptions.onError.
+The generated control container
+Search a random text or lat/lon using Jawg Places.
+All features are points with properties, more details on our documentation.
+See JawgPlacesOptions.reverse for lat/lon search.
+The text to search using Jawg Places
+A promise with the feature collection received from Jawg Places
+Open the result list with the error message. This will trigger JawgPlacesOptions.onError.
The error to show, can be a string or an object.
-Open the result list with elements from the FeatureCollection. We use the properties.label field of each features.
This will trigger JawgPlacesOptions.onFeatures.
Feature Collection of geocoded points.
-Submit the search using the value of the <input>. This will trigger JawgPlacesOptions.onFeatures.
Generated using TypeDoc
Generated using TypeDoc
Option to show administrative area when available.
-Optional fillFill color for the polygon.
-Optional outlineOutline color for the polygon.
-true to show administrative boundary when the result is a administrative area.
Generated using TypeDoc
Set of options when you are looking for places in a particular region.
-new JawgPlaces({
boundaries: {
countries: 'fra',
point: { lat: 0, lon: 0 },
gids: ['whosonfirst:locality:101751119']
}
})
+Search within a circular region. Circle can be static or dynamic with the function.
-Add a restriction by alpha-2 or alpha-3 ISO-3166 country code. Countries can be static or dynamic with the function.
-Search within a rectangular region. Rectangle can be static or dynamic with the function.
-Generated using TypeDoc
Representation of geographic coordinate using the spatial reference World Geodetic System (WSG84, also known as EPSG:4326).
-The latitude, geographic coordinate that specifies the north-south position of a point on the Earth's surface.
-The longitude, geographic coordinate that specifies the east-west position of a point on the Earth's surface.
-Radius over the point in meters.
-Generated using TypeDoc
Set of options when you want to prioritize places from particular region.
+new JawgPlaces({
focus: {
countries: 'fra',
point: { lat: 0, lon: 0 },
gids: ['whosonfirst:locality:101751119']
}
})
+Add a priorities by alpha-2 or alpha-3 ISO-3166 country code. Countries can be static or dynamic with the function.
+Add a priorities by Jawg GIDs. GIDs can be static or dynamic with the function.
+Optional pointSort results in part by their proximity to the given coordinate. Coordinates can be static or dynamic with the function.
+Generated using TypeDoc
Options for JawgPlaces.Input
-Optional accessYour personal access token, create your own on the Jawg Lab. This is filled automatically when you get the library with our CDN.
-Optional boundarySet of options when you are looking for places in a particular region.
-Optional clearAdd a clear cross in the right side of the input.
-Optional debounceSet the number of milliseconds to wait before a search validation. +
Optional boundarySet of options when you are looking for places in a particular region.
+Optional clearAdd a clear cross in the right side of the input.
+Optional debounceSet the number of milliseconds to wait before a search validation.
If you press Enter the search will be immediately validated.
This option work only when searchOnTyping=true.
Default value is 350.
Optional focusSort results in part by their proximity to the given coordinate. Coordinates can be static or dynamic with the function.
-The <input> to transform into a geocoding search bar.
+
Optional focusThe <input> to transform into a geocoding search bar.
This can be either a id (e.g #my-input), class selector (e.g .my-input) or the HTMLElement.
With some frameworks/UI libs such as React, you can't use the ref here.
Optional languageReturn results in a specific language using BCP47 standard (e.g 'en', 'fr', 'de', ...). +
Optional languageReturn results in a specific language using BCP47 standard (e.g 'en', 'fr', 'de', ...). By default, we use HTTP Header set by the browser and English when not present. Language can be static or dynamic with the function.
-Optional layersFilter the kind of place you want to find. Layers can be static or dynamic with the function.
-Optional minSet the minimum number of characters to trigger a geocoding request. +
Optional layersFilter the kind of place you want to find. Layers can be static or dynamic with the function.
+Optional minSet the minimum number of characters to trigger a geocoding request.
If you press Enter the search will be validated even if the length is not reached.
This option work only when searchOnTyping=true.
Default value is 0.
Optional onCallback triggered when the input is empty.
+Optional onCallback triggered when the input is empty.
Callback triggered when the input is empty.
-Optional onCallback triggered when the user click on a result.
+Optional onCallback triggered when the user click on a result.
Callback triggered when the user click on a result.
-selected by the user
-selected by the user
-Optional onCallback triggered when the result list is closed/cleared.
+The feature selected by the user
+The feature selected by the user
+Optional onCallback triggered when the result list is closed/cleared.
Callback triggered when the result list is closed/cleared.
-Optional onCallback triggered when Jawg Places API returns an error.
+Optional onCallback triggered when Jawg Places API returns an error.
Callback triggered when Jawg Places API returns an error.
-Optional onCallback triggered when Jawg Places API returns without error.
+Optional onCallback triggered when Jawg Places API returns without error.
Callback triggered when Jawg Places API returns without error.
-list of features returned by Jawg Places API
-list of features returned by Jawg Places API
-Optional resultThe custom <div> that will contain the geocoding results.
+
The list of features returned by Jawg Places API
+The list of features returned by Jawg Places API
+Optional resultThe custom <div> that will contain the geocoding results.
By default the container is created by Jawg Places JS.
With some frameworks/UI libs such as React, you can't use the ref here.
Optional reverseOption to activate reverse geocoding withing the input. +
Optional reverseOption to activate reverse geocoding withing the input.
You can paste coordinates in the form {lat}/{lon} in the input.
The separation can be either / (slash), , (comma) or (space).
Optional searchSet this to true to activate search on typing, this will also use autocomplete search.
+
Optional searchSet this to true to activate search on typing, this will also use autocomplete search.
Default value is false, you will need to press Enter to validate your search.
Optional showShow icon at the left each results.
-Optional sizeSet the default number of results. Default value is 10.
-Optional sourcesFilter the originating source of the data. Sources can be static or dynamic with the function.
-Generated using TypeDoc
Options for JawgPlaces.Leaflet
-The Leaflet instance for marker creation
-Optional accessYour personal access token, create your own on the Jawg Lab. +
Optional accessYour personal access token, create your own on the Jawg Lab. This is filled automatically when you get the library with our CDN.
-Optional adminOption to show administrative area when available.
-Optional boundarySet of options when you are looking for places in a particular region.
-Optional clearAdd a clear cross in the right side of the input.
-Optional containerThe custom <div> that will contain the input and geocoding results when Places JS is used as Leaflet Control.
+
Optional adminOption to show administrative area when available.
+Optional boundarySet of options when you are looking for places in a particular region.
+Optional clearAdd a clear cross in the right side of the input.
+Optional containerThe custom <div> that will contain the input and geocoding results when Places JS is used as Leaflet Control.
By default this is generated by Jawg Places JS.
With some frameworks/UI libs such as React, you can't use the ref here.
Optional debounceSet the number of milliseconds to wait before a search validation. +
Optional debounceSet the number of milliseconds to wait before a search validation.
If you press Enter the search will be immediately validated.
This option work only when searchOnTyping=true.
Default value is 350.
Optional focusSort results in part by their proximity to the given coordinate. Coordinates can be static or dynamic with the function.
-Optional inputThe <input> to transform into a geocoding search bar.
+
Optional focusOptional inputThe <input> to transform into a geocoding search bar.
This can be either a id (e.g #my-input), class selector (e.g .my-input) or the HTMLElement.
With some frameworks/UI libs such as React, you can't use the ref here.
Optional inputClass to add to the input when it's generated by the library.
-Optional languageReturn results in a specific language using BCP47 standard (e.g 'en', 'fr', 'de', ...). +
Optional inputClass to add to the input when it's generated by the library.
+Optional languageReturn results in a specific language using BCP47 standard (e.g 'en', 'fr', 'de', ...). By default, we use HTTP Header set by the browser and English when not present. Language can be static or dynamic with the function.
-Optional layersFilter the kind of place you want to find. Layers can be static or dynamic with the function.
-Optional markerOption to configure result markers on the map.
-Optional minSet the minimum number of characters to trigger a geocoding request. +
Optional layersFilter the kind of place you want to find. Layers can be static or dynamic with the function.
+Optional markerOption to configure result markers on the map.
+Optional minSet the minimum number of characters to trigger a geocoding request.
If you press Enter the search will be validated even if the length is not reached.
This option work only when searchOnTyping=true.
Default value is 0.
Optional noSet a custom message when no results are found. This can be disabled.
-Optional onCallback triggered when the input is empty.
+Optional noSet a custom message when no results are found. This can be disabled.
+Optional onCallback triggered when the input is empty.
Callback triggered when the input is empty.
-Optional onCallback triggered when the user click on a result.
+Optional onCallback triggered when the user click on a result.
Callback triggered when the user click on a result.
-selected by the user
-selected by the user
-Optional onCallback triggered when the result list is closed/cleared.
+The feature selected by the user
+The feature selected by the user
+Optional onCallback triggered when the result list is closed/cleared.
Callback triggered when the result list is closed/cleared.
-Optional onCallback triggered when Jawg Places API returns an error.
+Optional onCallback triggered when Jawg Places API returns an error.
Callback triggered when Jawg Places API returns an error.
-Optional onCallback triggered when Jawg Places API returns without error.
+Optional onCallback triggered when Jawg Places API returns without error.
Callback triggered when Jawg Places API returns without error.
-list of features returned by Jawg Places API
-list of features returned by Jawg Places API
-Optional placeholderPlaceholder text to add when the input in generated by the library.
-Optional positionPosition of the input on the map.
-Optional resultThe custom <div> that will contain the geocoding results.
+
The list of features returned by Jawg Places API
+The list of features returned by Jawg Places API
+Optional placeholderPlaceholder text to add when the input in generated by the library.
+Optional positionPosition of the input on the map.
+Optional resultThe custom <div> that will contain the geocoding results.
By default the container is created by Jawg Places JS.
With some frameworks/UI libs such as React, you can't use the ref here.
Optional reverseOption to activate reverse geocoding withing the input. +
Optional reverseOption to activate reverse geocoding withing the input.
You can paste coordinates in the form {lat}/{lon} in the input.
The separation can be either / (slash), , (comma) or (space).
Optional searchSet this to true to activate search on typing, this will also use autocomplete search.
+
Optional searchSet this to true to activate search on typing, this will also use autocomplete search.
Default value is false, you will need to press Enter to validate your search.
Optional showShow icon at the left each results.
-Optional sizeSet the default number of results. Default value is 10.
-Optional sourcesFilter the originating source of the data. Sources can be static or dynamic with the function.
-Optional transitionOption to configure transition on result selection.
-Generated using TypeDoc
Options for JawgPlaces.MapLibre and JawgPlaces.Mapbox
-Optional accessYour personal access token, create your own on the Jawg Lab. This is filled automatically when you get the library with our CDN.
-Optional adminOption to show administrative area when available.
-Optional boundarySet of options when you are looking for places in a particular region.
-Optional clearAdd a clear cross in the right side of the input.
-Optional containerThe custom <div> that will contain the input and geocoding results when Places JS is used as MapLibre Control.
+
Optional adminOption to show administrative area when available.
+Optional boundarySet of options when you are looking for places in a particular region.
+Optional clearAdd a clear cross in the right side of the input.
+Optional containerThe custom <div> that will contain the input and geocoding results when Places JS is used as MapLibre Control.
By default this is generated by Jawg Places JS.
With some frameworks/UI libs such as React, you can't use the ref here.
Optional debounceSet the number of milliseconds to wait before a search validation. +
Optional debounceSet the number of milliseconds to wait before a search validation.
If you press Enter the search will be immediately validated.
This option work only when searchOnTyping=true.
Default value is 350.
Optional focusSort results in part by their proximity to the given coordinate. Coordinates can be static or dynamic with the function.
-Optional inputThe <input> to transform into a geocoding search bar.
+
Optional focusOptional inputThe <input> to transform into a geocoding search bar.
This can be either a id (e.g #my-input), class selector (e.g .my-input) or the HTMLElement.
With some frameworks/UI libs such as React, you can't use the ref here.
Optional inputClass to add to the input when it's generated by the library.
-Optional languageReturn results in a specific language using BCP47 standard (e.g 'en', 'fr', 'de', ...). +
Optional inputClass to add to the input when it's generated by the library.
+Optional languageReturn results in a specific language using BCP47 standard (e.g 'en', 'fr', 'de', ...). By default, we use HTTP Header set by the browser and English when not present. Language can be static or dynamic with the function.
-Optional layersFilter the kind of place you want to find. Layers can be static or dynamic with the function.
-Optional markerOption to configure result markers on the map.
-Optional minSet the minimum number of characters to trigger a geocoding request. +
Optional layersFilter the kind of place you want to find. Layers can be static or dynamic with the function.
+Optional markerOption to configure result markers on the map.
+Optional minSet the minimum number of characters to trigger a geocoding request.
If you press Enter the search will be validated even if the length is not reached.
This option work only when searchOnTyping=true.
Default value is 0.
Optional noSet a custom message when no results are found. This can be disabled.
-Optional onCallback triggered when the input is empty.
+Optional noSet a custom message when no results are found. This can be disabled.
+Optional onCallback triggered when the input is empty.
Callback triggered when the input is empty.
-Optional onCallback triggered when the user click on a result.
+Optional onCallback triggered when the user click on a result.
Callback triggered when the user click on a result.
-selected by the user
-selected by the user
-Optional onCallback triggered when the result list is closed/cleared.
+The feature selected by the user
+The feature selected by the user
+Optional onCallback triggered when the result list is closed/cleared.
Callback triggered when the result list is closed/cleared.
-Optional onCallback triggered when Jawg Places API returns an error.
+Optional onCallback triggered when Jawg Places API returns an error.
Callback triggered when Jawg Places API returns an error.
-Optional onCallback triggered when Jawg Places API returns without error.
+Optional onCallback triggered when Jawg Places API returns without error.
Callback triggered when Jawg Places API returns without error.
-list of features returned by Jawg Places API
-list of features returned by Jawg Places API
-Optional placeholderPlaceholder text to add when the input in generated by the library.
-Optional resultThe custom <div> that will contain the geocoding results.
+
The list of features returned by Jawg Places API
+The list of features returned by Jawg Places API
+Optional placeholderPlaceholder text to add when the input in generated by the library.
+Optional resultThe custom <div> that will contain the geocoding results.
By default the container is created by Jawg Places JS.
With some frameworks/UI libs such as React, you can't use the ref here.
Optional reverseOption to activate reverse geocoding withing the input. +
Optional reverseOption to activate reverse geocoding withing the input.
You can paste coordinates in the form {lat}/{lon} in the input.
The separation can be either / (slash), , (comma) or (space).
Optional searchSet this to true to activate search on typing, this will also use autocomplete search.
+
Optional searchSet this to true to activate search on typing, this will also use autocomplete search.
Default value is false, you will need to press Enter to validate your search.
Optional showShow icon at the left each results.
-Optional sizeSet the default number of results. Default value is 10.
-Optional sourcesFilter the originating source of the data. Sources can be static or dynamic with the function.
-Optional transitionOption to configure transition on result selection.
-Generated using TypeDoc
Basic options for Places JS.
-new JawgPlaces({
accessToken: '<Access-Token>',
input: '#my-input'
})
+Optional accessYour personal access token, create your own on the Jawg Lab. This is filled automatically when you get the library with our CDN.
-Optional boundarySet of options when you are looking for places in a particular region.
-Optional clearAdd a clear cross in the right side of the input.
-Optional debounceSet the number of milliseconds to wait before a search validation. +
Optional boundarySet of options when you are looking for places in a particular region.
+Optional clearAdd a clear cross in the right side of the input.
+Optional debounceSet the number of milliseconds to wait before a search validation.
If you press Enter the search will be immediately validated.
This option work only when searchOnTyping=true.
Default value is 350.
Optional focusSort results in part by their proximity to the given coordinate. Coordinates can be static or dynamic with the function.
-Optional inputThe <input> to transform into a geocoding search bar.
+
Optional focusOptional inputThe <input> to transform into a geocoding search bar.
This can be either a id (e.g #my-input), class selector (e.g .my-input) or the HTMLElement.
With some frameworks/UI libs such as React, you can't use the ref here.
Optional languageReturn results in a specific language using BCP47 standard (e.g 'en', 'fr', 'de', ...). +
Optional languageReturn results in a specific language using BCP47 standard (e.g 'en', 'fr', 'de', ...). By default, we use HTTP Header set by the browser and English when not present. Language can be static or dynamic with the function.
-Optional layersFilter the kind of place you want to find. Layers can be static or dynamic with the function.
-Optional minSet the minimum number of characters to trigger a geocoding request. +
Optional layersFilter the kind of place you want to find. Layers can be static or dynamic with the function.
+Optional minSet the minimum number of characters to trigger a geocoding request.
If you press Enter the search will be validated even if the length is not reached.
This option work only when searchOnTyping=true.
Default value is 0.
Optional onCallback triggered when the input is empty.
+Optional onCallback triggered when the input is empty.
Callback triggered when the input is empty.
-Optional onCallback triggered when the user click on a result.
+Optional onCallback triggered when the user click on a result.
Callback triggered when the user click on a result.
-selected by the user
-selected by the user
-Optional onCallback triggered when the result list is closed/cleared.
+The feature selected by the user
+The feature selected by the user
+Optional onCallback triggered when the result list is closed/cleared.
Callback triggered when the result list is closed/cleared.
-Optional onCallback triggered when Jawg Places API returns an error.
+Optional onCallback triggered when Jawg Places API returns an error.
Callback triggered when Jawg Places API returns an error.
-Optional onCallback triggered when Jawg Places API returns without error.
+Optional onCallback triggered when Jawg Places API returns without error.
Callback triggered when Jawg Places API returns without error.
-list of features returned by Jawg Places API
-list of features returned by Jawg Places API
-Optional resultThe custom <div> that will contain the geocoding results.
+
The list of features returned by Jawg Places API
+The list of features returned by Jawg Places API
+Optional resultThe custom <div> that will contain the geocoding results.
By default the container is created by Jawg Places JS.
With some frameworks/UI libs such as React, you can't use the ref here.
Optional reverseOption to activate reverse geocoding withing the input. +
Optional reverseOption to activate reverse geocoding withing the input.
You can paste coordinates in the form {lat}/{lon} in the input.
The separation can be either / (slash), , (comma) or (space).
Optional searchSet this to true to activate search on typing, this will also use autocomplete search.
+
Optional searchSet this to true to activate search on typing, this will also use autocomplete search.
Default value is false, you will need to press Enter to validate your search.
Optional showShow icon at the left each results.
-Optional sizeSet the default number of results. Default value is 10.
-Optional sourcesFilter the originating source of the data. Sources can be static or dynamic with the function.
-Generated using TypeDoc
Representation of geographic coordinate using the spatial reference World Geodetic System (WSG84, also known as EPSG:4326).
-The latitude, geographic coordinate that specifies the north-south position of a point on the Earth's surface.
-The longitude, geographic coordinate that specifies the east-west position of a point on the Earth's surface.
-Generated using TypeDoc
Option for Leaflet markers.
-Optional iconMarker to use for results.
-true to show the result marker, all to show all results and false to hide markers.
Generated using TypeDoc
Option for transition when the user click on a result on Leaflet.
-Optional typeType of camera move on result selection.
jump: change the position of the camera without animation
fly: animating camera transition along curve that evokes flight
hybrid: use fly when the camera is near the point and jump otherwise
Generated using TypeDoc
Option for MapLibre and Mapbox markers.
-Optional anchorAnchor for the marker.
-Optional iconName of the marker from your sprites.
-Optional iconUse a custom marker with a URL. The response must be a PNG image.
-true to show the result marker, all to show all results and false to hide markers.
Generated using TypeDoc
Option for transition when the user click on a result on MapLibre or Mapbox.
-Optional flyThe zooming "curve" that will occur along the flight path.
-Optional flyThe average speed of the animation defined in relation to curve.
Optional typeType of camera move on result selection. +
Optional flyThe average speed of the animation defined in relation to curve.
Optional typeType of camera move on result selection.
jump: change the position of the camera without animation
fly: animating camera transition along curve that evokes flight
hybrid: use fly when the camera is near the point and jump otherwise
Generated using TypeDoc
Options to search within a rectangular region.
-Generated using TypeDoc
Option to activate reverse geocoding withing the input.
You can paste coordinates in the form {lat}/{lon} in the input.
The separation can be either / (slash), , (comma) or (space).
Generated using TypeDoc
Welcome to Jawg Places type documentation. +Checkout our examples on our documentation website and the source code on GitHub.
+Type of geometries used by Jawg Places API.
-Generated using TypeDoc
Return type of Jawg Places API.
-Generated using TypeDoc
All available layers.
-Generated using TypeDoc
All available layers.
+Generated using TypeDoc
All available sources.
-Generated using TypeDoc
All available sources.
+Generated using TypeDoc
Const Current version of the library in Semantic Versioning.
-Generated using TypeDoc
This class will help you to transform any input into search bar for geocoding.
-