charton API / @chart-on/core / index / PriceFormatModel
Interface: PriceFormatModel
Defined in: packages/core/src/util/price-format.ts:54
A resolved PriceFormat: every price label in the chart goes through one of these.
Properties
unit?
optionalunit?:string
Defined in: packages/core/src/util/price-format.ts:64
Methods
axisStep()
axisStep(
step,price):number
Defined in: packages/core/src/util/price-format.ts:63
A price-axis label step at least step that lands on ticks.
Parameters
step
number
price
number
Returns
number
format()
format(
price):string
Defined in: packages/core/src/util/price-format.ts:55
Parameters
price
number
Returns
string
parse()
parse(
text):number
Defined in: packages/core/src/util/price-format.ts:57
Inverse of format; NaN when the text is not a price in this format.
Parameters
text
string
Returns
number
round()
round(
price):number
Defined in: packages/core/src/util/price-format.ts:61
price rounded to the nearest tick (unchanged without a tick size).
Parameters
price
number
Returns
number
tickSize()
tickSize(
price):number
Defined in: packages/core/src/util/price-format.ts:59
Price increment at price; 0 when prices are not snapped.
Parameters
price
number
Returns
number