Class Photon

constructor

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

• Parameters

  • Optionaloptions: Partial<PhotonOptions>

  Returns Photon

options

_decodeFeatureName

• _decodeFeatureName(f: Feature<Geometry, GeoJsonProperties>): string

• Parameters

  • f: Feature<Geometry, GeoJsonProperties>

  Returns string

_parseResults

• _parseResults(
      data: FeatureCollection<Point, GeoJsonProperties>,
  ): GeocodingResult[]

• Parameters

  • data: FeatureCollection<Point, GeoJsonProperties>

  Returns GeocodingResult[]

geocode

• geocode(query: string, context?: GeocodingContext): Promise<GeocodingResult[]>

• Performs a geocoding query and returns the results as promise

  Parameters

  • query: string

    the query
  • Optionalcontext: GeocodingContext

    the context for the query

  Returns Promise<GeocodingResult[]>

reverse

• reverse(latLng: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

• Performs a reverse geocoding query and returns the results as promise

  Parameters

  • latLng: LatLngLiteral
  • scale: number

    the map scale possibly used for reverse geocoding

  Returns Promise<GeocodingResult[]>

suggest

• suggest(query: string): Promise<GeocodingResult[]>

• Performs a geocoding query suggestion (this happens while typing) and returns the results as promise

  Parameters

  • query: string

    the query

  Returns Promise<GeocodingResult[]>