charton

Appearance

charton API

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

Interface: TradeMarkerOptions ​

Defined in: packages/core/src/annotations/trades.ts:36

Options for trade markers: shape, size, how many draw per bar, and what counted markers and badges show.

Properties ​

countDisplay ​

countDisplay: "both" | "quantity" | "count"

Defined in: packages/core/src/annotations/trades.ts:44

What badges and counted markers show. Default count.

formatQuantity? ​

optional formatQuantity?: (quantity) => string

Defined in: packages/core/src/annotations/trades.ts:45

Parameters ​

quantity ​

number

Returns ​

string

labelFormatter? ​

optional labelFormatter?: (group) => string

Defined in: packages/core/src/annotations/trades.ts:47

Text of a badge or count marker; wins over countDisplay.

Parameters ​

group ​

TradeGroup

Returns ​

string

markerScale ​

markerScale: number

Defined in: packages/core/src/annotations/trades.ts:40

Size multiplier. Default 1.

maxPerColumn ​

maxPerColumn: number

Defined in: packages/core/src/annotations/trades.ts:42

Most markers drawn on one bar; extra ones are left out. Default 4.

variant ​

variant: TradeMarkerVariant

Defined in: packages/core/src/annotations/trades.ts:38

chevron (default) points up for buys and down for sells; dot; count is a dot with the count; badge a pill with text.