Interface HasSelection

Payload for selection change events, which includes the currently selected nodes and their IDs.

interface HasSelection {
    selection(): INode[];
    isSelected(node: INode): boolean;
    select(node: INode, option: "in_group" | "isolated"): void;
    deselect(node: INode, option: "in_group" | "isolated"): void;
    clearSelection(): void;
}

Implemented by

DiagramView

Index

Methods

selection isSelected select deselect clearSelection

Methods

selection

selection(): INode[]
Returns an array of currently selected nodes in the diagram.

Returns INode[]
An array of INode objects representing the selected nodes.
- Defined in src/interfaces.ts:372

isSelected

isSelected(node: INode): boolean
Checks if a given node is currently selected in the diagram.
Parameters
- node: INode
  The node to check for selection.
Returns boolean
True if the node is selected, false otherwise.
- Defined in src/interfaces.ts:378

select

select(node: INode, option: "in_group" | "isolated"): void
Selects a given node in the diagram.
Parameters
- node: INode
  The node to select.
- option: "in_group" | "isolated"
  The selection option, either 'in_group' or 'isolated'.
Returns void
- Defined in src/interfaces.ts:384

deselect

deselect(node: INode, option: "in_group" | "isolated"): void
Deselects a given node in the diagram.
Parameters
- node: INode
  The node to deselect.
- option: "in_group" | "isolated"
  The selection option, either 'in_group' or 'isolated'.
Returns void
- Defined in src/interfaces.ts:390

clearSelection

clearSelection(): void
Clears the current selection in the diagram.

Returns void
- Defined in src/interfaces.ts:394