Javascript API 7.x

Namespace: geocoding

bu. geocoding

This namespace contains definitions for geocoding providers. A geocoding provider is any object that can resolve an address string and return a coordinate plus several other information about the returned point. At least the coordinates returned must be in EPSG:4326 LonLat although the provider can return other projection coordinates if it is defined a function for it.

Source:
bu/geocoding/geocoding.jsdoc

Classes

Bing
Coords
Google
MapQuest
OSM
OSMProxy
Pelias
Photon
Provider
Sok

Type Definitions

Address

Geocoding address returned by a Geocoding provider.

Type:
  • Object
Properties:
Name Type Description
fullname string

Full name of the address.
postcode string | undefined

Postal code.
building string | undefined

Building identifier.
housenumber string | undefined

House number identifier.
road string | undefined

Road or atreet name.
town string | undefined

Town name.
village string | undefined

Village name.
city string | undefined

City name.
state string | undefined

State name.
country string | undefined

Country name.
Source:
bu/typedefs.js

CoordsOptions

Options for the Coords geocoding provider.

Type:
  • Object
Properties:
Name Type Description
name string | undefined

Name of the object provider. To be shown in a control selector. Default is 'Coords'.
tipLabel string | undefined

A tip label to be shown in a control textbox for best pattern in query entry.
autocompletable boolean | undefined

If true this provider search function can be used in an autocomplete control.
Source:
bu/typedefs.js

OSMOptions

Options for the OSM Nominatim geocoding provider.

Type:
  • Object
Properties:
Name Type Description
name string | undefined

Name of the object provider. To be shown in a control selector. Default is 'OSM'.
tipLabel string | undefined

A tip label to be shown in a control textbox for best pattern in query entry.
autocompletable boolean | undefined

If true this provider search function can be used in an autocomplete control.
Source:
bu/typedefs.js

OSMProxyOptions

Options for the OSM geocoding proxy provider.

Type:
  • Object
Properties:
Name Type Description
name string | undefined

Name of the object provider. To be shown in a control selector. Default is 'OSM Proxy'.
tipLabel string | undefined

A tip label to be shown in a control textbox for best pattern in query entry.
autocompletable boolean | undefined

If true this provider search function can be used in an autocomplete control.
usertoken string | undefined

Usertoken to access BlomURBEX web services.
Source:
bu/typedefs.js

ProviderOptions

Options for a the base of geocoding providers.

Type:
  • Object
Properties:
Name Type Description
name string | undefined

Name of the object provider. To be shown in a control selector.
tipLabel string | undefined

A tip label to be shown in a control textbox for best pattern in query entry.
autocompletable boolean | undefined

If true this provider search function can be used in an autocomplete control.
Source:
bu/typedefs.js

ProviderType

Types of geocoding providers.

BING: 'bing'
COORDS: 'coords'
GOOGLE: 'google'
MAPQUEST: 'mapquest'
OSM: 'osm'
OSMPROXY: 'osmproxy'
PELIAS: 'pelias'
PHOTON: 'photon'
SOK: 'sok'
Type:
  • string
Source:
bu/enums.js

Result

Geocoding result is a pair of address and coordinate returned by a Geocoding provider. The location must be always a WGS84 (EPSG:4326) lon, lat.

Type:
  • Object
Properties:
Name Type Description
address bu.geocoding.Address
location bu.Coordinate
htmlAddress string | undefined

an HTML formatted version of address.
htmlLocation string | undefined

an HTML formatted version of location.
Source:
bu/typedefs.js

SokOptions

Options for the BlomURBEX Sok geocoding provider.

Type:
  • Object
Properties:
Name Type Description
name string | undefined

Name of the object provider. To be shown in a control selector. Default is 'Sok'.
tipLabel string | undefined

A tip label to be shown in a control textbox for best pattern in query entry.
autocompletable boolean | undefined

If true this provider search function can be used in an autocomplete control.
usertoken string | undefined

Usertoken to access BlomURBEX web services.
Source:
bu/typedefs.js