Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • GeocoderDefinition

Implemented by

Index

Methods

extendedWithAlternateName

  • Returns a new definition with an extra alternate name added. Does not modify the object on which it is called.

    Parameters

    • name: string

    Returns GeocoderDefinition

getAlternateNames

  • getAlternateNames(): string[]
  • Returns string[]

getBoundingBox

  • Get the smallest bounding box that entirely encloses the definition

    Returns BuildingLocationBBox

getDescription

  • getDescription(): string
  • Displayed to the user and used in search.

    Returns string

getLocation

getName

  • getName(): string
  • Displayed to the user and the main factor in search. Must be unique among definitions.

    Returns string

getTags

  • May be displayed to the user and used in search.

    Returns DefinitionTag[]

hasTag

  • Parameters

    Returns boolean

Generated using TypeDoc