6min
distance()
Returns the distance between built-in addresses in ChartHop in the specified units.
distance(point1, point2[, 'unit'])
- point1 - the first location from which to measure distance.
- point2 - the destination to which the function measures distance.
- unit - (optional) the units of the returned distance.
- Accepted values are: meters (default), miles, km.
- Return type: Number
distance(address, workAddress, 'meters') returns the distance in meters.
distance(address, workAddress, 'miles') returns the distance in miles.
Input type | Return type | Logic |
Address (x2) | Number | If two Addresses are passed, the distance between the two will be returned in the specified units. Default units are meters. |
Unsupported data types | Null | Unsupported data types return Null. |