Interface Geolocation

The Geolocation interface represents an object able to obtain the position of the device programmatically.

interface Geolocation {
    clearWatch(watchId: number): void;
    getCurrentPosition(
        successCallback: PositionCallback,
        errorCallback?: PositionErrorCallback | null,
        options?: PositionOptions,
    ): void;
    watchPosition(
        successCallback: PositionCallback,
        errorCallback?: PositionErrorCallback | null,
        options?: PositionOptions,
    ): number;
}

Index

Methods

clearWatch getCurrentPosition watchPosition

Methods

clearWatch

clearWatch(watchId: number): void
The clearWatch() method of the Geolocation interface is used to unregister location/error monitoring handlers previously installed using Geolocation.watchPosition().

MDN Reference
Parameters
- watchId: number
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:12488

getCurrentPosition

getCurrentPosition(
    successCallback: PositionCallback,
    errorCallback?: PositionErrorCallback | null,
    options?: PositionOptions,
): void
The getCurrentPosition() method of the Geolocation interface is used to get the current position of the device.

MDN Reference
Parameters
- successCallback: PositionCallback
- OptionalerrorCallback: PositionErrorCallback | null
- Optionaloptions: PositionOptions
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:12494

watchPosition

watchPosition(
    successCallback: PositionCallback,
    errorCallback?: PositionErrorCallback | null,
    options?: PositionOptions,
): number
The watchPosition() method of the Geolocation interface is used to register a handler function that will be called automatically each time the position of the device changes.

MDN Reference
Parameters
- successCallback: PositionCallback
- OptionalerrorCallback: PositionErrorCallback | null
- Optionaloptions: PositionOptions
Returns number
- Defined in node_modules/typescript/lib/lib.dom.d.ts:12500