namespace-sdk

Namespace: SDK

Here you will find a full reference to all publicly available methods in
the Miro SDK for web plugins development.

The Root interface contains the SDK main commands and is a good starting point.

Index

Styling Enumerations

Account and User Interfaces

Board Manipulation Interfaces

Extension Points Interfaces

General Interfaces

Other Interfaces

Styling Interfaces

Widgets Manipulation Interfaces

Account and User Type aliases

Extension Points Type aliases

General Type aliases

Styling Type aliases

Widgets Manipulation Type aliases

Account and User Type aliases

AccountPermission

Ƭ AccountPermission: "MANAGE_APPS"


BoardPermission

Ƭ BoardPermission: "EDIT_INFO" | "EDIT_CONTENT" | "EDIT_COMMENTS"


Extension Points Type aliases

ButtonExtensionPoint

Ƭ ButtonExtensionPoint: T | () => Promise<T | void>

Type parameters:

Name
T

UIPanel

Ƭ UIPanel: "toolbar" | "top" | "bottomBar" | "map"

The available panels in the board.


General Type aliases

EventType

Ƭ EventType: "SELECTION_UPDATED" | "WIDGETS_CREATED" | "WIDGETS_DELETED" | "WIDGETS_TRANSFORMATION_UPDATED" | "ESC_PRESSED" | "ALL_WIDGETS_LOADED" | "COMMENT_CREATED" | "CANVAS_CLICKED" | "DATA_BROADCASTED" | "RUNTIME_STATE_UPDATED" | "METADATA_CHANGED" | "ONLINE_USERS_CHANGED"

Constant defining different events that can be triggered by the main application.

The following events are experimental and can be unstable:

  • ESC_PRESSED
  • ALL_WIDGETS_LOADED
  • COMMENT_CREATED
  • CANVAS_CLICKED
  • DATA_BROADCASTED
  • RUNTIME_STATE_UPDATED
  • METADATA_CHANGED
  • ONLINE_USERS_CHANGED

Styling Type aliases

BackgroundColorStyle

Ƭ BackgroundColorStyle: string | number


BackgroundOpacityStyle

Ƭ BackgroundOpacityStyle: number


BoldStyle

Ƭ BoldStyle: 0 | 1


BorderColorStyle

Ƭ BorderColorStyle: string | number


BorderOpacityStyle

Ƭ BorderOpacityStyle: number


BorderWidthStyle

Ƭ BorderWidthStyle: number


FontSizeStyle

Ƭ FontSizeStyle: number


HighlightingStyle

Ƭ HighlightingStyle: string | number


ItalicStyle

Ƭ ItalicStyle: 0 | 1


LineColorStyle

Ƭ LineColorStyle: string | number


LineThicknessStyle

Ƭ LineThicknessStyle: number


PaddingStyle

Ƭ PaddingStyle: 0 | 8


StrikeStyle

Ƭ StrikeStyle: 0 | 1


TextColorStyle

Ƭ TextColorStyle: string | number


UnderlineStyle

Ƭ UnderlineStyle: 0 | 1


Widgets Manipulation Type aliases

CreateTagRequest

Ƭ CreateTagRequest: { color: number | string ; title: string ; widgetIds?: InputWidgets }

Commands to interact and manipulate tags

Type declaration:

NameType
colornumber | string
titlestring
widgetIds?InputWidgets

InputTags

Ƭ InputTags: string | string[] | { id: string } | { id: string }[]

Commands to interact and manipulate tags


InputWidget

Ƭ InputWidget: string | { id: string }

Representation of one widget by id


InputWidgets

Ƭ InputWidgets: string | string[] | { id: string } | { id: string }[]

Representation of one or multiple widgets by id


OneOrMany

Ƭ OneOrMany: T | T[]

Type parameters:

Name
T

UpdateTagRequest

Ƭ UpdateTagRequest: { color?: number | string ; id: string ; title?: undefined | string ; widgetIds?: InputWidgets }

Commands to interact and manipulate tags

Type declaration:

NameType
color?number | string
idstring
title?undefined | string
widgetIds?InputWidgets

WidgetCapabilities

Ƭ WidgetCapabilities: { editable: boolean }

Type declaration:

NameType
editableboolean

WidgetMetadata

Ƭ WidgetMetadata: { [x:string]: any; }


WidgetNamespacesKeys

Ƭ WidgetNamespacesKeys: keyof IWidgetNamespaces


WidgetToBeCreated

Ƭ WidgetToBeCreated: { [index:string]: any; type: string }

Note: when creating a widget that requires a URL, if the URL has special characters. Make sure the URL is encoded properly.

Type declaration:

NameType
typestring

Did this page help you?