Class FrameItem

Hierarchy

  • BaseFrameItem
    • FrameItem

Properties

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

Methods

delete getAllItems 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?: FrameData

Optional geometry

geometry?: Geometry

id

id: string

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 position

position?: Position

Optional style

style?: FrameStyle

type

type: string

Type of item that is returned.

Methods

delete

  • Deletes a frame from a board.

    Required scope

    boards:write

    Rate limiting

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

    Summary

    Delete frame

    Returns Promise<void>

getAllItems

  • Retrieves a list of items within a specific frame. A frame is a parent item and all items within a frame are child items.

    Required scope

    boards:read

    Rate limiting

    Level 2
    Returns an iterator which will automatically paginate and fetch all available items

    Summary

    Get items within frame

    Parameters

    • Optional query: Omit<undefined | {
          cursor?: string;
          limit?: string;
          type?: string;
      }, "cursor">

    Returns AsyncGenerator<WidgetItem, void, unknown>

update

  • Updates a frame on a board based on the data, style, or geometry 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 frame

    Parameters

    Returns Promise<void>

@mirohq/miro-api