Mapspace API Reference

Class: Photon

Mapspace.geocoding. Photon

A Photon geocoding provider. https://photon.komoot.de/

new Photon( [opt_options])

Parameters:
Name Type Argument Description
opt_options Mapspace.geocoding.PhotonOptions <optional>

Options.
Source:
mapspace/geocoding/photon.js

Extends

Methods

formatAddress(address)

Formats a geocoding address in HTML.

Parameters:
Name Type Description
address Mapspace.geocoding.Address

Geocoding address.
Inherited From:
Source:
mapspace/geocoding/provider.js
Returns:
Type
string

formatAddressToCopy(address)

Formats a geocoding address as a string to be copied to clipboard.

Parameters:
Name Type Description
address Mapspace.geocoding.Address

Geocoding address.
Inherited From:
Source:
mapspace/geocoding/provider.js
Returns:
Type
string

formatLocation(lonlat, projected, projection)

Formats a geocoding location in HTML.

Parameters:
Name Type Description
lonlat Mapspace.Coordinate | undefined

Geocoding location in EPSG:4326.
projected Mapspace.Coordinate | undefined

Geocoding location in other projection.
projection string | undefined

EPSG projection code for the projected coordinates.
Inherited From:
Source:
mapspace/geocoding/provider.js
Returns:
Type
string

getProviderType()

Returns the provider type.

Inherited From:
Overrides:
Source:
mapspace/geocoding/provider.js
Returns:
Type
Mapspace.geocoding.ProviderType

Execute a request to the provider service service.

Parameters:
Name Type Description
query string

The query string.
load function

Function to execute if response is loaded.
error function

Function to execute if response has an error.
Inherited From:
Overrides:
Source:
mapspace/geocoding/provider.js

updateLanguage()

Updates the geocoding provider for the current language in the Mapspace.Globalization singleton.

Inherited From:
Source:
mapspace/geocoding/provider.js