Skip to content
silverpoint
Documentation menu

Charts · Bars

CandlestickChart

OHLC bodies and wicks. Family: Bars · chart 12 of 60.
Share priceShare price
Share price
timeopenhighlowclose
Mon10210899106
Tue106109101103
Wed1031059799
Thu9910496103
Fri103111102110
Mon110114107108
Tue108110104109
Wed109116108115
Share priceShare price
Share price
timeopenhighlowclose
Mon10210899106
Tue106109101103
Wed1031059799
Thu9910496103
Fri103111102110
Mon110114107108
Tue108110104109
Wed109116108115
mode="precision"
Share priceShare price
Share price
timeopenhighlowclose
Mon10210899106
Tue106109101103
Wed1031059799
Thu9910496103
Fri103111102110
Mon110114107108
Tue108110104109
Wed109116108115
substrate="green"
Share priceShare price
Share price
timeopenhighlowclose
Mon10210899106
Tue106109101103
Wed1031059799
Thu9910496103
Fri103111102110
Mon110114107108
Tue108110104109
Wed109116108115
ground="cyanotype"

Example

The chart above, in each framework. Pick a framework once and every example on the site follows it.

shell
npm install @silverpoint/react @silverpoint/grounds @silverpoint/fonts
tsx
import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import { CandlestickChart } from '@silverpoint/react/candlestick-chart';

const data = [
  { time: 'Mon', open: 102, high: 108, low: 99, close: 106 },
  { time: 'Tue', open: 106, high: 109, low: 101, close: 103 },
  { time: 'Wed', open: 103, high: 105, low: 97, close: 99 },
  { time: 'Thu', open: 99, high: 104, low: 96, close: 103 },
  { time: 'Fri', open: 103, high: 111, low: 102, close: 110 },
  { time: 'Mon', open: 110, high: 114, low: 107, close: 108 },
  { time: 'Tue', open: 108, high: 110, low: 104, close: 109 },
  { time: 'Wed', open: 109, high: 116, low: 108, close: 115 },
];

export default function App() {
  return (
    <div style={{ width: 480 }}>
      <CandlestickChart
        data={data}
        timeKey="time"
        openKey="open"
        highKey="high"
        lowKey="low"
        closeKey="close"
        title="Share price"
      />
    </div>
  );
}

Import

Each chart has its own subpath, so a bundle only carries the charts it uses. Every adapter also exports every chart from its barrel.

FrameworkImport
Reactimport { CandlestickChart } from '@silverpoint/react/candlestick-chart';
Vueimport { SpCandlestickChart } from '@silverpoint/vue/candlestick-chart';
Angularimport { SpCandlestickChart } from '@silverpoint/angular/candlestick-chart'; // <sp-candlestick-chart>
Reflexfrom reflex_silverpoint_react import candlestick_chart

Props

The props CandlestickChart adds to the ones every chart takes. Accessor props (…Key, keys, names) name fields of your rows and are ignored without data.

React / AngularVueReflexTypeDescription
timeKeytime-keytime_keyAccessor<string | number>—
openKeyopen-keyopen_keyAccessor<number | null | undefined>—
highKeyhigh-keyhigh_keyAccessor<number | null | undefined>—
lowKeylow-keylow_keyAccessor<number | null | undefined>—
closeKeyclose-keyclose_keyAccessor<number | null | undefined>—
boundsboundsboundsreadonly [number, number]Price bounds of the scale; derived from the data when omitted (REQ-097).

Common props

Every chart also takes these. Framework conventions: camelCase in React and Angular, kebab-case in Vue templates, snake_case in Reflex. Read more about them.

Show the 22 common props
React / AngularVueReflexTypeDescription
datadatadatareadonly Datum[]Rows to draw. If omitted, the demo dataset is rendered (REQ-093) and the accessor props (…_key, keys, names) are ignored.
groundgroundgroundGroundRefStyle ground: silverpoint or cyanotype, or a ground object. Defaults to the app provider's, or silverpoint.
substratesubstratesubstrateSubstrateNamePrepared substrate within the ground (REQ-046).
modemodemodeInkModeink by default; precision disables inking (REQ-021).
seedseedseedSeedSeed. If omitted, it is derived from id stably (REQ-003).
idididstringStable identifier. If omitted, it is generated deterministically.
heightheightheightnumberHeight of the drawing area in px. Width is the container's unless pinned.
widthwidthwidthnumber—
chromechromechrome'card' | 'bare'card draws the full frame; bare only the drawing area (REQ-095).
hatchFillhatch-fillhatch_fill'tile' | 'per-shape'How areas are filled (REQ-029).
titletitletitlestring—
badgebadgebadgestring—
valuevaluevaluestring | number—
unitunitunitstring—
footerLeftfooter-leftfooter_leftstring—
footerRightfooter-rightfooter_rightstring—
labellabellabelstringAccessible name. If omitted, it is derived from title (REQ-120).
descriptiondescriptiondescriptionstringLong description for screen readers (REQ-120).
dataTabledata-tabledata_table'visible' | 'hidden' | 'none'Tabular alternative; hidden leaves it for assistive technology only (REQ-121).
localelocalelocalestring—
numberFormatnumber-formatnumber_formatIntl.NumberFormatOptions—
classNameclass-nameclass_namestring—

Events

Pointer and keyboard exploration are built in. The item under the pointer or focus is reported, and a click, Enter or Space selects it. The item is { seriesKey, index, datum, value, point: { x, y } }.

FrameworkActive itemSelectionCustom readout
ReactonActiveChangeonSelecttooltip={(item, readout) => …}
Vue@active-change@select<template #tooltip>
Angular(activeChange)(select)<ng-template spTooltip>
Reflexon_active_changeon_selecttooltip=tooltip_template(…)
Interaction and readouts →
Report it
Found something wrong with CandlestickChart? Open an issue on GitHub — the form comes pre-filled with the chart and the version.