Class HyloGeolocation

Tool for monitoring the users geo position.

Properties

available initialised

Methods

endWatching getLastPosition getPosition initialise startWatching

Events

hyloNewGeoLocation

Properties

available

available: boolean = false

Will be set by the component itself. Needs to be checked before calling any function.

Can change when user denies access.

initialised

initialised: boolean = false

Will be set by the component itself. Needs to be checked before calling any function.

Methods

endWatching

  • endWatching(): Promise<void>

  • Ends monitoring the users position.

    Returns Promise<void>

getLastPosition

  • getLastPosition(): Promise<[number, number]>

  • Returns the last saved position of the user [longitude, latitude]. Returns immediately.

    Returns Promise<[number, number]>

getPosition

  • getPosition(): Promise<[number, number]>

  • Returns the users position [longitude, latitude].

    Returns Promise<[number, number]>

initialise

  • initialise(): Promise<void>

  • Initialises the component. Sets "initialised" and "available". Called by the component itself but can be called again if circumstances change.

    Returns Promise<void>

startWatching

  • startWatching(): Promise<[number, number]>

  • Starts monitoring the users position. Returns the current position [longitude, latitude]. Fires "hyloNewGeoLocation" when the position changed.

    Returns Promise<[number, number]>

Events

hyloNewGeoLocation

hyloNewGeoLocation: EventEmitter<[number, number]>

Triggered every time a new position is calculated. Emits [longitude, latitude].

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc