GuidesWeb SDK 2.0REST API 2.0SCIM APILive EmbedChangelogMarketplaceRoadmap
Build your app

Shape

Suggest Edits

Shape.Shape

Shape

Represents a geometric shape on a board.
Shapes are useful when drawing flowcharts and diagrams.

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

  • Set or update only width.
    Default width: 100 dp
  • Set or update onlyheight.
    Default height: 100 dp
  • Set or update width and height at the same time.

Example:

const shape = await miro.board.createShape({
  content: '<p>This is a star shape.</p>',
  shape: 'star',
  style: {
    fillColor: '#fbff00', // Default color: transparent (no fill)
    fontFamily: 'arial', // Default font type for the text
    fontSize: 14, // Default font size in dp for the text
    textAlign: 'center', // Default alignment: center
    textAlignVertical: 'middle', // Default alignment: middle
  },
  x: 0, // Default value: center of the board
  y: 0, // Default value: center of the board
  width: 200,
  height: 200,
});

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

Shape item (star shape):

Shape item example: a star shape.Shape item example: a star shape.
Figure 1. Shape item example: a star shape.

Table of contents

Properties

Methods

Properties

type

• Readonly type: "shape"

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:

height

• Readonly height: number

Height of the item in dp.

See also:

rotation

• rotation: number

Rotation angle of an item in degrees, relative to the board.
You can rotate items clockwise (right) and counterclockwise (left) by specifying positive and negative values, respectively.

The rotation property doesn't perform a rotation action on an item; it assigns the item a rotation angle.
Invoking the same rotation value multiple times on an item re-applies the same value; it doesn't result in multiple rotations of the item.

See also:

content

• content: string = ''

The text that you want to display on the shape item.
The text must be shorter than 6000 characters.

content supports plain text, and the following HTML tags:

  • <p>
  • <a>
  • <strong>
  • <b>
  • <em>
  • <i>
  • <u>
  • <s>
  • <span>
  • <br>

Unsupported HTML tags are automatically stripped.

shape

• shape: "rectangle"

The geometric shape of the item displayed on a board.

Possible values:

  • rectangle
  • round_rectangle
  • circle
  • triangle
  • rhombus
  • parallelogram
  • trapezoid
  • pentagon
  • hexagon
  • octagon
  • wedge_round_rectangle_callout
  • star
  • flow_chart_predefined_process
  • cloud
  • cross
  • can
  • right_arrow
  • left_arrow
  • left_right_arrow
  • left_brace
  • right_brace

Default: rectangle

style

• style: Object

The style object groups properties that define the layout, the look and feel of specific elements of an item, when it's displayed on the board.
For example: background color, font family, font type, horizontal and vertical alignment of the text, text color, and so on.

The Miro Web SDK doesn't support all standard style, yet. Additional styles will be included in future releases.

style data structure:

style: {
  fillColor: '#6DEB0C', // Default color: transparent (no fill)
  fontFamily: 'arial', // Default font type for the text
  fontSize: 14, // Default font size in dp for the text
  textAlign: 'center', // Default alignment: center
  textAlignVertical: 'middle', // Default alignment: middle
},

fillColor

Hex value representing the color that fills the area of the shape.

ℹ️ Note:

The following shapes don't support the fillColor property:

  • brace_left
  • brace_right

Default: transparent (no fill color)

fontFamily

Sets the type of font for the text in the content property of the shape item.

Possible font families:

  • arial
  • cursive
  • abril_fatface
  • bangers
  • eb_garamond
  • georgia
  • graduate
  • gravitas_one
  • fredoka_one
  • nixie_one
  • open_sans
  • permanent_marker
  • pt_sans
  • pt_sans_narrow
  • pt_serif
  • rammetto_one
  • roboto
  • roboto_condensed
  • roboto_slab
  • caveat
  • times_new_roman
  • titan_one
  • lemon_tuesday
  • roboto_mono
  • noto_sans
  • plex_sans
  • plex_serif
  • plex_mono
  • spoof
  • tiempos_text
  • noto_serif
  • noto_serif_jp
  • noto_sans_jp
  • noto_sans_hebrew
  • noto_serif_sc
  • noto_serif_kr
  • noto_sans_sc
  • noto_sans_kr
  • serif
  • sans_serif
  • monospace

Default: arial

fontSize

Defines the font size, in dp, for the text in the content property of the shape item.

Default: 14

textAlign

Sets the horizontal alignment of any text in the content property of the shape item.

Possible values:

  • left: the text is aligned with the left margin of the text area.
  • center: the text is at an equal distance from the left and right margins of the text area.
  • right: the text is aligned with the right margin of the text area.

Default: center

textAlignVertical

Sets the vertical alignment of any text in the content property of the shape item.

Possible values:

  • top: the text is aligned with the top margin of the text area.
  • middle: the text is at an equal distance from the top and bottom margins of the text area.
  • bottom: the text is aligned with the bottom margin of the text area.

Default: middle

Type declaration

NameType
fillColorstring
fontFamilyFontFamily
fontSizenumber
textAlignTextAlign
textAlignVerticalTextAlignVertical

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>

Updated 5 months ago

Did this page help you?