Unsupported

Unsupported.Unsupported

Unsupported

The Miro Web SDK doesn't yet support all board items. Unsupported items are grouped under a generic category called unsupported items.
We're planning to gradually support them in future releases.

At the moment it's not possible to create, update, or delete these items programmatically.
Currently, the Miro Web SDK supports reading and updating xand y coordinates of unsupported items.

Unsupported itemDescription
ConnectorDraws lines on a board to link objects. Helpful when building diagrams and flowcharts.
DocumentEmbeds a document—for example, a PDF file, a presentation slide deck, or a Google doc—in a board, so that it is possible to view it from within the board.
EmojiAdds emojis to a board.
KanbanCreates Kanban boards that can be populated with Cards to manage product delivery.
Mind MapHelps visually represent thought processes and hierarchical relationships.
MockupEnables using wireframes to create mock-ups to prototype interaction interfaces quickly and efficiently.
StrokeIt simulates a pen stroke to draws lines on a board.
SVGCreates icons from Scalable Vector Graphics format XML.
Table textEnables adding, editing, and deleting text from tables on a board.
TableEnables adding, editing, and deleting tables on a board.
USMUser Story Mapping (USM) helps structure, organize, and plan user tasks and product releases.
WebScreenEnables taking a screenshot of a web page in Chrome, and then saving it to a library. The screenshot can then be added to a board. It's part of the Miro Web Clipper web browser extension.

Table of contents

Properties

Methods

Properties

type

Readonly type: UnsupportedType

Defines the type of item.
Item type is useful to retrieve specific items from a board.
For example, you can fetch all card and shape items from the board, and then carry out an action on them.

Example:

// Get all items from the board
const items = await miro.board.get();

// Count all card and shape items on the board
let cards = 0;
let shapes = 0;

items.forEach((items) => {
  switch (items.type) {
    case 'card':
      cards++;
    case 'shape':
      shapes++;
  }
});

// Output to the console the total amount of card and shape items
console.log('The current board has ${cards} cards and ${shapes} shapes.');

Overrides

BaseItem.type


id

Readonly id: string


origin

origin: "center"

origin marks:

  • The positioning reference point of a board item.
    This is the point used to calculate the x and y coordinates of an item when it's positioned on the board, or when it's a child inside a parent item.
  • The rotation pivot point of a board item that supports rotation.

origin accepts only one value: center.
Any other value throws an error.


parentId

Readonly parentId: null | string

If an item is a child of another item, the child's parentId returns the unique identifier of the corresponding parent item.
If an item has no parent, its parentId is null.

You can use the value to retrieve a tree structure when items are nested inside containers.
For example, sticky notes inside frames.


createdAt

Readonly createdAt: string

Timestamp

Date and time when the item was created.

Format: UTC, ISO 8601.
Includes a trailing Z offset.

Example: 2021-05-18T07:59:01Z


createdBy

Readonly createdBy: string

Miro users are automatically assigned a unique ID.

createdBy contains the ID of the user who created the item.

Example: 3658432978520043388


modifiedAt

Readonly modifiedAt: string

Timestamp

Date and time when the item was last modified.

Format: UTC, ISO 8601.
Includes a trailing Z offset.

Example: 2021-05-18T07:59:01Z


modifiedBy

Readonly modifiedBy: string

Miro users are automatically assigned a unique ID.

modifiedBy contains the ID of the user who applied the most recent edit to the item.

Example: 3658432978520043388


x

x: number

The x-axis coordinate of an item is the horizontal distance in dp of the center point of the item from the center point of the board.

The center point of the board has x: 0 and y: 0 coordinates.

Default: 0

See also:


y

y: number

The y-axis coordinate of an item is the vertical distance in dp of the center point of the item from the center point of the board.

The center point of the board has x: 0 and y: 0 coordinates.

Default: 0

See also:

Methods

sync

sync(): Promise<void>

sync propagates to the board any changes to item and tag properties.
After updating the properties of an item or a tag, sync it with the board to:

  • Propagate to the board the changes applied to the item or to the tag.
  • Make the changes visible on the board.

All board items and tags require sync to make any changes to their properties visible on the board.

For more information and examples, see Update and sync item properties.

Returns

Promise<void>


Did this page help you?