@kumo-charts/core/chart-types
The API reference is generated from the source comments.
import { … } from '@kumo-charts/core/chart-types';
Functions
chartTypesfunctionSource
function chartTypes(types: readonly ChartType[] = []): ChartTypesModule
The chart types module, with the chart types given, such as chartTypes(allChartTypes) or
chartTypes([heikinAshi, renko]): their transforms join chart.transforms, their series types
chart.series.
Interfaces
ChartTypeinterfaceSource
interface ChartType
A chart type: how its bars are built from the bars of the timeframe (transform, set with
chart.transforms.set()), how they are drawn (series, the main series' type), or both, as
Kagi lines are.
readonly transform?: BarTransformDefinitionreadonly series?: SeriesTypeDefinition<object>Types
ChartTypesModuletypeSource
type ChartTypesModule = ChartModule
Adds nothing to the chart's API: its types join chart.transforms and chart.series.
PointFigureSourcetypeSource
type PointFigureSource = 'close' | 'hl'
What a point & figure chart is plotted from: the closes, or the highs and lows.
RenkoSourcetypeSource
type RenkoSource = 'close' | 'ohlc'
What Renko bricks are built from: the closes, or the open, high, low and close of each bar.
Variables
allChartTypesvariableSource
const allChartTypes: readonly ChartType[]
Every chart type of the library, for chartTypes(allChartTypes).
heikinAshivariableSource
const heikinAshi: ChartType
Heikin-Ashi candles, each from the average of its bar and the one before.
kagivariableSource
const kagi: ChartType
Kagi lines, thick where they pass the last shoulder and thin under the last waist.
lineBreakvariableSource
const lineBreak: ChartType
Line break: a line goes on until the closes break the lines before.
pointFigurevariableSource
const pointFigure: ChartType
Point & figure columns of X's and O's.
rangeBarsvariableSource
const rangeBars: ChartType
Range bars, each spanning the same range.
renkovariableSource
const renko: ChartType
Renko bricks on a grid of multiples of the box.
tickBarsvariableSource
const tickBars: ChartType
Bars of the same number of trades.
turnoverBarsvariableSource
const turnoverBars: ChartType
Bars of the same turnover.
volumeBarsvariableSource
const volumeBars: ChartType
Bars of the same volume.
volumeCandlesvariableSource
const volumeCandles: ChartType
Candles as wide as their volume.