Link

Defined in: parts/Link.ts:15

A visual link between two nodes.

Extends

• Part

Constructors

Constructor

new Link(key, fromKey, toKey): Link

Defined in: parts/Link.ts:67

Parameters

key

NodeKey

fromKey

NodeKey

toKey

NodeKey

Returns

Link

Overrides

Part.constructor

Properties

CircleArrowHead

readonly static CircleArrowHead: "circle" = 'circle'

Defined in: parts/Link.ts:27

---

Curved

readonly static Curved: "curved" = 'curved'

Defined in: parts/Link.ts:19

---

DiamondArrowHead

readonly static DiamondArrowHead: "diamond" = 'diamond'

Defined in: parts/Link.ts:26

---

None

readonly static None: "none" = 'none'

Defined in: parts/Link.ts:22

---

OpenTriangleArrowHead

readonly static OpenTriangleArrowHead: "openArrow" = 'openArrow'

Defined in: parts/Link.ts:24

---

Orthogonal

readonly static Orthogonal: "orthogonal" = 'orthogonal'

Defined in: parts/Link.ts:18

---

StandardArrowHead

readonly static StandardArrowHead: "triangle" = 'triangle'

Defined in: parts/Link.ts:25

---

Straight

readonly static Straight: "straight" = 'straight'

Defined in: parts/Link.ts:17

---

TriangleArrowHead

readonly static TriangleArrowHead: "triangle" = 'triangle'

Defined in: parts/Link.ts:23

Accessors

actualBounds

Get Signature

get actualBounds(): Rect

Defined in: parts/Part.ts:230

GoJS-compatible: The actual bounds of this part in document coordinates.

Returns

Rect

Set Signature

set actualBounds(value): void

Defined in: parts/Part.ts:234

Parameters

value

Rect

Returns

void

Inherited from

Part.actualBounds

---

adornments

Get Signature

get adornments(): ReadonlyMap<string, Adornment>

Defined in: parts/Part.ts:572

Get all adornments on this part.

Returns

ReadonlyMap<string, Adornment>

Inherited from

Part.adornments

---

angle

Get Signature

get angle(): number

Defined in: parts/Part.ts:313

The rotation angle in degrees.

Returns

number

Set Signature

set angle(value): void

Defined in: parts/Part.ts:317

Parameters

value

number

Returns

void

Inherited from

Part.angle

---

arrowhead

Get Signature

get arrowhead(): ArrowheadStyle

Defined in: parts/Link.ts:281

The arrowhead style at the target end.

Returns

ArrowheadStyle

Set Signature

set arrowhead(value): void

Defined in: parts/Link.ts:285

Parameters

value

ArrowheadStyle

Returns

void

---

arrowheadSize

Get Signature

get arrowheadSize(): number

Defined in: parts/Link.ts:290

The size of the arrowhead.

Returns

number

Set Signature

set arrowheadSize(value): void

Defined in: parts/Link.ts:294

Parameters

value

number

Returns

void

---

avoidObstacles

Get Signature

get avoidObstacles(): boolean

Defined in: parts/Link.ts:425

Whether this link should route around obstacles (nodes).

Returns

boolean

Set Signature

set avoidObstacles(value): void

Defined in: parts/Link.ts:429

Parameters

value

boolean

Returns

void

---

background

Get Signature

get background(): string | null

Defined in: parts/Part.ts:185

GoJS-compatible: The background color of this part.

Returns

string | null

Set Signature

set background(value): void

Defined in: parts/Part.ts:189

Parameters

value

string | null

Returns

void

Inherited from

Part.background

---

bindings

Get Signature

get bindings(): readonly Binding[]

Defined in: parts/Part.ts:603

Get all bindings on this part.

Returns

readonly Binding[]

Inherited from

Part.bindings

---

bounds

Get Signature

get bounds(): Rect

Defined in: parts/Part.ts:135

Returns

Rect

Set Signature

set bounds(value): void

Defined in: parts/Part.ts:139

Parameters

value

Rect

Returns

void

Inherited from

Part.bounds

---

category

Get Signature

get category(): string

Defined in: parts/Part.ts:368

GoJS-compatible: The category of this part (used to select a template).

Returns

string

Set Signature

set category(value): void

Defined in: parts/Part.ts:372

Parameters

value

string

Returns

void

Inherited from

Part.category

---

center

Get Signature

get center(): object

Defined in: parts/Link.ts:559

Get the center point of the link.

Returns

object

x

x: number

y

y: number

Overrides

Part.center

---

containingGroup

Get Signature

get containingGroup(): Part | null

Defined in: parts/Part.ts:405

Get the containing group, or null if top-level.

Returns

Part | null

Set Signature

set containingGroup(value): void

Defined in: parts/Part.ts:410

Set the containing group.

Parameters

value

Group | null

Returns

void

Inherited from

Part.containingGroup

---

contextMenu

Get Signature

get contextMenu(): Panel | HTMLInfo | null

Defined in: parts/Part.ts:488

GoJS-compatible: a context menu shown on right-click — a Panel template drawn to canvas, or an HTMLInfo for full control over an HTML element.

Returns

Panel | HTMLInfo | null

Set Signature

set contextMenu(value): void

Defined in: parts/Part.ts:492

Parameters

value

Panel | HTMLInfo | null

Returns

void

Inherited from

Part.contextMenu

---

copyable

Get Signature

get copyable(): boolean

Defined in: parts/Part.ts:118

GoJS-compatible: Whether this part can be copied.

Returns

boolean

Set Signature

set copyable(value): void

Defined in: parts/Part.ts:122

Parameters

value

boolean

Returns

void

Inherited from

Part.copyable

---

corner

Get Signature

get corner(): number

Defined in: parts/Link.ts:326

The corner rounding radius for orthogonal routing.

Returns

number

Set Signature

set corner(value): void

Defined in: parts/Link.ts:330

Parameters

value

number

Returns

void

---

cursor

Get Signature

get cursor(): string

Defined in: parts/Part.ts:203

GoJS-compatible: The cursor shown when hovering this part.

Returns

string

Set Signature

set cursor(value): void

Defined in: parts/Part.ts:207

Parameters

value

string

Returns

void

Inherited from

Part.cursor

---

curve

Get Signature

get curve(): "None" | "Bezier" | "JumpOver" | "AvoidsNodes"

Defined in: parts/Link.ts:145

GoJS-compatible: The type of curve used for this link.

Returns

"None" | "Bezier" | "JumpOver" | "AvoidsNodes"

Set Signature

set curve(value): void

Defined in: parts/Link.ts:149

Parameters

value

"None" | "Bezier" | "JumpOver" | "AvoidsNodes"

Returns

void

---

curviness

Get Signature

get curviness(): number

Defined in: parts/Link.ts:380

Controls the tightness of curved routing. 0 = default, positive = tighter, negative = looser.

Returns

number

Set Signature

set curviness(value): void

Defined in: parts/Link.ts:384

Parameters

value

number

Returns

void

---

data

Get Signature

get data(): NodeData | null

Defined in: parts/Part.ts:359

GoJS-compatible: Reference to the model data object for this part.

Returns

NodeData | null

Set Signature

set data(value): void

Defined in: parts/Part.ts:363

Parameters

value

NodeData | null

Returns

void

Inherited from

Part.data

---

deletable

Get Signature

get deletable(): boolean

Defined in: parts/Part.ts:96

GoJS-compatible: Whether this part can be deleted.

Returns

boolean

Set Signature

set deletable(value): void

Defined in: parts/Part.ts:100

Parameters

value

boolean

Returns

void

Inherited from

Part.deletable

---

desiredSize

Get Signature

get desiredSize(): Size | null

Defined in: parts/Part.ts:162

GoJS-compatible: The desired size of this part.

Returns

Size | null

Set Signature

set desiredSize(value): void

Defined in: parts/Part.ts:167

Parameters

value

Size | { height: number; width: number; } | null

Returns

void

Inherited from

Part.desiredSize

---

diagram

Get Signature

get diagram(): Diagram | null

Defined in: parts/Part.ts:443

GoJS-compatible: The diagram that this part is in (or null).

Returns

Diagram | null

Set Signature

set diagram(value): void

Defined in: parts/Part.ts:448

Set the diagram this part belongs to.

Parameters

value

Diagram | null

Returns

void

Inherited from

Part.diagram

---

dragAlpha

Get Signature

get dragAlpha(): number

Defined in: parts/Part.ts:377

GoJS-compatible: The opacity used when this part is being dragged.

Returns

number

Set Signature

set dragAlpha(value): void

Defined in: parts/Part.ts:381

Parameters

value

number

Returns

void

Inherited from

Part.dragAlpha

---

draggable

Get Signature

get draggable(): boolean

Defined in: parts/Part.ts:506

Whether this part can be dragged.

Returns

boolean

Set Signature

set draggable(value): void

Defined in: parts/Part.ts:510

Parameters

value

boolean

Returns

void

Inherited from

Part.draggable

---

elements

Get Signature

get elements(): readonly GraphObject[]

Defined in: parts/Part.ts:546

GoJS-compatible: Get the child elements in this part’s visual tree.

Returns

readonly GraphObject[]

Inherited from

Part.elements

---

fill

Get Signature

get fill(): string

Defined in: parts/Part.ts:280

Returns

string

Set Signature

set fill(value): void

Defined in: parts/Part.ts:284

Parameters

value

string

Returns

void

Inherited from

Part.fill

---

fromEndSegmentLength

Get Signature

get fromEndSegmentLength(): number

Defined in: parts/Link.ts:443

GoJS-compatible: Length of the segment at the start of the link.

Returns

number

Set Signature

set fromEndSegmentLength(value): void

Defined in: parts/Link.ts:447

Parameters

value

number

Returns

void

---

fromEndSegmentOrientation

Get Signature

get fromEndSegmentOrientation(): number

Defined in: parts/Link.ts:163

GoJS-compatible: The orientation of the segment leaving the from-end.

Returns

number

Set Signature

set fromEndSegmentOrientation(value): void

Defined in: parts/Link.ts:167

Parameters

value

number

Returns

void

---

fromKey

Get Signature

get fromKey(): NodeKey

Defined in: parts/Link.ts:75

Returns

NodeKey

Set Signature

set fromKey(value): void

Defined in: parts/Link.ts:79

Parameters

value

NodeKey

Returns

void

---

fromNode

Get Signature

get fromNode(): Node | null

Defined in: parts/Link.ts:84

GoJS-compatible: The source node of this link (or null).

Returns

Node | null

Set Signature

set fromNode(value): void

Defined in: parts/Link.ts:90

Parameters

value

NodeKey | Node | null

Returns

void

---

fromPort

Get Signature

get fromPort(): object

Defined in: parts/Link.ts:180

Returns

object

x

x: number

y

y: number

Set Signature

set fromPort(value): void

Defined in: parts/Link.ts:184

Parameters

value

x

number

y

number

Returns

void

---

fromPortName

Get Signature

get fromPortName(): string | undefined

Defined in: parts/Link.ts:197

The name of the source port on the from-node.

Returns

string | undefined

Set Signature

set fromPortName(value): void

Defined in: parts/Link.ts:201

Parameters

value

string | undefined

Returns

void

---

fromShortLength

Get Signature

get fromShortLength(): number

Defined in: parts/Link.ts:407

GoJS-compatible: The distance from the from-end to the first point.

Returns

number

Set Signature

set fromShortLength(value): void

Defined in: parts/Link.ts:411

Parameters

value

number

Returns

void

---

fromSpot

Get Signature

get fromSpot(): Spot | null

Defined in: parts/Link.ts:215

The spot on the from-node where this link connects.

Returns

Spot | null

Set Signature

set fromSpot(value): void

Defined in: parts/Link.ts:219

Parameters

value

Spot | null

Returns

void

---

hasManualReshape

Get Signature

get hasManualReshape(): boolean

Defined in: parts/Link.ts:272

Whether pathPoints were set by the user reshaping this link (via LinkReshapingTool) rather than computed by the router. While true, model syncs that don’t touch this link’s own endpoints leave pathPoints alone instead of overwriting the manual shape; moving either endpoint node clears it (see Diagram.invalidateLinksForNode), reverting to auto-routing.

Returns

boolean

Set Signature

set hasManualReshape(value): void

Defined in: parts/Link.ts:276

Parameters

value

boolean

Returns

void

---

height

Get Signature

get height(): number

Defined in: parts/Part.ts:153

GoJS-compatible: The height of this part (delegates to its bounds).

Returns

number

Set Signature

set height(value): void

Defined in: parts/Part.ts:157

Parameters

value

number

Returns

void

Inherited from

Part.height

---

isHighlighted

Get Signature

get isHighlighted(): boolean

Defined in: parts/Part.ts:127

GoJS-compatible: Whether this part is currently highlighted.

Returns

boolean

Set Signature

set isHighlighted(value): void

Defined in: parts/Part.ts:131

Parameters

value

boolean

Returns

void

Inherited from

Part.isHighlighted

---

isInDocumentBounds

Get Signature

get isInDocumentBounds(): boolean

Defined in: parts/Part.ts:386

GoJS-compatible: Whether this part is within the document bounds.

Returns

boolean

Set Signature

set isInDocumentBounds(value): void

Defined in: parts/Part.ts:390

Parameters

value

boolean

Returns

void

Inherited from

Part.isInDocumentBounds

---

isMemberOfGroup

Get Signature

get isMemberOfGroup(): boolean

Defined in: parts/Part.ts:415

GoJS-compatible: Whether this part is a member of a group.

Returns

boolean

Inherited from

Part.isMemberOfGroup

---

isPositioned

Get Signature

get isPositioned(): boolean

Defined in: parts/Part.ts:420

GoJS-compatible: Whether this part has been given a position/bounds.

Returns

boolean

Inherited from

Part.isPositioned

---

isSelected

Get Signature

get isSelected(): boolean

Defined in: parts/Part.ts:264

Returns

boolean

Set Signature

set isSelected(value): void

Defined in: parts/Part.ts:268

Parameters

value

boolean

Returns

void

Inherited from

Part.isSelected

---

isTreeExpanded

Get Signature

get isTreeExpanded(): boolean

Defined in: parts/Part.ts:109

GoJS-compatible: Whether this part’s tree-children (per findTreeChildrenNodes) are shown. Distinct from Group.isSubGraphExpanded — this applies to any Part and is what TreeExpanderButton toggles via Diagram.collapseTree/expandTree.

Returns

boolean

Set Signature

set isTreeExpanded(value): void

Defined in: parts/Part.ts:113

Parameters

value

boolean

Returns

void

Inherited from

Part.isTreeExpanded

---

isTreeLink

Get Signature

get isTreeLink(): boolean

Defined in: parts/Link.ts:389

GoJS-compatible: Whether this link is a tree link (parent-child).

Returns

boolean

Set Signature

set isTreeLink(value): void

Defined in: parts/Link.ts:393

Parameters

value

boolean

Returns

void

---

isVisibleObject

Get Signature

get isVisibleObject(): boolean

Defined in: parts/Part.ts:239

GoJS-compatible: Whether this part and its ancestors are visible.

Returns

boolean

Inherited from

Part.isVisibleObject

---

jumpOver

Get Signature

get jumpOver(): boolean

Defined in: parts/Link.ts:434

Whether this link should jump over other links at crossings.

Returns

boolean

Set Signature

set jumpOver(value): void

Defined in: parts/Link.ts:438

Parameters

value

boolean

Returns

void

---

key

Get Signature

get key(): NodeKey

Defined in: parts/Part.ts:72

Returns

NodeKey

Inherited from

Part.key

---

label

Get Signature

get label(): string

Defined in: parts/Link.ts:299

The label text shown on the link.

Returns

string

Set Signature

set label(value): void

Defined in: parts/Link.ts:303

Parameters

value

string

Returns

void

---

labelAlignment

Get Signature

get labelAlignment(): "start" | "end" | "middle"

Defined in: parts/Link.ts:371

Horizontal alignment of the label along its segment.

Returns

"start" | "end" | "middle"

Set Signature

set labelAlignment(value): void

Defined in: parts/Link.ts:375

Parameters

value

"start" | "end" | "middle"

Returns

void

---

labelColor

Get Signature

get labelColor(): string

Defined in: parts/Link.ts:308

The color of the link label.

Returns

string

Set Signature

set labelColor(value): void

Defined in: parts/Link.ts:312

Parameters

value

string

Returns

void

---

labelFont

Get Signature

get labelFont(): string

Defined in: parts/Link.ts:317

The font of the link label.

Returns

string

Set Signature

set labelFont(value): void

Defined in: parts/Link.ts:321

Parameters

value

string

Returns

void

---

labelOffset

Get Signature

get labelOffset(): number

Defined in: parts/Link.ts:335

The perpendicular offset of the link label from the path.

Returns

number

Set Signature

set labelOffset(value): void

Defined in: parts/Link.ts:339

Parameters

value

number

Returns

void

---

labelSegmentFraction

Get Signature

get labelSegmentFraction(): number

Defined in: parts/Link.ts:353

GoJS-compatible (“segmentFraction”): position along the chosen segment, 0 (start) to 1 (end). Default 0.5 (midpoint).

Returns

number

Set Signature

set labelSegmentFraction(value): void

Defined in: parts/Link.ts:357

Parameters

value

number

Returns

void

---

labelSegmentIndex

Get Signature

get labelSegmentIndex(): number

Defined in: parts/Link.ts:344

The segment index to place the label on (-1 = middle segment).

Returns

number

Set Signature

set labelSegmentIndex(value): void

Defined in: parts/Link.ts:348

Parameters

value

number

Returns

void

---

labelSide

Get Signature

get labelSide(): "top" | "bottom" | "left" | "right" | "auto"

Defined in: parts/Link.ts:362

Which side of the link to place the label on.

Returns

"top" | "bottom" | "left" | "right" | "auto"

Set Signature

set labelSide(value): void

Defined in: parts/Link.ts:366

Parameters

value

"top" | "bottom" | "left" | "right" | "auto"

Returns

void

---

layer

Get Signature

get layer(): Layer | null

Defined in: parts/Part.ts:425

Get the layer this part belongs to.

Returns

Layer | null

Set Signature

set layer(value): void

Defined in: parts/Part.ts:430

Set the layer this part belongs to.

Parameters

value

Layer | null

Returns

void

Inherited from

Part.layer

---

layerName

Get Signature

get layerName(): string

Defined in: parts/Part.ts:395

GoJS-compatible: The name of the layer this part belongs to.

Returns

string

Set Signature

set layerName(_value): void

Defined in: parts/Part.ts:399

Parameters

_value

string

Returns

void

Inherited from

Part.layerName

---

location

Get Signature

get location(): Point

Defined in: parts/Part.ts:326

GoJS-compatible: The location point of this part — the point within the bounds at locationSpot. With the default locationSpot (0.5, 0.5) this is the center; changing locationSpot moves the part so the spot stays put.

Returns

Point

Set Signature

set location(value): void

Defined in: parts/Part.ts:334

Parameters

value

Point

Returns

void

Inherited from

Part.location

---

locationSpot

Get Signature

get locationSpot(): object

Defined in: parts/Part.ts:341

GoJS-compatible: The spot in the part that corresponds to the location point.

Returns

object

x

x: number

y

y: number

Set Signature

set locationSpot(value): void

Defined in: parts/Part.ts:345

Parameters

value

x

number

y

number

Returns

void

Inherited from

Part.locationSpot

---

maxSize

Get Signature

get maxSize(): object

Defined in: parts/Part.ts:221

GoJS-compatible: The maximum size of this part.

Returns

object

height

height: number

width

width: number

Set Signature

set maxSize(value): void

Defined in: parts/Part.ts:225

Parameters

value

height

number

width

number

Returns

void

Inherited from

Part.maxSize

---

minSize

Get Signature

get minSize(): object

Defined in: parts/Part.ts:212

GoJS-compatible: The minimum size of this part.

Returns

object

height

height: number

width

width: number

Set Signature

set minSize(value): void

Defined in: parts/Part.ts:216

Parameters

value

height

number

width

number

Returns

void

Inherited from

Part.minSize

---

name

Get Signature

get name(): string

Defined in: parts/Part.ts:87

GoJS-compatible: an arbitrary name for this part. Real GoJS has this because Part extends GraphObject, which has its own .name (used for findObject-style lookups); graphojs’s Part is a separate class, so it needs its own copy of the same property rather than inheriting it — most relevant for a bare decorative Part (see Diagram.add), which ported GoJS code may still identify by .name the way it would identify any other GraphObject.

Returns

string

Set Signature

set name(value): void

Defined in: parts/Part.ts:91

Parameters

value

string

Returns

void

Inherited from

Part.name

---

opacity

Get Signature

get opacity(): number

Defined in: parts/Part.ts:272

Returns

number

Set Signature

set opacity(value): void

Defined in: parts/Part.ts:276

Parameters

value

number

Returns

void

Inherited from

Part.opacity

---

panel

Get Signature

get panel(): Panel | null

Defined in: parts/Part.ts:533

GoJS-compatible: Get the panel used to render this part’s visual tree.

Returns

Panel | null

Set Signature

set panel(value): void

Defined in: parts/Part.ts:538

GoJS-compatible: Set the panel used to render this part’s visual tree.

Parameters

value

Panel | null

Returns

void

Inherited from

Part.panel

---

pathPattern

Get Signature

get pathPattern(): string | null

Defined in: parts/Link.ts:488

GoJS-compatible: Custom path pattern for the link stroke.

Returns

string | null

Set Signature

set pathPattern(value): void

Defined in: parts/Link.ts:492

Parameters

value

string | null

Returns

void

---

pathPoints

Get Signature

get pathPoints(): object[]

Defined in: parts/Link.ts:233

The computed path points for this link.

Returns

object[]

---

pickable

Get Signature

get pickable(): boolean

Defined in: parts/Part.ts:194

GoJS-compatible: Whether this part is pickable (hit-testable).

Returns

boolean

Set Signature

set pickable(value): void

Defined in: parts/Part.ts:198

Parameters

value

boolean

Returns

void

Inherited from

Part.pickable

---

position

Get Signature

get position(): object

Defined in: parts/Part.ts:668

Get the position (top-left).

Returns

object

x

x: number

y

y: number

Set Signature

set position(value): void

Defined in: parts/Part.ts:673

Set the position (top-left), preserving size.

Parameters

value

x

number

y

number

Returns

void

Inherited from

Part.position

---

relinkableFrom

Get Signature

get relinkableFrom(): boolean

Defined in: parts/Link.ts:461

GoJS-compatible: Whether the link can be relinked from the start end.

Returns

boolean

Set Signature

set relinkableFrom(value): void

Defined in: parts/Link.ts:465

Parameters

value

boolean

Returns

void

---

relinkableTo

Get Signature

get relinkableTo(): boolean

Defined in: parts/Link.ts:470

GoJS-compatible: Whether the link can be relinked to the end end.

Returns

boolean

Set Signature

set relinkableTo(value): void

Defined in: parts/Link.ts:474

Parameters

value

boolean

Returns

void

---

reshapable

Get Signature

get reshapable(): boolean

Defined in: parts/Link.ts:479

GoJS-compatible: Whether the link path can be reshaped by dragging midpoints.

Returns

boolean

Set Signature

set reshapable(value): void

Defined in: parts/Link.ts:483

Parameters

value

boolean

Returns

void

---

resizable

Get Signature

get resizable(): boolean

Defined in: parts/Part.ts:515

Whether this part can be resized.

Returns

boolean

Set Signature

set resizable(value): void

Defined in: parts/Part.ts:519

Parameters

value

boolean

Returns

void

Inherited from

Part.resizable

---

resizingSegmentIndex

Get Signature

get resizingSegmentIndex(): number

Defined in: parts/Link.ts:154

GoJS-compatible: The segment index being resized, or -1.

Returns

number

Set Signature

set resizingSegmentIndex(value): void

Defined in: parts/Link.ts:158

Parameters

value

number

Returns

void

---

rotatable

Get Signature

get rotatable(): boolean

Defined in: parts/Part.ts:524

Whether this part can be rotated.

Returns

boolean

Set Signature

set rotatable(value): void

Defined in: parts/Part.ts:528

Parameters

value

boolean

Returns

void

Inherited from

Part.rotatable

---

routing

Get Signature

get routing(): LinkRouting

Defined in: parts/Link.ts:131

Returns

LinkRouting

Set Signature

set routing(value): void

Defined in: parts/Link.ts:135

Parameters

value

LinkRouting

Returns

void

---

scale

Get Signature

get scale(): number

Defined in: parts/Part.ts:176

GoJS-compatible: The scale of this part.

Returns

number

Set Signature

set scale(value): void

Defined in: parts/Part.ts:180

Parameters

value

number

Returns

void

Inherited from

Part.scale

---

selectable

Get Signature

get selectable(): boolean

Defined in: parts/Part.ts:256

Returns

boolean

Set Signature

set selectable(value): void

Defined in: parts/Part.ts:260

Parameters

value

boolean

Returns

void

Inherited from

Part.selectable

---

selectionObject

Get Signature

get selectionObject(): GraphObject | null

Defined in: parts/Part.ts:350

GoJS-compatible: The GraphObject that is used as the selection object (for adornment placement).

Returns

GraphObject | null

Set Signature

set selectionObject(_value): void

Defined in: parts/Part.ts:354

Parameters

_value

GraphObject | null

Returns

void

Inherited from

Part.selectionObject

---

size

Get Signature

get size(): object

Defined in: parts/Part.ts:679

Get the size.

Returns

object

height

height: number

width

width: number

Inherited from

Part.size

---

stroke

Get Signature

get stroke(): string

Defined in: parts/Part.ts:288

Returns

string

Set Signature

set stroke(value): void

Defined in: parts/Part.ts:292

Parameters

value

string

Returns

void

Inherited from

Part.stroke

---

strokeWidth

Get Signature

get strokeWidth(): number

Defined in: parts/Part.ts:296

Returns

number

Set Signature

set strokeWidth(value): void

Defined in: parts/Part.ts:300

Parameters

value

number

Returns

void

Inherited from

Part.strokeWidth

---

toEndSegmentLength

Get Signature

get toEndSegmentLength(): number

Defined in: parts/Link.ts:452

GoJS-compatible: Length of the segment at the end of the link.

Returns

number

Set Signature

set toEndSegmentLength(value): void

Defined in: parts/Link.ts:456

Parameters

value

number

Returns

void

---

toEndSegmentOrientation

Get Signature

get toEndSegmentOrientation(): number

Defined in: parts/Link.ts:172

GoJS-compatible: The orientation of the segment entering the to-end.

Returns

number

Set Signature

set toEndSegmentOrientation(value): void

Defined in: parts/Link.ts:176

Parameters

value

number

Returns

void

---

toKey

Get Signature

get toKey(): NodeKey

Defined in: parts/Link.ts:98

Returns

NodeKey

Set Signature

set toKey(value): void

Defined in: parts/Link.ts:102

Parameters

value

NodeKey

Returns

void

---

toNode

Get Signature

get toNode(): Node | null

Defined in: parts/Link.ts:107

GoJS-compatible: The destination node of this link (or null).

Returns

Node | null

Set Signature

set toNode(value): void

Defined in: parts/Link.ts:113

Parameters

value

NodeKey | Node | null

Returns

void

---

tooltip

Get Signature

get tooltip(): string

Defined in: parts/Part.ts:463

The tooltip text shown when hovering over this part.

Returns

string

Set Signature

set tooltip(value): void

Defined in: parts/Part.ts:467

Parameters

value

string

Returns

void

Inherited from

Part.tooltip

---

toolTip

Get Signature

get toolTip(): Panel | HTMLInfo | null

Defined in: parts/Part.ts:475

GoJS-compatible: a tooltip shown on hover — a Panel template drawn to canvas, or an HTMLInfo for full control over an HTML element.

Returns

Panel | HTMLInfo | null

Set Signature

set toolTip(value): void

Defined in: parts/Part.ts:479

Parameters

value

Panel | HTMLInfo | null

Returns

void

Inherited from

Part.toolTip

---

tooltipVisible

Get Signature

get tooltipVisible(): boolean

Defined in: parts/Part.ts:497

Whether the tooltip is currently visible.

Returns

boolean

Set Signature

set tooltipVisible(value): void

Defined in: parts/Part.ts:501

Parameters

value

boolean

Returns

void

Inherited from

Part.tooltipVisible

---

toPort

Get Signature

get toPort(): object

Defined in: parts/Link.ts:188

Returns

object

x

x: number

y

y: number

Set Signature

set toPort(value): void

Defined in: parts/Link.ts:192

Parameters

value

x

number

y

number

Returns

void

---

toPortName

Get Signature

get toPortName(): string | undefined

Defined in: parts/Link.ts:206

The name of the target port on the to-node.

Returns

string | undefined

Set Signature

set toPortName(value): void

Defined in: parts/Link.ts:210

Parameters

value

string | undefined

Returns

void

---

toShortLength

Get Signature

get toShortLength(): number

Defined in: parts/Link.ts:416

GoJS-compatible: The distance from the to-end to the last point.

Returns

number

Set Signature

set toShortLength(value): void

Defined in: parts/Link.ts:420

Parameters

value

number

Returns

void

---

toSpot

Get Signature

get toSpot(): Spot | null

Defined in: parts/Link.ts:224

The spot on the to-node where this link connects.

Returns

Spot | null

Set Signature

set toSpot(value): void

Defined in: parts/Link.ts:228

Parameters

value

Spot | null

Returns

void

---

treeLinkRoute

Get Signature

get treeLinkRoute(): "straight" | "orthogonal" | "angled"

Defined in: parts/Link.ts:398

GoJS-compatible: The routing style for tree links.

Returns

"straight" | "orthogonal" | "angled"

Set Signature

set treeLinkRoute(value): void

Defined in: parts/Link.ts:402

Parameters

value

"straight" | "orthogonal" | "angled"

Returns

void

---

visible

Get Signature

get visible(): boolean

Defined in: parts/Part.ts:248

Returns

boolean

Set Signature

set visible(value): void

Defined in: parts/Part.ts:252

Parameters

value

boolean

Returns

void

Inherited from

Part.visible

---

width

Get Signature

get width(): number

Defined in: parts/Part.ts:144

GoJS-compatible: The width of this part (delegates to its bounds).

Returns

number

Set Signature

set width(value): void

Defined in: parts/Part.ts:148

Parameters

value

number

Returns

void

Inherited from

Part.width

---

zOrder

Get Signature

get zOrder(): number

Defined in: parts/Part.ts:304

Returns

number

Set Signature

set zOrder(value): void

Defined in: parts/Part.ts:308

Parameters

value

number

Returns

void

Inherited from

Part.zOrder

Methods

addAdornment()

addAdornment(name, adornment): void

Defined in: parts/Part.ts:582

Add an adornment to this part.

Parameters

name

string

adornment

Adornment

Returns

void

Inherited from

Part.addAdornment

---

addBinding()

addBinding(binding): this

Defined in: parts/Part.ts:608

Add a binding to this part.

Parameters

binding

Binding

Returns

this

Inherited from

Part.addBinding

---

addVisual()

addVisual(element): this

Defined in: parts/Part.ts:551

GoJS-compatible: Add a child element to this part’s visual tree.

Parameters

element

GraphObject

Returns

this

Inherited from

Part.addVisual

---

applyBindings()

applyBindings(nodeData): number

Defined in: parts/Part.ts:632

Apply all bindings from model data to this part. Returns the number of properties set.

Parameters

nodeData

NodeData

Returns

number

Inherited from

Part.applyBindings

---

applyTwoWayBindings()

applyTwoWayBindings(nodeData): number

Defined in: parts/Part.ts:647

Apply TwoWay bindings: write Part properties back to model data.

Parameters

nodeData

NodeData

Returns

number

Inherited from

Part.applyTwoWayBindings

---

clearAdornments()

clearAdornments(): void

Defined in: parts/Part.ts:598

Remove all adornments from this part.

Returns

void

Inherited from

Part.clearAdornments

---

clearBindings()

clearBindings(): void

Defined in: parts/Part.ts:622

Remove all bindings from this part.

Returns

void

Inherited from

Part.clearBindings

---

containsPoint()

containsPoint(point): boolean

Defined in: parts/Link.ts:564

Check if a point is near the link path.

Parameters

point

x

number

y

number

Returns

boolean

Overrides

Part.containsPoint

---

copy()

copy(): this

Defined in: parts/Link.ts:497

Deep copy of this link, including endpoint keys and path state.

Returns

this

Overrides

Part.copy

---

findAdornment()

findAdornment(name): Adornment | undefined

Defined in: parts/Part.ts:577

Get a specific adornment by name.

Parameters

name

string

Returns

Adornment | undefined

Inherited from

Part.findAdornment

---

findAdornmentNamed()

findAdornmentNamed(name): Adornment | null

Defined in: parts/Part.ts:588

GoJS-compatible: Find an adornment by name, or null if not present.

Parameters

name

string

Returns

Adornment | null

Inherited from

Part.findAdornmentNamed

---

findBinding()

findBinding(targetProperty): Binding | undefined

Defined in: parts/Part.ts:627

Find a binding targeting a specific property.

Parameters

targetProperty

string

Returns

Binding | undefined

Inherited from

Part.findBinding

---

findDiagram()

findDiagram(): Diagram | null

Defined in: parts/Part.ts:453

GoJS-compatible: Find the diagram that contains this part.

Returns

Diagram | null

Inherited from

Part.findDiagram

---

findFromNode()

findFromNode(): Node | null

Defined in: parts/Link.ts:122

GoJS-compatible: Find the source node of this link (or null).

Returns

Node | null

---

findLayer()

findLayer(): Layer | null

Defined in: parts/Part.ts:458

GoJS-compatible: Find the layer that contains this part.

Returns

Layer | null

Inherited from

Part.findLayer

---

findObject()

findObject(name): GraphObject | null

Defined in: parts/Part.ts:566

GoJS-compatible: Find a GraphObject by name in this part’s visual tree.

Parameters

name

string

Returns

GraphObject | null

Inherited from

Part.findObject

---

findToNode()

findToNode(): Node | null

Defined in: parts/Link.ts:127

GoJS-compatible: Find the destination node of this link (or null).

Returns

Node | null

---

getLabelBounds()

getLabelBounds(): Rect | null

Defined in: parts/Link.ts:248

Approximate screen-space bounds of the rendered label (based on the last routed pathPoints), or null if this link has no label. Used for label-drag hit-testing; the text width is estimated from character count since no canvas context is available here for exact measurement.

Returns

Rect | null

---

removeAdornment()

removeAdornment(name): boolean

Defined in: parts/Part.ts:593

Remove an adornment from this part.

Parameters

name

string

Returns

boolean

Inherited from

Part.removeAdornment

---

removeBinding()

removeBinding(binding): boolean

Defined in: parts/Part.ts:614

Remove a binding from this part.

Parameters

binding

Binding

Returns

boolean

Inherited from

Part.removeBinding

---

removeVisual()

removeVisual(element): boolean

Defined in: parts/Part.ts:560

GoJS-compatible: Remove a child element from this part’s visual tree.

Parameters

element

GraphObject

Returns

boolean

Inherited from

Part.removeVisual

---

setPathPoints()

setPathPoints(points): void

Defined in: parts/Link.ts:238

Set the computed path points.

Parameters

points

object[]

Returns

void

---

updateBounds()

updateBounds(): void

Defined in: parts/Link.ts:535

Update the bounds based on all path points.

Returns

void