Skip to main content

Geocoding

Forward and reverse geocoding, offline. Created with kind geocoding.

TypeClass
"multi-osm-offline"MultiOSMOfflineGeocodingService
"multi-osm-offline-reverse"MultiOSMOfflineReverseGeocodingService
"request"hand-written factory
"reverse-request"hand-written factory

"multi-osm-offline" — MultiOSMOfflineGeocodingService

{"type": "multi-osm-offline"}
KeyTypeAlways requiredNotes

Inherited from GeocodingService:

PropertyTypeAccessDescription
autocompletebooleanread/write
languagestringread/write
maxResultsintegerread/write
MethodArgumentsReturns
adddatabase: stringvoid
calculateAddressesrequest: handlejson
removedatabase: stringbool

"multi-osm-offline-reverse" — MultiOSMOfflineReverseGeocodingService

{"type": "multi-osm-offline-reverse"}
KeyTypeAlways requiredNotes

Inherited from ReverseGeocodingService:

PropertyTypeAccessDescription
languagestringread/write
MethodArgumentsReturns
adddatabase: stringvoid
calculateAddressesrequest: handlejson
removedatabase: stringbool

"request"

A forward geocoding request.

KeyTypeNotes
querystringwhat to search for
projectionstringthe projection results come back in

"reverse-request"

A reverse geocoding request.

KeyTypeNotes
locationpositionthe point to name
projectionstringits projection, by name

Base classes

Not constructed directly. Their properties are reachable on every object above that derives from them.

GeocodingRequest

PropertyTypeAccessDescription
locationstruct massif::MapPosread/writeReturns the location attribute of the request. The matching address near the specified location (up to a specified radius) are preferred.
locationRadiusnumberread/writeReturns the location radius attribute of the request (in meters).
projectionobject std::shared_ptr<massif::Projection>read-onlyReturns the projection of the request.
querystringread-onlyReturns the text-based query of the request.

GeocodingService

PropertyTypeAccessDescription
autocompletebooleanread/write
languagestringread/write
maxResultsintegerread/write
MethodArgumentsReturns
calculateAddressesrequest: handlejson

ReverseGeocodingRequest

PropertyTypeAccessDescription
locationstruct massif::MapPosread-onlyReturns the location of the query.
projectionobject std::shared_ptr<massif::Projection>read-onlyReturns the projection of the query.
searchRadiusnumberread/writeReturns the search radius (in meters).

ReverseGeocodingService

PropertyTypeAccessDescription
languagestringread/write
MethodArgumentsReturns
calculateAddressesrequest: handlejson