ForwardGeocodingApi class

The forward geocoding query type allows you to look up a single location by name and returns its geographic coordinates.

https://docs.mapbox.com/api/search/#forward-geocoding

Constructors

ForwardGeocodingApi(MapboxApi api, {String version = 'v5', String endpoint = 'https://api.mapbox.com/geocoding'})

Properties

api MapboxApi
getter/setter pair
endpoint String
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
version String
getter/setter pair

Methods

batch({GeocoderEndpoint endpoint = GeocoderEndpoint.PLACES_PERMANENT, List<String> searchTexts = const <String>[], bool autocomplete = true, GeocoderBbox? bbox, List<String> country = const <String>[], bool fuzzyMatch = true, String? language, int limit = 5, List<double> proximity = const <double>[], bool routing = false, List<GeocoderPlaceType> types = const <GeocoderPlaceType>[]}) Future<GeocodingApiResponse>
The batch geocoding query type allows you to have multiple forward geocoding queries in a single request
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
request({GeocoderEndpoint endpoint = GeocoderEndpoint.PLACES, String? searchText, bool autocomplete = true, GeocoderBbox? bbox, List<String> country = const <String>[], bool fuzzyMatch = true, String? language, int limit = 5, List<double> proximity = const <double>[], bool routing = false, List<GeocoderPlaceType> types = const <GeocoderPlaceType>[]}) Future<GeocodingApiResponse>
The API response for a forward geocoding query returns a GeoJSON feature collection in Mapbox Geocoding Response format.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited