Class BaseItem`Abstract` `Internal`

Contains the result data.

Hierarchy

GenericItem
- BaseItem
  - Item

Implements

ConnectTo

Index

Constructors

Methods

connectTo fromGenericItem

Properties

createdAt? createdBy? data? geometry? id modifiedAt? modifiedBy? parent? position? type

Constructors

constructor

new BaseItem(): BaseItem
Returns BaseItem

Inherited from GenericItem.constructor

Methods

connectTo

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

Type declaration

- (endItem: string | number | ItemConnectionCreationData, connectorCreationData?: ConnectorCreationData): Promise<Connector>
- Parameters
  - endItem: string | number | ItemConnectionCreationData
  - Optional connectorCreationData: ConnectorCreationData
  Returns Promise<Connector>

`Static` fromGenericItem

fromGenericItem(api: MiroApi, boardId: string, item: GenericItem): WidgetItem
Parameters
- api: MiroApi
- boardId: string
- item: GenericItem
Returns WidgetItem
- Defined in highlevel/Item.ts:75

Properties

`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?: WidgetDataOutput

`Optional` geometry

geometry?: Geometry

id

id: string

Unique identifier (ID) of an item.

`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?: Parent

`Optional` position

position?: Position

type

type: string

Type of item that is returned.