Options

Configuration Structure

Options: {
chart: { ... },
height: number,
id: string,
series: Array,
name: string,
data: Array,
x: number | string,
y: number[],
v: number,
theme: { ... },
mode: 'light' | 'dark',
plotOptions: { ... },
stockChart: { ... },
indicators: { ... },
moving average: { ... },
enabled: boolean,
bollinger bands: { ... },
enabled: boolean,
enabled: boolean,
enabled: boolean,
linear regression: { ... },
enabled: boolean,
enabled: boolean,
rsi: { ... },
enabled: boolean,
macd: { ... },
enabled: boolean,
volumes: { ... },
enabled: boolean,
price volume trend: { ... },
enabled: boolean,
stochastic oscillator: { ... },
enabled: boolean,
enabled: boolean,
enabled: boolean,
chaikin oscillator: { ... },
enabled: boolean,
enabled: boolean,
trend strength index: { ... },
enabled: boolean,
enabled: boolean,
bollinger bands %b: { ... },
enabled: boolean,
bollinger bands width: { ... },
enabled: boolean,
}

chart

Chart-level options controlling dimensions and identification.

height

Options.chart.height
Default: 350

Total height of the ApexStock chart in pixels, including the main candlestick area and any oscillator panels below it.

id

Options.chart.id

Unique identifier for the chart instance. Auto-generated if not provided.

series

Array of data series. Each series contains OHLCV data points rendered as candlesticks on the main chart.

series: [
  {
    name: 'Stock Price',
    data: [
      { x: 1706745600000, y: [150, 155, 148, 153], v: 1200000 },
      { x: 1706832000000, y: [153, 158, 151, 157], v: 980000 },
    ],
  },
]

name

Options.series.name

Name of the data series displayed in the legend and tooltips.

data

Options.series.data

Array of data points in OHLCV format.

x

Options.series.data.x

Timestamp or date for the data point. Can be a Unix timestamp (number) or a date string.

y

Options.series.data.y

Array containing [open, high, low, close] prices in that order. Used to render the candlestick body and wicks.

v

Options.series.data.v

Volume for the time period. When present, volume data is available for the Volumes indicator.

theme

Theme configuration for the chart.

mode

Options.theme.mode
Default: 'light'

Color scheme for the chart.

Available Options:

  • light (default) — light background with dark text
  • dark — dark background with light text

plotOptions

Plot-specific options for the stock chart.

stockChart

Options.plotOptions.stockChart

Configuration specific to the stock chart component.

indicators

Options.plotOptions.stockChart.indicators

Configure which technical indicators are available. Indicators are split into overlays (drawn on the main chart) and oscillators (rendered in separate panels below).

Pass an object to enable/disable individual indicators, or an array of indicator name strings to enable only those.

plotOptions: {
  stockChart: {
    indicators: {
      'moving average': { enabled: true },
      'bollinger bands': { enabled: true },
      'rsi': { enabled: true },
      'macd': { enabled: false },
    },
  },
}

moving average

Options.plotOptions.stockChart.indicators.moving average

Moving Average overlay configuration.

enabled

Options.plotOptions.stockChart.indicators.moving average.enabled

Enable the Simple Moving Average overlay on the main chart.

bollinger bands

Options.plotOptions.stockChart.indicators.bollinger bands

Bollinger Bands overlay configuration.

enabled

Options.plotOptions.stockChart.indicators.bollinger bands.enabled

Enable the Bollinger Bands overlay showing price volatility bands.

exponential moving average

Options.plotOptions.stockChart.indicators.exponential moving average

Exponential Moving Average overlay configuration.

enabled

Options.plotOptions.stockChart.indicators.exponential moving average.enabled

Enable the Exponential Moving Average overlay for trend analysis.

fibonacci retracements

Options.plotOptions.stockChart.indicators.fibonacci retracements

Fibonacci Retracements overlay configuration.

enabled

Options.plotOptions.stockChart.indicators.fibonacci retracements.enabled

Enable Fibonacci retracement levels for support and resistance analysis.

linear regression

Options.plotOptions.stockChart.indicators.linear regression

Linear Regression overlay configuration.

enabled

Options.plotOptions.stockChart.indicators.linear regression.enabled

Enable the Linear Regression trend line overlay.

ichimoku cloud indicator

Options.plotOptions.stockChart.indicators.ichimoku cloud indicator

Ichimoku Cloud overlay configuration.

enabled

Options.plotOptions.stockChart.indicators.ichimoku cloud indicator.enabled

Enable the Ichimoku Cloud indicator for comprehensive trend analysis.

rsi

Options.plotOptions.stockChart.indicators.rsi

RSI oscillator configuration.

enabled

Options.plotOptions.stockChart.indicators.rsi.enabled

Enable the Relative Strength Index oscillator in a separate panel.

macd

Options.plotOptions.stockChart.indicators.macd

MACD oscillator configuration.

enabled

Options.plotOptions.stockChart.indicators.macd.enabled

Enable the Moving Average Convergence Divergence oscillator.

volumes

Options.plotOptions.stockChart.indicators.volumes

Volumes indicator configuration.

enabled

Options.plotOptions.stockChart.indicators.volumes.enabled

Enable the volume indicator showing trading volume in a separate panel.

price volume trend

Options.plotOptions.stockChart.indicators.price volume trend

Price Volume Trend indicator configuration.

enabled

Options.plotOptions.stockChart.indicators.price volume trend.enabled

Enable the Price Volume Trend indicator combining price and volume analysis.

stochastic oscillator

Options.plotOptions.stockChart.indicators.stochastic oscillator

Stochastic Oscillator configuration.

enabled

Options.plotOptions.stockChart.indicators.stochastic oscillator.enabled

Enable the Stochastic Oscillator for momentum analysis.

standard deviation indicator

Options.plotOptions.stockChart.indicators.standard deviation indicator

Standard Deviation indicator configuration.

enabled

Options.plotOptions.stockChart.indicators.standard deviation indicator.enabled

Enable the Standard Deviation indicator for volatility measurement.

average directional index

Options.plotOptions.stockChart.indicators.average directional index

Average Directional Index configuration.

enabled

Options.plotOptions.stockChart.indicators.average directional index.enabled

Enable the Average Directional Index (ADX) for trend strength analysis.

chaikin oscillator

Options.plotOptions.stockChart.indicators.chaikin oscillator

Chaikin Oscillator configuration.

enabled

Options.plotOptions.stockChart.indicators.chaikin oscillator.enabled

Enable the Chaikin Oscillator for accumulation/distribution analysis.

commodity channel index

Options.plotOptions.stockChart.indicators.commodity channel index

Commodity Channel Index configuration.

enabled

Options.plotOptions.stockChart.indicators.commodity channel index.enabled

Enable the Commodity Channel Index (CCI) oscillator.

trend strength index

Options.plotOptions.stockChart.indicators.trend strength index

Trend Strength Index configuration.

enabled

Options.plotOptions.stockChart.indicators.trend strength index.enabled

Enable the Trend Strength Index for measuring trend momentum.

accelerator oscillator

Options.plotOptions.stockChart.indicators.accelerator oscillator

Accelerator Oscillator configuration.

enabled

Options.plotOptions.stockChart.indicators.accelerator oscillator.enabled

Enable the Accelerator Oscillator for momentum acceleration analysis.

bollinger bands %b

Options.plotOptions.stockChart.indicators.bollinger bands %b

Bollinger Bands %B indicator configuration.

enabled

Options.plotOptions.stockChart.indicators.bollinger bands %b.enabled

Enable the Bollinger Bands %B indicator showing price position within bands.

bollinger bands width

Options.plotOptions.stockChart.indicators.bollinger bands width

Bollinger Bands Width indicator configuration.

enabled

Options.plotOptions.stockChart.indicators.bollinger bands width.enabled

Enable the Bollinger Bands Width indicator measuring band expansion/contraction.