Interface: IBoardCommands

Possible functions (commands) that you can execute
on the current board.

The specific commands and examples are defined on its own section.

Hierarchy

• IBoardCommands

Index

Properties

• info
• selection
• tags
• ui
• utils
• viewport
• widgets

Methods

• __disableLeftClickOnCanvas
• __enableLeftClickOnCanvas
• __getParamsFromURL

Properties

info

• info: IBoardInfoCommands

Command related to the board information

---

selection

• selection: IBoardSelectionCommands

Commands related to the selection of widgets in the board

---

tags

• tags: IBoardTagsCommands

Commands related to tags

---

ui

• ui: IBoardUICommands

Commands related to the user interface control

---

utils

• utils: IBoardUtils

Utilities to work with the board

---

viewport

• viewport: IBoardViewportCommands

Commands related to the board viewport

---

widgets

• widgets: IBoardWidgetsCommands

Commands related to widgets like create, update, delete and metadata.

Methods

__disableLeftClickOnCanvas

▸ __disableLeftClickOnCanvas(): void

Disable the usage of the mouse left button on the board.

experimental

Returns: void

---

__enableLeftClickOnCanvas

▸ __enableLeftClickOnCanvas(): void

Enables the usage of the mouse left button on the board.
It has no effect if the left button was not previously disabled.

experimental

Returns: void

---

__getParamsFromURL

▸ __getParamsFromURL(): Promise<any>

Returns the deserialized parameters contained in the miro_sdk address (location.href) query parameter.

experimental

Returns: Promise<any>

A promise resolving into the deserialized data in the miro_sdk query parameter.