Components
Candlestick chart
Open, high, low and close per period, for prices and other ranged values.
ChartCandlestick draws one candle per period from its open, high, low and close: each point is { x, y: [open, high, low, close] }. Use it for prices, or any value whose range within a period matters.
ChartCandlestick Connecting to the DMS preview…
Usage
src/pages/dashboard.ts
import { ChartCandlestick } from "@antelopejs/interface-dms/base/chart";
static price = ChartCandlestick({
title: "$billing.credits.price",
fetchUrl: "/api/billing/credits/ohlc",
xaxisType: "datetime",
});
The route answers { series } in the shape listed under Data shapes. Wrap the chart in a ChartCard to add a headline value and a comparison.
Options
| Option | Type | Default | Description |
|---|---|---|---|
titleContent | string | – | |
descriptionContent | string | – | |
colorAppearance | string | string[] | – | |
heightAppearance | string | – | |
widthAppearance | number | – | |
showTooltipAppearance | boolean | true | |
showLegendAppearance | boolean | true | |
legendPositionAppearance | "top" | "bottom" | – | |
showGridAppearance | boolean | true | |
yRange.min*Appearance | number | – | |
yRange.max*Appearance | number | – | |
comparisonStyleAppearance | "dashed" | "solid" | "dimmed" | – | |
smoothAppearance | boolean | true | |
curveAppearance | "smooth" | "straight" | "stepline" | – | |
xaxisTypeAppearance | "category" | "datetime" | "numeric" | – |
Recipes
Click a candle
POINT_CLICK carries the candle's tuple in values (value is null), so a watched action can open the period it stands for.

