Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DiagramMakerNode<NodeType>

Interface for storing the state of a given diagram maker node.

Type parameters

  • NodeType

    The type of data stored per node by the consumer.

Hierarchy

  • DiagramMakerNode

Index

Properties

Properties

Optional Readonly consumerData

consumerData?: NodeType

Contains data managed by the consumer

Readonly diagramMakerData

diagramMakerData: { dragging?: boolean; position: Position; selected?: boolean; size: Size }

Contains node data managed by diagram maker.

Type declaration

  • Optional Readonly dragging?: boolean

    Denotes whether the node is currently being dragged.

  • Readonly position: Position

    Current position of the node w.r.t the workspace

  • Optional Readonly selected?: boolean

    Denotes whether the node is currently selected.

  • Readonly size: Size

    Current size of the node

Readonly id

id: string

Unique identifier for the node. Autogenerated for nodes newly created. Supplied for nodes already present when diagram maker initializes. In the case it is supplied, please ensure that this is unique.

Optional Readonly typeId

typeId?: string

Type of the node. Optional. References to the id present on the potential node when it was dragged in. Also useful to specify override connector placements, hiding specific connectors or providing the shape for boundary connector placements.

Generated using TypeDoc