mermaid

---

Interface: CommonLayoutPaintOptions

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:54

Properties

clusterDb?

optional clusterDb: ClusterDb

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:55

---

getEdgeNode()?

optional getEdgeNode: (id, edge, context) => object | Node | undefined

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:60

Parameters

id

string | undefined

edge

Edge

context

CommonLayoutPaintContext<unknown, { graph: Graph; groups: { clusters: D3Selection<SVGGElement>; edgeLabels: D3Selection<SVGGElement>; edgePaths: D3Selection<SVGGElement>; nodes: D3Selection<SVGGElement>; rootGroups: D3Selection<SVGGElement>; }; nodeElements: Map<string, D3Selection<SVGElement | SVGGElement>>; }>

Returns

object | Node | undefined

---

getNodes()?

optional getNodes: (data4Layout, context) => Iterable<Node>

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:56

Parameters

data4Layout

LayoutData

context

CommonLayoutPaintContext<unknown, { graph: Graph; groups: { clusters: D3Selection<SVGGElement>; edgeLabels: D3Selection<SVGGElement>; edgePaths: D3Selection<SVGGElement>; nodes: D3Selection<SVGGElement>; rootGroups: D3Selection<SVGGElement>; }; nodeElements: Map<string, D3Selection<SVGElement | SVGGElement>>; }>

Returns

Iterable<Node>

---

isCluster()?

optional isCluster: (node, context) => boolean

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:69

Parameters

node

Node

context

CommonLayoutPaintContext<unknown, { graph: Graph; groups: { clusters: D3Selection<SVGGElement>; edgeLabels: D3Selection<SVGGElement>; edgePaths: D3Selection<SVGGElement>; nodes: D3Selection<SVGGElement>; rootGroups: D3Selection<SVGGElement>; }; nodeElements: Map<string, D3Selection<SVGElement | SVGGElement>>; }>

Returns

boolean

---

skipEdge()?

optional skipEdge: (edge) => boolean

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:73

Parameters

edge

Edge

Returns

boolean

---

skipIntersect?

optional skipIntersect: boolean | (edge) => boolean

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:74

---

skipNode()?

optional skipNode: (node, context) => boolean

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:65

Parameters

node

Node

context

CommonLayoutPaintContext<unknown, { graph: Graph; groups: { clusters: D3Selection<SVGGElement>; edgeLabels: D3Selection<SVGGElement>; edgePaths: D3Selection<SVGGElement>; nodes: D3Selection<SVGGElement>; rootGroups: D3Selection<SVGGElement>; }; nodeElements: Map<string, D3Selection<SVGElement | SVGGElement>>; }>

Returns

boolean