Skip to content

LayerType

Built-in layer types are derived from the built-in layer definitions. Custom layers may use any other non-empty string.

ts
type BuiltInLayerType =
  | 'price:candlesticks'
  | 'price:ohlc-bars'
  | 'price:line'
  | 'price:area'
  | 'volume:bars'
  | 'adx'
  | 'atr'
  | 'bollinger-bands'
  | 'cci'
  | 'ema'
  | 'macd'
  | 'obv'
  | 'parabolic-sar'
  | 'rsi'
  | 'sma'
  | 'stochastic'
  | 'williams-r';

type LayerType = BuiltInLayerType | (string & {});
ValueDescription
'price:candlesticks'OHLC candlestick chart
'price:ohlc-bars'OHLC bar chart
'price:line'Line chart of a single price field
'price:area'Area chart of a single price field
'volume:bars'Volume bar chart
'adx'Average Directional Index indicator
'atr'Average True Range indicator
'bollinger-bands'Bollinger Bands indicator
'cci'Commodity Channel Index indicator
'ema'Exponential Moving Average indicator
'macd'MACD indicator
'obv'On-Balance Volume indicator
'parabolic-sar'Parabolic SAR indicator
'rsi'Relative Strength Index indicator
'sma'Simple Moving Average indicator
'stochastic'Stochastic Oscillator indicator
'williams-r'Williams %R indicator

Custom layer types are not globally registered. Add their definitions through the chart's layerDefinitions prop.

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