CommandHandler

Defined in: command/CommandHandler.ts:22

Handles high-level editing commands for a diagram. Provides delete, copy, cut, paste, and select-all operations.

Constructors

Constructor

new CommandHandler(diagram): CommandHandler

Defined in: command/CommandHandler.ts:31

Parameters

diagram

Diagram

Returns

CommandHandler

Methods

align()

align(alignment): boolean

Defined in: command/CommandHandler.ts:408

Align selected nodes (needs at least 2). Returns true if aligned.

Parameters

alignment

AlignDirection

Returns

boolean

---

bringToFront()

bringToFront(): boolean

Defined in: command/CommandHandler.ts:551

Bring the selected parts to the front (highest z-order in their layer).

Returns

boolean

---

canCopy()

canCopy(): boolean

Defined in: command/CommandHandler.ts:41

Whether copy/paste is available (there is something selected).

Returns

boolean

---

canCopySelection()

canCopySelection(): boolean

Defined in: command/CommandHandler.ts:644

Returns

boolean

---

canCutSelection()

canCutSelection(): boolean

Defined in: command/CommandHandler.ts:648

Returns

boolean

---

canDecreaseZoom()

canDecreaseZoom(): boolean

Defined in: command/CommandHandler.ts:783

GoJS-compatible: Whether decreaseZoom is possible.

Returns

boolean

---

canDeleteSelection()

canDeleteSelection(): boolean

Defined in: command/CommandHandler.ts:640

Returns

boolean

---

canDuplicateSelection()

canDuplicateSelection(): boolean

Defined in: command/CommandHandler.ts:758

GoJS-compatible: Whether duplicateSelection is possible.

Returns

boolean

---

canGroupSelection()

canGroupSelection(): boolean

Defined in: command/CommandHandler.ts:666

GoJS-compatible: Whether groupSelection is possible (>=1 selected node).

Returns

boolean

---

canIncreaseZoom()

canIncreaseZoom(): boolean

Defined in: command/CommandHandler.ts:771

GoJS-compatible: Whether increaseZoom is possible.

Returns

boolean

---

canPaste()

canPaste(): boolean

Defined in: command/CommandHandler.ts:46

Whether there is content on the clipboard to paste.

Returns

boolean

---

canPasteSelection()

canPasteSelection(): boolean

Defined in: command/CommandHandler.ts:656

Returns

boolean

---

canSelectAll()

canSelectAll(): boolean

Defined in: command/CommandHandler.ts:652

Returns

boolean

---

canUngroupSelection()

canUngroupSelection(): boolean

Defined in: command/CommandHandler.ts:725

GoJS-compatible: Whether ungroupSelection is possible (>=1 selected group).

Returns

boolean

---

canZoomToFit()

canZoomToFit(): boolean

Defined in: command/CommandHandler.ts:802

GoJS-compatible: Whether the diagram can zoom to fit.

Returns

boolean

---

clearClipboard()

clearClipboard(): void

Defined in: command/CommandHandler.ts:368

Clear the clipboard.

Returns

void

---

copySelection()

copySelection(): boolean

Defined in: command/CommandHandler.ts:175

Copy the selected parts (and their connected links) to the clipboard.

Returns

boolean

---

cutSelection()

cutSelection(): boolean

Defined in: command/CommandHandler.ts:216

Cut the selected parts (copy + delete).

Returns

boolean

---

decreaseZoom()

decreaseZoom(factor?): boolean

Defined in: command/CommandHandler.ts:788

GoJS-compatible: Zoom out by a factor.

Parameters

factor?

number = 1.25

Returns

boolean

---

deleteSelection()

deleteSelection(): boolean

Defined in: command/CommandHandler.ts:56

Delete the currently selected parts (undoable).

Returns

boolean

---

deleteSelectionNoUndo()

deleteSelectionNoUndo(): boolean

Defined in: command/CommandHandler.ts:154

Delete the selection without undo support. Returns true if any were removed.

Returns

boolean

---

distributeHorizontally()

distributeHorizontally(): boolean

Defined in: command/CommandHandler.ts:485

Distribute selected nodes evenly along the horizontal axis. Returns true if done.

Returns

boolean

---

distributeVertically()

distributeVertically(): boolean

Defined in: command/CommandHandler.ts:518

Distribute selected nodes evenly along the vertical axis. Returns true if done.

Returns

boolean

---

duplicateSelection()

duplicateSelection(): boolean

Defined in: command/CommandHandler.ts:763

GoJS-compatible: Duplicate the selection at a small offset.

Returns

boolean

---

getClipboard()

getClipboard(): object

Defined in: command/CommandHandler.ts:356

Get the current clipboard contents.

Returns

object

links

links: readonly NodeData[]

nodes

nodes: readonly NodeData[]

---

getDiagram()

getDiagram(): Diagram

Defined in: command/CommandHandler.ts:36

Get the diagram this handler belongs to.

Returns

Diagram

---

groupSelection()

groupSelection(): boolean

Defined in: command/CommandHandler.ts:671

GoJS-compatible: Group the selected nodes into a new Group part.

Returns

boolean

---

increaseZoom()

increaseZoom(factor?): boolean

Defined in: command/CommandHandler.ts:776

GoJS-compatible: Zoom in by a factor.

Parameters

factor?

number = 1.25

Returns

boolean

---

lower()

lower(): boolean

Defined in: command/CommandHandler.ts:617

Lower the selected parts by one z-order step.

Returns

boolean

---

nudgeSelection()

nudgeSelection(dx, dy, scale?): boolean

Defined in: command/CommandHandler.ts:383

GoJS-compatible: Nudge the selected parts by the given deltas (arrow keys).

Parameters

dx

number

dy

number

scale?

number = 1

Returns

boolean

---

pasteClipboard()

pasteClipboard(offset?): boolean

Defined in: command/CommandHandler.ts:223

Paste the clipboard (nodes + links) into the diagram (undoable).

Parameters

offset?

number = 20

Returns

boolean

---

pasteClipboardAt()

pasteClipboardAt(x, y): boolean

Defined in: command/CommandHandler.ts:228

Paste the clipboard so the first node lands at the given position.

Parameters

x

number

y

number

Returns

boolean

---

pasteSelection()

pasteSelection(position?): boolean

Defined in: command/CommandHandler.ts:814

GoJS-compatible: Paste the current clipboard at the given position, if any.

Parameters

position?

x

number

y

number

Returns

boolean

---

raise()

raise(): boolean

Defined in: command/CommandHandler.ts:612

Raise the selected parts by one z-order step.

Returns

boolean

---

redo()

redo(): boolean

Defined in: command/CommandHandler.ts:351

Redo the last operation.

Returns

boolean

---

resetZoom()

resetZoom(): boolean

Defined in: command/CommandHandler.ts:795

GoJS-compatible: Reset the zoom to 1.

Returns

boolean

---

selectAll()

selectAll(): boolean

Defined in: command/CommandHandler.ts:321

Select all parts in the diagram.

Returns

boolean

---

selectAllInDiagram()

selectAllInDiagram(): boolean

Defined in: command/CommandHandler.ts:661

GoJS-compatible: Select all parts in the diagram.

Returns

boolean

---

sendToBack()

sendToBack(): boolean

Defined in: command/CommandHandler.ts:582

Send the selected parts to the back (lowest z-order in their layer).

Returns

boolean

---

setClipboard()

setClipboard(data): void

Defined in: command/CommandHandler.ts:361

Set the clipboard contents.

Parameters

data

NodeData[] | { links: NodeData[]; nodes: NodeData[]; }

Returns

void

---

undo()

undo(): boolean

Defined in: command/CommandHandler.ts:346

Undo the last operation.

Returns

boolean

---

ungroupSelection()

ungroupSelection(): boolean

Defined in: command/CommandHandler.ts:730

GoJS-compatible: Ungroup the selected groups, releasing their members.

Returns

boolean

---

zoomToFit()

zoomToFit(): boolean

Defined in: command/CommandHandler.ts:807

GoJS-compatible: Zoom to fit the entire diagram in the viewport.

Returns

boolean