Preview

Preview

Represents the Open Graph metadata of the URL as a sneak peek.
It's the same mechanism that enables displaying link previews on social media sites like Facebook, or messaging apps like iMessage.

When creating or updating a preview item, you can define its dimensions in the following way:

Set or update only width.
Default width: 250 dp
Set or update only height.
height has no default value.

Based on the specified value, the preview is scaled accordingly to keep its aspect ratio.

ℹ️ Note:

It's possible to initially set url, but at the moment it's not possible to update it.

Example:

const preview = await miro.board.createPreview({
  url: 'https://miro.com/',
  x: 0, // Default value: horizontal center of the board
  y: 0, // Default value: vertical center of the board
  width: 400,
});

// Output the created item to the developer console
console.log(preview);

Preview item:

Preview item.
Figure 1. Preview item.

Properties

Methods

sync

Properties

type

• Readonly type: "preview"

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

width

• Readonly width: number

Width of the item in dp.

See also:

Pixels and dimensions

height

• Readonly height: number

Height of the item in dp.

See also:

Pixels and dimensions

url

• Readonly url: string

A valid URL pointing to a web page containing Open Graph metadata in the HTML <head></head> section.

Possible transport protocols:

HTTP
HTTPS

ℹ️ Note:

It's possible to initially set url, but at the moment it's not possible to update it.

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>

Table of contents

Properties

Methods

Properties

type

Overrides

width

height

url

id

origin

parentId

createdAt

createdBy

modifiedAt

modifiedBy

x

y

Methods

sync

Returns