Package-level declarations

Types

Link copied to clipboard
open class Geolocation

The Geolocation interface represents an object able to obtain the position of the device programmatically. It gives Web content access to the location of the device. This allows a website or app to offer customized results based on the user's location.

Link copied to clipboard

The GeolocationCoordinates interface represents the position and altitude of the device on Earth, as well as the accuracy with which these properties are calculated. The geographic position information is provided in terms of World Geodetic System coordinates (WGS84). Available only in secure contexts.

Link copied to clipboard

The GeolocationPosition interface represents the position of the concerned device at a given time. The position, represented by a GeolocationCoordinates object, comprehends the 2D position of the device, on a spheroid representing the Earth, but also its altitude and its speed. Available only in secure contexts.

Link copied to clipboard

The GeolocationPositionError interface represents the reason of an error occurring when using the geolocating device.

Link copied to clipboard
sealed interface GeolocationWatchId
Link copied to clipboard
typealias PositionCallback = (position: GeolocationPosition) -> Unit
Link copied to clipboard
typealias PositionErrorCallback = (positionError: GeolocationPositionError) -> Unit
Link copied to clipboard
interface PositionOptions

Functions

Link copied to clipboard

The getCurrentPosition() method of the Geolocation interface is used to get the current position of the device.

Link copied to clipboard

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. You can also, optionally, specify an error handling callback function.