Summary
Provides information about numbers.
Details
| Name: | Number Supplier |
|---|---|
| Prefix: | number (optional) |
| Supported Content: | Numbers |
| Provided By: | Reporting Plugin, from version 1.3 |
Keys Supported
The following are the list of keys which this supplier will return a value for.
| Key | Content Types | Return Type | Description |
|---|---|---|---|
| type | Numbers | Text | The name of the number type (Integer, Double, etc). |
| is whole | Numbers | Boolean | Returns true if the number is a 'whole' number, or an integer. That is, it does not have any decimal places. |
| is decimal | Numbers | Boolean | Returns true if the number has a decimal point. |
| is nan | Numbers | Boolean | Is true if the current value is not a valid number. (Since 2.0.0) |
| + [X] | Numbers | Number | Adds X to the current value. Eg "my:value > +10". (Since 2.0.0) |
| - [X] | Numbers | Number | Subtracts X from the current value. Eg "my:value > -5.6" (Since 2.0.0) |
| * [X] | Numbers | Number | Multiplies the current value by X. Eg "my:value > *2.5" (Since 2.0.0) |
| / [X] | Numbers | Number | Divides the current value by X. Eg "my:value > / 2.5". (Since 2.0.0) |
| mod [X] | Numbers | Number | Outputs the 'mod' value of two numbers. Eg, if "my:value" is currenlty 5, "my:value > mod 3" will return "2". (Since 2.0.0) |
| equals [X] | Numbers | Boolean | Compares the current number with the supplied number. Eg "my:value > equals 5". (Since 2.0.0) |
| less than [X] | Numbers | Boolean | Is true if the current number is less than X. Eg "my:value > less than 100". (Since 2.0.0) |
| greater than [X] | Numbers | Boolean | Is true if the current value is greater than X. Eg "my:value > greater than 1.5". (Since 2.0.0) |
| number format | Numbers | Text | All other values are interpreted as formatted numbers. Eg:
"#,##0.00" will return a text string with at least one value before the decimal point, two after, and every 3rd digit will have a comma separator. |
Discussions