Class ShapeItem

Hierarchy

Properties

boardId createdAt? createdBy? data? geometry? id links? modifiedAt? modifiedBy? parent? position? style? type

Methods

connectTo delete update

Properties

boardId

boardId: string

Optional createdAt

createdAt?: Date

Date and time when the item was created.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

Optional createdBy

createdBy?: CreatedBy

Optional data

data?: ShapeDataForCreate

Optional geometry

geometry?: Geometry

id

id: string

Unique identifier (ID) of an item.

Optional links

links?: WidgetLinks

Optional modifiedAt

modifiedAt?: Date

Date and time when the item was last modified.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

Optional modifiedBy

modifiedBy?: ModifiedBy

Optional parent

parent?: ParentLinksEnvelope

Optional position

position?: Position

Optional style

style?: ShapeStyleForCreate

type

type: "shape" = 'shape'

Type of item that is returned.

Methods

connectTo

connectTo: ((endItem: string | number | ItemConnectionCreationData, connectorCreationData?: ConnectorCreationData) => Promise<Connector>) = ConnectableItem.prototype.connectTo

Type declaration

delete

  • Deletes a shape item from the board.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 3

    Summary

    Delete shape item

    Returns Promise<void>

update

  • Updates a shape item on a board based on the data and style properties provided in the request body.

    Required scope

    boards:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#rate-limiting">Level 2

    Summary

    Update shape item

    Parameters

    Returns Promise<void>

@mirohq/miro-api