Interface: ISymbolValueFormatter

Charting Library.ISymbolValueFormatter

Specific formatter for number

Hierarchy

• INumberFormatter

  ↳ ISymbolValueFormatter

  ↳↳ IPriceFormatter

Methods

format

▸ format(price, options?): string

Default formatter function used to assign the correct sign (+ or -) to a number

Parameters

Name	Type
price	number
options?	SymbolValueFormatterFormatOptions

Returns

string

Overrides

INumberFormatter.format

---

formatChange

▸ formatChange(currentPrice, prevPrice, options?): string

Formatter for a price change

Parameters

Name	Type	Description
currentPrice	number	current price
prevPrice	number	previous price
options?	SymbolValueFormatterFormatOptions	format options

Returns

string

Overrides

INumberFormatter.formatChange

---

parse

▸ parse(value, options?): ErrorFormatterParseResult | SuccessFormatterParseResult<number>

Check if the input value satisfies the logic and return either an error or the result of the parsing

Parameters

Name	Type
value	string
options?	FormatterParseOptions

Returns

ErrorFormatterParseResult | SuccessFormatterParseResult<number>

Inherited from

INumberFormatter.parse