OHLC.

PRO

Read four prices from a high-low line and open-close ticks.

Live preview20 feature examples

LIVE EXAMPLE

OHLC bars

Match the page theme
Interact with the chart to see selection and range-change results here.
OptionsChanges are reflected in the preview and code.
Appearance and style8
Axes and grid lines11
Legend and interaction13
Title and dimensions3

Show the four prices with thin lines and ticks. All values are sample data.

View code
Current preview
<div id="chart-container" style="width: 100%; min-width: 0;"></div>

<script type="module">
  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-ohlc-chart.js';
  define0();

  // Pro: complete registerLicense at app startup using your issued certificate.
  // The website preview certificate is not for use in customer apps.
  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-ohlc-chart",
      "props": {
        "data": [
          {
            "time": 1767225600000,
            "open": 100,
            "close": 95,
            "high": 103,
            "low": 92,
            "volume": 1200
          },
          {
            "time": 1767312000000,
            "open": 104,
            "close": 106,
            "high": 109,
            "low": 101,
            "volume": 1337
          },
          {
            "time": 1767398400000,
            "open": 107,
            "close": 105,
            "high": 110,
            "low": 102,
            "volume": 1474
          },
          {
            "time": 1767484800000,
            "open": 109,
            "close": 114,
            "high": 117,
            "low": 106,
            "volume": 1611
          },
          {
            "time": 1767571200000,
            "open": 108,
            "close": 109,
            "high": 112,
            "low": 105,
            "volume": 1748
          },
          {
            "time": 1767657600000,
            "open": 106,
            "close": 103,
            "high": 109,
            "low": 100,
            "volume": 1885
          },
          {
            "time": 1767744000000,
            "open": 102,
            "close": 106,
            "high": 109,
            "low": 99,
            "volume": 2022
          },
          {
            "time": 1767830400000,
            "open": 100,
            "close": 100,
            "high": 103,
            "low": 97,
            "volume": 2159
          },
          {
            "time": 1767916800000,
            "open": 98,
            "close": 94,
            "high": 101,
            "low": 91,
            "volume": 2296
          },
          {
            "time": 1768003200000,
            "open": 99,
            "close": 102,
            "high": 105,
            "low": 96,
            "volume": 2433
          },
          {
            "time": 1768089600000,
            "open": 101,
            "close": 100,
            "high": 104,
            "low": 97,
            "volume": 2570
          },
          {
            "time": 1768176000000,
            "open": 105,
            "close": 100,
            "high": 108,
            "low": 97,
            "volume": 2707
          },
          {
            "time": 1768262400000,
            "open": 109,
            "close": 111,
            "high": 114,
            "low": 106,
            "volume": 2844
          },
          {
            "time": 1768348800000,
            "open": 113,
            "close": 111,
            "high": 116,
            "low": 108,
            "volume": 2981
          },
          {
            "time": 1768435200000,
            "open": 115,
            "close": 120,
            "high": 123,
            "low": 112,
            "volume": 1318
          },
          {
            "time": 1768521600000,
            "open": 115,
            "close": 116,
            "high": 119,
            "low": 112,
            "volume": 1455
          },
          {
            "time": 1768608000000,
            "open": 114,
            "close": 111,
            "high": 117,
            "low": 108,
            "volume": 1592
          },
          {
            "time": 1768694400000,
            "open": 111,
            "close": 115,
            "high": 118,
            "low": 108,
            "volume": 1729
          },
          {
            "time": 1768780800000,
            "open": 108,
            "close": 108,
            "high": 111,
            "low": 105,
            "volume": 1866
          },
          {
            "time": 1768867200000,
            "open": 105,
            "close": 101,
            "high": 108,
            "low": 98,
            "volume": 2003
          },
          {
            "time": 1768953600000,
            "open": 105,
            "close": 108,
            "high": 111,
            "low": 102,
            "volume": 2140
          },
          {
            "time": 1769040000000,
            "open": 107,
            "close": 106,
            "high": 110,
            "low": 103,
            "volume": 2277
          },
          {
            "time": 1769126400000,
            "open": 110,
            "close": 105,
            "high": 113,
            "low": 102,
            "volume": 2414
          },
          {
            "time": 1769212800000,
            "open": 114,
            "close": 116,
            "high": 119,
            "low": 111,
            "volume": 2551
          },
          {
            "time": 1769299200000,
            "open": 119,
            "close": 117,
            "high": 122,
            "low": 114,
            "volume": 2688
          },
          {
            "time": 1769385600000,
            "open": 121,
            "close": 126,
            "high": 129,
            "low": 118,
            "volume": 2825
          },
          {
            "time": 1769472000000,
            "open": 123,
            "close": 124,
            "high": 127,
            "low": 120,
            "volume": 2962
          },
          {
            "time": 1769558400000,
            "open": 121,
            "close": 118,
            "high": 124,
            "low": 115,
            "volume": 1299
          },
          {
            "time": 1769644800000,
            "open": 119,
            "close": 123,
            "high": 126,
            "low": 116,
            "volume": 1436
          },
          {
            "time": 1769731200000,
            "open": 116,
            "close": 116,
            "high": 119,
            "low": 113,
            "volume": 1573
          },
          {
            "time": 1769817600000,
            "open": 113,
            "close": 109,
            "high": 116,
            "low": 106,
            "volume": 1710
          },
          {
            "time": 1769904000000,
            "open": 112,
            "close": 115,
            "high": 118,
            "low": 109,
            "volume": 1847
          }
        ],
        "barStyle": "ohlc",
        "timeScale": "ordinal",
        "width": 640,
        "height": 360,
        "brandPosition": "bottom-right",
        "brandLogo": ""
      }
    }
  ];
  const container = document.querySelector('#chart-container');
  const elements = specs.map(({ tag, id, props }) => {
    const element = document.createElement(tag);
    element.id = id;
    Object.assign(element, props);
    element.setAttribute('aria-label', 'ohlc example chart');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  const observer = new ResizeObserver(([entry]) => {
    const width = Math.max(160, Math.floor(entry.contentRect.width));
    elements.forEach(element => { element.width = width; });
  });
  observer.observe(container);

  // In an SPA, call this function when the view is disposed.
  function disposeChart() {
    observer.disconnect();
    container.replaceChildren();
  }
</script>

Usage and data

#

Use to display many price bars compactly.

Uses the same data format as Candlestick. Keep time zones and intervals consistent.

Data contract

PropertyInput format
dataA price array with time, open, high, low, and close.
barStyleThe tick style: ohlc, hlc, or hilo.

Updating data

Assign a new array or object to the property instead of mutating values inside an array. Chart events provide selection results through event.detail. When disposing of the view, clean up ResizeObserver and event listeners registered by your app.

Feature examples

#

Try 20 interactive feature examples and inspect their code. Select “Edit in preview” to combine more options in the settings panel above.

HLC representationPRO

Show high, low, and close prices without the opening-price tick.

Interact with the chart to see results here.
View code

Volume panelPRO

Show volume below prices on the same time axis.

Interact with the chart to see results here.
View code

Inspect values with the pointerPRO

Point to data to view the value at that location.

Interact with the chart to see results here.
View code

Crosshair trackingPRO

Move the pointer to read horizontal and vertical coordinates alongside values.

Interact with the chart to see results here.
View code

Drag to zoom and panPRO

Drag to zoom and hold Shift to pan. Use Ctrl + wheel to zoom in or out.

Interact with the chart to see results here.
View code

Replay animationPRO

Redraw the same example to inspect its initial display animation.

Interact with the chart to see results here.
View code

AnimationPRO

Compare 1 examples of Animation. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

AxisPRO

Compare 5 examples of Axis. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

CrosshairPRO

Compare 5 examples of Crosshair. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Data inputPRO

Compare 1 examples of Data input. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Large datasetsPRO

Compare 1 examples of Large datasets. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

SizePRO

Compare 1 examples of Size. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

StylePRO

Compare 4 examples of Style. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

TooltipPRO

Compare 13 examples of Tooltip. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Zoom and panPRO

Compare 6 examples of Zoom and pan. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Context menuPRO

Compare 1 examples of Context menu. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Data context menuPRO

Compare 1 examples of Data context menu. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Read coordinates and dataPRO

Compare 1 examples of Read coordinates and data. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

OverviewPRO

Compare 4 examples of Overview. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

Streaming · Add and update live dataPRO

Compare 6 examples of Add and update live data. Buttons and options update both the live result and source code.

Interact with the chart to see results here.
View code

API reference

#

The full public API for sy-ohlc-chart. Pass objects and arrays as JavaScript properties. Select a name to view usage code and type definitions.

Key properties

Attribute / PropertyType / DefaultDescription
barStyle'ohlc' | 'hlc' | 'hilo'Default: 'ohlc'The tick style: ohlc, hlc, or hilo.
CandlestickDataDefault: undefinedA price array with time, open, high, low, and close.
numberDefault: 900Chart width in pixels. Update with ResizeObserver when the container changes.
numberDefault: 360Chart height in pixels.
brandLogostringDefault: undefinedThe default is the Syidax logo. With the Pro chart.branding entitlement, use none or a PNG, JPEG, or WebP data URL.
brandPosition'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'Default: 'bottom-right'The corner where the logo is anchored. Applies equally to Community and Pro, on screen and in image exports.
xAxisCartesianAxisInputDefault: undefinedAllowed values: auto, off. Default: undefined.
yAxisYAxisInputDefault: undefinedAllowed values: auto, off. Default: undefined.
gridLinesCartesianGridLinesInputDefault: undefinedAllowed values: auto, off. Default: undefined.
CartesianCrosshairInputDefault: undefinedCrosshair that follows the cursor across the plot (forwarded; the inner `crosshairMove` bubbles through the host).
CartesianZoomInputDefault: undefinedSettings for zooming and the visible range.
upColorstringDefault: '#26a69a'Set as an HTML attribute or JavaScript property. type: string.
downColorstringDefault: '#ef5350'Set as an HTML attribute or JavaScript property. type: string.
candleWidthnumberDefault: 0.7The tick length's share of the bar pitch (the candle body ratio; 0.7 by default).
wickWidthnumberDefault: 1The spine and tick thickness in CSS px.
timeScaleCandlestickTimeScaleDefault: 'ordinal'Allowed values: linear, ordinal. Default: 'ordinal'.
CandlestickVolumeModeDefault: 'off'Allowed values: off, pane. Default: 'off'.
volumeHeightnumberDefault: 0.25Set as an HTML attribute or JavaScript property. type: number.
chartTitlestringDefault: undefinedThe title inside the chart. Explain the data's unit and meaning alongside it.
chartSubtitlestringDefault: undefinedThe subtitle inside the chart.
CartesianTooltipInputDefault: undefinedTooltip settings for pointer-driven values, position, and content.
tooltipEnabledbooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
animatedbooleanDefault: falseWhether to animate initial display and data changes.
animationDurationnumberDefault: 600Animation duration in milliseconds.
animationEasingCandlestickEasingDefault: 'ease-out'Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.
animationTypeCandlestickAnimationTypeDefault: undefinedAllowed values: initial, update. Default: undefined.
Other properties 29
Attribute / PropertyType / DefaultDescription
xMinnumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
xMaxnumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
yMinnumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
yMaxnumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
numberDefault: 0.05Set as an HTML attribute or JavaScript property. type: number.
flatColorstringDefault: '#9ca3af'Set as an HTML attribute or JavaScript property. type: string.
candleMinPxnumberDefault: 1Set as an HTML attribute or JavaScript property. type: number.
candleMaxPxnumberDefault: 40Set as an HTML attribute or JavaScript property. type: number.
tickLengthnumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
fillAlphanumberDefault: undefinedSet as an HTML attribute or JavaScript property. type: number.
bodyMinPxnumberDefault: 1Set as an HTML attribute or JavaScript property. type: number.
bodyStyleCandlestickBodyStyleDefault: 'solid'Candle-only lanes, forwarded for parity (an OHLC bar has no body to hollow).
bodyBorderPxnumberDefault: 1Set as an HTML attribute or JavaScript property. type: number.
wickColorstringDefault: 'auto'Set as an HTML attribute or JavaScript property. type: string.
CandlestickAntialiasDefault: 'auto'Allowed values: auto, off, on. Default: 'auto'.
pixelSnapbooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
CandlestickSessionInput | stringDefault: '24x7'Pass as a JavaScript property. type: CandlestickSessionInput | string.
labelLocalestringDefault: 'en-US'Set as an HTML attribute or JavaScript property. type: string.
volumeUpColorstringDefault: 'auto'Set as an HTML attribute or JavaScript property. type: string.
volumeDownColorstringDefault: 'auto'Set as an HTML attribute or JavaScript property. type: string.
volumeAlphanumberDefault: 0.45Set as an HTML attribute or JavaScript property. type: number.
CandlestickOverlayInput | stringDefault: undefinedPass as a JavaScript property. type: CandlestickOverlayInput | string.
enableMouseTrackingbooleanDefault: trueSet as an HTML attribute or JavaScript property. type: boolean.
tooltipFormat(detail: CandlestickPointEventDetail) => stringDefault: undefinedPass as a JavaScript property. type: (detail: CandlestickPointEventDetail) => string.
streamSourceCandlestickStreamSourceDefault: undefinedA stream source for live data. Check the contract for the specific type.
streamMaxnumberDefault: undefinedThe maximum number of streaming data points to retain.
streamWindownumberDefault: undefinedThe streaming data range to keep visible.
CandlestickEngineModeDefault: 'auto'Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.
CandlestickUnavailableBehaviourDefault: 'fallback'Allowed values: fallback, error. Default: 'fallback'.
Methods 35

Stencil methods return Promises. Use await within an async function to read the result.

Method / ArgumentsReturn typeDescription
Promise<ChartDataTable>Current normalized table, including the retained stream; independent of GPU availability.
Promise<CandlestickRenderResult>An asynchronous method. Check the argument and return types below.
Promise<CandlestickEngineTier>An asynchronous method. Check the argument and return types below.
Promise<string | undefined>An asynchronous method. Check the argument and return types below.
data: CandlestickDataPromise<void>An asynchronous method. Check the argument and return types below.
bar: CandlestickBarInputPromise<void>An asynchronous method. Check the argument and return types below.
bars: ReadonlyArray<CandlestickBarInput>Promise<void>An asynchronous method. Check the argument and return types below.
count: numberPromise<void>An asynchronous method. Check the argument and return types below.
bars: ReadonlyArray<CandlestickBarInput>Promise<void>An asynchronous method. Check the argument and return types below.
Promise<CandlestickStreamSource | undefined>An asynchronous method. Check the argument and return types below.
options: { duration?: number; easing?: CandlestickEasing; enabled?: boolean; type?: CandlestickAnimationType }Promise<void>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
cssX: number, cssY: numberPromise<CandlestickPointEventDetail | null>An asynchronous method. Check the argument and return types below.
index: numberPromise<CandlestickBar | null>An asynchronous method. Check the argument and return types below.
time: numberPromise<(CandlestickBar & { index: number }) | null>An asynchronous method. Check the argument and return types below.
Promise<number>An asynchronous method. Check the argument and return types below.
Promise<CandlestickExtent>An asynchronous method. Check the argument and return types below.
Promise<CandlestickDomain>An asynchronous method. Check the argument and return types below.
Promise<CandlestickVisibleRange>An asynchronous method. Check the argument and return types below.
index: numberPromise<CartesianTooltipEventDetail | null>An asynchronous method. Check the argument and return types below.
Promise<void>An asynchronous method. Check the argument and return types below.
index: numberPromise<CandlestickPointEventDetail | null>An asynchronous method. Check the argument and return types below.
Promise<CandlestickOverlayState[]>An asynchronous method. Check the argument and return types below.
index: numberPromise<Record<string, number | null>>An asynchronous method. Check the argument and return types below.
Promise<CandlestickPaneRects>An asynchronous method. Check the argument and return types below.
Promise<CandlestickTimeScaleState>An asynchronous method. Check the argument and return types below.
request: CartesianZoomRequestPromise<CartesianZoomChangeEventDetail | null>An asynchronous method. Check the argument and return types below.
factor: number, anchorFraction?: numberPromise<CartesianZoomChangeEventDetail | null>An asynchronous method. Check the argument and return types below.
delta: { x?: number; y?: number }Promise<CartesianZoomChangeEventDetail | null>An asynchronous method. Check the argument and return types below.
Promise<CartesianZoomChangeEventDetail | null>An asynchronous method. Check the argument and return types below.
Promise<CartesianZoomState | null>An asynchronous method. Check the argument and return types below.
request?: CartesianZoomExtentRequestPromise<CartesianZoomExtentDetail | null>An asynchronous method. Check the argument and return types below.
Promise<ChartEngineStatus>Requested engine vs what runs, and why (CHART-ADD-08): the inner candlestick's own status once it is mounted (it gates chart.type.ohlc and chart.type.candlestick); before that, this proxy's chart.type.ohlc decision, read without side effects.

OHLC forwards bubbling events from its internal Candlestick chart, including pointClick, pointHover, and rendered.