charton

Appearance

charton API

charton API / @chart-on/ui / index / DepthLadderOptions

Interface: DepthLadderOptions ​

Defined in: ui/src/depth-ladder.ts:6

Options for createDepthLadder: its heading, the levels listed per side, and how prices and sizes are formatted.

Properties ​

depth? ​

optional depth?: number

Defined in: ui/src/depth-ladder.ts:10

Levels listed per side. Default 10.

formatPrice? ​

optional formatPrice?: (price) => string

Defined in: ui/src/depth-ladder.ts:12

Price text; defaults to the number as is. Pass chart.formatPrice bound to a pane to match the axis.

Parameters ​

price ​

number

Returns ​

string

formatSize? ​

optional formatSize?: (size) => string

Defined in: ui/src/depth-ladder.ts:14

Size text; defaults to a compact number (1.2K).

Parameters ​

size ​

number

Returns ​

string

localization? ​

optional localization?: Localizer

Defined in: ui/src/depth-ladder.ts:16

Language of the built-in text (title and column headings), e.g. chart.localization; read when the ladder is made.

title? ​

optional title?: string

Defined in: ui/src/depth-ladder.ts:8

Heading and accessible name. Default Order book in the localization language (message ladderTitle).