@knowvah/dot-engine

Appearance

Interface: GvGraphBuilder ​

Defined in: api/builder.ts:69

Builder returned by createGraph. Provides idiomatic programmatic construction of a graph model.

Properties ​

graph ​

ts
readonly graph: Graph;

Defined in: api/builder.ts:86

Methods ​

addEdge() ​

ts
addEdge(
   tail: string | GvNode, 
   head: string | GvNode, 
   attrs?: Record<string, string>): GvEdge;

Defined in: api/builder.ts:71

Parameters ​

tail ​

string | GvNode

string | GvNode

attrs? ​

Record<string, string>

Returns ​

GvEdge

addNode() ​

ts
addNode(name: string, attrs?: Record<string, string>): GvNode;

Defined in: api/builder.ts:70

Parameters ​

name ​

string

attrs? ​

Record<string, string>

Returns ​

GvNode

addSubgraph() ​

ts
addSubgraph(name: string, attrs?: Record<string, string>): GvGraphBuilder;

Defined in: api/builder.ts:76

Parameters ​

name ​

string

attrs? ​

Record<string, string>

Returns ​

GvGraphBuilder

getAttr() ​

ts
getAttr(k: string): string | undefined;

Defined in: api/builder.ts:85

Parameters ​

k ​

string

Returns ​

string | undefined

setAttr() ​

ts
setAttr(k: string, v: string): void;

Defined in: api/builder.ts:77

Parameters ​

k ​

string

v ​

string

Returns ​

void

setHtmlAttr() ​

ts
setHtmlAttr(k: string, v: string): void;

Defined in: api/builder.ts:84

Set an attribute on this (sub)graph to an HTML-string value — the supported way to give a cluster an HTML-table label (the header-size reservation the jar drives) without hand-writing the internal marker.

Parameters ​

k ​

string

v ​

string

Returns ​

void

See ​

GvNode.setHtmlAttr