Stock chart data types

Import

import type { OHLCVData } from "@sixtyfold/stock";

Use the public entry point shown above.

`CandleStyle`

Style for rendering price data

Import @sixtyfold/stocktype

type CandleStyle = "filled" | "hollow" | "ohlc"

`KeyboardAnnouncementMessages`

Localizable announcements emitted after keyboard chart actions.

Import @sixtyfold/stockinterface

interface KeyboardAnnouncementMessages

Member	Definition	Description
`panLeft?`	`string \| undefined`	Pan left text.
`panRight?`	`string \| undefined`	Pan right text.
`reset?`	`string \| undefined`	Reset text.
`selectionCancelled?`	`string \| undefined`	Selection cancelled text.
`viewport?`	`string \| undefined`	Optional viewport context appended after a successful pan, zoom, or reset. The placeholders `{startPercent}`, `{endPercent}`, and `{spanPercent}` are replaced with positions relative to the complete data range. Set an empty string to announce only the action message.
`zoomIn?`	`string \| undefined`	Zoom in text.
`zoomOut?`	`string \| undefined`	Zoom out text.

`OHLCVData`

Six aligned ordered timestamp, OHLC, and volume columns.

Import @sixtyfold/stockinterface

interface OHLCVData

Member	Definition	Description
`close`	`Float64Array<ArrayBufferLike>`	Closing price column aligned by index with the OHLCV timestamps.
`high`	`Float64Array<ArrayBufferLike>`	Upper bound values aligned by index with X and the matching lower-bound column.
`length`	`number`	Number of active aligned rows to read from the supplied data columns.
`low`	`Float64Array<ArrayBufferLike>`	Lower bound values aligned by index with X and the matching upper-bound column.
`open`	`Float64Array<ArrayBufferLike>`	Opening price column aligned by index with the OHLCV timestamps.
`timestamp`	`Float64Array<ArrayBufferLike>`	Unix timestamps (ms). Ascending and descending input are accepted.
`volume`	`Float64Array<ArrayBufferLike>`	Volume column aligned by index with the OHLCV timestamps and price columns.

`OverlayErrorCallback`

Called when an overlay update has one or more resolution or delivery failures.

Import @sixtyfold/stocktype

type OverlayErrorCallback = (error: ChartOverlayError) => void

`RendererErrorCallback`

Called once when the chart renderer fails and is about to be torn down.

Import @sixtyfold/stocktype

type RendererErrorCallback = (error: ChartRendererError) => void

`RendererFailurePhase`

Stage at which a chart renderer stopped working.

Import @sixtyfold/stocktype

type RendererFailurePhase = "initialization" | "runtime"

`StockCandleBatch`

One transferable aligned OHLCV column batch used during streaming installation.

Import @sixtyfold/stockinterface

interface StockCandleBatch

Member	Definition	Description
`close`	`Float64Array<ArrayBufferLike>`	Closing price column aligned by index with the OHLCV timestamps.
`high`	`Float64Array<ArrayBufferLike>`	Upper bound values aligned by index with X and the matching lower-bound column.
`low`	`Float64Array<ArrayBufferLike>`	Lower bound values aligned by index with X and the matching upper-bound column.
`open`	`Float64Array<ArrayBufferLike>`	Opening price column aligned by index with the OHLCV timestamps.
`timestamp`	`Float64Array<ArrayBufferLike>`	Timestamp in Unix epoch milliseconds. Keep it ordered with the other aligned columns.
`volume`	`Float64Array<ArrayBufferLike>`	Volume column aligned by index with the OHLCV timestamps and price columns.

`StockChartStats`

Renderer and aggregation telemetry for the active stock dataset and frame.

Import @sixtyfold/stockinterface

interface StockChartStats

Member	Definition	Description
`aggregation`	`string`	Aggregation text.
`bufferUsage`	`number`	Buffer usage value.
`firstRenderTime`	`string`	First render time text.
`fps`	`number`	Fps value.
`frameTime`	`string`	Frame time text.
`lodBuilt`	`number`	LOD built value.
`lodLevel`	`number`	LOD level value.
`lodReady`	`boolean`	Whether to enable LOD ready.
`lodTotal`	`number`	LOD total value.
`renderedCandles`	`number`	Rendered candles value.
`renderMode`	`"worker" \| "main"`	Selects the render mode.
`ringBuffer`	`boolean`	Whether to enable ring buffer.
`totalCandles`	`number`	Count reported for total candles in the current stock chart stats snapshot.
`totalReceived`	`number`	Count reported for total received in the current stock chart stats snapshot.
`visibleCandles`	`number`	Visible candles value.

`StockCrosshairIndicatorValue`

Fields for stock crosshair indicator value.

Import @sixtyfold/stockinterface

interface StockCrosshairIndicatorValue

Member	Definition	Description
`color`	`string`	Stock crosshair indicator value color.
`formattedValue`	`string`	Formatted value text.
`id`	`string`	Unique identifier for this stock crosshair indicator value.
`label`	`string`	Stock crosshair indicator value label.
`value`	`number`	Value value.

`StockCrosshairMoveDetail`

Stock candle and derived values under the active crosshair.

Import @sixtyfold/stockinterface

interface StockCrosshairMoveDetail

Member	Definition	Description
`bullish`	`boolean`	Whether to enable bullish.
`candle`	`{ open: number; high: number; low: number; close: number; volume: number; }`	Raw OHLCV values for the selected candle before display formatting.
`change`	`number`	Change value.
`changePercent`	`number`	Ratio used for change; consult the accepted range in the parent configuration.
`color`	`string`	Stock crosshair move detail color.
`formatted`	`{ open: string; high: string; low: string; close: string; volume: string; }`	Display-ready strings for the selected candle, after the configured units and bounded precision are applied.
`formattedChange`	`string`	Formatted change text.
`indicators?`	`StockCrosshairIndicatorValue[] \| undefined`	Indicator configurations or computed indicator values associated with stock crosshair move detail; order is preserved for rendering and tooltip display.
`screenX`	`number`	Screen X value.
`screenY`	`number`	Screen Y value.
`timestamp`	`number`	Timestamp in Unix epoch milliseconds. Keep it ordered with the other aligned columns.

`StockIndicator`

Declarative stock indicator configuration.

Import @sixtyfold/stocktype

type StockIndicator = SMAIndicatorConfig | EMAIndicatorConfig | BollingerBandsIndicatorConfig | VWAPIndicatorConfig

`StockIndicatorLineDash`

Accepted values for stock indicator line dash.

Import @sixtyfold/stocktype

type StockIndicatorLineDash = "solid" | "dashed" | "dotted"

`StockMarkerPosition`

Vertical anchor used when positioning a stock marker.

Import @sixtyfold/stocktype

type StockMarkerPosition = "above" | "below" | "price"

`StockMarkerShape`

Glyphs supported by data-anchored stock markers.

Import @sixtyfold/stocktype

type StockMarkerShape = "circle" | "square" | "diamond" | "triangle-up" | "triangle-down"

`StockPriceSource`

Price column or derived price used as indicator input.

Import @sixtyfold/stocktype

type StockPriceSource = "open" | "high" | "low" | "close" | "hl2" | "hlc3" | "ohlc4"

`StockTimeScale`

Continuous elapsed-time positioning or compressed observed-market positioning.

Import @sixtyfold/stocktype

type StockTimeScale = "continuous" | "market"

`StockTooltipFieldLabels`

Accepted values for stock tooltip field labels.

Import @sixtyfold/stocktype

type StockTooltipFieldLabels = Partial<Record<StockTooltipField, string>>

Member	Definition	Description
`change?`	`string \| undefined`	Text shown for the `change` label.
`changePercent?`	`string \| undefined`	Text shown for the `changePercent` label.
`close?`	`string \| undefined`	Text shown for the `close` label.
`high?`	`string \| undefined`	Text shown for the `high` label.
`low?`	`string \| undefined`	Text shown for the `low` label.
`open?`	`string \| undefined`	Text shown for the `open` label.
`volume?`	`string \| undefined`	Text shown for the `volume` label.

`StockVisibleRangeChangeDetail`

Renderer-synchronized visible X range and complete data extent.

Import @sixtyfold/stockinterface

interface StockVisibleRangeChangeDetail

Member	Definition	Description
`dataBounds`	`{ xMin: number; xMax: number; }`	Complete installed-data extent for stock visible range change detail, expressed in the chart's X units.
`viewport`	`{ xMin: number; xMax: number; }`	Current visible X-domain extent for stock visible range change detail, expressed in the chart's X units.

`TimeRange`

A supported stock viewport preset identifier.

Import @sixtyfold/stocktype

type TimeRange = (typeof STOCK_TIME_RANGES)[number]

`TimeRangeChangeDetail`

Payload for the time range change event.

Import @sixtyfold/stockinterface

interface TimeRangeChangeDetail

Member	Definition	Description
`previousRange`	`"1D" \| "5D" \| "1M" \| "3M" \| "6M" \| "YTD" \| "1Y" \| "5Y" \| "ALL" \| null`	Previously applied stock time-range preset, or `null` when no concrete preset matched the viewport.
`range`	`"1D" \| "5D" \| "1M" \| "3M" \| "6M" \| "YTD" \| "1Y" \| "5Y" \| "ALL" \| null`	Applied stock time-range preset, or `null` when no concrete preset matched the viewport.
`source`	`TimeRangeChangeSource`	Selects the source value used to calculate or render time range change detail.

`VWAPReset`

Accepted values for VWAP reset.

Import @sixtyfold/stocktype

type VWAPReset = "day" | "week" | "none"