Interface GeolocationPublicApi

The object mounted on GeoLeaf.Geolocation.

interface GeolocationPublicApi {
    isEnabled(): boolean;
    getConfig(): GeolocationCapabilityConfig;
    getState(): GeolocationStateSnapshot;
}

Index

Methods

isEnabled getConfig getState

Methods

isEnabled

isEnabled(): boolean
Returns true when the GPS button is enabled (modules.geolocation.enabled !== false).

Returns boolean
- Defined in src/capabilities/geolocation/public-api.ts:31

getConfig

getConfig(): GeolocationCapabilityConfig
Returns the resolved modules.geolocation config (merged over the built-in defaults).

Returns GeolocationCapabilityConfig
- Defined in src/capabilities/geolocation/public-api.ts:33

getState

getState(): GeolocationStateSnapshot
Returns the live GPS state singleton (position, accuracy, active/watch flags).

Returns GeolocationStateSnapshot
- Defined in src/capabilities/geolocation/public-api.ts:35