Documentation menu

JavaScript API reference

Every class, function and type of @ferrochart/core, generated from the TypeScript declarations shipped in the package. For how to use them, see the guide chapters; for loading the module and general conventions, see JavaScript API overview.

Classes

FerroChartA chart on a <canvas>.
SeriesA series of a FerroChart.
IndicatorAn indicator attached with FerroChart.addIndicator.
PriceLineA price line created with Series.createPriceLine.
DrawingsThe drawings of a chart (FerroChart.drawings).
SyncGroupA group of charts whose crosshair, visible range and (optionally) drawings follow each other.
FerroPlotA plot with numeric, category or date axes on a <canvas>.
MarkA mark of a FerroPlot.
AxisAn axis of a FerroPlot.
RuleA rule of a FerroPlot.
LabelA label of a FerroPlot.

Functions

indicatorNamesNames accepted by FerroChart.addIndicator.
randomWalkDeterministic random-walk OHLCV bars, bit-identical to Rust's ferrochart_core::testing::random_walk (for demos, benchmarks and tests).

Interfaces

Anchor
AxisOptionsOptions of an axis (plot.axis(name).applyOptions).
BandOptionsColors of FerroChart.addBand; null uses the default (the upper series' color at 15% opacity; fillCrossed.
BarOne bar for Series.update.
BarValuesValues of the first OHLC series that has a bar under the crosshair.
ChartCreateOptionsOptions of FerroChart.create.
ChartEventMap
ChartStateSaved view, layout and drawings (saveState); plain JSON.
ClickEventA press and release in a plot that moved at most 3 CSS px (not sent while a drawing is being created).
CrosshairPoint
DepthSnapshotAn order book snapshot of appendDepth (bids and asks, in book order).
DrawingDataA drawing.
DrawingStyle
DrawingToolCtxWhat a JS drawing tool gets in addition to PluginCtx.
DrawingToolJsA drawing tool for Drawings.register.
FootprintOptionsOptions of addFootprint (docs.
HeatmapOptionsOptions of addHeatmap.
IntroOptionsOptions of playIntro.
LabelOptionsOptions of addLabel.
LayerPluginJsA layer plugin for FerroChart.addLayer.
LogicalRange
MarkDataColumns of Mark.setData / append; all have the same length.
Marker
MarkOptionsOptions of a mark (addMark, Mark.applyOptions).
MarkPointThe new last point for Mark.update.
OhlcDataColumns of Series.setData.
OhlcRowOne bar of a Series.setData row array (columns are faster for large data).
PlotCreateOptionsOptions of FerroPlot.create.
PlotEventMap
PlotHitThe element under the pointer.
PluginCtxWhat a JS plugin gets while the frame is built.
PriceLineOptions
PriceScaleOptions
RuleOptionsOptions of addRule / Rule.applyOptions.
SeriesOptionsSeries options.
SyncOptions
TpoOptionsOptions of addTpo.
TradeDataTrades of appendTrades.
TransformParamsTransform parameters (prices in the series' units).
ValueDataColumns of Series.setData for line, area, baseline, histogram and points series.
ValuePointOne point for Series.update of a single-value series.
ValueRowOne point of a Series.setData row array for single-value series.

Types

AxisName
ChartWarningA non-fatal problem.
ClickTargetWhat a click hit.
ColorA CSS color.
ColorScaleOptionsA color scale.
Column
DrawingParam
DrawingSyncOpA change of a synced drawing; key identifies the drawing in the group.
LineStyle
MarkKind
PlacementWhere addIndicator puts the outputs.
PlotFormatHow labels and value texts are written.
PlotIcon
PluginCommandA drawing command of a JS plugin.
SeriesKindSeries kinds of FerroChart.addSeries.
SyncMessage
TransformNameTransforms of FerroChart.addTransformSeries (https://ferrochart.com/docs/series).