Class Graph

Graph containing nodes, connectors, edges and models

NOTICE: this class is used internally in the Project class, always use the Project class

Hierarchy

Graph

Implements

GraphInterface

Index

Constructors

constructor

Properties

elements

Constructors

constructor

new Graph(): Graph

- Defined in Graph.ts:17
Returns Graph

Properties

Private elements

elements: Dictionary<AbstractElement>

Methods

addConnector

addConnector(id: Guid, type: string, nodeId: Guid, properties: Dictionary<any>): void

Implementation of GraphInterface.addConnector
- Defined in Graph.ts:192
Adds a Connector to the Graph

Parameters
- id: Guid
- type: string
- nodeId: Guid
- properties: Dictionary<any>
Returns void

addEdge

addEdge(id: Guid, type: string, modelId: Guid, startConnectorId: Guid, endConnectorId: Guid, properties?: Dictionary<any>): void

Implementation of GraphInterface.addEdge
- Defined in Graph.ts:131
Adds an Edge to the Graph

Parameters
- id: Guid
- type: string
- modelId: Guid
- startConnectorId: Guid
- endConnectorId: Guid
- Default value properties: Dictionary<any> = {}
Returns void

addModel

addModel(id: Guid, type: string, properties: Dictionary<any>, parentId?: Guid): void

Implementation of GraphInterface.addModel
- Defined in Graph.ts:224
Adds a Model to the Graph

Parameters
- id: Guid
- type: string
- properties: Dictionary<any>
- Optional parentId: Guid
Returns void

addNode

addNode(id: Guid, type: string, modelId: Guid, properties: Dictionary<any>): void

Implementation of GraphInterface.addNode
- Defined in Graph.ts:102
Adds a Node to the Graph

Parameters
- id: Guid
- type: string
- modelId: Guid
- properties: Dictionary<any>
Returns void

deleteConnector

deleteConnector(id: Guid): void

Implementation of GraphInterface.deleteConnector
- Defined in Graph.ts:288
Deletes a Connector from the Graph

Parameters
- id: Guid
Returns void

deleteEdge

deleteEdge(id: Guid): void

Implementation of GraphInterface.deleteEdge
- Defined in Graph.ts:281
Deletes an Edge from the Graph

Parameters
- id: Guid
Returns void

deleteElement

deleteElement(id: Guid, ofType?: ElementType): void

- Defined in Graph.ts:83
Removes an element from the graph, WARNING: does not perform a cascading delete (i.e. no removal of orphan edges)

Parameters
- id: Guid
  
  Identifier of the element to remove
- Optional ofType: ElementType
  
  Only delete the element if it is of the matching Type, if undefined, this check will be skipped
Returns void

deleteModel

deleteModel(id: Guid): void

Implementation of GraphInterface.deleteModel
- Defined in Graph.ts:295
Deletes a Model from the Graph

Parameters
- id: Guid
Returns void

deleteNode

deleteNode(id: Guid): void

Implementation of GraphInterface.deleteNode
- Defined in Graph.ts:274
Deletes a Node from the Graph

Parameters
- id: Guid
Returns void

deleteProperty

deleteProperty(id: Guid, name: string): void

Implementation of GraphInterface.deleteProperty
- Defined in Graph.ts:302
Deletes a Property from the Graph

Parameters
- id: Guid
- name: string
Returns void

deserialize

deserialize(jsonObject: Object): GraphInterface

Implementation of GraphInterface.deserialize
- Defined in Graph.ts:314
Creates a new GraphInterface from a JSON Graph

For the expected format, please read the documentation The expected format is the same as the format returned by serialize()

Parameters
- jsonObject: Object
Returns GraphInterface

Private enqueueChildElement

enqueueChildElement(type: string, children: string[], queue: Queue<Object>, inQueue: Dictionary<Boolean>): void

- Defined in Graph.ts:402
Iterate over the child elements to add them

Parameters
- type: string
  
  Type of the child elements
- children: string[]
  
  the Children to iterate over
- queue: Queue<Object>
  
  The queue to add elements to
- inQueue: Dictionary<Boolean>
  
  register which elements are processed
Returns void

getElement

getElement(id: Guid): AbstractElement

- Defined in Graph.ts:28
Returns an element given an GUID

Parameters
- id: Guid
  
  GUID representing an element identifier
Returns AbstractElement

hasConnector

hasConnector(id: Guid): boolean

Implementation of GraphInterface.hasConnector
- Defined in Graph.ts:64
Returns whether a Connector with the ID exists

Parameters
- id: Guid
Returns boolean

hasEdge

hasEdge(id: Guid): boolean

Implementation of GraphInterface.hasEdge
- Defined in Graph.ts:72
Returns whether an Edge with the ID exists

Parameters
- id: Guid
Returns boolean

hasElement

hasElement(id: Guid): boolean

Implementation of GraphInterface.hasElement
- Defined in Graph.ts:41
Returns whether an Element with the ID exists

Parameters
- id: Guid
Returns boolean

hasModel

hasModel(id: Guid): boolean

Implementation of GraphInterface.hasModel
- Defined in Graph.ts:48
Returns whether a Model with the ID exists

Parameters
- id: Guid
Returns boolean

hasNode

hasNode(id: Guid): boolean

Implementation of GraphInterface.hasNode
- Defined in Graph.ts:56
Returns whether a Node with the ID exists

Parameters
- id: Guid
Returns boolean

Private propertiesFromJSON

propertiesFromJSON(jsonProperties: Object): Dictionary<any>

- Defined in Graph.ts:417
Creates a Property dictionary from JSON

Parameters
- jsonProperties: Object
  
  JSON object that contains the properties
Returns Dictionary<any>

serialize

serialize(): object

Implementation of GraphInterface.serialize
- Defined in Graph.ts:428
Transforms this Graph to a plain JSON graph

Returns object
- connectors: object
- edges: object
- models: object
- nodes: object

setProperty

setProperty(id: Guid, name: string, value: any): void

Implementation of GraphInterface.setProperty
- Defined in Graph.ts:263
Sets a property on an Element

Parameters
- id: Guid
- name: string
- value: any
Returns void

Generated using TypeDoc