IChartCandlestickDatum

interface
Chart

One OHLC data point in a candlestick series. Supplies the date label plus the four price levels (open, high, low, close) for the period. A datum missing any of the four price fields is silently skipped by the chart.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

date
required
string
ISO date string or any human-readable label rendered on the X axis.
open
required
number
Opening price of the period.
high
required
number
Highest price of the period.
low
required
number
Lowest price of the period.
close
required
number
Closing price of the period.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Providing OHLC data for a candlestick chart

typescript