Skip to content

API Reference ​

Chart ​

<Chart>Root chart component
ScaleSmoothingConfigY-scale transition smoothing
BordersConfigChart border styling
CrosshairsConfigCrosshair configuration
TimeCrosshairConfigTime crosshair configuration
ValueCrosshairConfigValue crosshair configuration
TimeCrosshairLabelConfigTime crosshair label
ValueCrosshairLabelConfigValue crosshair label
GridConfigGrid line configuration
XAxisConfigX-axis configuration
DataPointOHLCV data point
GranularityCandle time interval

Panel ​

PanelConfigPanel configuration
PanelControlsConfigPanel controls configuration

Layer ​

LayerConfigUnion of built-in and custom layer config types
LayerTypeDerived built-in types plus custom strings
BaseLayerConfigShared properties for all layers
Custom LayersDefine and register chart-scoped indicator layers
AdxLayerConfigAverage Directional Index
AreaLayerConfigArea price chart
AtrLayerConfigAverage True Range
BollingerBandsLayerConfigBollinger Bands
CandlestickLayerConfigCandlesticks
CciLayerConfigCommodity Channel Index
EmaLayerConfigExponential Moving Average
MacdLayerConfigMACD
ObvLayerConfigOn-Balance Volume
OhlcBarsLayerConfigOHLC bars
ParabolicSarLayerConfigParabolic SAR
PriceLineLayerConfigPrice line
RsiLayerConfigRelative Strength Index
SmaLayerConfigSimple Moving Average
StochasticLayerConfigStochastic Oscillator
VolumeBarsLayerConfigVolume bars
WilliamsRLayerConfigWilliams %R
YAxisConfigY-axis configuration

Drawing ​

Custom DrawingsDefine and register chart-scoped drawing overlays

Value Marker ​

ValueMarkerConfigValue marker configuration
DirectionalValueMarkerConfigDirectional value marker configuration
ValueMarkerModeValue marker mode

Legend ​

LegendConfigLegend configuration
LegendFieldConfigLegend field configuration

Elements ​

Line ​

LineConfigLine styling
DirectionalLineConfigDirectional line styling

Bar ​

BarConfigBar styling
DirectionalBarConfigDirectional bar styling

Label ​

LabelConfigBase label styling
ValueLabelConfigValue axis label
TimeLabelConfigTime axis label
BoxedValueLabelConfigBoxed value label
BoxedTimeLabelConfigBoxed time label

Button ​

ButtonConfigButton styling

Theme ​

ThemeFull theme interface
Light ThemeDefault light theme values
Dark ThemeDefault dark theme values

React Candlesticks is available on npm and GitHub under the MIT License.