Class GraphBase<T>`Abstract`

Base class for Graph objects.

Type Parameters

T extends AttributeKey

Hierarchy

AttributesBase_6<T>
- GraphBase

Implements

GraphBaseModel<T>

Index

Constructors

constructor

new GraphBase<T>(attributes?): GraphBase<T>
Type Parameters
- T extends AttributeKey
Parameters
- Optional attributes: AttributesObject<T>
Returns GraphBase<T>
Inherited from AttributesBase_6<T>.constructor
- Defined in packages/core/lib/core.d.ts:127

Properties

`Private` #private

#private: any

`Private` #private

#private: any

`Readonly` attributes

attributes: Readonly<GraphCommonAttributes>

`Optional` comment

comment?: string

Comments to include when outputting with toDot.

`Optional` `Readonly` id

id?: string

Accessors

edges

get edges(): readonly EdgeModel[]
Edge objects in the graph.

Returns readonly EdgeModel[]
Implementation of GraphBaseModel.edges
- Defined in packages/core/lib/core.d.ts:323

nodes

get nodes(): readonly NodeModel[]
Node objects in the graph.

Returns readonly NodeModel[]
Implementation of GraphBaseModel.nodes
- Defined in packages/core/lib/core.d.ts:322

size

get size(): number
Size of the set of keys and values held by the DOT object.

Returns number
Implementation of GraphBaseModel.size
Inherited from AttributesBase_6.size
- Defined in packages/core/lib/core.d.ts:129

subgraphs

get subgraphs(): readonly SubgraphModel[]
Subgraph objects in the graph.

Returns readonly SubgraphModel[]
Implementation of GraphBaseModel.subgraphs
- Defined in packages/core/lib/core.d.ts:324

values

get values(): readonly [T, Attribute<T>][]
The key/value tuples of the object attributes.

Returns readonly [T, Attribute<T>][]
Implementation of GraphBaseModel.values
Inherited from AttributesBase_6.values
- Defined in packages/core/lib/core.d.ts:128

Methods

addEdge

addEdge(edge): void
Add Edge to the graph.
Parameters
- edge: EdgeModel
Returns void
Implementation of GraphBaseModel.addEdge
- Defined in packages/core/lib/core.d.ts:327

addNode

addNode(node): void
Add a Node to the graph.
Parameters
- node: NodeModel
Returns void
Implementation of GraphBaseModel.addNode
- Defined in packages/core/lib/core.d.ts:326

addSubgraph

addSubgraph(subgraph): void
Add a Subgraph to the graph.
Parameters
- subgraph: SubgraphModel
Returns void
Implementation of GraphBaseModel.addSubgraph
- Defined in packages/core/lib/core.d.ts:328

apply

apply(attributes): void
Apply keys and values that can be specified for DOT objects collectively.
Parameters
- attributes: AttributesObject<T> | AttributesEntities<T>
  An array of objects or tuples of attribute key/value pairs.
Returns void
Implementation of GraphBaseModel.apply
Inherited from AttributesBase_6.apply
- Defined in packages/core/lib/core.d.ts:133

clear

clear(): void
Delete all attributes specified for the DOT object.

Returns void
Implementation of GraphBaseModel.clear
Inherited from AttributesBase_6.clear
- Defined in packages/core/lib/core.d.ts:134

createEdge

createEdge(targets, attributes?): EdgeModel
Create Edge and add it to the graph.
Parameters
- targets: EdgeTargetLikeTuple
- Optional attributes: EdgeAttributesObject
Returns EdgeModel
Implementation of GraphBaseModel.createEdge
- Defined in packages/core/lib/core.d.ts:340

createNode

createNode(id, attributes?): NodeModel
Create a Node in the graph.
Parameters
- id: string
- Optional attributes: NodeAttributesObject
Returns NodeModel
Implementation of GraphBaseModel.createNode
- Defined in packages/core/lib/core.d.ts:337

createSubgraph

createSubgraph(id?, attributes?): SubgraphModel
Create a Subgraph and add it to the graph.
Parameters
- Optional id: string
  Subgraph ID
- Optional attributes: SubgraphAttributesObject
  Subgraph attribute object
Returns SubgraphModel
Implementation of GraphBaseModel.createSubgraph
- Defined in packages/core/lib/core.d.ts:332
createSubgraph(attributes?): SubgraphModel
Parameters
- Optional attributes: SubgraphAttributesObject
Returns SubgraphModel
Implementation of GraphBaseModel.createSubgraph
- Defined in packages/core/lib/core.d.ts:333

delete

delete(key): void
Delete the value of an attribute from a DOT object by specifying a key.
Parameters
- key: T
Returns void
Implementation of GraphBaseModel.delete
Inherited from AttributesBase_6.delete
- Defined in packages/core/lib/core.d.ts:132

edge

edge(targets, callback?): EdgeModel
Create a edge.

By specifying a callback function, the target edge can be received and manipulated as an argument.
```
const G = digraph('G', (g) => {
  // Create a edge.
  g.edge(['a', 'b']);
});

console.log(toDot(G));
// digraph "G" {
//   "a" -> "b";
// }
```
Parameters
- targets: EdgeTargetLikeTuple
  Nodes.
- Optional callback: ((edge) => void)
  Callbacks for manipulating created or retrieved edge.
  - - (edge): void
    - Parameters
      edge: EdgeModel
      Returns void
Returns EdgeModel
Implementation of GraphBaseModel.edge
- Defined in packages/core/lib/core.d.ts:348
edge(targets, attributes, callback?): EdgeModel
Create a edge and adapt the attributes.

By specifying a callback function, the target edge can be received and manipulated as an argument.
```
const G = digraph('G', (g) => {
  // Create a edge and specifying its attributes.
  g.edge(['a', 'b'], {
    [attribute.color]: 'red',
    [attribute.label]: 'my label',
  });
});

console.log(toDot(G));
// digraph "G" {
//   "a" -> "b" [
//     color = "red",
//     label = "my label",
//   ];
// }
```
Parameters
- targets: EdgeTargetLikeTuple
- attributes: EdgeAttributesObject
  Object of attributes to be adapted to the edge.
- Optional callback: ((edge) => void)
  Callbacks for manipulating created or retrieved edge.
  - - (edge): void
    - Parameters
      edge: EdgeModel
      Returns void
Returns EdgeModel
Implementation of GraphBaseModel.edge
- Defined in packages/core/lib/core.d.ts:349
edge(attributes): void

Set a common attribute for the edges in the graph.

const G = digraph('G', (g) => {
  // Set a common attribute for the edges in the graph.
  g.edge({
    [attribute.color]: 'red',
    [attribute.label]: 'my label',
  });
});

console.log(toDot(G));
// digraph "G" {
//   edge [
//     color = "red",
//     label = "my label",
//   ];
// }

Parameters

attributes: EdgeAttributesObject
Object of attributes to be adapted to the edges.

Returns void

existEdge

existEdge(edge): boolean
Check if the Edge exists in the graph.
Parameters
- edge: EdgeModel
Returns boolean
Implementation of GraphBaseModel.existEdge
- Defined in packages/core/lib/core.d.ts:330

existNode

existNode(nodeId): boolean
Check if the Node exists in the graph.
Parameters
- nodeId: string
Returns boolean
Implementation of GraphBaseModel.existNode
- Defined in packages/core/lib/core.d.ts:329

existSubgraph

existSubgraph(subgraph): boolean
Check if the Subgraph exists in the graph.
Parameters
- subgraph: SubgraphModel
Returns boolean
Implementation of GraphBaseModel.existSubgraph
- Defined in packages/core/lib/core.d.ts:331

get

get<K>(key): undefined | Attribute<K>
Get the value of an attribute by a DOT object by specifying its key.

If the value corresponding to the key does not exist, undefined is returned.
Type Parameters
- K extends AttributeKey
Parameters
- key: K
Returns undefined | Attribute<K>
Implementation of GraphBaseModel.get
Inherited from AttributesBase_6.get
- Defined in packages/core/lib/core.d.ts:130

getNode

getNode(id): undefined | NodeModel
Get Node in cluster by specifying id.
Parameters
- id: string
Returns undefined | NodeModel
Description
If there is no Node with the specified id in the graph, return undefined.
Implementation of GraphBaseModel.getNode
- Defined in packages/core/lib/core.d.ts:339

getSubgraph

getSubgraph(id): undefined | SubgraphModel
Get Subgraph in cluster by specifying id.

If there is no Subgraph with the specified id in the graph, return undefined.
Parameters
- id: string
Returns undefined | SubgraphModel
Implementation of GraphBaseModel.getSubgraph
- Defined in packages/core/lib/core.d.ts:338

graph

graph(attributes): void

Set a common attribute for the graph in the graph.

const G = digraph('G', (g) => {
  g.graph({
    [attribute.color]: 'red',
    [attribute.label]: 'my label',
  });
});

console.log(toDot(G));
// digraph "G" {
//   graph [
//     color = "red",
//     label = "my label",
//   ];
// }

Parameters

attributes: SubgraphAttributesObject
Object of attributes to be adapted to the graph.

Returns void

node

node(id, callback?): NodeModel
Create a node by specifying its id (or get it if it already exists).

By specifying a callback function, the target node can be received and manipulated as an argument.
```
const G = digraph('G', (g) => {
  // Create a node with id as A.
  g.node('A');
});

console.log(toDot(G));
// digraph "G" {
//   "A";
// }
```
Parameters
- id: string
  Node ID.
- Optional callback: ((node) => void)
  Callbacks for manipulating created or retrieved node.
  - - (node): void
    - Parameters
      node: NodeModel
      Returns void
Returns NodeModel
Implementation of GraphBaseModel.node
- Defined in packages/core/lib/core.d.ts:345
node(id, attributes, callback?): NodeModel
Create a node (or get one if it already exists) and adapt the attributes.

By specifying a callback function, the target node can be received and manipulated as an argument.
```
const G = digraph('G', (g) => {
  // Create a node by specifying its id and specifying its attributes.
  g.node('A', {
    [attribute.color]: 'red',
    [attribute.label]: 'my label',
  });
});

console.log(toDot(G));
// digraph "G" {
//   "A" [
//     color = "red",
//     label = "my label",
//   ];
// }
```
Parameters
- id: string
  Node ID.
- attributes: NodeAttributesObject
  Object of attributes to be adapted to the node.
- Optional callback: ((node) => void)
  Callbacks for manipulating created or retrieved node.
  - - (node): void
    - Parameters
      node: NodeModel
      Returns void
Returns NodeModel
Implementation of GraphBaseModel.node
- Defined in packages/core/lib/core.d.ts:346
node(attributes): void

Set a common attribute for the nodes in the graph.

const G = digraph('G', (g) => {
  // Set a common attribute for the nodes in the graph.
  g.node({
    [attribute.color]: 'red',
    [attribute.label]: 'my label',
  });
});

console.log(toDot(G));
// digraph "G" {
//   node [
//     color = "red",
//     label = "my label",
//   ];
// }

Parameters

attributes: NodeAttributesObject
Object of attributes to be adapted to the nodes.

Returns void

removeEdge

removeEdge(edge): void
Remove Edge from the graph.
Parameters
- edge: EdgeModel
Returns void
Implementation of GraphBaseModel.removeEdge
- Defined in packages/core/lib/core.d.ts:335

removeNode

removeNode(node): void
Remove Node from the graph.
Parameters
- node: string | NodeModel
Returns void
Implementation of GraphBaseModel.removeNode
- Defined in packages/core/lib/core.d.ts:334

removeSubgraph

removeSubgraph(subgraph): void
Remove Subgraph from the graph.
Parameters
- subgraph: SubgraphModel
Returns void
Implementation of GraphBaseModel.removeSubgraph
- Defined in packages/core/lib/core.d.ts:336

set

set<K>(key, value): void
Set a value, by specifying the key of the attributes in the DOT object.
Type Parameters
- K extends AttributeKey
Parameters
- key: K
- value: Attribute<K>
Returns void
Implementation of GraphBaseModel.set
Inherited from AttributesBase_6.set
- Defined in packages/core/lib/core.d.ts:131

subgraph

subgraph(id, callback?): SubgraphModel
Create a subgraph by specifying its id (or get it if it already exists).

By specifying a callback function, the target subgraph can be received and manipulated as an argument.
```
const G = digraph('G', (g) => {
  // Create a cluster with id as A.
  g.subgraph('A', (A) => {
    // Create a node with id as A1 in cluster A.
    A.node('A1');
  });
});

console.log(toDot(G));
// digraph "G" {
//   subgraph "A" {
//     "A1";
//   }
// }
```
Parameters
- id: string
  Subgraph ID.
- Optional callback: ((subgraph) => void)
  Callbacks for manipulating created or retrieved subgraph.
  - - (subgraph): void
    - Parameters
      subgraph: SubgraphModel
      Returns void
Returns SubgraphModel
Implementation of GraphBaseModel.subgraph
- Defined in packages/core/lib/core.d.ts:341
subgraph(id, attributes, callback?): SubgraphModel
Create a subgraph (or get one if it already exists) and adapt the attributes.

By specifying a callback function, the target subgraph can be received and manipulated as an argument.
```
const G = digraph('G', (g) => {
  // Create a cluster with id as A and specifying its attributes.
  g.subgraph('A', { [attribute.color]: 'red', [attribute.label]: 'my label' }, (A) => {
    // Create a node with id as A1 in cluster A.
    A.node('A1');
  });
});

console.log(toDot(G));
// digraph "G" {
//   subgraph "A" {
//     color = "red";
//     label = "my label";
//     "A1";
//   }
// }
```
Parameters
- id: string
  Subgraph ID.
- attributes: SubgraphAttributesObject
  Object of attributes to be adapted to the subgraph.
- Optional callback: ((subgraph) => void)
  Callbacks for manipulating created or retrieved subgraph.
  - - (subgraph): void
    - Parameters
      subgraph: SubgraphModel
      Returns void
Returns SubgraphModel
Implementation of GraphBaseModel.subgraph
- Defined in packages/core/lib/core.d.ts:342
subgraph(attributes, callback?): SubgraphModel
Create anonymous subgraphs and and adapt the attributes.

By specifying a callback function, the target subgraph can be received and manipulated as an argument.
```
const G = digraph('G', (g) => {
  // Create a anonymous cluster and specifying its attributes.
  g.subgraph({ [attribute.color]: 'red', [attribute.label]: 'my label' }, (A) => {
    // Create a node with id as A1 in anonymous cluster.
    A.node('A1');
  });
});

console.log(toDot(G));
// digraph "G" {
//   subgraph {
//     color = "red";
//     label = "my label";
//     "A1";
//   }
// }
```
Parameters
- attributes: SubgraphAttributesObject
  Object of attributes to be adapted to the subgraph.
- Optional callback: ((subgraph) => void)
  Callbacks for manipulating created or retrieved subgraph.
  - - (subgraph): void
    - Parameters
      subgraph: SubgraphModel
      Returns void
Returns SubgraphModel
Implementation of GraphBaseModel.subgraph
- Defined in packages/core/lib/core.d.ts:343
subgraph(callback?): SubgraphModel
Create anonymous subgraphs and manipulate them with callback functions.

By specifying a callback function, the target subgraph can be received and manipulated as an argument.
Parameters
- Optional callback: ((subgraph) => void)
  Callbacks for manipulating created or retrieved subgraph.
  - - (subgraph): void
    - Parameters
      subgraph: SubgraphModel
      Returns void
Returns SubgraphModel
Implementation of GraphBaseModel.subgraph
- Defined in packages/core/lib/core.d.ts:344

with

with(models): void
Parameters
- models: Partial<ModelsContext>
Returns void
Implementation of GraphBaseModel.with
- Defined in packages/core/lib/core.d.ts:325

Class GraphBase<T>Abstract

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns GraphBase<T>

Properties

Private #private

Private #private

Readonly attributes

Optional comment

Optional Readonly id

Accessors

edges

Returns readonly EdgeModel[]

nodes

Returns readonly NodeModel[]

size

Returns number

subgraphs

Returns readonly SubgraphModel[]

values

Returns readonly [T, Attribute<T>][]

Methods

addEdge

Parameters

Returns void

addNode

Parameters

Returns void

addSubgraph

Parameters

Returns void

apply

Parameters

Returns void

clear

Returns void

createEdge

Parameters

Returns EdgeModel

createNode

Parameters

Returns NodeModel

createSubgraph

Parameters

Returns SubgraphModel

Parameters

Returns SubgraphModel

delete

Parameters

Returns void

edge

Parameters

Parameters

Returns void

Returns EdgeModel

Parameters

Parameters

Returns void

Returns EdgeModel

Parameters

Returns void

existEdge

Parameters

Returns boolean

existNode

Parameters

Returns boolean

existSubgraph

Parameters

Returns boolean

Class GraphBase<T>`Abstract`

`Private` #private

`Private` #private

`Readonly` attributes

`Optional` comment

`Optional` `Readonly` id