NumberFormatterOptions
Formatter Options for Numeric Columns
export interface NumberFormatterOptions extendsExtends
BaseFormatterOptions
Properties
| Property | Type | Description |
|---|---|---|
| Abs | boolean | Returns absolute value of cell value |
| Ceiling | boolean | Returns smallest integer greater than cell value |
| Content | string | number | Replaces cell value with supplied value (that can contain Template Literals) |
| Empty | boolean | Show nothing in cell (but underlying value remains) |
| Floor | boolean | Returns largest integer cell value |
| FractionDigits | number | Number of digits to show in Fractions (up to 20) |
| FractionSeparator | string | Separator to use in fractions |
| IntegerDigits | number | Number of digits to show for Integers (up to 20) |
| IntegerSeparator | string | Separator to use in Integers |
| Multiplier | number | Multiplier to use on cell value |
| Notation | 'standard' | 'scientific' | Numeric notation to use when rendering the value. |
| Parentheses | boolean | Shows negative numbers in parentheses |
| Prefix | string | Prefix to use before cell value |
| Round | boolean | Rounds cell value |
| Suffix | string | Suffix to use after cell value |
| Truncate | boolean | Truncates cell value |
| ZeroDisplay | string | When the numeric value is zero (after multiplier and rounding): - omitted / undefined, or '0' — use normal formatting (e.g. 0, 0.00) - '' — show a blank cell (user cleared the default 0 in the wizard) - any other string — show that text (e.g. -, —) |
Property Details
Abs
Returns absolute value of cell value
Abs?: boolean;Property Value
boolean
Ceiling
Returns smallest integer greater than cell value
Ceiling?: boolean;Property Value
boolean
Content
Replaces cell value with supplied value (that can contain Template Literals)
Content?: string | number;Property Value
string | number
Empty
Show nothing in cell (but underlying value remains)
Empty?: boolean;Property Value
boolean
Floor
Returns largest integer cell value
Floor?: boolean;Property Value
boolean
FractionDigits
Number of digits to show in Fractions (up to 20)
FractionDigits?: number;Property Value
number
FractionSeparator
Separator to use in fractions
FractionSeparator?: string;Property Value
string
IntegerDigits
Number of digits to show for Integers (up to 20)
IntegerDigits?: number;Property Value
number
IntegerSeparator
Separator to use in Integers
IntegerSeparator?: string;Property Value
string
Multiplier
Multiplier to use on cell value
Multiplier?: number;Property Value
number
Notation
Numeric notation to use when rendering the value.
'standard'(default) — renders the number normally. -'scientific'— renders the number in scientific notation (e.g.1.23e+5). When set,IntegerSeparatoris ignored andFractionDigitscontrols the number of mantissa digits.
Notation?: 'standard' | 'scientific';Property Value
'standard' | 'scientific'
Parentheses
Shows negative numbers in parentheses
Parentheses?: boolean;Property Value
boolean
Prefix
Prefix to use before cell value
Prefix?: string;Property Value
string
Round
Rounds cell value
Round?: boolean;Property Value
boolean
Suffix
Suffix to use after cell value
Suffix?: string;Property Value
string
Truncate
Truncates cell value
Truncate?: boolean;Property Value
boolean
ZeroDisplay
When the numeric value is zero (after multiplier and rounding): - omitted / undefined, or '0' — use normal formatting (e.g. 0, 0.00) - '' — show a blank cell (user cleared the default 0 in the wizard) - any other string — show that text (e.g. -, —)
ZeroDisplay?: string;Property Value
string