website logo
ChartHop documentation
Carrot reference
Release notes
Navigate through spaces
ChartHop documentation
Carrot reference
Release notes
⌘K
Getting started
Getting started with Carrot
Operator precedence
Data categories
Basic Org Information
Compensation
Job Changes
Permissions
Personal
Recruiting
Structure
Time off
Data types
Address
Boolean
Comp
Comp Band
Currency
Date
DateTime
DaysOff
Enum
EnumList
File
Group
Image
Job
List
Money
Name
Number
Null
Percent
Person
PersonList
Shares
StockGrant
String
TimeOff
User
Operators
+ (add)
- (subtract)
* (multiply)
/ (divide)
% (modulus)
&& (and)
|| (or)
if
: (match)
= (equals)
!= (not-equals)
! (not)
> (greater-than)
>= (greater-than-equals)
< (less-than)
<= (less-than-equals)
[ ](array)
. (dot)
? (ternary)
?: (elvis)
Functions
abs()
boolean()
compHistory()
date()
day()
daysOffBetween()
diffYears()
diffMonths()
distance()
monthEnd()
formatMoney()
formatRound()
formatNumber()
formatPercent()
formatDate()
grantedShares()
length()
max()
mean()
money()
month()
min()
nextAnniversary()
number()
pluralize()
percent()
random()
round()
roundUp()
roundDown()
string()
subString()
stockPrice()
monthStart()
split()
vestValue()
vestShares()
year()
Aggregators
count{}
max{}
mean{}
min{}
sum{}
Docs powered by archbee 
6min

distance()

Returns the distance between built-in addresses in ChartHop in the specified units.

Syntax

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

Sample usage

distance(address, workAddress, 'meters') returns the distance in meters.

distance(address, workAddress, 'miles') returns the distance in miles.

Supported data types

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.



Updated 07 Dec 2021
Did this page help you?
Yes
No
UP NEXT
monthEnd()
Docs powered by archbee 
Updated 07 Dec 2021
Did this page help you?
Yes
No
UP NEXT
monthEnd()
Docs powered by archbee 
TABLE OF CONTENTS
Syntax
Sample usage
Supported data types