Class: CoordinateSat

bemap.CoordinateSat(options)

GPS coordinate with satellite-derived metadata. Extends bemap.Coordinate with altitude, heading, speed, time and satellite count. Used by TraceRoute and other GPS-trace-oriented services introduced in v1.5.

Constructor

new CoordinateSat(options)

Parameters:
Name Type Description
options Object
Properties
Name Type Attributes Description
lon Number Longitude in degrees decimal (WGS84).
lat Number Latitude in degrees decimal (WGS84).
alt Number <optional>
 Altitude in metres above mean sea level.
heading Number <optional>
 Heading in degrees clockwise from north (0–360).
speed Number <optional>
 Speed in metres per second.
time Number | String | Date <optional>
 GPS timestamp (epoch ms, ISO-8601 string or Date).
satellites Number <optional>
 Number of satellites visible at the fix.
Since:
  • 1.5.0
Source:

Extends

Members

(protected) alt :Number|null

Type:
  • Number | null
Source:

(protected) heading :Number|null

Type:
  • Number | null
Source:

(protected) lat :double

Type:
  • double
Inherited From:
Source:

(protected) lon :double

Type:
  • double
Inherited From:
Source:

(protected) satellites :Number|null

Type:
  • Number | null
Source:

(protected) speed :Number|null

Type:
  • Number | null
Source:

(protected) time :Number|String|Date|null

Type:
  • Number | String | Date | null
Source:

Methods

(static) fromJson(json) → {bemap.CoordinateSat}

Hydrate a CoordinateSat from a plain JSON object (typically from a BeMap response). Accepts both the modern `sat` field and the legacy `satellites` field.
Parameters:
Name Type Description
json Object
Source:
Returns:
Type
bemap.CoordinateSat

getLat() → {double}

Return the latitude coordinate in degrees decimal (WGS84).
Inherited From:
Source:
Returns:
Return the latitude coordinate in degrees decimal (WGS84).
Type
double

getLatLonArray() → {array}

Return an array of composed by longitude and latitude coordinate in degrees decimal (WGS84).
Inherited From:
Source:
Returns:
Return an array of composed by longitude and latitude coordinate in degrees decimal (WGS84).
Type
array

getLon() → {double}

Return the longitude coordinate in degrees decimal (WGS84).
Inherited From:
Source:
Returns:
Return the longitude coordinate in degrees decimal (WGS84).
Type
double

getLonLatArray() → {array}

Return an array of composed by latitude and longitude coordinate in degrees decimal (WGS84).
Inherited From:
Source:
Returns:
Return an array of composed by latitude and longitude coordinate in degrees decimal (WGS84).
Type
array

setLat(lat) → {bemap.Coordinate}

Set the latitude coordinate in degrees decimal (WGS84).
Parameters:
Name Type Description
lat double Latitude in degrees decimal (WGS84).
Inherited From:
Source:
Returns:
Return this.
Type
bemap.Coordinate

setLon(lon) → {bemap.Coordinate}

Set the longitude coordinate in degrees decimal (WGS84).
Parameters:
Name Type Description
lon double Longitude in degrees decimal (WGS84).
Inherited From:
Source:
Returns:
Return this.
Type
bemap.Coordinate

toJson() → {Object}

Return a wire-format JSON object suitable for inclusion in a BeMap request body. Only non-null fields are emitted. Wire field names mirror the BeMap server contract (cross-checked against the Flutter SDK `bemap-flutter-api/lib/service/map/model/coordinate_sat.dart`): - `lon` / `lat` (not longitude / latitude) - `sat` (not satellites) - `time` as epoch milliseconds (integer) — Dates and ISO strings are coerced
Source:
Returns:
Type
Object