GraphLinksModel

Defined in: model/GraphLinksModel.ts:12

A model that supports nodes and links between nodes.

Extends

• Model

Constructors

Constructor

new GraphLinksModel(options?): GraphLinksModel

Defined in: model/GraphLinksModel.ts:19

GoJS-compatible: options object.

Parameters

options?

linkDataArray?

LinkData[]

linkKeyProperty?

string

nodeDataArray?

NodeData[]

nodeKeyProperty?

string

Returns

GraphLinksModel

Overrides

Model.constructor

Properties

changedEventLog

changedEventLog: ChangedEvent[] = []

Defined in: model/Model.ts:402

GoJS-compatible: The log of changed events since the last clear.

Inherited from

Model.changedEventLog

Accessors

allowsDuplicateLinks

Get Signature

get allowsDuplicateLinks(): boolean

Defined in: model/GraphLinksModel.ts:146

Whether duplicate links are allowed. Default: true

Returns

boolean

Set Signature

set allowsDuplicateLinks(value): void

Defined in: model/GraphLinksModel.ts:151

Set whether duplicate links are allowed.

Parameters

value

boolean

Returns

void

---

allowsSelfLoops

Get Signature

get allowsSelfLoops(): boolean

Defined in: model/GraphLinksModel.ts:136

Whether self-loops are allowed. Default: true

Returns

boolean

Set Signature

set allowsSelfLoops(value): void

Defined in: model/GraphLinksModel.ts:141

Set whether self-loops are allowed.

Parameters

value

boolean

Returns

void

---

isModified

Get Signature

get isModified(): boolean

Defined in: model/Model.ts:245

Returns

boolean

Set Signature

set isModified(value): void

Defined in: model/Model.ts:249

Parameters

value

boolean

Returns

void

Inherited from

Model.isModified

---

isReadOnly

Get Signature

get isReadOnly(): boolean

Defined in: model/Model.ts:515

GoJS-compatible: Whether this model is read-only.

Returns

boolean

Set Signature

set isReadOnly(value): void

Defined in: model/Model.ts:519

Parameters

value

boolean

Returns

void

Inherited from

Model.isReadOnly

---

isValidLink

Get Signature

get isValidLink(): LinkValidationCallback | null

Defined in: model/GraphLinksModel.ts:121

Get the link validation callback.

Returns

LinkValidationCallback | null

Set Signature

set isValidLink(callback): void

Defined in: model/GraphLinksModel.ts:116

Set a callback to validate link data before adding.

Parameters

callback

LinkValidationCallback | null

Returns

void

---

isValidLinkRemoval

Get Signature

get isValidLinkRemoval(): LinkValidationCallback | null

Defined in: model/GraphLinksModel.ts:131

Get the link removal validation callback.

Returns

LinkValidationCallback | null

Set Signature

set isValidLinkRemoval(callback): void

Defined in: model/GraphLinksModel.ts:126

Set a callback to validate link data before removal.

Parameters

callback

LinkValidationCallback | null

Returns

void

---

isValidNode

Get Signature

get isValidNode(): NodeValidationCallback | null

Defined in: model/Model.ts:533

Get the node validation callback.

Returns

NodeValidationCallback | null

Set Signature

set isValidNode(callback): void

Defined in: model/Model.ts:528

Set a callback to validate node data before adding.

Parameters

callback

NodeValidationCallback | null

Returns

void

Inherited from

Model.isValidNode

---

isValidNodeRemoval

Get Signature

get isValidNodeRemoval(): NodeValidationCallback | null

Defined in: model/Model.ts:543

Get the node removal validation callback.

Returns

NodeValidationCallback | null

Set Signature

set isValidNodeRemoval(callback): void

Defined in: model/Model.ts:538

Set a callback to validate node data before removal.

Parameters

callback

NodeValidationCallback | null

Returns

void

Inherited from

Model.isValidNodeRemoval

---

linkDataArray

Get Signature

get linkDataArray(): readonly LinkData[]

Defined in: model/GraphLinksModel.ts:189

GoJS-compatible: Get the link data array.

Returns

readonly LinkData[]

Set Signature

set linkDataArray(value): void

Defined in: model/GraphLinksModel.ts:194

GoJS-compatible: Set the link data array, assigning keys and emitting events.

Parameters

value

LinkData[]

Returns

void

---

linkFromPortIdProperty

Get Signature

get linkFromPortIdProperty(): string

Defined in: model/GraphLinksModel.ts:63

Returns

string

Set Signature

set linkFromPortIdProperty(value): void

Defined in: model/GraphLinksModel.ts:67

Parameters

value

string

Returns

void

---

linkToPortIdProperty

Get Signature

get linkToPortIdProperty(): string

Defined in: model/GraphLinksModel.ts:74

Returns

string

Set Signature

set linkToPortIdProperty(value): void

Defined in: model/GraphLinksModel.ts:78

Parameters

value

string

Returns

void

---

nodeCategoryProperty

Get Signature

get nodeCategoryProperty(): string

Defined in: model/Model.ts:193

GoJS-compatible: Get or set the node category property name.

Returns

string

Set Signature

set nodeCategoryProperty(value): void

Defined in: model/Model.ts:197

Parameters

value

string

Returns

void

Inherited from

Model.nodeCategoryProperty

---

nodeDataArray

Get Signature

get nodeDataArray(): readonly NodeData[]

Defined in: model/Model.ts:104

GoJS-compatible: Get the node data array.

Returns

readonly NodeData[]

Set Signature

set nodeDataArray(value): void

Defined in: model/Model.ts:109

GoJS-compatible: Set the node data array, assigning keys and emitting events.

Parameters

value

NodeData[]

Returns

void

Inherited from

Model.nodeDataArray

---

usesUndoManager

Get Signature

get usesUndoManager(): boolean

Defined in: model/Model.ts:224

GoJS-compatible: Whether this model supports undo/redo.

Returns

boolean

Set Signature

set usesUndoManager(value): void

Defined in: model/Model.ts:228

Parameters

value

boolean

Returns

void

Inherited from

Model.usesUndoManager

Methods

addChangedListener()

addChangedListener(listener): void

Defined in: model/Model.ts:375

Add a change listener.

Parameters

listener

ChangedEventHandler

Returns

void

Inherited from

Model.addChangedListener

---

addLink()

addLink(linkData): NodeKey

Defined in: model/GraphLinksModel.ts:296

Add a link.

Parameters

linkData

LinkData

Returns

NodeKey

---

addLinkData()

addLinkData(linkData): void

Defined in: model/GraphLinksModel.ts:381

GoJS-compatible: Add a link data object to the model.

Parameters

linkData

LinkData

Returns

void

---

addNode()

addNode(nodeData): NodeKey

Defined in: model/Model.ts:264

Add a node. Returns the generated key if none provided.

Parameters

nodeData

NodeData

Returns

NodeKey

Inherited from

Model.addNode

---

addNodeData()

addNodeData(nodeData): void

Defined in: model/Model.ts:326

GoJS-compatible: Add a node data object to the model.

Parameters

nodeData

NodeData

Returns

void

Inherited from

Model.addNodeData

---

applyIncrementalJson()

applyIncrementalJson(json): void

Defined in: model/GraphLinksModel.ts:482

GoJS-compatible: Apply an incremental JSON representation produced by toIncrementalJson (or a full GraphLinksModelJSON snapshot).

Parameters

json

modifiedLinkData?

LinkData[]

modifiedNodeData?

NodeData[]

removedLinkIds?

NodeKey[]

removedNodeIds?

NodeKey[]

Returns

void

---

clear()

clear(): void

Defined in: model/GraphLinksModel.ts:543

GoJS-compatible: Remove all nodes and links from the model.

Returns

void

---

clearChangedEventLog()

clearChangedEventLog(): void

Defined in: model/Model.ts:405

GoJS-compatible: Clear the changed event log.

Returns

void

Inherited from

Model.clearChangedEventLog

---

clearIsModified()

clearIsModified(): void

Defined in: model/Model.ts:254

GoJS-compatible: Clear the modified flag.

Returns

void

Inherited from

Model.clearIsModified

---

commitTransaction()

commitTransaction(_name?): boolean

Defined in: model/Model.ts:471

GoJS-compatible: Commit the current transaction, flushing buffered events.

Parameters

_name?

string = ''

Returns

boolean

Inherited from

Model.commitTransaction

---

containsLink()

containsLink(from, to): boolean

Defined in: model/GraphLinksModel.ts:408

Check if a link exists between two nodes.

Parameters

from

NodeKey

to

NodeKey

Returns

boolean

---

containsNode()

containsNode(key): boolean

Defined in: model/Model.ts:153

Check if a node exists.

Parameters

key

NodeKey

Returns

boolean

Inherited from

Model.containsNode

---

copy()

copy(): GraphLinksModel

Defined in: model/GraphLinksModel.ts:554

Create a deep copy of this model.

Returns

GraphLinksModel

Overrides

Model.copy

---

copyLinkData()

copyLinkData(linkData): LinkData

Defined in: model/GraphLinksModel.ts:88

GoJS-compatible: Copy a link data object.

Parameters

linkData

LinkData

Returns

LinkData

---

copyNodeData()

copyNodeData(nodeData): NodeData

Defined in: model/Model.ts:178

GoJS-compatible: Copy a node data object.

Parameters

nodeData

NodeData

Returns

NodeData

Inherited from

Model.copyNodeData

---

equals()

equals(other): boolean

Defined in: model/GraphLinksModel.ts:532

Check if this model equals another model.

Parameters

other

Model

Returns

boolean

Overrides

Model.equals

---

findLinkDataForKey()

findLinkDataForKey(key): LinkData | undefined

Defined in: model/GraphLinksModel.ts:98

GoJS-compatible: Find link data by key.

Parameters

key

NodeKey

Returns

LinkData | undefined

---

findNodeDataForKey()

findNodeDataForKey(key): NodeData | undefined

Defined in: model/Model.ts:163

GoJS-compatible: Find node data by key (alias).

Parameters

key

NodeKey

Returns

NodeData | undefined

Inherited from

Model.findNodeDataForKey

---

findNodeDataForPart()

findNodeDataForPart(partKey): NodeData | undefined

Defined in: model/Model.ts:188

GoJS-compatible: Find the node data that corresponds to a part (by key).

Parameters

partKey

NodeKey

Returns

NodeData | undefined

Inherited from

Model.findNodeDataForPart

---

generateKey()

generateKey(): NodeKey

Defined in: model/Model.ts:90

Generate a unique key that is not already in use.

Returns

NodeKey

Inherited from

Model.generateKey

---

getCategoryForNodeData()

getCategoryForNodeData(nodeData): string

Defined in: model/Model.ts:202

GoJS-compatible: Get the category of a node data object.

Parameters

nodeData

NodeData

Returns

string

Inherited from

Model.getCategoryForNodeData

---

getKeyProperty()

getKeyProperty(): string

Defined in: model/Model.ts:212

GoJS-compatible: Get or set the key property (GoJS name).

Returns

string

Inherited from

Model.getKeyProperty

---

getLinkCount()

getLinkCount(): number

Defined in: model/GraphLinksModel.ts:231

Get the number of links.

Returns

number

---

getLinkData()

getLinkData(key): LinkData | undefined

Defined in: model/GraphLinksModel.ts:282

Get a link data object by key.

Parameters

key

NodeKey

Returns

LinkData | undefined

---

getLinkDataArray()

getLinkDataArray(): readonly LinkData[]

Defined in: model/GraphLinksModel.ts:184

Get all link data.

Returns

readonly LinkData[]

---

getLinkKey()

getLinkKey(linkData): NodeKey | undefined

Defined in: model/GraphLinksModel.ts:236

Get the key of a link data object.

Parameters

linkData

LinkData

Returns

NodeKey | undefined

---

getLinkKeyProperty()

getLinkKeyProperty(): string

Defined in: model/GraphLinksModel.ts:46

Get the link key property name.

Returns

string

---

getLinkKeyPropertyName()

getLinkKeyPropertyName(): string

Defined in: model/GraphLinksModel.ts:56

GoJS-compatible: Get or set the link key property (GoJS names).

Returns

string

---

getLinkProperty()

getLinkProperty(key, propertyName): unknown

Defined in: model/GraphLinksModel.ts:246

Get a property from a link.

Parameters

key

NodeKey

propertyName

string

Returns

unknown

---

getLinksForNode()

getLinksForNode(key): readonly LinkData[]

Defined in: model/GraphLinksModel.ts:393

Get links connected to a node.

Parameters

key

NodeKey

Returns

readonly LinkData[]

---

getLinksFrom()

getLinksFrom(key): readonly LinkData[]

Defined in: model/GraphLinksModel.ts:398

Get links from a node.

Parameters

key

NodeKey

Returns

readonly LinkData[]

---

getLinksTo()

getLinksTo(key): readonly LinkData[]

Defined in: model/GraphLinksModel.ts:403

Get links to a node.

Parameters

key

NodeKey

Returns

readonly LinkData[]

---

getNodeCount()

getNodeCount(): number

Defined in: model/Model.ts:148

Get the number of nodes.

Returns

number

Inherited from

Model.getNodeCount

---

getNodeData()

getNodeData(key): NodeData | undefined

Defined in: model/Model.ts:158

Get node data by key.

Parameters

key

NodeKey

Returns

NodeData | undefined

Inherited from

Model.getNodeData

---

getNodeDataArray()

getNodeDataArray(): readonly NodeData[]

Defined in: model/Model.ts:99

Get all node data.

Returns

readonly NodeData[]

Inherited from

Model.getNodeDataArray

---

getNodeDataForKey()

getNodeDataForKey(key): NodeData | undefined

Defined in: model/Model.ts:168

GoJS-compatible: Find node data by key (alias).

Parameters

key

NodeKey

Returns

NodeData | undefined

Inherited from

Model.getNodeDataForKey

---

getNodeKey()

getNodeKey(nodeData): NodeKey

Defined in: model/Model.ts:80

Get the key of a node data object.

Parameters

nodeData

NodeData

Returns

NodeKey

Inherited from

Model.getNodeKey

---

getNodeKeyProperty()

getNodeKeyProperty(): string

Defined in: model/Model.ts:70

Get the node key property name.

Returns

string

Inherited from

Model.getNodeKeyProperty

---

getNodeProperty()

getNodeProperty(key, propertyName): unknown

Defined in: model/Model.ts:368

Get a property from a node.

Parameters

key

NodeKey

propertyName

string

Returns

unknown

Inherited from

Model.getNodeProperty

---

getUndoManager()

getUndoManager(): unknown

Defined in: model/Model.ts:233

GoJS-compatible: Get the associated UndoManager.

Returns

unknown

Inherited from

Model.getUndoManager

---

isTransactionInProgress()

isTransactionInProgress(): boolean

Defined in: model/Model.ts:501

GoJS-compatible: Whether a transaction is currently in progress.

Returns

boolean

Inherited from

Model.isTransactionInProgress

---

makeLinkData()

makeLinkData(value?): LinkData

Defined in: model/GraphLinksModel.ts:83

GoJS-compatible: Make a new link data object from a prototype.

Parameters

value?

Partial<LinkData>

Returns

LinkData

---

makeNodeData()

makeNodeData(value?): NodeData

Defined in: model/Model.ts:173

GoJS-compatible: Make a new node data object from a prototype.

Parameters

value?

Partial<NodeData>

Returns

NodeData

Inherited from

Model.makeNodeData

---

mergeChanges()

mergeChanges(changes): void

Defined in: model/Model.ts:413

GoJS-compatible: Merge the changed events recorded by another model (or by this model’s change log) into this model.

Parameters

changes

Model | ChangedEvent[]

Returns

void

Inherited from

Model.mergeChanges

---

mergeLinkData()

mergeLinkData(linkData, newData): void

Defined in: model/GraphLinksModel.ts:93

GoJS-compatible: Merge new data into an existing link data object.

Parameters

linkData

LinkData

newData

Partial<LinkData>

Returns

void

---

mergeNodeData()

mergeNodeData(nodeData, newData): void

Defined in: model/Model.ts:183

GoJS-compatible: Merge new data into an existing node data object.

Parameters

nodeData

NodeData

newData

Partial<NodeData>

Returns

void

Inherited from

Model.mergeNodeData

---

relinkNodeData()

relinkNodeData(nodeKey, newKey): void

Defined in: model/GraphLinksModel.ts:103

GoJS-compatible: Relink a node: update all links to/from the old key to the new key.

Parameters

nodeKey

NodeKey

newKey

NodeKey

Returns

void

---

removeChangedListener()

removeChangedListener(listener): void

Defined in: model/Model.ts:380

Remove a change listener.

Parameters

listener

ChangedEventHandler

Returns

void

Inherited from

Model.removeChangedListener

---

removeLink()

removeLink(key): boolean

Defined in: model/GraphLinksModel.ts:352

Remove a link by key.

Parameters

key

NodeKey

Returns

boolean

---

removeLinkData()

removeLinkData(key): boolean

Defined in: model/GraphLinksModel.ts:386

GoJS-compatible: Remove a link data object (or its key) from the model.

Parameters

key

NodeKey | LinkData

Returns

boolean

---

removeLinksForNode()

removeLinksForNode(key): void

Defined in: model/GraphLinksModel.ts:413

Remove all links connected to a node.

Parameters

key

NodeKey

Returns

void

---

removeNode()

removeNode(key): boolean

Defined in: model/GraphLinksModel.ts:424

Override removeNode to also remove connected links.

Parameters

key

NodeKey

Returns

boolean

Overrides

Model.removeNode

---

removeNodeData()

removeNodeData(key): boolean

Defined in: model/Model.ts:331

GoJS-compatible: Remove a node data object (or its key) from the model.

Parameters

key

NodeKey | NodeData

Returns

boolean

Inherited from

Model.removeNodeData

---

rollbackTransaction()

rollbackTransaction(): boolean

Defined in: model/Model.ts:486

GoJS-compatible: Roll back the current transaction, undoing its mutations.

Returns

boolean

Inherited from

Model.rollbackTransaction

---

setCategoryForNodeData()

setCategoryForNodeData(nodeData, category): void

Defined in: model/Model.ts:207

GoJS-compatible: Set the category of a node data object.

Parameters

nodeData

NodeData

category

string

Returns

void

Inherited from

Model.setCategoryForNodeData

---

setDataProperty()

setDataProperty(data, propertyName, value): void

Defined in: model/Model.ts:600

Set a property on any data object (node or link) with change event.

Parameters

data

LinkData | NodeData

propertyName

string

value

unknown

Returns

void

Inherited from

Model.setDataProperty

---

setKeyProperty()

setKeyProperty(value): void

Defined in: model/Model.ts:216

Parameters

value

string

Returns

void

Inherited from

Model.setKeyProperty

---

setLinkDataArray()

setLinkDataArray(value): void

Defined in: model/GraphLinksModel.ts:199

Set all link data, assigning missing keys and emitting add/remove events.

Parameters

value

LinkData[]

Returns

void

---

setLinkKey()

setLinkKey(linkData, key): void

Defined in: model/GraphLinksModel.ts:241

Set the key of a link data object.

Parameters

linkData

LinkData

key

NodeKey

Returns

void

---

setLinkKeyProperty()

setLinkKeyProperty(property): void

Defined in: model/GraphLinksModel.ts:51

Set the link key property name.

Parameters

property

string

Returns

void

---

setLinkProperty()

setLinkProperty(key, propertyName, value): void

Defined in: model/GraphLinksModel.ts:253

Set a property on a link.

Parameters

key

NodeKey

propertyName

string

value

unknown

Returns

void

---

setNodeDataArray()

setNodeDataArray(value): void

Defined in: model/Model.ts:114

Set all node data, assigning missing keys and emitting add/remove events.

Parameters

value

NodeData[]

Returns

void

Inherited from

Model.setNodeDataArray

---

setNodeKey()

setNodeKey(nodeData, key): void

Defined in: model/Model.ts:85

Set the key of a node data object.

Parameters

nodeData

NodeData

key

NodeKey

Returns

void

Inherited from

Model.setNodeKey

---

setNodeKeyProperty()

setNodeKeyProperty(property): void

Defined in: model/Model.ts:75

Set the node key property name.

Parameters

property

string

Returns

void

Inherited from

Model.setNodeKeyProperty

---

setNodeProperty()

setNodeProperty(key, propertyName, value): void

Defined in: model/Model.ts:337

Set a property on a node.

Parameters

key

NodeKey

propertyName

string

value

unknown

Returns

void

Inherited from

Model.setNodeProperty

---

setUndoManager()

setUndoManager(undoManager): void

Defined in: model/Model.ts:238

GoJS-compatible: Set the associated UndoManager.

Parameters

undoManager

unknown

Returns

void

Inherited from

Model.setUndoManager

---

startTransaction()

startTransaction(_name?): boolean

Defined in: model/Model.ts:465

GoJS-compatible: Begin a transaction; changed events are buffered until commit.

Parameters

_name?

string = ''

Returns

boolean

Inherited from

Model.startTransaction

---

toIncrementalJson()

toIncrementalJson(): object

Defined in: model/GraphLinksModel.ts:444

GoJS-compatible: Produce an incremental JSON representation based on the current change log. Falls back to a full snapshot when no log exists.

Returns

object

modifiedLinkData?

optional modifiedLinkData?: LinkData[]

modifiedNodeData?

optional modifiedNodeData?: NodeData[]

removedLinkIds?

optional removedLinkIds?: NodeKey[]

removedNodeIds?

optional removedNodeIds?: NodeKey[]

---

toJson()

toJson(): ModelJSON

Defined in: model/Model.ts:578

GoJS-compatible: Alias for toJSON (GoJS uses toJson).

Returns

ModelJSON

Inherited from

Model.toJson

---

toJSON()

toJSON(): GraphLinksModelJSON

Defined in: model/GraphLinksModel.ts:430

Convert to JSON.

Returns

GraphLinksModelJSON

Overrides

Model.toJSON

---

validateLink()

validateLink(linkData): boolean

Defined in: model/GraphLinksModel.ts:159

Validate a link before it is added. Checks self-loops, duplicates, and the user callback.

Parameters

linkData

LinkData

Returns

boolean

---

validateLinkRemoval()

validateLinkRemoval(linkData): boolean

Defined in: model/GraphLinksModel.ts:176

Validate a link before it is removed. Returns true if valid (allows removal).

Parameters

linkData

LinkData

Returns

boolean

---

validateNode()

validateNode(nodeData): boolean

Defined in: model/Model.ts:551

Validate a node before it is added. Returns true if valid (allows insertion).

Parameters

nodeData

NodeData

Returns

boolean

Inherited from

Model.validateNode

---

validateNodeRemoval()

validateNodeRemoval(nodeData): boolean

Defined in: model/Model.ts:567

Validate a node before it is removed. Returns true if valid (allows removal).

Parameters

nodeData

NodeData

Returns

boolean

Inherited from

Model.validateNodeRemoval

---

fromJSON()

static fromJSON(json): GraphLinksModel

Defined in: model/GraphLinksModel.ts:515

Create from JSON.

Parameters

json

GraphLinksModelJSON

Returns

GraphLinksModel

Overrides

Model.fromJSON