Candlestick
Compare open, high, low, and close values over time.
Chart ID: candlestick. Independent import: @revolist/charts/candlestick.
Live example
Section titled “Live example”Loading chart…
Reading the chart
Section titled “Reading the chart”Read the high/low wick and the open/close body for each observation. Rising and falling candles use different styling; time placement and price display modes are configurable.
Data requirements
Section titled “Data requirements”Bind open, high, low and close to their numeric series IDs; volume-price additionally needs volume. Use category order, a time axis for instants or a supported numeric X scale for numeric observation coordinates.
The roles below describe the chart's data contract. Generic category/value roles resolve from the dataset; explicitly bind specialized numeric roles as shown in the complete example.
| Data role | Field count |
|---|---|
category | 1 or more |
series | 4 or more |
open | 1 or more |
high | 1 or more |
low | 1 or more |
close | 1 or more |
Download the complete sample data and settings (JSON). See Data & Configuration for mapping, null values, updates and lifecycle rules.
Create this chart
Section titled “Create this chart”Install the package using the installation guide, give the host an explicit height, and call createCandlestickChart after the host mounts. This factory fixes the chart type to candlestick.
<div id="chart" style="width: 100%; height: 450px;"></div>Complete runnable TypeScript example with sample data
import { createCandlestickChart } from '@revolist/charts/candlestick';
const container = document.getElementById('chart')!;const chart = await createCandlestickChart({ container, "dataset": { "revision": 0, "source": "client", "categories": [ { "id": "preview-category-0", "label": "Mon", "path": [ "Mon" ], "labels": [ "Mon" ], "depth": 1, "kind": "leaf" }, { "id": "preview-category-1", "label": "Tue", "path": [ "Tue" ], "labels": [ "Tue" ], "depth": 1, "kind": "leaf" }, { "id": "preview-category-2", "label": "Wed", "path": [ "Wed" ], "labels": [ "Wed" ], "depth": 1, "kind": "leaf" }, { "id": "preview-category-3", "label": "Thu", "path": [ "Thu" ], "labels": [ "Thu" ], "depth": 1, "kind": "leaf" }, { "id": "preview-category-4", "label": "Fri", "path": [ "Fri" ], "labels": [ "Fri" ], "depth": 1, "kind": "leaf" } ], "series": [ { "id": "preview-series-0", "label": "Open", "columnPath": [ "Open" ], "labels": [ "Open" ], "kind": "leaf", "prop": "preview-0" }, { "id": "preview-series-1", "label": "High", "columnPath": [ "High" ], "labels": [ "High" ], "kind": "leaf", "prop": "preview-1" }, { "id": "preview-series-2", "label": "Low", "columnPath": [ "Low" ], "labels": [ "Low" ], "kind": "leaf", "prop": "preview-2" }, { "id": "preview-series-3", "label": "Close", "columnPath": [ "Close" ], "labels": [ "Close" ], "kind": "leaf", "prop": "preview-3" } ], "values": [ [ 42, 48, 39, 46 ], [ 46, 51, 43, 44 ], [ 44, 55, 42, 53 ], [ 53, 57, 49, 51 ], [ 51, 61, 50, 59 ] ], "analyticalFrame": { "fields": [ { "id": "pivot:category", "label": "pivot:category", "role": "dimension", "semanticType": "category" }, { "id": "pivot:series", "label": "pivot:series", "role": "dimension", "semanticType": "category" }, { "id": "preview-series-0", "label": "Open", "role": "measure", "semanticType": "number", "sourceField": "preview-0" }, { "id": "preview-series-1", "label": "High", "role": "measure", "semanticType": "number", "sourceField": "preview-1" }, { "id": "preview-series-2", "label": "Low", "role": "measure", "semanticType": "number", "sourceField": "preview-2" }, { "id": "preview-series-3", "label": "Close", "role": "measure", "semanticType": "number", "sourceField": "preview-3" } ], "observations": [ { "id": "[\"preview-category-0\",\"preview-series-0\"]", "dimensions": { "pivot:category": { "value": "Mon", "label": "Mon", "path": [ "Mon" ], "labels": [ "Mon" ] }, "pivot:series": { "value": "Open", "label": "Open", "path": [ "Open" ], "labels": [ "Open" ] } }, "measures": { "preview-series-0": 42 } }, { "id": "[\"preview-category-0\",\"preview-series-1\"]", "dimensions": { "pivot:category": { "value": "Mon", "label": "Mon", "path": [ "Mon" ], "labels": [ "Mon" ] }, "pivot:series": { "value": "High", "label": "High", "path": [ "High" ], "labels": [ "High" ] } }, "measures": { "preview-series-1": 48 } }, { "id": "[\"preview-category-0\",\"preview-series-2\"]", "dimensions": { "pivot:category": { "value": "Mon", "label": "Mon", "path": [ "Mon" ], "labels": [ "Mon" ] }, "pivot:series": { "value": "Low", "label": "Low", "path": [ "Low" ], "labels": [ "Low" ] } }, "measures": { "preview-series-2": 39 } }, { "id": "[\"preview-category-0\",\"preview-series-3\"]", "dimensions": { "pivot:category": { "value": "Mon", "label": "Mon", "path": [ "Mon" ], "labels": [ "Mon" ] }, "pivot:series": { "value": "Close", "label": "Close", "path": [ "Close" ], "labels": [ "Close" ] } }, "measures": { "preview-series-3": 46 } }, { "id": "[\"preview-category-1\",\"preview-series-0\"]", "dimensions": { "pivot:category": { "value": "Tue", "label": "Tue", "path": [ "Tue" ], "labels": [ "Tue" ] }, "pivot:series": { "value": "Open", "label": "Open", "path": [ "Open" ], "labels": [ "Open" ] } }, "measures": { "preview-series-0": 46 } }, { "id": "[\"preview-category-1\",\"preview-series-1\"]", "dimensions": { "pivot:category": { "value": "Tue", "label": "Tue", "path": [ "Tue" ], "labels": [ "Tue" ] }, "pivot:series": { "value": "High", "label": "High", "path": [ "High" ], "labels": [ "High" ] } }, "measures": { "preview-series-1": 51 } }, { "id": "[\"preview-category-1\",\"preview-series-2\"]", "dimensions": { "pivot:category": { "value": "Tue", "label": "Tue", "path": [ "Tue" ], "labels": [ "Tue" ] }, "pivot:series": { "value": "Low", "label": "Low", "path": [ "Low" ], "labels": [ "Low" ] } }, "measures": { "preview-series-2": 43 } }, { "id": "[\"preview-category-1\",\"preview-series-3\"]", "dimensions": { "pivot:category": { "value": "Tue", "label": "Tue", "path": [ "Tue" ], "labels": [ "Tue" ] }, "pivot:series": { "value": "Close", "label": "Close", "path": [ "Close" ], "labels": [ "Close" ] } }, "measures": { "preview-series-3": 44 } }, { "id": "[\"preview-category-2\",\"preview-series-0\"]", "dimensions": { "pivot:category": { "value": "Wed", "label": "Wed", "path": [ "Wed" ], "labels": [ "Wed" ] }, "pivot:series": { "value": "Open", "label": "Open", "path": [ "Open" ], "labels": [ "Open" ] } }, "measures": { "preview-series-0": 44 } }, { "id": "[\"preview-category-2\",\"preview-series-1\"]", "dimensions": { "pivot:category": { "value": "Wed", "label": "Wed", "path": [ "Wed" ], "labels": [ "Wed" ] }, "pivot:series": { "value": "High", "label": "High", "path": [ "High" ], "labels": [ "High" ] } }, "measures": { "preview-series-1": 55 } }, { "id": "[\"preview-category-2\",\"preview-series-2\"]", "dimensions": { "pivot:category": { "value": "Wed", "label": "Wed", "path": [ "Wed" ], "labels": [ "Wed" ] }, "pivot:series": { "value": "Low", "label": "Low", "path": [ "Low" ], "labels": [ "Low" ] } }, "measures": { "preview-series-2": 42 } }, { "id": "[\"preview-category-2\",\"preview-series-3\"]", "dimensions": { "pivot:category": { "value": "Wed", "label": "Wed", "path": [ "Wed" ], "labels": [ "Wed" ] }, "pivot:series": { "value": "Close", "label": "Close", "path": [ "Close" ], "labels": [ "Close" ] } }, "measures": { "preview-series-3": 53 } }, { "id": "[\"preview-category-3\",\"preview-series-0\"]", "dimensions": { "pivot:category": { "value": "Thu", "label": "Thu", "path": [ "Thu" ], "labels": [ "Thu" ] }, "pivot:series": { "value": "Open", "label": "Open", "path": [ "Open" ], "labels": [ "Open" ] } }, "measures": { "preview-series-0": 53 } }, { "id": "[\"preview-category-3\",\"preview-series-1\"]", "dimensions": { "pivot:category": { "value": "Thu", "label": "Thu", "path": [ "Thu" ], "labels": [ "Thu" ] }, "pivot:series": { "value": "High", "label": "High", "path": [ "High" ], "labels": [ "High" ] } }, "measures": { "preview-series-1": 57 } }, { "id": "[\"preview-category-3\",\"preview-series-2\"]", "dimensions": { "pivot:category": { "value": "Thu", "label": "Thu", "path": [ "Thu" ], "labels": [ "Thu" ] }, "pivot:series": { "value": "Low", "label": "Low", "path": [ "Low" ], "labels": [ "Low" ] } }, "measures": { "preview-series-2": 49 } }, { "id": "[\"preview-category-3\",\"preview-series-3\"]", "dimensions": { "pivot:category": { "value": "Thu", "label": "Thu", "path": [ "Thu" ], "labels": [ "Thu" ] }, "pivot:series": { "value": "Close", "label": "Close", "path": [ "Close" ], "labels": [ "Close" ] } }, "measures": { "preview-series-3": 51 } }, { "id": "[\"preview-category-4\",\"preview-series-0\"]", "dimensions": { "pivot:category": { "value": "Fri", "label": "Fri", "path": [ "Fri" ], "labels": [ "Fri" ] }, "pivot:series": { "value": "Open", "label": "Open", "path": [ "Open" ], "labels": [ "Open" ] } }, "measures": { "preview-series-0": 51 } }, { "id": "[\"preview-category-4\",\"preview-series-1\"]", "dimensions": { "pivot:category": { "value": "Fri", "label": "Fri", "path": [ "Fri" ], "labels": [ "Fri" ] }, "pivot:series": { "value": "High", "label": "High", "path": [ "High" ], "labels": [ "High" ] } }, "measures": { "preview-series-1": 61 } }, { "id": "[\"preview-category-4\",\"preview-series-2\"]", "dimensions": { "pivot:category": { "value": "Fri", "label": "Fri", "path": [ "Fri" ], "labels": [ "Fri" ] }, "pivot:series": { "value": "Low", "label": "Low", "path": [ "Low" ], "labels": [ "Low" ] } }, "measures": { "preview-series-2": 50 } }, { "id": "[\"preview-category-4\",\"preview-series-3\"]", "dimensions": { "pivot:category": { "value": "Fri", "label": "Fri", "path": [ "Fri" ], "labels": [ "Fri" ] }, "pivot:series": { "value": "Close", "label": "Close", "path": [ "Close" ], "labels": [ "Close" ] } }, "measures": { "preview-series-3": 59 } } ], "matrixCells": [ { "categoryId": "preview-category-0", "seriesId": "preview-series-0", "observationId": "[\"preview-category-0\",\"preview-series-0\"]", "measureFieldId": "preview-series-0" }, { "categoryId": "preview-category-0", "seriesId": "preview-series-1", "observationId": "[\"preview-category-0\",\"preview-series-1\"]", "measureFieldId": "preview-series-1" }, { "categoryId": "preview-category-0", "seriesId": "preview-series-2", "observationId": "[\"preview-category-0\",\"preview-series-2\"]", "measureFieldId": "preview-series-2" }, { "categoryId": "preview-category-0", "seriesId": "preview-series-3", "observationId": "[\"preview-category-0\",\"preview-series-3\"]", "measureFieldId": "preview-series-3" }, { "categoryId": "preview-category-1", "seriesId": "preview-series-0", "observationId": "[\"preview-category-1\",\"preview-series-0\"]", "measureFieldId": "preview-series-0" }, { "categoryId": "preview-category-1", "seriesId": "preview-series-1", "observationId": "[\"preview-category-1\",\"preview-series-1\"]", "measureFieldId": "preview-series-1" }, { "categoryId": "preview-category-1", "seriesId": "preview-series-2", "observationId": "[\"preview-category-1\",\"preview-series-2\"]", "measureFieldId": "preview-series-2" }, { "categoryId": "preview-category-1", "seriesId": "preview-series-3", "observationId": "[\"preview-category-1\",\"preview-series-3\"]", "measureFieldId": "preview-series-3" }, { "categoryId": "preview-category-2", "seriesId": "preview-series-0", "observationId": "[\"preview-category-2\",\"preview-series-0\"]", "measureFieldId": "preview-series-0" }, { "categoryId": "preview-category-2", "seriesId": "preview-series-1", "observationId": "[\"preview-category-2\",\"preview-series-1\"]", "measureFieldId": "preview-series-1" }, { "categoryId": "preview-category-2", "seriesId": "preview-series-2", "observationId": "[\"preview-category-2\",\"preview-series-2\"]", "measureFieldId": "preview-series-2" }, { "categoryId": "preview-category-2", "seriesId": "preview-series-3", "observationId": "[\"preview-category-2\",\"preview-series-3\"]", "measureFieldId": "preview-series-3" }, { "categoryId": "preview-category-3", "seriesId": "preview-series-0", "observationId": "[\"preview-category-3\",\"preview-series-0\"]", "measureFieldId": "preview-series-0" }, { "categoryId": "preview-category-3", "seriesId": "preview-series-1", "observationId": "[\"preview-category-3\",\"preview-series-1\"]", "measureFieldId": "preview-series-1" }, { "categoryId": "preview-category-3", "seriesId": "preview-series-2", "observationId": "[\"preview-category-3\",\"preview-series-2\"]", "measureFieldId": "preview-series-2" }, { "categoryId": "preview-category-3", "seriesId": "preview-series-3", "observationId": "[\"preview-category-3\",\"preview-series-3\"]", "measureFieldId": "preview-series-3" }, { "categoryId": "preview-category-4", "seriesId": "preview-series-0", "observationId": "[\"preview-category-4\",\"preview-series-0\"]", "measureFieldId": "preview-series-0" }, { "categoryId": "preview-category-4", "seriesId": "preview-series-1", "observationId": "[\"preview-category-4\",\"preview-series-1\"]", "measureFieldId": "preview-series-1" }, { "categoryId": "preview-category-4", "seriesId": "preview-series-2", "observationId": "[\"preview-category-4\",\"preview-series-2\"]", "measureFieldId": "preview-series-2" }, { "categoryId": "preview-category-4", "seriesId": "preview-series-3", "observationId": "[\"preview-category-4\",\"preview-series-3\"]", "measureFieldId": "preview-series-3" } ] } }, "bindings": { "open": [ "preview-series-0" ], "high": [ "preview-series-1" ], "low": [ "preview-series-2" ], "close": [ "preview-series-3" ] }, "presentation": { "dataLabels": false }});
// When the host unmounts:// chart.destroy();Await updates before reading a snapshot or exporting. Call chart.destroy() when the host unmounts. See the live catalog to interact with this type.
Supported options
Section titled “Supported options”Set these fields in chartOptions. The option schema validates supported keys, ranges and choices; updating chartOptions replaces that authored object.
| Option | Default | Accepted values |
|---|---|---|
showGridLines | true | true or false |
markOpacity | 1 | 0.2 to 1; step 0.05 |
priceStyle | candlestick | candlestick, ohlc, hlc, highLow, line, stepLine |
candleFill | legacy | legacy, filled, hollow |
Configure price scales, bounds, reversal, tick policy, formatting and placement through axes.y, secondary and named value axes. Close-owned OHLC groups can also target independent named X axes. Marks clip to the authored price domain, and axis labels use measured gutters. See price-axis options and limits.
Titles, legends, theme and labels belong to presentation or the corresponding top-level setting. Axis, color, navigation and interaction support depends on the selected chart; see Data & Configuration.
Related charts
Section titled “Related charts”- OHLC — Show open, high, low, and close values with compact ticks.
- Volume and price — Compare price movement with trading volume.
Charts overview · Installation · Data & Configuration
Use primary axes.x for category, time or numeric (linear, log, symlog, sqrt) observation coordinates. data maps and path level selection preserve source identities. See financial numeric X axes for ticks, windows, aligned price/volume panes, Pivot controls and limits.
Bind multiple OHLC groups with parallel open/high/low/close arrays. Each close field owns its group and its X/Y assignments. See candlestick and OHLC collections for helper broadcasts, named axes, grouped slots and Pivot controls.
Use Financial sessions and the trading toolbar for explicit exchange-session or ordinal time spacing, supplied named-zone calendars and the shared navigation/drawing controls. Omission retains continuous time and source timestamps.