charton

Appearance

charton API

charton API / @chart-on/core / index / PriceAxisOptions

Interface: PriceAxisOptions ​

Defined in: packages/core/src/chart.ts:299

Price axis layout: auto-width sizing (priceAxisWidth: 'auto'), lines, font and label pills.

Properties ​

border ​

border: boolean

Defined in: packages/core/src/chart.ts:309

The line between the plot and the price axes. Default true.

fontSize? ​

optional fontSize?: number

Defined in: packages/core/src/chart.ts:311

Font size (css px) of the price axis text and labels; unset for the theme's axis font.

labelMode ​

labelMode: "fill" | "content"

Defined in: packages/core/src/chart.ts:316

Width of the filled labels (last value, crosshair, drawings): 'fill' spans the axis column, 'content' fits the text. Default 'fill'.

labelPaddingY ​

labelPaddingY: number

Defined in: packages/core/src/chart.ts:320

Space (css px) above and below the text of a filled label. Default 4.

labelPointer ​

labelPointer: boolean

Defined in: packages/core/src/chart.ts:318

Give each filled label a point on its plot side, at its exact price. Default false.

maxWidth? ​

optional maxWidth?: number

Defined in: packages/core/src/chart.ts:305

Widest column (css px); unset for no limit. Labels wider than this are clipped.

minWidth ​

minWidth: number

Defined in: packages/core/src/chart.ts:303

Narrowest column (css px). Default 48.

padding ​

padding: number

Defined in: packages/core/src/chart.ts:301

Space (css px) between the widest label and the outer edge of its column. Default 8.

ticks ​

ticks: boolean

Defined in: packages/core/src/chart.ts:307

Short marks at each tick label, on the plot edge of its column. Default false.