API reference

You learned the ideas in Core concepts and the daily tasks in Chart usage. API reference is the lookup layer — exact method names, types, and return values when you code or ask your AI assistant.

ChartInstance, Chart environment, and ChartUI include TypeScript-synced API tables (regenerated on every docs build) from packages/chart and packages/react-chart-ui.

No need to read this cover to cover. Open the page that matches your question.

Loading chart…

Every method below belongs to the chart instance returned by createChart().

Pick your page

You want to…	Read
Look up a method on the chart (setMainSeriesData, appendTick, settings, …)	ChartInstance
ChartUI props, theme tokens, hooks (useChartEnvironment, …)	ChartUI
Compact layout, breakpoints, ENVIRONMENT_CHANGE	Chart environment and layout
Build or wire a Data Connector (DataAdapter, loadData, …)	Data Connectors

How this relates to other sections

flowchart TB
  CU["Chart usage — what to call, in what order"]
  ADV["Advanced integration — ChartUI, mobile, Chart class"]
  API["API reference — exact signatures"]
  TUT["Tutorials — full copy-paste examples"]

  CU --> API
  ADV --> API
  API --> TUT

Section	Role
Chart usage	Explains tasks in plain language
Advanced integration	ChartUI, mobile, runtime gaps
API reference (here)	Method and type cheat sheet
Tutorials	End-to-end recipes

The one object you hold

Almost everything goes through ChartInstance — the return value of createChart():

import { createChart } from "@efixdata/exeria-chart";

const chart = createChart({ container });
chart.init();
await chart.setMainSeriesData(candles, interval);

Import types from the same package:

import type {
  Candle,
  Tick,
  Interval,
  Instrument,
  ChartInstance,
  DataAdapter,
  LoadDataOptions,
} from "@efixdata/exeria-chart";

Data connectors in one glance

Connectors implement DataAdapter. The chart wraps them with setDataAdapter, loadData, and subscribeToUpdates:

Cryptocurrency

Timeframe

Loading chart…

Types and contract: Data Connectors. Beginner guide: Data connectors overview.

Quick lookup — most-used methods

Task	Method
First paint	init() → setMainSeriesData()
Live price	appendTick() or subscribeToUpdates()
Scroll / fit	fit()
Linear / log scale	setValueAxisMode("lin" | "log" | "%")
Add indicator	addScript("SMA", …)
Draw a line	toolDrawer.drawTrendLine()
Save user prefs	exportChartSettingsTemplate()
Cleanup	destroy()

Full grouped list: ChartInstance.

What is not on ChartInstance

Some runtime methods exist only on the exported Chart class (moveToStamp, addPanelToModel, …). See Chart runtime access.

Quick troubleshooting

Problem	Check
TypeScript says method missing	You may need Chart class — runtime access
loadData types confusing	Data Connectors + LoadDataOptions
Layout mode not updating	Chart environment — setLayoutMode, ENVIRONMENT_CHANGE
Event payload shape	ChartInstance → Events

Ready? Open ChartInstance or jump to the topic you need.