Candlestick

data

An array of { time, open, high, low, close, volume? }.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CandlestickData

  Type definition

width

Chart width in pixels. If the container width changes, update width from a ResizeObserver.

height

Chart height in pixels. Allow space for axes, titles, and the legend.

brandLogo

The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

brandPosition

The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports.

xAxis

Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CartesianAxisInput

  Type definition

yAxis

Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• YAxisInput

  Type definition

gridLines

Allowed values: auto, off. Default: undefined.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CartesianGridLinesInput

  Type definition

crosshair

Crosshair that follows the cursor across the plot.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CartesianCrosshairInput

  Type definition

zoom

Zoom (Storybook parity, 2026-09-10): 'x' | 'y' | 'xy' | true (x) enable the drag rectangle, the pan, the Ctrl + wheel, the pinch and the keyboard (+ / - / Escape) on the primary axes — x narrows the bar window (slots under the ordinal scale, wall time under linear), y the price; an object refines mode / drag / keyboard / minRangePx / resetButton / pan / wheel / pinch / inside. Off by default; the methods (zoomTo / zoomBy / panBy / resetZoom) work regardless of the gesture switches.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CartesianZoomInput

  Type definition

xMin

Explicit domain ends (an omitted end follows the bars; x-axis / y-axis min / max also set them).

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

xMax

Set as an HTML attribute or JavaScript property. type: number.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

yMin

Set as an HTML attribute or JavaScript property. type: number.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

yMax

Set as an HTML attribute or JavaScript property. type: number.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

padding

The price padding above and below the bars (a fraction of the span; default 0.05).

upColor

Set as an HTML attribute or JavaScript property. type: string.

downColor

Set as an HTML attribute or JavaScript property. type: string.

flatColor

Set as an HTML attribute or JavaScript property. type: string.

candleWidth

The body's share of the bar pitch (0 … 1; default 0.7).

candleMinPx

Set as an HTML attribute or JavaScript property. type: number.

candleMaxPx

Set as an HTML attribute or JavaScript property. type: number.

wickWidth

The wick width in CSS px.

bodyMinPx

The minimum body height in CSS px (a doji stays visible).

barStyle

candle (default) or ohlc (a high–low spine, an open tick left, a close tick right); hlc (no open tick). <sy-ohlc-chart> takes ohlc / hlc.

• CandlestickBarStyle

  Type definition

tickLength

(carry-over D5) — the OHLC / HLC tick length in CSS px (default: the body half-width).

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

fillAlpha

(carry-over D5) — the band fill alpha 0 … 1 (default 0.12).

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

bodyStyle

solid (default), hollow, or hollow-up (rising bars hollow, falling filled).

• CandlestickBodyStyle

  Type definition

bodyBorderPx

the hollow ring's border in CSS px.

wickColor

the wick colour; auto follows the body colour.

antialias

the edge coverage: auto (on while the pitch is at least two device px), on, off.

• CandlestickAntialias

  Type definition

pixelSnap

snap the body and the wick to integer device-px widths (crisp, uniform candles).

timeScale

ordinal reflects trading order; linear reflects elapsed time.

• CandlestickTimeScale

  Type definition

session

the exchange session the labels read: 24x7, us-equity, or an object / JSON string { timezone, sessions, holidays, closedWeekdays }.

• CandlestickSessionInput

  Type definition

labelLocale

the BCP-47 locale of the month labels.

volume

Select pane to display volume alongside prices.

• CandlestickVolumeMode

  Type definition

volumeHeight

the volume pane's share of the plot height (0.05 … 0.8).

volumeUpColor

the volume bar colours; auto follows up-color / down-color.

volumeDownColor

Set as an HTML attribute or JavaScript property. type: string.

volumeAlpha

the volume bars' alpha.

overlays

moving-average overlays over the closes: spec objects { kind, period?, color?, width?, label? }, a JSON string of them, or the compact "sma:20 ema:50"; the kinds are the stock chart's (sma, ema, wma, dema, tema, vwma, hma, linreg). A legend at the top of the price pane names each line and reads its value under the pointer.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CandlestickOverlayInput

  Type definition

chartTitle

The title inside the chart. Explain the data's unit and meaning alongside it.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

chartSubtitle

The subtitle inside the chart.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

enableMouseTracking

Set as an HTML attribute or JavaScript property. type: boolean.

tooltip

the bar tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …).

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CartesianTooltipInput

  Type definition

tooltipEnabled

Set as an HTML attribute or JavaScript property. type: boolean.

tooltipFormat

a plain-text formatter of the default tooltip (tooltip.format wins).

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CandlestickPointEventDetail

  Type definition

animated

Whether to animate initial display and data changes.

animationDuration

Animation duration in milliseconds.

animationEasing

Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.

• CandlestickEasing

  Type definition

animationType

Allowed values: initial, update. Default: undefined.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CandlestickAnimationType

  Type definition

streamSource

A stream source of bars (§3.6); without one appendPoint creates an internal source.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

• CandlestickStreamSource

  Type definition

streamMax

The bars the internal stream source tracks at most.

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

streamWindow

The newest N streamed bars the chart renders (the whole buffer when unset).

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

engine

Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.

• CandlestickEngineMode

  Type definition

unavailable

Allowed values: fallback, error. Default: 'fallback'.

• CandlestickUnavailableBehaviour

  Type definition

rendered

Every drawn frame; engine is the engine status (requested / effective / code / the governing license feature).

Event name: rendered. Names are case-sensitive. Read the payload from detail on CustomEvent<CandlestickRenderResult & { tier: CandlestickEngineTier; engine?: ChartEngineStatus }>.

chart.addEventListener('rendered', event => {
  console.log(event.detail); // CandlestickRenderResult & { tier: CandlestickEngineTier; engine?: ChartEngineStatus }
});

• CandlestickRenderResult

  Type definition

• CandlestickEngineTier

  Type definition

• ChartEngineStatus

  Type definition

pointClick

A point selection event. Read the selected data and index from CustomEvent.detail.

Event name: pointClick. Names are case-sensitive. Read the payload from detail on CustomEvent<CandlestickPointEventDetail>.

chart.addEventListener('pointClick', event => {
  console.log(event.detail); // CandlestickPointEventDetail
});

• CandlestickPointEventDetail

  Type definition

pointHover

CustomEvent.detail type: CandlestickPointEventDetail | null. Event names are case-sensitive.

Event name: pointHover. Names are case-sensitive. Read the payload from detail on CustomEvent<CandlestickPointEventDetail | null>.

chart.addEventListener('pointHover', event => {
  console.log(event.detail); // CandlestickPointEventDetail | null
});

• CandlestickPointEventDetail

  Type definition

crosshairMove

CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive.

Event name: crosshairMove. Names are case-sensitive. Read the payload from detail on CustomEvent<CartesianCrosshairEventDetail | null>.

chart.addEventListener('crosshairMove', event => {
  console.log(event.detail); // CartesianCrosshairEventDetail | null
});

• CartesianCrosshairEventDetail

  Type definition

pointContextMenu

CustomEvent.detail type: ChartPointContextMenuEventDetail<CandlestickPointEventDetail>. Event names are case-sensitive.

Event name: pointContextMenu. Names are case-sensitive. Read the payload from detail on CustomEvent<ChartPointContextMenuEventDetail<CandlestickPointEventDetail>>.

chart.addEventListener('pointContextMenu', event => {
  console.log(event.detail); // ChartPointContextMenuEventDetail<CandlestickPointEventDetail>
});

• ChartPointContextMenuEventDetail

  Type definition

• CandlestickPointEventDetail

  Type definition

appended

CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive.

Event name: appended. Names are case-sensitive. Read the payload from detail on CustomEvent<{ count: number; replaced: number }>.

chart.addEventListener('appended', event => {
  console.log(event.detail); // { count: number; replaced: number }
});

windowSlid

CustomEvent.detail type: { dropped: number }. Event names are case-sensitive.

Event name: windowSlid. Names are case-sensitive. Read the payload from detail on CustomEvent<{ dropped: number }>.

chart.addEventListener('windowSlid', event => {
  console.log(event.detail); // { dropped: number }
});

tooltipShow

the tooltip events of the shared contract.

Event name: tooltipShow. Names are case-sensitive. Read the payload from detail on CustomEvent<CartesianTooltipEventDetail>.

chart.addEventListener('tooltipShow', event => {
  console.log(event.detail); // CartesianTooltipEventDetail
});

• CartesianTooltipEventDetail

  Type definition

tooltipHide

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: tooltipHide. Names are case-sensitive. Read the payload from detail on CustomEvent<void>.

chart.addEventListener('tooltipHide', event => {
  console.log(event.detail); // void
});

tooltipAction

CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive.

Event name: tooltipAction. Names are case-sensitive. Read the payload from detail on CustomEvent<CartesianTooltipActionEventDetail>.

chart.addEventListener('tooltipAction', event => {
  console.log(event.detail); // CartesianTooltipActionEventDetail
});

• CartesianTooltipActionEventDetail

  Type definition

chartAnimationStart

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: chartAnimationStart. Names are case-sensitive. Read the payload from detail on CustomEvent<void>.

chart.addEventListener('chartAnimationStart', event => {
  console.log(event.detail); // void
});

chartAnimationEnd

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: chartAnimationEnd. Names are case-sensitive. Read the payload from detail on CustomEvent<void>.

chart.addEventListener('chartAnimationEnd', event => {
  console.log(event.detail); // void
});

chartAnimationInterrupted

CustomEvent.detail type: void. Event names are case-sensitive.

Event name: chartAnimationInterrupted. Names are case-sensitive. Read the payload from detail on CustomEvent<void>.

chart.addEventListener('chartAnimationInterrupted', event => {
  console.log(event.detail); // void
});

zoomChange

Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state.

Event name: zoomChange. Names are case-sensitive. Read the payload from detail on CustomEvent<CartesianZoomChangeEventDetail>.

chart.addEventListener('zoomChange', event => {
  console.log(event.detail); // CartesianZoomChangeEventDetail
});

• CartesianZoomChangeEventDetail

  Type definition

getDataTable

Current normalized table, including the retained stream; independent of GPU availability.

getDataTable(): Promise<ChartDataTable>

Return type: Promise<ChartDataTable>. Call the method after element registration and await its Promise result.

• ChartDataTable

  Type definition

redraw

Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves.

redraw(): Promise<CandlestickRenderResult>

Return type: Promise<CandlestickRenderResult>. Call the method after element registration and await its Promise result.

• CandlestickRenderResult

  Type definition

getActiveTier

An asynchronous method. Check the argument and return types below.

getActiveTier(): Promise<CandlestickEngineTier>

Return type: Promise<CandlestickEngineTier>. Call the method after element registration and await its Promise result.

• CandlestickEngineTier

  Type definition

getUnavailableReason

Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back.

getUnavailableReason(): Promise<string | undefined>

Return type: Promise<string | undefined>. Call the method after element registration and await its Promise result.

setData

Replace the bar set.

setData(data: CandlestickData): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

• CandlestickData

  Type definition

appendPoint

Append one value to the stream. Check the argument type and the licensing requirements for streaming.

appendPoint(bar: CandlestickBarInput): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

• CandlestickBarInput

  Type definition

appendBatch

Append multiple values to the stream. Check the argument type and the licensing requirements for streaming.

appendBatch(bars: ReadonlyArray<CandlestickBarInput>): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

• CandlestickBarInput

  Type definition

shift

Drop the oldest streamed bars (the data bars are not the stream).

shift(count: number): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

replace

Swap the streamed set (replace([]) clears it); the base values never leave. Without chart.streaming the dies upsert into the base like a batch (quietly: no appended, no binChanged, as a ring replace).

replace(bars: ReadonlyArray<CandlestickBarInput>): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

• CandlestickBarInput

  Type definition

getStreamSource

The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.

getStreamSource(): Promise<CandlestickStreamSource | undefined>

Return type: Promise<CandlestickStreamSource | undefined>. Call the method after element registration and await its Promise result.

• CandlestickStreamSource

  Type definition

setAnimation

An asynchronous method. Check the argument and return types below.

setAnimation(options: { duration?: number; easing?: CandlestickEasing; enabled?: boolean; type?: CandlestickAnimationType }): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

• CandlestickEasing

  Type definition

• CandlestickAnimationType

  Type definition

pauseAnimation

Pause the current animation.

pauseAnimation(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

resumeAnimation

Resume a paused animation.

resumeAnimation(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

replayAnimation

Replay the initial sweep from min → value(s). No-op when animation is off / reduced.

replayAnimation(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

hitTest

The bar under a host-local point (the nearest bar within half a pitch, anywhere inside the plot's height).

hitTest(cssX: number, cssY: number): Promise<CandlestickPointEventDetail | null>

Return type: Promise<CandlestickPointEventDetail | null>. Call the method after element registration and await its Promise result.

• CandlestickPointEventDetail

  Type definition

getBar

The normalised bar at an index (null outside).

getBar(index: number): Promise<CandlestickBar | null>

Return type: Promise<CandlestickBar | null>. Call the method after element registration and await its Promise result.

• CandlestickBar

  Type definition

getBarAt

The bar nearest to a time (null for an empty series).

getBarAt(time: number): Promise<(CandlestickBar & { index: number }) | null>

Return type: Promise<(CandlestickBar & { index: number }) | null>. Call the method after element registration and await its Promise result.

• CandlestickBar

  Type definition

getBarCount

An asynchronous method. Check the argument and return types below.

getBarCount(): Promise<number>

Return type: Promise<number>. Call the method after element registration and await its Promise result.

getExtent

An asynchronous method. Check the argument and return types below.

getExtent(): Promise<CandlestickExtent>

Return type: Promise<CandlestickExtent>. Call the method after element registration and await its Promise result.

• CandlestickExtent

  Type definition

getDomain

The data domain the grid spans.

getDomain(): Promise<CandlestickDomain>

Return type: Promise<CandlestickDomain>. Call the method after element registration and await its Promise result.

• CandlestickDomain

  Type definition

getVisibleRange

The bars the plot shows: the x-axis window, narrowed by the zoom when one is in place.

getVisibleRange(): Promise<CandlestickVisibleRange>

Return type: Promise<CandlestickVisibleRange>. Call the method after element registration and await its Promise result.

• CandlestickVisibleRange

  Type definition

showTooltipAtIndex

open the tooltip on a bar by index (null when the tooltip is off or the bar is outside the visible window).

showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>

Return type: Promise<CartesianTooltipEventDetail | null>. Call the method after element registration and await its Promise result.

• CartesianTooltipEventDetail

  Type definition

hideTooltip

Close the currently visible tooltip.

hideTooltip(): Promise<void>

Return type: Promise<void>. Call the method after element registration and await its Promise result.

focusBarAt

move the keyboard focus ring to a bar (null outside the visible window); emits pointHover like the walk.

focusBarAt(index: number): Promise<CandlestickPointEventDetail | null>

Return type: Promise<CandlestickPointEventDetail | null>. Call the method after element registration and await its Promise result.

• CandlestickPointEventDetail

  Type definition

getOverlays

the overlays: each settled spec with where its PRIMARY line exists and what is visible (the outputs and the band ride on the spec).

getOverlays(): Promise<CandlestickOverlayState[]>

Return type: Promise<CandlestickOverlayState[]>. Call the method after element registration and await its Promise result.

• CandlestickOverlayState

  Type definition

getOverlayValues

the overlay values at a bar index: the primary output under the overlay id, the others under id.key (null through a warm-up).

getOverlayValues(index: number): Promise<Record<string, number | null>>

Return type: Promise<Record<string, number | null>>. Call the method after element registration and await its Promise result.

getPanes

the panes: the price pane, the volume pane when it exists, the separator, and why there is none.

getPanes(): Promise<CandlestickPaneRects>

Return type: Promise<CandlestickPaneRects>. Call the method after element registration and await its Promise result.

• CandlestickPaneRects

  Type definition

getTimeScale

the time scale of the visible range: the kind, the slots, the spacing and the ordinal ticks.

getTimeScale(): Promise<CandlestickTimeScaleState>

Return type: Promise<CandlestickTimeScaleState>. Call the method after element registration and await its Promise result.

• CandlestickTimeScaleState

  Type definition

zoomTo

Zoom to explicit windows: x / y as { min, max } or [min, max] (null clears that orientation; x in slots under the ordinal scale — bar i sits at i — or epoch ms under linear, y in price); xAxis / yAxis name the axis by id or slot index (default: the primary axis).

zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>

Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.

• CartesianZoomChangeEventDetail

  Type definition

• CartesianZoomRequest

  Type definition

zoomBy

Scale the current windows by factor (< 1 zooms in) around anchorFraction (0..1, default centre).

zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>

Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.

• CartesianZoomChangeEventDetail

  Type definition

panBy

Slide the zoomed windows by data units ({ x?, y? } — x in slots or ms, y in price); a no-op at the full extent.

panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>

Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.

• CartesianZoomChangeEventDetail

  Type definition

resetZoom

Reset the zoomed or panned range to the original data range.

resetZoom(): Promise<CartesianZoomChangeEventDetail | null>

Return type: Promise<CartesianZoomChangeEventDetail | null>. Call the method after element registration and await its Promise result.

• CartesianZoomChangeEventDetail

  Type definition

getZoom

Read the current zoom range. Check the return type's nullability and the range for each axis.

getZoom(): Promise<CartesianZoomState | null>

Return type: Promise<CartesianZoomState | null>. Call the method after element registration and await its Promise result.

• CartesianZoomState

  Type definition

getZoomExtent

The full extent (and key) of the primary — or the named — master axes (x: the visible slot range −0.5 … n − 0.5 under ordinal, the ms window under linear; y: the fitted price domain).

getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>

Return type: Promise<CartesianZoomExtentDetail | null>. Call the method after element registration and await its Promise result.

• CartesianZoomExtentDetail

  Type definition

• CartesianZoomExtentRequest

  Type definition

getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported.

getEngineStatus(): Promise<ChartEngineStatus>

Return type: Promise<ChartEngineStatus>. Call the method after element registration and await its Promise result.

• ChartEngineStatus

  Type definition