Class Photon

Implementation of the Photon geocoder

Hierarchy

Photon

Implements

IGeocoder

Index

Constructors

constructor

Methods

Object literals

options

Constructors

constructor

new Photon(options?: Partial<PhotonOptions>): Photon

- Defined in src/geocoders/photon.ts:26
Parameters
- Optional options: Partial<PhotonOptions>
Returns Photon

Methods

_decodeFeatureName

_decodeFeatureName(f: Feature): string

- Defined in src/geocoders/photon.ts:88
Parameters
- f: Feature
Returns string

_decodeFeatures

_decodeFeatures(data: FeatureCollection<Point>): GeocodingResult[]

- Defined in src/geocoders/photon.ts:61
Parameters
- data: FeatureCollection<Point>
Returns GeocodingResult[]

geocode

geocode(query: string, cb: GeocodingCallback, context?: any): void

Implementation of IGeocoder.geocode
- Defined in src/geocoders/photon.ts:32
Parameters
- query: string
- cb: GeocodingCallback
- Optional context: any
Returns void

reverse

reverse(latLng: LatLngLiteral, scale: number, cb: GeocodingCallback, context?: any): void

Implementation of IGeocoder.reverse
- Defined in src/geocoders/photon.ts:47
Parameters
- latLng: LatLngLiteral
- scale: number
- cb: GeocodingCallback
- Optional context: any
Returns void

suggest

suggest(query: string, cb: GeocodingCallback, context?: any): void

Implementation of IGeocoder.suggest
- Defined in src/geocoders/photon.ts:43
Parameters
- query: string
- cb: GeocodingCallback
- Optional context: any
Returns void

Object literals

options

options: object

nameProperties

nameProperties: string[] = ['name', 'street', 'suburb', 'hamlet', 'town', 'city', 'state', 'country']

reverseUrl

reverseUrl: string = "https://photon.komoot.io/reverse/"

serviceUrl

serviceUrl: string = "https://photon.komoot.io/api/"

Generated using TypeDoc