charton

Appearance

charton API

charton API / @chart-on/core / index / SymbolInfo

Interface: SymbolInfo ​

Defined in: packages/core/src/data/types.ts:44

A symbol as a data source describes it: its key and names, price format, data delay, timezone and supported intervals.

Properties ​

delay? ​

optional delay?: number | "eod"

Defined in: packages/core/src/data/types.ts:59

Minutes the data lags realtime, or 'eod' for end-of-day data; 0 or unset is realtime.

description? ​

optional description?: string

Defined in: packages/core/src/data/types.ts:48

exchange? ​

optional exchange?: string

Defined in: packages/core/src/data/types.ts:51

expired? ​

optional expired?: boolean

Defined in: packages/core/src/data/types.ts:61

A contract that no longer trades, e.g. an expired future.

intervals? ​

optional intervals?: string[]

Defined in: packages/core/src/data/types.ts:73

Intervals this symbol supports; any when omitted or empty. Entries the chart cannot parse are ignored. setSymbol with another interval shows the nearest supported one and emits interval:change.

name ​

name: string

Defined in: packages/core/src/data/types.ts:47

precision? ​

optional precision?: number

Defined in: packages/core/src/data/types.ts:53

Price decimals; the chart auto-detects them when omitted.

priceFormat? ​

optional priceFormat?: PriceFormat

Defined in: packages/core/src/data/types.ts:57

Full price format (fractions, tick bands, a unit...); wins over precision and tickSize.

symbol ​

symbol: string

Defined in: packages/core/src/data/types.ts:46

Key passed back to the data source and used for caching.

tickSize? ​

optional tickSize?: number

Defined in: packages/core/src/data/types.ts:55

Smallest price increment; sets the decimals unless precision is given.

timezone? ​

optional timezone?: string

Defined in: packages/core/src/data/types.ts:67

IANA timezone of the exchange, e.g. 'America/New_York'. Calendar bars (months, quarters, years) start in it, UTC when unset; with the chart option applySymbolTimezone the chart also displays it.

type? ​

optional type?: string

Defined in: packages/core/src/data/types.ts:50

Free-form kind, e.g. 'crypto', 'stock', 'index'.