Diagram

Defined in: diagram/Diagram.ts:229

A diagram that renders nodes and links on a canvas.

Constructors

Constructor

new Diagram(options): Diagram

Defined in: diagram/Diagram.ts:381

Parameters

options

string | HTMLDivElement | DiagramOptions

Returns

Diagram

Properties

accessibilityMessages

accessibilityMessages: AccessibilityMessages

Defined in: diagram/Diagram.ts:282

Accessibility: message formatters for the aria-label and live-region announcements (default: English).

---

toolTipDelay

toolTipDelay: number = 500

Defined in: diagram/Diagram.ts:321

GoJS-compatible: delay (ms) before a part’s toolTip Panel appears on hover.

---

AlignFill

readonly static AlignFill: "Fill" = 'Fill'

Defined in: diagram/Diagram.ts:236

---

AlignMax

readonly static AlignMax: "Max" = 'Max'

Defined in: diagram/Diagram.ts:234

---

AlignMin

readonly static AlignMin: "Min" = 'Min'

Defined in: diagram/Diagram.ts:233

---

AlignNone

readonly static AlignNone: "None" = 'None'

Defined in: diagram/Diagram.ts:231

---

AlignScale

readonly static AlignScale: "Scale" = 'Scale'

Defined in: diagram/Diagram.ts:235

---

AlignSpot

readonly static AlignSpot: "Spot" = 'Spot'

Defined in: diagram/Diagram.ts:232

Accessors

actualBounds

Get Signature

get actualBounds(): Rect

Defined in: diagram/Diagram.ts:3973

GoJS-compatible: The actual bounds currently occupied by parts.

Returns

Rect

---

allLinks

Get Signature

get allLinks(): Link[]

Defined in: diagram/Diagram.ts:2676

GoJS-compatible: All links in this diagram.

Returns

Link[]

---

allNodes

Get Signature

get allNodes(): Node[]

Defined in: diagram/Diagram.ts:2681

GoJS-compatible: All nodes in this diagram (as an array).

Returns

Node[]

---

allowArrange

Get Signature

get allowArrange(): boolean

Defined in: diagram/Diagram.ts:1049

GoJS-compatible: Whether parts can be rearranged.

Returns

boolean

Set Signature

set allowArrange(value): void

Defined in: diagram/Diagram.ts:1053

Parameters

value

boolean

Returns

void

---

allowCopy

Get Signature

get allowCopy(): boolean

Defined in: diagram/Diagram.ts:896

GoJS-compatible: Whether parts can be copied.

Returns

boolean

Set Signature

set allowCopy(value): void

Defined in: diagram/Diagram.ts:900

Parameters

value

boolean

Returns

void

---

allowDelete

Get Signature

get allowDelete(): boolean

Defined in: diagram/Diagram.ts:905

GoJS-compatible: Whether parts can be deleted.

Returns

boolean

Set Signature

set allowDelete(value): void

Defined in: diagram/Diagram.ts:909

Parameters

value

boolean

Returns

void

---

allowDrop

Get Signature

get allowDrop(): boolean

Defined in: diagram/Diagram.ts:914

GoJS-compatible: Whether parts can be dropped onto the diagram.

Returns

boolean

Set Signature

set allowDrop(value): void

Defined in: diagram/Diagram.ts:918

Parameters

value

boolean

Returns

void

---

allowGroup

Get Signature

get allowGroup(): boolean

Defined in: diagram/Diagram.ts:1013

GoJS-compatible: Whether nodes can be grouped.

Returns

boolean

Set Signature

set allowGroup(value): void

Defined in: diagram/Diagram.ts:1017

Parameters

value

boolean

Returns

void

---

allowHorizontalScroll

Get Signature

get allowHorizontalScroll(): boolean

Defined in: diagram/Diagram.ts:932

GoJS-compatible: Whether horizontal scrolling is allowed.

Returns

boolean

Set Signature

set allowHorizontalScroll(value): void

Defined in: diagram/Diagram.ts:936

Parameters

value

boolean

Returns

void

---

allowInsert

Get Signature

get allowInsert(): boolean

Defined in: diagram/Diagram.ts:1022

GoJS-compatible: Whether new nodes can be inserted.

Returns

boolean

Set Signature

set allowInsert(value): void

Defined in: diagram/Diagram.ts:1026

Parameters

value

boolean

Returns

void

---

allowLink

Get Signature

get allowLink(): boolean

Defined in: diagram/Diagram.ts:995

GoJS-compatible: Whether new links can be drawn.

Returns

boolean

Set Signature

set allowLink(value): void

Defined in: diagram/Diagram.ts:999

Parameters

value

boolean

Returns

void

---

allowMove

Get Signature

get allowMove(): boolean

Defined in: diagram/Diagram.ts:887

GoJS-compatible: Whether parts can be moved.

Returns

boolean

Set Signature

set allowMove(value): void

Defined in: diagram/Diagram.ts:891

Parameters

value

boolean

Returns

void

---

allowRelink

Get Signature

get allowRelink(): boolean

Defined in: diagram/Diagram.ts:1004

GoJS-compatible: Whether existing links can be reconnected.

Returns

boolean

Set Signature

set allowRelink(value): void

Defined in: diagram/Diagram.ts:1008

Parameters

value

boolean

Returns

void

---

allowResize

Get Signature

get allowResize(): boolean

Defined in: diagram/Diagram.ts:1031

GoJS-compatible: Whether nodes can be resized.

Returns

boolean

Set Signature

set allowResize(value): void

Defined in: diagram/Diagram.ts:1035

Parameters

value

boolean

Returns

void

---

allowRotate

Get Signature

get allowRotate(): boolean

Defined in: diagram/Diagram.ts:1040

GoJS-compatible: Whether nodes can be rotated.

Returns

boolean

Set Signature

set allowRotate(value): void

Defined in: diagram/Diagram.ts:1044

Parameters

value

boolean

Returns

void

---

allowTextEdit

Get Signature

get allowTextEdit(): boolean

Defined in: diagram/Diagram.ts:986

GoJS-compatible: Whether in-place text editing is allowed.

Returns

boolean

Set Signature

set allowTextEdit(value): void

Defined in: diagram/Diagram.ts:990

Parameters

value

boolean

Returns

void

---

allowVerticalScroll

Get Signature

get allowVerticalScroll(): boolean

Defined in: diagram/Diagram.ts:941

GoJS-compatible: Whether vertical scrolling is allowed.

Returns

boolean

Set Signature

set allowVerticalScroll(value): void

Defined in: diagram/Diagram.ts:945

Parameters

value

boolean

Returns

void

---

allowZoom

Get Signature

get allowZoom(): boolean

Defined in: diagram/Diagram.ts:923

GoJS-compatible: Whether zooming is allowed.

Returns

boolean

Set Signature

set allowZoom(value): void

Defined in: diagram/Diagram.ts:927

Parameters

value

boolean

Returns

void

---

animationManager

Get Signature

get animationManager(): AnimationManager

Defined in: diagram/Diagram.ts:611

GoJS-compatible: The animation manager.

Returns

AnimationManager

---

autoScale

Get Signature

get autoScale(): number

Defined in: diagram/Diagram.ts:2786

GoJS-compatible: AutoScale mode (0=None, 1=Uniform, 2=Fit).

Returns

number

Set Signature

set autoScale(value): void

Defined in: diagram/Diagram.ts:2790

Parameters

value

number

Returns

void

---

background

Get Signature

get background(): string

Defined in: diagram/Diagram.ts:2961

GoJS-compatible: The background color of the diagram.

Returns

string

Set Signature

set background(value): void

Defined in: diagram/Diagram.ts:2965

Parameters

value

string

Returns

void

---

commandHandler

Get Signature

get commandHandler(): CommandHandler

Defined in: diagram/Diagram.ts:621

GoJS-compatible: The command handler.

Returns

CommandHandler

---

contentAlignment

Get Signature

get contentAlignment(): Spot | null

Defined in: diagram/Diagram.ts:2774

GoJS-compatible: The alignment of the diagram content within the viewport.

Returns

Spot | null

Set Signature

set contentAlignment(value): void

Defined in: diagram/Diagram.ts:2778

Parameters

value

Spot | null

Returns

void

---

div

Get Signature

get div(): HTMLDivElement | null

Defined in: diagram/Diagram.ts:2922

GoJS-compatible: The HTML element this diagram renders into, or null if detached.

Returns

HTMLDivElement | null

Set Signature

set div(value): void

Defined in: diagram/Diagram.ts:2933

GoJS-compatible: reparent this diagram (the same instance, model, undo history, selection, and viewport) into a different div, or detach it from the DOM entirely with null. Real GoJS’s div is read/write for exactly this: moving a diagram between containers (e.g. a framework remounting its host element) without recreating it.

Parameters

value

HTMLDivElement | null

Returns

void

---

documentBounds

Get Signature

get documentBounds(): Rect

Defined in: diagram/Diagram.ts:3958

GoJS-compatible: The bounds of the document (all content).

Returns

Rect

---

grid

Get Signature

get grid(): Panel | null

Defined in: diagram/Diagram.ts:2737

GoJS-compatible: A Panel (type "Grid", e.g. $(go.Panel, "Grid", { gridCellSize }, $(go.Shape, "LineH", ...), $(go.Shape, "LineV", ...))) used as the background grid pattern. Its Shape children’s stroke/ strokeWidth style the grid lines; null falls back to the default styling driven by gridSize alone.

Returns

Panel | null

Set Signature

set grid(value): void

Defined in: diagram/Diagram.ts:2741

Parameters

value

Panel | null

Returns

void

---

groups

Get Signature

get groups(): ReadonlyMap<NodeKey, Group>

Defined in: diagram/Diagram.ts:2696

GoJS-compatible: The groups in this diagram.

Returns

ReadonlyMap<NodeKey, Group>

---

groupTemplate

Get Signature

get groupTemplate(): Panel | null

Defined in: diagram/Diagram.ts:650

GoJS-compatible: Get the default group template.

Returns

Panel | null

Set Signature

set groupTemplate(value): void

Defined in: diagram/Diagram.ts:655

GoJS-compatible: Set the default group template.

Parameters

value

Panel | null

Returns

void

---

groupTemplateMap

Get Signature

get groupTemplateMap(): Map<string, Panel>

Defined in: diagram/Diagram.ts:672

GoJS-compatible: Get the group template map.

Returns

Map<string, Panel>

---

horizontalScrollPosition

Get Signature

get horizontalScrollPosition(): number

Defined in: diagram/Diagram.ts:3978

GoJS-compatible: The horizontal scroll position in document coordinates.

Returns

number

Set Signature

set horizontalScrollPosition(value): void

Defined in: diagram/Diagram.ts:3982

Parameters

value

number

Returns

void

---

initialContentAlignment

Get Signature

get initialContentAlignment(): Spot | null

Defined in: diagram/Diagram.ts:968

GoJS-compatible: The initial content alignment spot.

Returns

Spot | null

Set Signature

set initialContentAlignment(value): void

Defined in: diagram/Diagram.ts:972

Parameters

value

Spot | null

Returns

void

---

initialContentAlignmentOffset

Get Signature

get initialContentAlignmentOffset(): { x: number; y: number; } | null

Defined in: diagram/Diagram.ts:977

GoJS-compatible: The initial content alignment offset.

Returns

{ x: number; y: number; } | null

Set Signature

set initialContentAlignmentOffset(value): void

Defined in: diagram/Diagram.ts:981

Parameters

value

{ x: number; y: number; } | null

Returns

void

---

isEnabled

Get Signature

get isEnabled(): boolean

Defined in: diagram/Diagram.ts:950

GoJS-compatible: Whether the diagram is enabled (interactive).

Returns

boolean

Set Signature

set isEnabled(value): void

Defined in: diagram/Diagram.ts:954

Parameters

value

boolean

Returns

void

---

isModified

Get Signature

get isModified(): boolean

Defined in: diagram/Diagram.ts:2971

GoJS-compatible: Whether the diagram’s model has been modified.

Returns

boolean

Set Signature

set isModified(value): void

Defined in: diagram/Diagram.ts:2975

Parameters

value

boolean

Returns

void

---

isReadOnly

Get Signature

get isReadOnly(): boolean

Defined in: diagram/Diagram.ts:878

GoJS-compatible: Whether the diagram is read-only.

Returns

boolean

Set Signature

set isReadOnly(value): void

Defined in: diagram/Diagram.ts:882

Parameters

value

boolean

Returns

void

---

layers

Get Signature

get layers(): readonly Layer[]

Defined in: diagram/Diagram.ts:2853

GoJS-compatible: The layers in this diagram.

Returns

readonly Layer[]

---

layout

Get Signature

get layout(): Layout | null

Defined in: diagram/Diagram.ts:2860

Returns

Layout | null

Set Signature

set layout(value): void

Defined in: diagram/Diagram.ts:2864

Parameters

value

Layout | null

Returns

void

---

links

Get Signature

get links(): ReadonlyMap<NodeKey, Link>

Defined in: diagram/Diagram.ts:2691

GoJS-compatible: The links in this diagram.

Returns

ReadonlyMap<NodeKey, Link>

---

linkTemplate

Get Signature

get linkTemplate(): Panel | null

Defined in: diagram/Diagram.ts:638

GoJS-compatible: Get the default link template.

Returns

Panel | null

Set Signature

set linkTemplate(value): void

Defined in: diagram/Diagram.ts:643

GoJS-compatible: Set the default link template.

Parameters

value

Panel | null

Returns

void

---

linkTemplateMap

Get Signature

get linkTemplateMap(): Map<string, Panel>

Defined in: diagram/Diagram.ts:667

GoJS-compatible: Get the link template map.

Returns

Map<string, Panel>

---

maxScale

Get Signature

get maxScale(): number

Defined in: diagram/Diagram.ts:349

GoJS-compatible: The maximum zoom scale.

Returns

number

Set Signature

set maxScale(value): void

Defined in: diagram/Diagram.ts:354

GoJS-compatible: Set the maximum zoom scale.

Parameters

value

number

Returns

void

---

maxSelectionCount

Get Signature

get maxSelectionCount(): number

Defined in: diagram/Diagram.ts:1058

GoJS-compatible: The maximum number of parts that can be selected.

Returns

number

Set Signature

set maxSelectionCount(value): void

Defined in: diagram/Diagram.ts:1062

Parameters

value

number

Returns

void

---

minScale

Get Signature

get minScale(): number

Defined in: diagram/Diagram.ts:337

GoJS-compatible: The minimum zoom scale.

Returns

number

Set Signature

set minScale(value): void

Defined in: diagram/Diagram.ts:342

GoJS-compatible: Set the minimum zoom scale.

Parameters

value

number

Returns

void

---

model

Get Signature

get model(): GraphLinksModel

Defined in: diagram/Diagram.ts:2838

GoJS-compatible: Get the model.

Returns

GraphLinksModel

Set Signature

set model(value): void

Defined in: diagram/Diagram.ts:2843

GoJS-compatible: Set the model.

Parameters

value

GraphLinksModel

Returns

void

---

modelChanged

Get Signature

get modelChanged(): ((event) => void) | null

Defined in: diagram/Diagram.ts:3004

Returns

((event) => void) | null

Set Signature

set modelChanged(listener): void

Defined in: diagram/Diagram.ts:2994

GoJS-compatible: A listener called when the model changes (single handler).

Parameters

listener

((event) => void) | null

Returns

void

---

nodes

Get Signature

get nodes(): ReadonlyMap<NodeKey, Node>

Defined in: diagram/Diagram.ts:2686

GoJS-compatible: The nodes in this diagram.

Returns

ReadonlyMap<NodeKey, Node>

---

nodeTemplate

Get Signature

get nodeTemplate(): Panel | null

Defined in: diagram/Diagram.ts:626

GoJS-compatible: Get the default node template.

Returns

Panel | null

Set Signature

set nodeTemplate(value): void

Defined in: diagram/Diagram.ts:631

GoJS-compatible: Set the default node template.

Parameters

value

Panel | null

Returns

void

---

nodeTemplateMap

Get Signature

get nodeTemplateMap(): Map<string, Panel>

Defined in: diagram/Diagram.ts:662

GoJS-compatible: Get the node template map.

Returns

Map<string, Panel>

---

padding

Get Signature

get padding(): number

Defined in: diagram/Diagram.ts:3595

GoJS-compatible: The padding around the content.

Returns

number

Set Signature

set padding(value): void

Defined in: diagram/Diagram.ts:3599

Parameters

value

number | { bottom: number; left: number; right: number; top: number; }

Returns

void

---

parts

Get Signature

get parts(): Iterator<Part | Node | Link | Group>

Defined in: diagram/Diagram.ts:2709

GoJS-compatible: an iterator over all of this diagram’s top-level Parts (nodes, links, groups, and any bare decorative Parts added via add()), in no particular order — mirrors real GoJS’s Iterator protocol (call next() before reading .value) and is also a real [Symbol.iterator], so for (const p of diagram.parts) works too. Previously the only way to reach a Part was by already knowing its key (getPart/findPartForKey/findNodeForKey/…).

Returns

Iterator<Part | Node | Link | Group>

---

position

Get Signature

get position(): object

Defined in: diagram/Diagram.ts:3586

GoJS-compatible: The position (top-left of the viewport in diagram coordinates).

Returns

object

x

x: number

y

y: number

Set Signature

set position(value): void

Defined in: diagram/Diagram.ts:3590

Parameters

value

x

number

y

number

Returns

void

---

scale

Get Signature

get scale(): number

Defined in: diagram/Diagram.ts:3575

GoJS-compatible: The current zoom scale.

Returns

number

Set Signature

set scale(value): void

Defined in: diagram/Diagram.ts:3579

Parameters

value

number

Returns

void

---

scrollBehavior

Get Signature

get scrollBehavior(): number

Defined in: diagram/Diagram.ts:2798

GoJS-compatible: How scrolling and scrollbars behave.

Returns

number

Set Signature

set scrollBehavior(value): void

Defined in: diagram/Diagram.ts:2802

Parameters

value

number

Returns

void

---

scrollMode

Get Signature

get scrollMode(): "document" | "infinite"

Defined in: diagram/Diagram.ts:959

GoJS-compatible: The scroll mode (‘document’ or ‘infinite’).

Returns

"document" | "infinite"

Set Signature

set scrollMode(value): void

Defined in: diagram/Diagram.ts:963

Parameters

value

"document" | "infinite"

Returns

void

---

selection

Get Signature

get selection(): (Node | Link | Group)[]

Defined in: diagram/Diagram.ts:2671

GoJS-compatible: The set of currently selected parts.

Returns

(Node | Link | Group)[]

---

selectionStyle

Get Signature

get selectionStyle(): SelectionStyle

Defined in: diagram/Diagram.ts:2876

Colors used for selection highlights and the keyboard focus cursor. Defaults to a high-contrast palette when the OS requests more contrast (see the constructor); assigning here always overrides that default.

Returns

SelectionStyle

Set Signature

set selectionStyle(value): void

Defined in: diagram/Diagram.ts:2880

Parameters

value

SelectionStyle

Returns

void

---

themeManager

Get Signature

get themeManager(): ThemeManager

Defined in: diagram/Diagram.ts:3106

GoJS-compatible: the ThemeManager for this diagram, lazily created with the default light/dark themes on first access.

Returns

ThemeManager

Set Signature

set themeManager(value): void

Defined in: diagram/Diagram.ts:3114

Parameters

value

ThemeManager

Returns

void

---

toolManager

Get Signature

get toolManager(): ToolManager

Defined in: diagram/Diagram.ts:591

GoJS-compatible: The tool manager.

Returns

ToolManager

---

undoManager

Get Signature

get undoManager(): UndoManager

Defined in: diagram/Diagram.ts:601

GoJS-compatible: The undo manager.

Returns

UndoManager

---

verticalScrollPosition

Get Signature

get verticalScrollPosition(): number

Defined in: diagram/Diagram.ts:3987

GoJS-compatible: The vertical scroll position in document coordinates.

Returns

number

Set Signature

set verticalScrollPosition(value): void

Defined in: diagram/Diagram.ts:3991

Parameters

value

number

Returns

void

---

viewportBounds

Get Signature

get viewportBounds(): Rect

Defined in: diagram/Diagram.ts:3963

GoJS-compatible: The bounds of the viewport.

Returns

Rect

---

zoomFactor

Get Signature

get zoomFactor(): number

Defined in: diagram/Diagram.ts:3538

GoJS-compatible: The current zoom factor (alias for scale).

Returns

number

Set Signature

set zoomFactor(value): void

Defined in: diagram/Diagram.ts:3542

Parameters

value

number

Returns

void

Methods

add()

add(part): void

Defined in: diagram/Diagram.ts:3620

GoJS-compatible: Add a part directly to the diagram (and its data to the model).

Parameters

part

Part

Returns

void

---

addAnyDiagramListener()

addAnyDiagramListener(handler): void

Defined in: diagram/Diagram.ts:712

Add a listener for all diagram events.

Parameters

handler

(event) => void

Returns

void

---

addDiagramListener()

addDiagramListener(type, handler): void

Defined in: diagram/Diagram.ts:707

Add a diagram event listener.

Parameters

type

DiagramEventType

handler

(event) => void

Returns

void

---

addGroupTemplate()

addGroupTemplate(category, template): void

Defined in: diagram/Diagram.ts:687

GoJS-compatible: Add a group template for a category.

Parameters

category

string

template

Panel

Returns

void

---

addLayer()

addLayer(layer): void

Defined in: diagram/Diagram.ts:3019

Add a layer.

Parameters

layer

Layer

Returns

void

---

addLinkTemplate()

addLinkTemplate(category, template): void

Defined in: diagram/Diagram.ts:682

GoJS-compatible: Add a link template for a category.

Parameters

category

string

template

Panel

Returns

void

---

addModelChangedListener()

addModelChangedListener(listener): void

Defined in: diagram/Diagram.ts:2982

GoJS-compatible: Register a model changed listener.

Parameters

listener

(event) => void

Returns

void

---

addNodeTemplate()

addNodeTemplate(category, template): void

Defined in: diagram/Diagram.ts:677

GoJS-compatible: Add a node template for a category.

Parameters

category

string

template

Panel

Returns

void

---

addParts()

addParts(parts): void

Defined in: diagram/Diagram.ts:3661

GoJS-compatible: Add multiple parts at once.

Parameters

parts

Iterable<Part>

Returns

void

---

announce()

announce(message): void

Defined in: diagram/Diagram.ts:2543

Accessibility: push a message to the off-screen live region, announced to screen readers. Public so tools/command handlers can announce their own user-initiated actions (see CommandHandler.deleteSelection and ClickCreatingTool for examples).

Parameters

message

string

Returns

void

---

centerPoint()

centerPoint(p): void

Defined in: diagram/Diagram.ts:3918

GoJS-compatible: Scroll the view so that a point is centered.

Parameters

p

x

number

y

number

Returns

void

---

centerRect()

centerRect(rect): void

Defined in: diagram/Diagram.ts:3913

GoJS-compatible: Scroll the view so that a rect is centered.

Parameters

rect

Rect

Returns

void

---

clear()

clear(): void

Defined in: diagram/Diagram.ts:2430

GoJS-compatible: Remove all parts and clear the model.

Returns

void

---

clearSelection()

clearSelection(): void

Defined in: diagram/Diagram.ts:2598

Clear all selections.

Returns

void

---

collapseGroup()

collapseGroup(group): void

Defined in: diagram/Diagram.ts:2644

GoJS-compatible: Collapse a group’s subgraph, firing SubGraphCollapsed.

Parameters

group

Group

Returns

void

---

collapseTree()

collapseTree(node): void

Defined in: diagram/Diagram.ts:4044

GoJS-compatible: collapse a node’s tree — hide every descendant reachable via findTreeChildrenNodes (and any Link visually connecting them), used by TreeExpanderButton. Independent of Group.isSubGraphExpanded/collapseGroup.

Parameters

node

Node

Returns

void

---

commit()

commit(fn, name?): void

Defined in: diagram/Diagram.ts:858

GoJS-compatible: Execute a function within a transaction. If the function is provided, it’s called and the transaction is committed. If no function is provided, begins a transaction and returns a commit function.

Usage: diagram.commit(d => { d.model.addNode({ key: 1, name: ‘A’ }); }, ‘add node’);

Parameters

fn

(d) => void

name?

string = ''

Returns

void

---

commitTransaction()

commitTransaction(name?): boolean

Defined in: diagram/Diagram.ts:833

GoJS-compatible: Commit the current transaction.

Parameters

name?

string = ''

Returns

boolean

---

computeBounds()

computeBounds(): Rect

Defined in: diagram/Diagram.ts:3968

GoJS-compatible: The bounds of all content, including links.

Returns

Rect

---

deselect()

deselect(part): void

Defined in: diagram/Diagram.ts:2628

GoJS-compatible: Deselect a part.

Parameters

part

Part

Returns

void

---

destroy()

destroy(): void

Defined in: diagram/Diagram.ts:4097

Destroy the diagram and clean up resources.

Returns

void

---

disableDoubleBuffering()

disableDoubleBuffering(): void

Defined in: diagram/Diagram.ts:3144

Disable double-buffered rendering.

Returns

void

---

disableGrid()

disableGrid(): void

Defined in: diagram/Diagram.ts:3213

Hide the background grid.

Returns

void

---

disableLayerCaching()

disableLayerCaching(): void

Defined in: diagram/Diagram.ts:3073

Disable layer caching.

Returns

void

---

disableLOD()

disableLOD(): void

Defined in: diagram/Diagram.ts:3163

Disable level-of-detail rendering.

Returns

void

---

disableSnapToGrid()

disableSnapToGrid(): void

Defined in: diagram/Diagram.ts:3190

Disable grid snapping.

Returns

void

---

disableTooltips()

disableTooltips(): void

Defined in: diagram/Diagram.ts:3090

Disable hover tooltips.

Returns

void

---

disableVirtualization()

disableVirtualization(): void

Defined in: diagram/Diagram.ts:752

Disable virtualization.

Returns

void

---

enableDoubleBuffering()

enableDoubleBuffering(): void

Defined in: diagram/Diagram.ts:3138

Enable double-buffered rendering (render offscreen then blit).

Returns

void

---

enableGrid()

enableGrid(): void

Defined in: diagram/Diagram.ts:3207

GoJS-compatible: show the background grid — the closest equivalent of real GoJS’s myDiagram.grid.visible = true (its Diagram.grid exists by default but starts invisible; here that’s showGrid, false by default, toggled through this pair of methods rather than a settable property since enableSnapToGrid/disableSnapToGrid already established that shape for the closely-related snapToGrid).

Returns

void

---

enableLayerCaching()

enableLayerCaching(scale?): void

Defined in: diagram/Diagram.ts:3066

Enable layer caching (renders static layers to offscreen canvases).

Parameters

scale?

number

Returns

void

---

enableLOD()

enableLOD(threshold?): void

Defined in: diagram/Diagram.ts:3156

Enable level-of-detail rendering (hides labels when zoomed out).

Parameters

threshold?

number

Returns

void

---

enableSnapToGrid()

enableSnapToGrid(): void

Defined in: diagram/Diagram.ts:3185

Enable grid snapping for moved parts.

Returns

void

---

enableTooltips()

enableTooltips(options?): void

Defined in: diagram/Diagram.ts:3085

Enable hover tooltips for parts with a tooltip text.

Parameters

options?

delay?

number

offset?

number

style?

string

Returns

void

---

enableVirtualization()

enableVirtualization(bounds): void

Defined in: diagram/Diagram.ts:744

Enable virtualization (viewport culling) with a world bounds.

Parameters

bounds

Rect

Returns

void

---

executeCommand()

executeCommand(command): void

Defined in: diagram/Diagram.ts:798

Execute an undoable command.

Parameters

command

Command

Returns

void

---

expandGroup()

expandGroup(group): void

Defined in: diagram/Diagram.ts:2652

GoJS-compatible: Expand a group’s subgraph, firing SubGraphExpanded.

Parameters

group

Group

Returns

void

---

expandTree()

expandTree(node): void

Defined in: diagram/Diagram.ts:4058

GoJS-compatible: expand a node’s tree, showing its direct tree-children. A child that is itself collapsed keeps its own descendants hidden.

Parameters

node

Node

Returns

void

---

findGroupForKey()

findGroupForKey(key): Group | null

Defined in: diagram/Diagram.ts:2639

GoJS-compatible: Find a group part by its model key.

Parameters

key

NodeKey

Returns

Group | null

---

findHitGraphObject()

findHitGraphObject(part, point): GraphObject | null

Defined in: diagram/Diagram.ts:1317

Find the deepest GraphObject in part’s visual tree at the given diagram point. Every element’s _position/_actualSize (set during Panel.draw’s layout passes) is already in absolute diagram coordinates, not relative to part.bounds — so point is passed to panel.hitTest unchanged.

Parameters

part

Part

point

x

number

y

number

Returns

GraphObject | null

---

findLayer()

findLayer(name): Layer | null

Defined in: diagram/Diagram.ts:3014

GoJS-compatible: Find a layer by name.

Parameters

name

string

Returns

Layer | null

---

findLinkForData()

findLinkForData(data): Link | null

Defined in: diagram/Diagram.ts:2423

GoJS-compatible: Find a link part by its model data object.

Parameters

data

LinkData

Returns

Link | null

---

findLinkForKey()

findLinkForKey(key): Link | null

Defined in: diagram/Diagram.ts:2412

GoJS-compatible: Find a link part by its model key.

Parameters

key

NodeKey

Returns

Link | null

---

findNodeForData()

findNodeForData(data): Node | null

Defined in: diagram/Diagram.ts:2417

GoJS-compatible: Find a node part by its model data object.

Parameters

data

NodeData

Returns

Node | null

---

findNodeForKey()

findNodeForKey(key): Node | null

Defined in: diagram/Diagram.ts:2402

GoJS-compatible: Find a node part by its model key.

Parameters

key

NodeKey

Returns

Node | null

---

findPartAt()

findPartAt(x, y): Node | Link | Group | null

Defined in: diagram/Diagram.ts:2319

Find a part at the given diagram coordinates.

Parameters

x

number

y

number

Returns

Node | Link | Group | null

---

findPartForKey()

findPartForKey(key): Part | null

Defined in: diagram/Diagram.ts:2407

GoJS-compatible: Find a part (node, group, or link) by its model key.

Parameters

key

NodeKey

Returns

Part | null

---

findPartsInRect()

findPartsInRect(rect, _partialInclusion?): (Part | Node | Link | Group)[]

Defined in: diagram/Diagram.ts:3605

GoJS-compatible: Find all parts intersecting a rectangle.

Parameters

rect

height

number

width

number

x

number

y

number

_partialInclusion?

boolean = true

Returns

(Part | Node | Link | Group)[]

---

findTreeChildren()

findTreeChildren(node): Node[]

Defined in: diagram/Diagram.ts:4008

GoJS-compatible: Find the tree children of a node.

Parameters

node

Node

Returns

Node[]

---

findTreeParent()

findTreeParent(node): Node | null

Defined in: diagram/Diagram.ts:4020

GoJS-compatible: Find the tree parent of a node, or null.

Parameters

node

Node

Returns

Node | null

---

findTreeRoots()

findTreeRoots(): Node[]

Defined in: diagram/Diagram.ts:3996

GoJS-compatible: Find all nodes that are tree roots (no parent key).

Returns

Node[]

---

fireDiagramEvent()

fireDiagramEvent(type, part?, data?): void

Defined in: diagram/Diagram.ts:732

Fire a diagram event.

Parameters

type

DiagramEventType

part?

Part | null

data?

Record<string, unknown>

Returns

void

---

focus()

focus(): void

Defined in: diagram/Diagram.ts:2954

GoJS-compatible: Give keyboard focus to the diagram’s div.

Returns

void

---

fromJSON()

fromJSON(json): void

Defined in: diagram/Diagram.ts:3056

Deserialize JSON into the diagram.

Parameters

json

DiagramJSON

Returns

void

---

getAlignmentGuidelines()

getAlignmentGuidelines(): object[]

Defined in: diagram/Diagram.ts:2498

Get the alignment guideline segments currently shown.

Returns

object[]

---

getAnimationManager()

getAnimationManager(): AnimationManager

Defined in: diagram/Diagram.ts:606

Get the animation manager.

Returns

AnimationManager

---

getCanvasBounds()

getCanvasBounds(): object

Defined in: diagram/Diagram.ts:2722

GoJS-compatible: Get the bounds of the diagram canvas in page/screen coordinates.

Returns

object

height

height: number

width

width: number

x

x: number

y

y: number

---

getCommandHandler()

getCommandHandler(): CommandHandler

Defined in: diagram/Diagram.ts:616

Get the command handler.

Returns

CommandHandler

---

getContentBounds()

getContentBounds(): Rect

Defined in: diagram/Diagram.ts:3926

Get the bounds of all content in the diagram.

Returns

Rect

---

getContextMenu()

getContextMenu(): ContextMenu | null

Defined in: diagram/Diagram.ts:873

Get the current context menu.

Returns

ContextMenu | null

---

getDiagramDiv()

getDiagramDiv(): HTMLDivElement | null

Defined in: diagram/Diagram.ts:2949

GoJS-compatible: Get the HTML element this diagram renders into, or null if detached.

Returns

HTMLDivElement | null

---

getDiagramPoint()

getDiagramPoint(e): object

Defined in: diagram/Diagram.ts:2527

Get mouse position in diagram coordinates.

Parameters

e

MouseEvent

Returns

object

x

x: number

y

y: number

---

getGridSize()

getGridSize(): number

Defined in: diagram/Diagram.ts:3230

Get the grid size.

Returns

number

---

getLayer()

getLayer(name): Layer | undefined

Defined in: diagram/Diagram.ts:3009

Get a layer by name.

Parameters

name

string

Returns

Layer | undefined

---

getLayers()

getLayers(): readonly Layer[]

Defined in: diagram/Diagram.ts:2848

Get all layers.

Returns

readonly Layer[]

---

getLODLabelThreshold()

getLODLabelThreshold(): number

Defined in: diagram/Diagram.ts:3180

Get the LOD label threshold.

Returns

number

---

getModel()

getModel(): GraphLinksModel

Defined in: diagram/Diagram.ts:3507

Get the underlying model.

Returns

GraphLinksModel

---

getPart()

getPart(key): Part | Node | Link | Group | undefined

Defined in: diagram/Diagram.ts:2397

Get a part by key.

Parameters

key

NodeKey

Returns

Part | Node | Link | Group | undefined

---

getPartPool()

getPartPool(): PartPool

Defined in: diagram/Diagram.ts:768

Get the part pool.

Returns

PartPool

---

getRenderer()

getRenderer(): Renderer

Defined in: diagram/Diagram.ts:3512

Get the renderer.

Returns

Renderer

---

getSelectedParts()

getSelectedParts(): (Node | Link | Group)[]

Defined in: diagram/Diagram.ts:2660

Get selected parts.

Returns

(Node | Link | Group)[]

---

getSelectionRect()

getSelectionRect(): { height: number; width: number; x: number; y: number; } | null

Defined in: diagram/Diagram.ts:2475

Get the current selection rectangle, or null.

Returns

{ height: number; width: number; x: number; y: number; } | null

---

getTempLink()

getTempLink(): { from: { x: number; y: number; }; to: { x: number; y: number; }; } | null

Defined in: diagram/Diagram.ts:2456

Get the current temporary link, or null.

Returns

{ from: { x: number; y: number; }; to: { x: number; y: number; }; } | null

---

getToolManager()

getToolManager(): ToolManager

Defined in: diagram/Diagram.ts:586

Get the tool manager.

Returns

ToolManager

---

getTooltipManager()

getTooltipManager(): TooltipManager | null

Defined in: diagram/Diagram.ts:3096

Get the tooltip manager, or null if disabled.

Returns

TooltipManager | null

---

getUndoManager()

getUndoManager(): UndoManager

Defined in: diagram/Diagram.ts:596

Get the undo manager.

Returns

UndoManager

---

getViewport()

getViewport(): object

Defined in: diagram/Diagram.ts:3563

Get the current viewport.

Returns

object

height

height: number

scale

scale: number

width

width: number

x

x: number

y

y: number

---

getViewportBounds()

getViewportBounds(): Rect

Defined in: diagram/Diagram.ts:3947

Get the current viewport bounds in diagram coordinates.

Returns

Rect

---

getVirtualizationManager()

getVirtualizationManager(): VirtualizationManager | null

Defined in: diagram/Diagram.ts:763

Get the virtualization manager, or null if disabled.

Returns

VirtualizationManager | null

---

hasDiagramListeners()

hasDiagramListeners(type): boolean

Defined in: diagram/Diagram.ts:727

Check whether there are listeners for a diagram event type.

Parameters

type

DiagramEventType

Returns

boolean

---

hideAlignmentGuidelines()

hideAlignmentGuidelines(): void

Defined in: diagram/Diagram.ts:2490

Hide any alignment guidelines currently shown.

Returns

void

---

hideContextMenu()

hideContextMenu(): void

Defined in: diagram/Diagram.ts:1155

Hide any floating part context menu.

Returns

void

---

hideSelectionRect()

hideSelectionRect(): void

Defined in: diagram/Diagram.ts:2467

Hide the temporary selection rectangle.

Returns

void

---

hideTempLink()

hideTempLink(): void

Defined in: diagram/Diagram.ts:2448

Hide the temporary link preview.

Returns

void

---

hideToolTip()

hideToolTip(): void

Defined in: diagram/Diagram.ts:1237

GoJS-compatible: hide any floating part toolTip and reset hover tracking.

Returns

void

---

invalidate()

invalidate(): void

Defined in: diagram/Diagram.ts:3061

Invalidate the diagram (triggers re-render).

Returns

void

---

invalidateLinksForNode()

invalidateLinksForNode(nodeKey): void

Defined in: diagram/Diagram.ts:3737

Recompute the connection points of links attached to a node from its current bounds, and clear the cached paths so the renderer re-routes: adjacent links keep following the node during drags/resizes and after programmatic bounds changes, while non-adjacent auto-routed links re-route around the moved node (it may be an obstacle for them). Manually-reshaped routes are only discarded for links attached to the moved node.

Parameters

nodeKey

NodeKey

Returns

void

---

isDestroyed()

isDestroyed(): boolean

Defined in: diagram/Diagram.ts:4169

Check whether the diagram has been destroyed.

Returns

boolean

---

isDoubleBufferingEnabled()

isDoubleBufferingEnabled(): boolean

Defined in: diagram/Diagram.ts:3151

Check whether double-buffered rendering is enabled.

Returns

boolean

---

isGridEnabled()

isGridEnabled(): boolean

Defined in: diagram/Diagram.ts:3219

Check whether the background grid is currently shown.

Returns

boolean

---

isLayerCachingEnabled()

isLayerCachingEnabled(): boolean

Defined in: diagram/Diagram.ts:3080

Check whether layer caching is enabled.

Returns

boolean

---

isLODEnabled()

isLODEnabled(): boolean

Defined in: diagram/Diagram.ts:3169

Check whether LOD rendering is enabled.

Returns

boolean

---

isSnapToGridEnabled()

isSnapToGridEnabled(): boolean

Defined in: diagram/Diagram.ts:3195

Check whether grid snapping is enabled.

Returns

boolean

---

isTreeExpanded()

isTreeExpanded(node): boolean

Defined in: diagram/Diagram.ts:2714

GoJS-compatible: Whether a node (group) subgraph is expanded.

Parameters

node

Node

Returns

boolean

---

isVirtualizationEnabled()

isVirtualizationEnabled(): boolean

Defined in: diagram/Diagram.ts:758

Check whether virtualization is enabled.

Returns

boolean

---

layoutDiagram()

layoutDiagram(layout?): void

Defined in: diagram/Diagram.ts:2899

GoJS-compatible: Run the diagram layout (or the given layout) on all parts.

Parameters

layout?

Layout

Returns

void

---

layoutParts()

layoutParts(parts): void

Defined in: diagram/Diagram.ts:2911

GoJS-compatible: Run the layout on the given parts.

Parameters

parts

readonly Part[]

Returns

void

---

makeImage()

makeImage(options?): HTMLCanvasElement

Defined in: diagram/Diagram.ts:3519

Generate a raster image (canvas) of the diagram content.

Parameters

options?

background?

string

padding?

number

scale?

number

Returns

HTMLCanvasElement

---

makeImageData()

makeImageData(options?): string

Defined in: diagram/Diagram.ts:3528

GoJS-compatible: Render the diagram as a PNG data URL string.

Parameters

options?

background?

string

padding?

number

scale?

number

Returns

string

---

makeSvg()

makeSvg(): SVGElement

Defined in: diagram/Diagram.ts:3533

GoJS-compatible: Render the diagram as an SVGElement.

Returns

SVGElement

---

moveToLayer()

moveToLayer(part, layerName): void

Defined in: diagram/Diagram.ts:3042

Move a part to a layer by name.

Parameters

part

Node | Link | Group

layerName

string

Returns

void

---

print()

print(options?): void

Defined in: diagram/Diagram.ts:3551

Print the diagram by opening the browser’s print dialog with the diagram embedded as vector SVG (default) or a raster PNG image.

Parameters

options?

background?

string

fitToPage?

boolean

format?

"svg" | "png"

padding?

number

scale?

number

title?

string

Returns

void

---

redo()

redo(): boolean

Defined in: diagram/Diagram.ts:814

Redo the last undone command.

Returns

boolean

---

remove()

remove(part): void

Defined in: diagram/Diagram.ts:3671

GoJS-compatible: Remove a part directly from the diagram.

Parameters

part

Part

Returns

void

---

removeAnyDiagramListener()

removeAnyDiagramListener(handler): void

Defined in: diagram/Diagram.ts:722

Remove a listener from all diagram events.

Parameters

handler

(event) => void

Returns

void

---

removeDiagramListener()

removeDiagramListener(type, handler): boolean

Defined in: diagram/Diagram.ts:717

Remove a diagram event listener.

Parameters

type

DiagramEventType

handler

(event) => void

Returns

boolean

---

removeGroupTemplate()

removeGroupTemplate(category): boolean

Defined in: diagram/Diagram.ts:702

GoJS-compatible: Remove a group template by category.

Parameters

category

string

Returns

boolean

---

removeLayer()

removeLayer(name): boolean

Defined in: diagram/Diagram.ts:3026

Remove a layer by name.

Parameters

name

string

Returns

boolean

---

removeLinkTemplate()

removeLinkTemplate(category): boolean

Defined in: diagram/Diagram.ts:697

GoJS-compatible: Remove a link template by category.

Parameters

category

string

Returns

boolean

---

removeModelChangedListener()

removeModelChangedListener(listener): void

Defined in: diagram/Diagram.ts:2987

GoJS-compatible: Remove a model changed listener.

Parameters

listener

(event) => void

Returns

void

---

removeNodeTemplate()

removeNodeTemplate(category): boolean

Defined in: diagram/Diagram.ts:692

GoJS-compatible: Remove a node template by category.

Parameters

category

string

Returns

boolean

---

removeParts()

removeParts(parts): void

Defined in: diagram/Diagram.ts:3666

GoJS-compatible: Remove multiple parts at once.

Parameters

parts

Iterable<Part>

Returns

void

---

requestUpdate()

requestUpdate(): void

Defined in: diagram/Diagram.ts:2807

GoJS-compatible: Request a redraw of the diagram.

Returns

void

---

scrollToPart()

scrollToPart(part, _padding?): void

Defined in: diagram/Diagram.ts:3866

Scroll the viewport to show a specific part.

Parameters

part

Part

_padding?

number = 50

Returns

void

---

scrollToRect()

scrollToRect(rect, center?): void

Defined in: diagram/Diagram.ts:3890

GoJS-compatible: Scroll the view so that a rect is visible (optionally centered).

Parameters

rect

Rect

center?

boolean = false

Returns

void

---

select()

select(part, addToSelection?): boolean

Defined in: diagram/Diagram.ts:2610

GoJS-compatible: Select a part, adding it to the current selection.

Parameters

part

Part | null

addToSelection?

boolean = false

Returns

boolean

---

selectPartsInRect()

selectPartsInRect(rect, partialInclusion?): void

Defined in: diagram/Diagram.ts:2503

Select all parts intersecting a rectangle.

Parameters

rect

height

number

width

number

x

number

y

number

partialInclusion?

boolean = true

Returns

void

---

setContextMenu()

setContextMenu(menu): void

Defined in: diagram/Diagram.ts:868

Set a context menu for this diagram.

Parameters

menu

ContextMenu | null

Returns

void

---

setGridSize()

setGridSize(size): void

Defined in: diagram/Diagram.ts:3224

Set the grid size used for snapping.

Parameters

size

number

Returns

void

---

setLODLabelThreshold()

setLODLabelThreshold(threshold): void

Defined in: diagram/Diagram.ts:3174

Set the zoom threshold below which labels are hidden.

Parameters

threshold

number

Returns

void

---

setModel()

setModel(model): void

Defined in: diagram/Diagram.ts:2812

Set the model.

Parameters

model

GraphLinksModel

Returns

void

---

setViewport()

setViewport(x, y, scale?): void

Defined in: diagram/Diagram.ts:3698

Set the viewport.

Parameters

x

number

y

number

scale?

number

Returns

void

---

showAlignmentGuidelines()

showAlignmentGuidelines(lines): void

Defined in: diagram/Diagram.ts:2484

GoJS-compatible (“GuidedDraggingTool” extension style): show temporary alignment guideline segments while dragging, snapped to the edges/centers of nearby parts.

Parameters

lines

object[]

Returns

void

---

showSelectionRect()

showSelectionRect(rect): void

Defined in: diagram/Diagram.ts:2461

Show a temporary rubber-band selection rectangle.

Parameters

rect

height

number

width

number

x

number

y

number

Returns

void

---

showTempLink()

showTempLink(from, to): void

Defined in: diagram/Diagram.ts:2442

Show a temporary link preview (used by linking tools).

Parameters

from

x

number

y

number

to

x

number

y

number

Returns

void

---

snapPoint()

snapPoint(point): object

Defined in: diagram/Diagram.ts:3241

Snap a coordinate to the nearest grid line.

Parameters

point

x

number

y

number

Returns

object

x

x: number

y

y: number

---

snapValue()

snapValue(value): number

Defined in: diagram/Diagram.ts:3235

Snap a value to the nearest grid line.

Parameters

value

number

Returns

number

---

startTransaction()

startTransaction(name?): boolean

Defined in: diagram/Diagram.ts:825

GoJS-compatible: Begin a transaction. Commands are grouped into one undo unit.

Parameters

name?

string = 'Transaction'

Returns

boolean

---

toJSON()

toJSON(): DiagramJSON

Defined in: diagram/Diagram.ts:3051

Serialize the diagram to JSON.

Returns

DiagramJSON

---

undo()

undo(): boolean

Defined in: diagram/Diagram.ts:803

Undo the last command.

Returns

boolean

---

updateThemeBindings()

updateThemeBindings(): void

Defined in: diagram/Diagram.ts:3127

Re-apply every binding (including ThemeBindings) on every part, so templates using GraphObject.theme()/themeData() pick up the current theme. Called automatically when themeManager.currentTheme changes or themeManager.set(...) is called.

Returns

void

---

zoomToFit()

zoomToFit(padding?): void

Defined in: diagram/Diagram.ts:3821

Zoom to fit all content.

Parameters

padding?

number = 50

Returns

void

---

zoomToRect()

zoomToRect(rect, padding?): void

Defined in: diagram/Diagram.ts:3851

GoJS-compatible: Zoom the view so the given rect fills the viewport.

Parameters

rect

height

number

width

number

x

number

y

number

padding?

number = 50

Returns

void