Documentation / @ripl/charts / StockChartOptions
Interface: StockChartOptions<TData>
Defined in: charts/src/charts/stock.ts:82
Options for configuring a StockChart.
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
TData | unknown |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
animation? | boolean | Partial<ChartAnimationOptions> | Animation configuration, or a boolean toggling all transitions. See ChartAnimationOptions. | BaseChartOptions.animation | charts/src/core/chart.ts:89 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:83 |
axis? | ChartAxisInput<TData> | Axis configuration (labels, ticks, titles). | - | charts/src/charts/stock.ts:106 |
close | NumericAccessor<TData> | Accessor for each item's closing price. | - | charts/src/charts/stock.ts:94 |
crosshair? | ChartCrosshairInput | Crosshair overlay configuration. | - | charts/src/charts/stock.ts:102 |
data | TData[] | The dataset to render, one candlestick per item. | - | charts/src/charts/stock.ts:84 |
downColor? | string | Colour for candles that close below their open (bearish). | - | charts/src/charts/stock.ts:110 |
grid? | ChartGridInput | Background grid line configuration. | - | charts/src/charts/stock.ts:100 |
high | NumericAccessor<TData> | Accessor for each item's high price. | - | charts/src/charts/stock.ts:90 |
key | keyof TData | ((item) => string) | Accessor for each item's unique key, used along the x-axis and to match candles across updates. | - | charts/src/charts/stock.ts:86 |
low | NumericAccessor<TData> | Accessor for each item's low price. | - | charts/src/charts/stock.ts:92 |
open | NumericAccessor<TData> | Accessor for each item's opening price. | - | charts/src/charts/stock.ts:88 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | BaseChartOptions.padding | charts/src/core/chart.ts:85 |
showVolume? | boolean | Show the volume sub-chart below the candlesticks. Defaults to true (requires volume). | - | charts/src/charts/stock.ts:98 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:87 |
tooltip? | ChartTooltipInput | Hover tooltip configuration. | - | charts/src/charts/stock.ts:104 |
upColor? | string | Colour for candles that close at or above their open (bullish). | - | charts/src/charts/stock.ts:108 |
volume? | NumericAccessor<TData> | Optional accessor for each item's traded volume, enabling the volume sub-chart. | - | charts/src/charts/stock.ts:96 |