ScriptX

Appearance

Location ​

Access device location and geocoding services

Location provides access to GPS location and reverse geocoding. Requires location permissions.

Use Location to:

Examples ​

javascript
let loc = await Location.current();
console.log(`Lat: ${loc.latitude}, Lon: ${loc.longitude}`);
javascript
Location.setAccuracyToBest();
let loc = await Location.current();
javascript
let places = await Location.reverseGeocode(37.7749, -122.4194);
console.log(places[0].locality); // "San Francisco"

Methods ​

current ​

Get current device location

Returns location object with latitude, longitude, altitude, accuracy, speed, course, and timestamp.

typescript
static current(): void

Returns: Promise resolving to location object

Example:

javascript
let loc = await Location.current()

setAccuracyToBest ​

Set accuracy to best (highest precision, most battery)

typescript
static setAccuracyToBest(): void

Example:

javascript
Location.setAccuracyToBest()

setAccuracyToTenMeters ​

Set accuracy to 10 meters

typescript
static setAccuracyToTenMeters(): void

Example:

javascript
Location.setAccuracyToTenMeters()

setAccuracyToHundredMeters ​

Set accuracy to 100 meters

typescript
static setAccuracyToHundredMeters(): void

Example:

javascript
Location.setAccuracyToHundredMeters()

setAccuracyToKilometer ​

Set accuracy to 1 kilometer

typescript
static setAccuracyToKilometer(): void

Example:

javascript
Location.setAccuracyToKilometer()

setAccuracyToThreeKilometers ​

Set accuracy to 3 kilometers (lowest precision, least battery)

typescript
static setAccuracyToThreeKilometers(): void

Example:

javascript
Location.setAccuracyToThreeKilometers()

reverseGeocode ​

Convert coordinates to address (reverse geocoding)

Returns array of placemark objects with address components: name, thoroughfare, subThoroughfare, locality, subLocality, administrativeArea, postalCode, country, isoCountryCode.

typescript
static reverseGeocode(latitude, longitude, locale): void
  • latitude - Latitude coordinate
  • longitude - Longitude coordinate
  • locale - Optional locale identifier (e.g., "en_US")

Returns: Promise resolving to array of placemarks

Example:

javascript
await Location.reverseGeocode(lat, lon, "en_US")