Skip to content

Documentation / @ripl/charts / StockChartCandleEvent

Interface: StockChartCandleEvent

Defined in: charts/src/charts/stock.ts:114

Payload emitted for stock candlestick interaction events.

Properties

PropertyTypeDescriptionDefined in
closenumberThe candle's closing price.charts/src/charts/stock.ts:128
highnumberThe candle's high price.charts/src/charts/stock.ts:124
keystringThe candle's unique key.charts/src/charts/stock.ts:120
lownumberThe candle's low price.charts/src/charts/stock.ts:126
opennumberThe candle's opening price.charts/src/charts/stock.ts:122
volumenumberThe candle's traded volume (0 when no volume accessor is configured).charts/src/charts/stock.ts:130
xnumberX position of the candle body, in canvas coordinates.charts/src/charts/stock.ts:116
ynumberY position of the candle body's top, in canvas coordinates.charts/src/charts/stock.ts:118