<!-- Public documentation export; not library implementation source. -->
# SubscribeEventsMap

[Integration guide](https://docs.lumencharts.com/charting-library/reference/compatibility) · [Reference index](https://docs.lumencharts.com/charting-library/api/)

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}

```ts
toggle_sidebar: (isHidden: boolean) => void;
```

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

## indicators_dialog {#indicators_dialog}

```ts
indicators_dialog: EmptyCallback;
```

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

## toggle_header {#toggle_header}

```ts
toggle_header: (isHidden: boolean) => void;
```

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

## edit_object_dialog {#edit_object_dialog}

```ts
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}

```ts
chart_load_requested: (savedData: object) => void;
```

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

## chart_loaded {#chart_loaded}

```ts
chart_loaded: EmptyCallback;
```

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

## mouse_down {#mouse_down}

```ts
mouse_down: (params: MouseEventParams) => void;
```

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

## mouse_up {#mouse_up}

```ts
mouse_up: (params: MouseEventParams) => void;
```

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

## drawing {#drawing}

```ts
drawing: (params: StudyOrDrawingAddedToChartEventParams) => void;
```

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

## study {#study}

```ts
study: (params: StudyOrDrawingAddedToChartEventParams) => void;
```

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

## undo {#undo}

```ts
undo: EmptyCallback;
```

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

## redo {#redo}

```ts
redo: EmptyCallback;
```

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

## undo_redo_state_changed {#undo_redo_state_changed}

```ts
undo_redo_state_changed: (state: UndoRedoState) => void;
```

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

## reset_scales {#reset_scales}

```ts
reset_scales: EmptyCallback;
```

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

## compare_add {#compare_add}

```ts
compare_add: EmptyCallback;
```

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

## add_compare {#add_compare}

```ts
add_compare: EmptyCallback;
```

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

## load_study_template {#load_study_template}

```ts
load_study_template: EmptyCallback;
```

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

## onTick {#ontick}

```ts
onTick: (tick: Bar) => void;
```

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

## onAutoSaveNeeded {#onautosaveneeded}

```ts
onAutoSaveNeeded: EmptyCallback;
```

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

## save_status_retry_requested {#save_status_retry_requested}

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

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

## onScreenshotReady {#onscreenshotready}

```ts
onScreenshotReady: (url: string) => void;
```

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

## onMarkClick {#onmarkclick}

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

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

## onPlusClick {#onplusclick}

```ts
onPlusClick: (params: PlusClickParams) => void;
```

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

## onTimescaleMarkClick {#ontimescalemarkclick}

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

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

## onSelectedLineToolChanged {#onselectedlinetoolchanged}

```ts
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}

```ts
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}

```ts
layout_changed: EmptyCallback;
```

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

## activeChartChanged {#activechartchanged}

```ts
activeChartChanged: (chartIndex: number) => void;
```

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

## series_event {#series_event}

```ts
series_event: (seriesEventType: SeriesEventType) => void;
```

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

## study_event {#study_event}

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

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

## drawing_event {#drawing_event}

```ts
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}

```ts
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}

```ts
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}

```ts
panes_height_changed: () => void;
```

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

## panes_order_changed {#panes_order_changed}

```ts
panes_order_changed: () => void;
```

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

## Related types

- [EmptyCallback](https://docs.lumencharts.com/charting-library/api/EmptyCallback)
- [EditObjectDialogEventParams](https://docs.lumencharts.com/charting-library/api/EditObjectDialogEventParams)
- [MouseEventParams](https://docs.lumencharts.com/charting-library/api/MouseEventParams)
- [StudyOrDrawingAddedToChartEventParams](https://docs.lumencharts.com/charting-library/api/StudyOrDrawingAddedToChartEventParams)
- [UndoRedoState](https://docs.lumencharts.com/charting-library/api/UndoRedoState)
- [Bar](https://docs.lumencharts.com/charting-library/api/Bar)
- [Mark](https://docs.lumencharts.com/charting-library/api/Mark)
- [PlusClickParams](https://docs.lumencharts.com/charting-library/api/PlusClickParams)
- [TimescaleMark](https://docs.lumencharts.com/charting-library/api/TimescaleMark)
- [LayoutType](https://docs.lumencharts.com/charting-library/api/LayoutType)
- [SeriesEventType](https://docs.lumencharts.com/charting-library/api/SeriesEventType)
- [EntityId](https://docs.lumencharts.com/charting-library/api/EntityId)
- [StudyEventType](https://docs.lumencharts.com/charting-library/api/StudyEventType)
- [DrawingEventType](https://docs.lumencharts.com/charting-library/api/DrawingEventType)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/SubscribeEventsMap