Home > @magiclane/maps-sdk > AlarmsList > getDistance
AlarmsList.getDistance() method
Get the distance in meters from the item to the reference coordinate.
Signature:
abstract getDistance(index: number): number;Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
number |
The index of the overlay item. |
Returns:
number
The distance to the item specified by index, or 0 if the index is not in range.
Exceptions
An exception if it fails.