@serenity-is/corelib / NumberFormatter
Class: NumberFormatter
Defined in: src/ui/formatters/numberformatter.ts:6
Formats numeric values via formatNumber (default "0.##").
Implements
Constructors
Constructor
new NumberFormatter(
props):NumberFormatter
Defined in: src/ui/formatters/numberformatter.ts:14
Creates a new NumberFormatter.
Parameters
props
Formatter options.
displayFormat?
string
Number format string (default "0.##").
Returns
NumberFormatter
Properties
props
readonlyprops:object={}
Defined in: src/ui/formatters/numberformatter.ts:14
Formatter options.
displayFormat?
optionaldisplayFormat:string
[typeInfo]
static[typeInfo]:FormatterTypeInfo<"Serenity.">
Defined in: src/ui/formatters/numberformatter.ts:7
Accessors
displayFormat
Get Signature
get displayFormat():
string
Defined in: src/ui/formatters/numberformatter.ts:53
Gets the number display format.
Returns
string
The display format string.
Set Signature
set displayFormat(
value):void
Defined in: src/ui/formatters/numberformatter.ts:58
Sets the number display format.
Parameters
value
string
The display format string.
Returns
void
Methods
format()
format(
ctx):string
Defined in: src/ui/formatters/numberformatter.ts:23
Formats the cell value as a number string.
Parameters
ctx
FormatterContext
Formatter context containing the cell value.
Returns
string
Formatted number string.
Implementation of
format()
staticformat(value,format?):string
Defined in: src/ui/formatters/numberformatter.ts:33
Static helper to format any numeric-like value.
Parameters
value
any
Number or numeric string.
format?
string
Format string (default "0.##").
Returns
string
Formatted string.