Api

SubscribeEventsMap

Download Markdown

Integration guide · Reference index

Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.

toggle_sidebar

toggle_sidebar: (isHidden: boolean) => void;

Use the type signature above and the integration guide for the owning capability.

indicators_dialog

indicators_dialog: EmptyCallback;

Use the type signature above and the integration guide for the owning capability.

toggle_header

toggle_header: (isHidden: boolean) => void;

Use the type signature above and the integration guide for the owning capability.

edit_object_dialog

edit_object_dialog: (params: EditObjectDialogEventParams) => void;

Use the type signature above and the integration guide for the owning capability.

chart_load_requested

chart_load_requested: (savedData: object) => void;

Use the type signature above and the integration guide for the owning capability.

chart_loaded

chart_loaded: EmptyCallback;

Use the type signature above and the integration guide for the owning capability.

mouse_down

mouse_down: (params: MouseEventParams) => void;

Use the type signature above and the integration guide for the owning capability.

mouse_up

mouse_up: (params: MouseEventParams) => void;

Use the type signature above and the integration guide for the owning capability.

drawing

drawing: (params: StudyOrDrawingAddedToChartEventParams) => void;

Use the type signature above and the integration guide for the owning capability.

study

study: (params: StudyOrDrawingAddedToChartEventParams) => void;

Use the type signature above and the integration guide for the owning capability.

undo

undo: EmptyCallback;

Use the type signature above and the integration guide for the owning capability.

redo

redo: EmptyCallback;

Use the type signature above and the integration guide for the owning capability.

undo_redo_state_changed

undo_redo_state_changed: (state: UndoRedoState) => void;

Use the type signature above and the integration guide for the owning capability.

reset_scales

reset_scales: EmptyCallback;

Use the type signature above and the integration guide for the owning capability.

compare_add

compare_add: EmptyCallback;

Use the type signature above and the integration guide for the owning capability.

add_compare

add_compare: EmptyCallback;

Use the type signature above and the integration guide for the owning capability.

load_study_template

load_study_template: EmptyCallback;

Use the type signature above and the integration guide for the owning capability.

onTick

onTick: (tick: Bar) => void;

Use the type signature above and the integration guide for the owning capability.

onAutoSaveNeeded

onAutoSaveNeeded: EmptyCallback;

Use the type signature above and the integration guide for the owning capability.

save_status_retry_requested

save_status_retry_requested: (payload: { status: "failed" | "load-failed" }) => void;

The user clicked Retry on a failed header save status (setSaveStatus).

onScreenshotReady

onScreenshotReady: (url: string) => void;

Use the type signature above and the integration guide for the owning capability.

onMarkClick

onMarkClick: (markId: Mark["id"]) => void;

Use the type signature above and the integration guide for the owning capability.

onPlusClick

onPlusClick: (params: PlusClickParams) => void;

Use the type signature above and the integration guide for the owning capability.

onTimescaleMarkClick

onTimescaleMarkClick: (markId: TimescaleMark["id"]) => void;

Use the type signature above and the integration guide for the owning capability.

onSelectedLineToolChanged

onSelectedLineToolChanged: EmptyCallback;

Use the type signature above and the integration guide for the owning capability.

layout_about_to_be_changed

layout_about_to_be_changed: (newLayoutType: LayoutType) => void;

Use the type signature above and the integration guide for the owning capability.

layout_changed

layout_changed: EmptyCallback;

Use the type signature above and the integration guide for the owning capability.

activeChartChanged

activeChartChanged: (chartIndex: number) => void;

Use the type signature above and the integration guide for the owning capability.

series_event

series_event: (seriesEventType: SeriesEventType) => void;

Use the type signature above and the integration guide for the owning capability.

study_event

study_event: (entityId: EntityId, studyEventType: StudyEventType) => void;

Use the type signature above and the integration guide for the owning capability.

drawing_event

drawing_event: (
    sourceId: EntityId,
    drawingEventType: DrawingEventType,
  ) => void;

Use the type signature above and the integration guide for the owning capability.

study_properties_changed

study_properties_changed: (id: EntityId) => void;

Use the type signature above and the integration guide for the owning capability.

series_properties_changed

series_properties_changed: (id: EntityId) => void;

Use the type signature above and the integration guide for the owning capability.

panes_height_changed

panes_height_changed: () => void;

Use the type signature above and the integration guide for the owning capability.

panes_order_changed

panes_order_changed: () => void;

Use the type signature above and the integration guide for the owning capability.