Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Geocoder

Index

Constructors

constructor

  • Parameters

    Returns Geocoder

Properties

Private Readonly allNames

allNames: Set<string>

Private Readonly definitionsByAltName

definitionsByAltName: Map<string, GeocoderDefinition>

Definitions indexed by alternate names. They are not guaranteed to be unique, so some definitions may be overwritten. This should be used as a backup only if definitionsByName does not contain a requested name.

Private Readonly definitionsByLocation

Private Readonly definitionsByName

definitionsByName: Map<string, GeocoderDefinition>

Private Readonly roomCenterIndices

roomCenterIndices: Map<string, BuildingKDTree>

Spatial indices of room center locations, indexed by floor

Private Readonly search

search: Promise<MiniSearch<any>>

Static inject

inject: readonly ["mapData"] = ...

Methods

addDefinition

  • Adds a definition to the geocoder. Overrides any other definition with the same name, if already added to the geocoder. Returns the definition it replaced, if any.

    Parameters

    Returns Promise<Option<GeocoderDefinition>>

getClosestDefinition

getClosestDefinitionToFilteredWithDistance

getDefinitionFromName

  • Parameters

    • name: string

    Returns Option<GeocoderDefinition>

getSuggestionsFrom

  • Parameters

    • query: string

    Returns Promise<GeocoderSuggestion[]>

removeDefinition

  • Parameters

    Returns Promise<void>

updateTree

  • updateTree(floor: string, f: (tree: BuildingKDTree) => BuildingKDTree): void
  • Parameters

    • floor: string
    • f: (tree: BuildingKDTree) => BuildingKDTree
        • (tree: BuildingKDTree): BuildingKDTree
        • Parameters

          • tree: BuildingKDTree

          Returns BuildingKDTree

    Returns void

Generated using TypeDoc