Numbers and Math

This page covers number conversion, number formatting, and the Math object.

Topics on this page:

• Numbers in DG Script
• Converting values to numbers: Number, parseInt, parseNumber, isNaN
• numberFormat and number format patterns
• Math functions
• Number constants

See also: Strings, Date and Time.

You can write numbers as integers (42), decimals (3.14), with an exponent (1.5e3), or in hexadecimal (0xFF).

There are no global NaN or Infinity constants. When you need them, use Number("NaN") and Number("Infinity"), or compute 1 / 0.

When + has a number on the left, the right side is converted to a number, so 1 + "2" is 3. See Joining strings.

val = 123;
if (typeof val == "number") return "It's Numeric!";

Converts a value to a number and returns it.

• A string that contains only a number (for example "12.12", "-5", "1e3") is converted. Any other string, including "" and "12px", gives NaN.
• true gives 1 and false gives 0.
• null and other values give NaN.

print(Number("12.12"), "\n");
print(Number("12px"), "\n");
print(Number(true), "\n");
return Number(null);

Print output:

12.12
NaN
1

Output: NaN

Converts a value to a whole number by dropping the fraction. Unlike JavaScript, a value that cannot be converted gives 0, not NaN, and trailing text is not allowed (parseInt("12px") is 0).

When you pass an integer radix, the value is read as a whole number in that base, such as 16 for hexadecimal.

print(parseInt("12.7"), "\n");
print(parseInt(-3.9), "\n");
print(parseInt("abc"), "\n");
return parseInt("ff", 16);

Print output:

12
-3
0

Output: 255

Finds the first number inside a string and returns it. Use it to read numbers that contain units, currency symbols, or thousands separators.

• Commas inside the number are removed, so "1,234.5" gives 1234.5.
• A string that starts with # or 0x is read as hexadecimal. The rest of the string must be valid hex digits, otherwise an error occurs.
• If no number is found, or the string is empty, the result is default (NaN when omitted).
• str must be a string. Passing a number returns NaN; use Number() for numbers.

print(parseNumber("$12.11"), "\n");
print(parseNumber("Total: 1,234.5 kg"), "\n");
print(parseNumber("#ff"), "\n");
print(parseNumber("n/a"), "\n");
return parseNumber("n/a", 0);

Print output:

12.11
1234.5
255
NaN

Output: 0

Returns true only if the value is the number NaN. The value is not converted first, so any string, including "abc", returns false. This is different from JavaScript, where isNaN("abc") is true.

To check whether a string contains a valid number, convert it first: isNaN(Number(str)).

print(isNaN(Number("abc")), "\n");
print(isNaN("abc"), "\n");
print(isNaN("12"), "\n");
return isNaN(null);

Print output:

true
false
false

Output: false

Formats a number as a string using a number format pattern.

• value — a number, or a string that Number() can convert. For any other value the result is an empty string.
• pattern — a number format pattern (see below).
• decimalSeparator, groupSeparator — optional. Use them to change the decimal and grouping characters, for example for European formats. You can pass only decimalSeparator.

If the pattern is invalid, the result is an empty string.

print(numberFormat(123.456789, "$#.00"), "\n");
print(numberFormat(1234567.891, "#,##0.00"), "\n");
print(numberFormat(5, "000"), "\n");
print(numberFormat(0.256, "0.0%"), "\n");
print(numberFormat("12.5", "0.00"), "\n");
print(numberFormat(-1234.5, "#,##0.00;(#,##0.00)"), "\n");
return numberFormat(1234.5, "#,##0.00", ",", ".");

Print output:

$123.46
1,234,567.89
005
25.6%
12.50
(1,234.50)

Output: 1.234,50

Number format patterns use the ICU pattern syntax. The same patterns are used by the number formatting dataflow blocks and by bindings.

Other characters, such as $ or a space, are copied to the result as they are. The special pattern ,0.00 is treated as ,###.00.

Math functions accept only numbers. They do not convert strings: Math.abs("-5") is NaN. Convert with Number() first.

print(Math.abs(-47), "\n");
print(Math.min(-2, -1, 0, 1, 2), " ", Math.max(-2, -1, 0, 1, 2), "\n");
print(Math.max(1, "5"), "\n");
print(Math.sin(Math.PI / 2), " ", Math.cos(Math.PI), "\n");
print(Math.atan2(1, 1) == Math.PI / 4, "\n");
print(Math.ceil(1.2), " ", Math.floor(1.7), " ", Math.round(1.5), " ", Math.round(-2.5), "\n");
print(Math.sqrt(9), " ", Math.pow(2, 3), "\n");
return Math.log(10);

Print output:

47
-2 2
1
1 -1
true
2 1 2 -3
3 8

Output: 2.302585092994046

To round to a number of decimal places, multiply, round, and divide, or use numberFormat when you need a string:

x = 3.14159;
print(Math.round(x * 100) / 100, "\n");
return numberFormat(x, "0.00");

Print output:

3.14

Output: 3.14

function getRandom(min, max) {
    return Math.random() * (max - min) + min;
}
 
return getRandom(50, 75);

The Math object is read-only. Assigning to it, for example Math.PI = 3, causes an error.