API Reference - API

This page shows API which is available to chart users.

ChartReactSupportedAPI

Here goes the supported API reference:

ChartReactSupportedAPI.changeInstrument

ChartReactSupportedAPI.changeInstrument(instrument: string, chartId?: string): void

Changes the instrument.

Parameters

instrument: string

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.changePeriod

ChartReactSupportedAPI.changePeriod(period: AggregationPeriod, chartId?: string): void

Changes the aggregation period.

Parameters

period: AggregationPeriod

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.changeTheme

ChartReactSupportedAPI.changeTheme(theme: "dark" | "light"): void

Changes color theme.

Parameters

theme: "dark" | "light"

Returns

void

ChartReactSupportedAPI.setTimeframePreset

ChartReactSupportedAPI.setTimeframePreset(preset: TimeframePreset, chartId?: string): void

Sets the timeframe preset.

Parameters

preset: TimeframePreset

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setStudies

ChartReactSupportedAPI.setStudies(studies: TStudySettings[], chartId?: string): void

Sets the studies with parameters.

Parameters

studies: TStudySettings[]

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setStudiesByIds

ChartReactSupportedAPI.setStudiesByIds(studyIds: string[], chartId?: string): void

Sets studies only by ID's, parameters and colors will be set to default.

Parameters

studyIds: string[]

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.undo

ChartReactSupportedAPI.undo(chartId?: string): void

undo the last action on the chart if there is something to undo, takes selected chart id if none is provided

Parameters

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.redo

ChartReactSupportedAPI.redo(chartId?: string): void

redo the last action on the chart if there is something to redo, takes selected chart id if none is provided

Parameters

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setYAxisAlign

ChartReactSupportedAPI.setYAxisAlign(value: { scale: YExtentComponent; align: YAxisAlign; }, chartId?: string): void

Sets scale align to left or to right

Parameters

value: { scale: YExtentComponent; align: YAxisAlign; }

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.syncLayoutParts

ChartReactSupportedAPI.syncLayoutParts(layout: ChartLayoutWithId, options: AtLeastOne<SyncLayoutPartsOptions, keyof SyncLayoutPartsOptions>): void

Allows to synchronize parts of layout to target chart.

Parameters

layout: ChartLayoutWithId

options: AtLeastOne<SyncLayoutPartsOptions, keyof SyncLayoutPartsOptions>

Returns

void

ChartReactSupportedAPI.generateLayout

ChartReactSupportedAPI.generateLayout(partialLayout?: { version?: string; global?: { drawingMode?: boolean; magnetMode?: boolean; drawingSyncMode?: boolean; }; multiChart?: { layout?: "1x1" | "2x2" | "2x1" | "1x2" | "3x1" | "1x3" | "2x4"; selectedChartIndex?: string; sync?: { ...; }; }; charts?: { ...; }[]; }): MultiChartLayout

Allows to generate layout based on current multi chart state

Parameters

OptionalpartialLayout?: { version?: string; global?: { drawingMode?: boolean; magnetMode?: boolean; drawingSyncMode?: boolean; }; multiChart?: { layout?: "1x1" | "2x2" | "2x1" | "1x2" | "3x1" | "1x3" | "2x4"; selectedChartIndex?: string; sync?: { ...; }; }; charts?: { ...; }[]; }

Returns

MultiChartLayout

ChartReactSupportedAPI.sendNotification

ChartReactSupportedAPI.sendNotification(msg: string, options?: ChartNotificationOptions): void

Displays notifications at the top of the chart

Parameters

msg: string

Optionaloptions?: ChartNotificationOptions

Returns

void

ChartReactSupportedAPI.setNextCandleTimeOffset

ChartReactSupportedAPI.setNextCandleTimeOffset(timeInMs: number): void

Adds time to the next candle data timestamp, changes countdown label time

Parameters

timeInMs: number

Returns

void

ChartReactSupportedAPI.exportChartData

ChartReactSupportedAPI.exportChartData(chartId: string): void

Exports chart data

Parameters

chartId: string

Returns

void

ChartReactSupportedAPI.clearChartData

ChartReactSupportedAPI.clearChartData(chartId?: string): void

Clear main candle series and main instument from chart.

Parameters

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setDrawingSync

ChartReactSupportedAPI.setDrawingSync(enabled: boolean): void

Enables/disables drawing sync mode

Parameters

enabled: boolean

Returns

void

ChartReactSupportedAPI.onChartCreated

ChartReactSupportedAPI.onChartCreated(callback: (chartId: string, chart: ChartWithModules) => void): void

Registers callback for chart creation The callback will be called after the chart creation

Parameters

callback: (chartId: string, chart: ChartWithModules) => void

Returns

void

ChartReactSupportedAPI.onThemeChanged

ChartReactSupportedAPI.onThemeChanged(callback: (theme: "dark" | "light") => void): UnsubscribeCallback

Registers callback for theme change The callback will be called whenever the theme was changed

Parameters

callback: (theme: "dark" | "light") => void

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onChartSelected

ChartReactSupportedAPI.onChartSelected(callback: (chartId: string) => void): UnsubscribeCallback

Registers callback for chart select The callback will be called whenever the selected chart was changed

Parameters

callback: (chartId: string) => void

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onOrderClick

ChartReactSupportedAPI.onOrderClick(callback: (chartId: string, order: VisualOrder) => void): UnsubscribeCallback

Registers callbacks for order labels click/doubleclick/drag The callbacks will be called whenever the user clicked/dragged on order and position labels

Parameters

callback: (chartId: string, order: VisualOrder) => void

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onOrderDblClick

ChartReactSupportedAPI.onOrderDblClick(callback: (chartId: string, order: VisualOrder) => void): UnsubscribeCallback

Parameters

callback: (chartId: string, order: VisualOrder) => void

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onPositionClick

ChartReactSupportedAPI.onPositionClick(callback: (chartId: string, order: VisualPosition) => void): UnsubscribeCallback

Parameters

callback: (chartId: string, order: VisualPosition) => void

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onPositionDblClick

ChartReactSupportedAPI.onPositionDblClick(callback: (chartId: string, order: VisualPosition) => void): UnsubscribeCallback

Parameters

callback: (chartId: string, order: VisualPosition) => void

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onOrderDragStart

ChartReactSupportedAPI.onOrderDragStart(callback: (chartId: string, order: VisualOrder) => void): UnsubscribeCallback

Parameters

callback: (chartId: string, order: VisualOrder) => void

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onOrderDragEnd

ChartReactSupportedAPI.onOrderDragEnd(callback: (chartId: string, order: VisualOrder) => void): UnsubscribeCallback

Parameters

callback: (chartId: string, order: VisualOrder) => void

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onOrderDragTick

ChartReactSupportedAPI.onOrderDragTick(callback: (chartId: string, order: VisualOrder, y: number) => void): UnsubscribeCallback

Parameters

callback: (chartId: string, order: VisualOrder, y: number) => void

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onOrderEntryQuantityChanged

ChartReactSupportedAPI.onOrderEntryQuantityChanged(callback: (chartId: string, quantity: number) => void): UnsubscribeCallback

Registers callback for order entry quantity changed The callback will be called whenever the order entry quantity was changed

Parameters

callback: (chartId: string, quantity: number) => void

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onPeriodChanged

ChartReactSupportedAPI.onPeriodChanged(callback: (chartId: string, period: AggregationPeriod) => void, chartId?: string): UnsubscribeCallback

Registers callback for aggregation period changed The callback will be called whenever the period was changed

Parameters

callback: (chartId: string, period: AggregationPeriod) => void

OptionalchartId?: string

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onChartSettingsChanged

ChartReactSupportedAPI.onChartSettingsChanged(callback: (chartId: string, settings: ChartSettings) => void, chartId?: string): UnsubscribeCallback

Parameters

callback: (chartId: string, settings: ChartSettings) => void

OptionalchartId?: string

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onLayerItemsChanged

ChartReactSupportedAPI.onLayerItemsChanged(callback: (chartId: string, layerItems: Record<string, LayerItem[]>) => void, chartId?: string): UnsubscribeCallback

Parameters

callback: (chartId: string, layerItems: Record<string, LayerItem[]>) => void

OptionalchartId?: string

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onMultiChartLayoutChanged

ChartReactSupportedAPI.onMultiChartLayoutChanged(callback: Lazy<void>): void

Parameters

callback: Lazy<void>

Returns

void

ChartReactSupportedAPI.onMaximizedChartIdChanged

ChartReactSupportedAPI.onMaximizedChartIdChanged(callback: Lazy<void>): void

Parameters

callback: Lazy<void>

Returns

void

ChartReactSupportedAPI.onYAxisAlignMoved

ChartReactSupportedAPI.onYAxisAlignMoved(callback: (chartId: string, align: YAxisAlign) => void, chartId?: string): UnsubscribeCallback

Parameters

callback: (chartId: string, align: YAxisAlign) => void

OptionalchartId?: string

Returns

UnsubscribeCallback

ChartReactSupportedAPI.onStudiesScalesExtentChanged

ChartReactSupportedAPI.onStudiesScalesExtentChanged(callback: (chartId: string, data: Option<StudySeries>) => void, chartId?: string): UnsubscribeCallback

Parameters

callback: (chartId: string, data: Option<StudySeries>) => void

OptionalchartId?: string

Returns

UnsubscribeCallback

ChartReactSupportedAPI.getSelectedChartId

ChartReactSupportedAPI.getSelectedChartId(): string

Holds selected chart id.

Returns

string

ChartReactSupportedAPI.getChartInfo

ChartReactSupportedAPI.getChartInfo(chartId: string): ChartInfoSupported

Parameters

chartId: string

Returns

ChartInfoSupported

ChartReactSupportedAPI.getSelectedChartInfo

ChartReactSupportedAPI.getSelectedChartInfo(): ChartInfoSupported

Returns

ChartInfoSupported

ChartReactSupportedAPI.getMultiChartLayout

ChartReactSupportedAPI.getMultiChartLayout(): "1x1" | "2x2" | "2x1" | "1x2" | "3x1" | "1x3" | "2x4"

Returns

"1x1" | "2x2" | "2x1" | "1x2" | "3x1" | "1x3" | "2x4"

ChartReactSupportedAPI.getMaximizedChartId

ChartReactSupportedAPI.getMaximizedChartId(): Option<string>

Returns

Option<string>

ChartReactSupportedAPI.setVolumesEnabled

ChartReactSupportedAPI.setVolumesEnabled(enable: boolean, chartId?: string): void

An ability to disable volumes. If volumes are disabled - user can't enabled volume's visibility

Parameters

enable: boolean

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setVolumesMode

ChartReactSupportedAPI.setVolumesMode(mode: "separate" | "overlay", chartId?: string): void

Sets volumes display mode, can be overlay (on the main chart) or separate (sub-graph)

Parameters

mode: "separate" | "overlay"

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setVolumesVisible

ChartReactSupportedAPI.setVolumesVisible(visible: boolean, chartId?: string): void

Sets volumes visibility

Parameters

visible: boolean

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setPriceType

ChartReactSupportedAPI.setPriceType(priceType: "last" | "mark" | "bid" | "ask", chartId?: string): void

Sets price type for chart data

Parameters

priceType: "last" | "mark" | "bid" | "ask"

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setCandlesAlignment

ChartReactSupportedAPI.setCandlesAlignment(alignment: "session_start" | "midnight", chartId?: string): void

Sets candle alignment chart data

Parameters

alignment: "session_start" | "midnight"

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setAggregationTimeframeChangeStrategy

ChartReactSupportedAPI.setAggregationTimeframeChangeStrategy(strategy: TimeframeChangeStrategy, chartId?: string): void

Parameters

strategy: TimeframeChangeStrategy

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setInstrumentTimeframeChangeStrategy

ChartReactSupportedAPI.setInstrumentTimeframeChangeStrategy(strategy: TimeframeChangeStrategy, chartId?: string): void

Parameters

strategy: TimeframeChangeStrategy

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setAggregationViewportStrategy

ChartReactSupportedAPI.setAggregationViewportStrategy(strategy: ViewportStrategy, chartId?: string): void

Sets chart's viewport strategy on aggregation period change

Parameters

strategy: ViewportStrategy

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setInstrumentViewportStrategy

ChartReactSupportedAPI.setInstrumentViewportStrategy(strategy: ViewportStrategy, chartId?: string): void

Sets chart's viewport strategy on instrument change

Parameters

strategy: ViewportStrategy

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setApplyPeriodUponCreation

ChartReactSupportedAPI.setApplyPeriodUponCreation(apply: boolean, chartId?: string): void

Sets whether period should apply upon creation or not

Parameters

apply: boolean

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setAggregationRestrictionRule

ChartReactSupportedAPI.setAggregationRestrictionRule(rule: (aggregation: AggregationPeriod) => boolean): void

Parameters

rule: (aggregation: AggregationPeriod) => boolean

Returns

void

ChartReactSupportedAPI.setChartSettings

ChartReactSupportedAPI.setChartSettings(settings: ChartSettings, chartId?: string): void

Parameters

settings: ChartSettings

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setLayerItems

ChartReactSupportedAPI.setLayerItems(layerItems: Record<string, LayerItem[]>, chartId?: string): void

Parameters

layerItems: Record<string, LayerItem[]>

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setCurrentTimezone

ChartReactSupportedAPI.setCurrentTimezone(timezone: string): void

Parameters

timezone: string

Returns

void

ChartReactSupportedAPI.changeChartType

ChartReactSupportedAPI.changeChartType(chartType: "candle" | "bar" | "line" | "area" | "scatterPlot" | "hollow" | "histogram" | "baseline" | "trend" | "heikinAshi" | "equivolume"): void

Parameters

chartType: "candle" | "bar" | "line" | "area" | "scatterPlot" | "hollow" | "histogram" | "baseline" | "trend" | "heikinAshi" | "equivolume"

Returns

void

ChartReactSupportedAPI.addCompareInstrument

ChartReactSupportedAPI.addCompareInstrument(symbol: string, chartId?: string): void

Parameters

symbol: string

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.removeCompareInstrument

ChartReactSupportedAPI.removeCompareInstrument(symbol: string, chartId?: string): void

Parameters

symbol: string

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setCompareInstruments

ChartReactSupportedAPI.setCompareInstruments(symbols: string[], chartId?: string): void

Parameters

symbols: string[]

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setTradingBoundaries

ChartReactSupportedAPI.setTradingBoundaries(value: { min?: number; max?: number; }, chartId?: string): void

Sets trading boundaries

Parameters

value: { min?: number; max?: number; }

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setTradingQuantity

ChartReactSupportedAPI.setTradingQuantity(quantity: number, chartId?: string): void

Sets quantity for order entry (while creating order)

Parameters

quantity: number

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setTradingQuantityPrecision

ChartReactSupportedAPI.setTradingQuantityPrecision(precision: number, chartId?: string): void

Sets precision for order entry quantity (while creating order)

Parameters

precision: number

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setTradingQuantityStep

ChartReactSupportedAPI.setTradingQuantityStep(step: number, chartId?: string): void

Sets step for order quantity (+/- buttons)

Parameters

step: number

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setPositionsPrecision

ChartReactSupportedAPI.setPositionsPrecision(precision: number, chartId?: string): void

Sets precision for positions

Parameters

precision: number

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setTradingItemsPricePrecision

ChartReactSupportedAPI.setTradingItemsPricePrecision(precision: number, chartId?: string): void

Sets precision for trading items price (visual orders and positions, if setPositionsPrecision is not used)

Parameters

precision: number

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setTradingMaxQuantity

ChartReactSupportedAPI.setTradingMaxQuantity(maxQuantity: number, chartId?: string): void

Sets maximum quantity for order entry

Parameters

maxQuantity: number

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.setExecutedOrders

ChartReactSupportedAPI.setExecutedOrders(orders: ExecutedOrder[], chartId?: string): void

Sets executed orders to the chart

Parameters

orders: ExecutedOrder[]

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.moveStudyToPane

ChartReactSupportedAPI.moveStudyToPane(data: { uuid: string; direction: MoveDataSeriesToPaneDirection; }, chartId?: string): void

Moves specific study series to the pane above/below current, creates a new one if not created yet

Parameters

data: { uuid: string; direction: MoveDataSeriesToPaneDirection; }

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.moveStudyToNewScaleWithinChartPane

ChartReactSupportedAPI.moveStudyToNewScaleWithinChartPane(data: { uuid: string; direction: YAxisAlign; }, chartId?: string): void

Creates a new chart pane Y scale and attaches the selected study series to it

Parameters

data: { uuid: string; direction: YAxisAlign; }

OptionalchartId?: string

Returns

void

ChartReactSupportedAPI.moveStudyToExistingScaleWithinChartPane

ChartReactSupportedAPI.moveStudyToExistingScaleWithinChartPane(data: { uuid: string; scale: string; }, chartId?: string): void

Moves specific study data series to the already created chart pane scale

Parameters

data: { uuid: string; scale: string; }

OptionalchartId?: string

Returns

void