TreeModel

Defined in: model/TreeModel.ts:12

A model for tree-structured diagrams. Each node data has an optional parent property referencing its parent key.

Extends

• Model

Constructors

Constructor

new TreeModel(options?): TreeModel

Defined in: model/TreeModel.ts:18

GoJS-compatible: options object.

Parameters

options?

nodeDataArray?

NodeData[]

nodeKeyProperty?

string

parentKeyProperty?

string

Returns

TreeModel

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

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

---

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

---

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

---

addNode()

addNode(nodeData): NodeKey

Defined in: model/TreeModel.ts:136

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

Parameters

nodeData

NodeData

Returns

NodeKey

Overrides

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

---

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

---

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(): TreeModel

Defined in: model/TreeModel.ts:273

Create a deep copy of this model.

Returns

TreeModel

Overrides

Model.copy

---

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/Model.ts:588

Check if this model equals another model.

Parameters

other

Model

Returns

boolean

Inherited from

Model.equals

---

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

---

getChildCount()

getChildCount(key): number

Defined in: model/TreeModel.ts:98

Get the number of children of a node.

Parameters

key

NodeKey

Returns

number

---

getChildKeys()

getChildKeys(key): NodeKey[]

Defined in: model/TreeModel.ts:82

Get the child keys of a node.

Parameters

key

NodeKey

Returns

NodeKey[]

---

getChildNodes()

getChildNodes(key): readonly NodeData[]

Defined in: model/TreeModel.ts:77

Get the direct children of a node.

Parameters

key

NodeKey

Returns

readonly NodeData[]

---

getDepth()

getDepth(key): number

Defined in: model/TreeModel.ts:123

Get the depth (level) of a node. Root = 0.

Parameters

key

NodeKey

Returns

number

---

getDescendants()

getDescendants(key): NodeData[]

Defined in: model/TreeModel.ts:103

Get the descendants (recursively) of a node.

Parameters

key

NodeKey

Returns

NodeData[]

---

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

---

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

---

getParentKey()

getParentKey(nodeData): NodeKey | undefined

Defined in: model/TreeModel.ts:46

Get the parent key of a node. Returns undefined for root nodes.

Parameters

nodeData

NodeData

Returns

NodeKey | undefined

---

getParentKeyForNode()

getParentKeyForNode(key): NodeKey | undefined

Defined in: model/TreeModel.ts:60

Get the parent key of a node by node key.

Parameters

key

NodeKey

Returns

NodeKey | undefined

---

getParentKeyProperty()

getParentKeyProperty(): string

Defined in: model/TreeModel.ts:36

Get the parent key property name.

Returns

string

---

getParentNode()

getParentNode(key): NodeData | undefined

Defined in: model/TreeModel.ts:87

Get the direct parent node data of a node.

Parameters

key

NodeKey

Returns

NodeData | undefined

---

getRootNodes()

getRootNodes(): NodeData[]

Defined in: model/TreeModel.ts:118

Get the root nodes (nodes without a parent).

Returns

NodeData[]

---

getUndoManager()

getUndoManager(): unknown

Defined in: model/Model.ts:233

GoJS-compatible: Get the associated UndoManager.

Returns

unknown

Inherited from

Model.getUndoManager

---

hasChildren()

hasChildren(key): boolean

Defined in: model/TreeModel.ts:93

Check if a node has children.

Parameters

key

NodeKey

Returns

boolean

---

isRoot()

isRoot(key): boolean

Defined in: model/TreeModel.ts:66

Check if a node is a root (has no parent).

Parameters

key

NodeKey

Returns

boolean

---

isTransactionInProgress()

isTransactionInProgress(): boolean

Defined in: model/Model.ts:501

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

Returns

boolean

Inherited from

Model.isTransactionInProgress

---

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

---

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

---

removeChangedListener()

removeChangedListener(listener): void

Defined in: model/Model.ts:380

Remove a change listener.

Parameters

listener

ChangedEventHandler

Returns

void

Inherited from

Model.removeChangedListener

---

removeNode()

removeNode(key): boolean

Defined in: model/TreeModel.ts:174

Remove a node and all its descendants.

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

---

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

---

setParent()

setParent(key, newParentKey): void

Defined in: model/TreeModel.ts:216

Set the parent of a node.

Parameters

key

NodeKey

newParentKey

NodeKey | undefined

Returns

void

---

setParentKey()

setParentKey(nodeData, key): void

Defined in: model/TreeModel.ts:51

Set the parent key of a node.

Parameters

nodeData

NodeData

key

NodeKey | undefined

Returns

void

---

setParentKeyProperty()

setParentKeyProperty(property): void

Defined in: model/TreeModel.ts:41

Set the parent key property name.

Parameters

property

string

Returns

void

---

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

---

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(): TreeModelJSON

Defined in: model/TreeModel.ts:252

Convert to JSON.

Returns

TreeModelJSON

Overrides

Model.toJSON

---

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): TreeModel

Defined in: model/TreeModel.ts:262

Create from JSON.

Parameters

json

TreeModelJSON

Returns

TreeModel

Overrides

Model.fromJSON