charton API / @chart-on/core / index / DepthLaneOptions
Interface: DepthLaneOptions
Defined in: packages/core/src/depth-lane.ts:36
Options for a depth lane: the axis side and width, levels shown per side, labels, colours and how often it repaints.
Properties
askColor
askColor:
string|null
Defined in: packages/core/src/depth-lane.ts:51
bidColor
bidColor:
string|null
Defined in: packages/core/src/depth-lane.ts:50
Bar colours; default to the theme's depthBid and depthAsk tokens.
highlightBest
highlightBest:
boolean
Defined in: packages/core/src/depth-lane.ts:48
Draw the best bid and ask in the theme's solid bid and ask colours.
labels
labels:
boolean
Defined in: packages/core/src/depth-lane.ts:46
Write each bar's size, where rows leave room for text.
maxLevels
maxLevels:
number
Defined in: packages/core/src/depth-lane.ts:44
Levels shown per side, nearest the best price first.
repaintInterval
repaintInterval:
number
Defined in: packages/core/src/depth-lane.ts:53
Least time between repaints caused by level changes, in ms.
side
side:
"left"|"right"
Defined in: packages/core/src/depth-lane.ts:40
Which price axis the lane sits beside.
visible
visible:
boolean
Defined in: packages/core/src/depth-lane.ts:38
A hidden lane takes no width.
width
width:
number
Defined in: packages/core/src/depth-lane.ts:42
Lane width in css px.