Interface Operator<N, L>

common interface shared by all layout operators

Sugiyama, Zherebko, and Grid all satisfy this interface, allowing code that is agnostic to the specific layout algorithm.

interface Operator<in N = never, in L = never> {
    gap(val: readonly [number, number]): Operator<N, L>;
    gap(): readonly [number, number];
    nodeSize(val: NodeSize<N, L>): Operator<N, L>;
    nodeSize(): NodeSize<N, L>;
    tweaks(): readonly Tweak<N, L>[];
    tweaks(val: readonly Tweak<N, L>[]): Operator<N, L>;
    (graph: Graph<N, L>): LayoutResult;
}

Type Parameters

in N = never
in L = never

Operator(graph: Graph<N, L>): LayoutResult
run the layout
Parameters
- graph: Graph<N, L>
Returns LayoutResult
- Defined in layout.ts:130

Index

Methods

gap nodeSize tweaks

Methods

gap

gap(val: readonly [number, number]): Operator<N, L>
set gap between nodes
Parameters
- val: readonly [number, number]
Returns Operator<N, L>
- Defined in layout.ts:140
gap(): readonly [number, number]
get current gap

Returns readonly [number, number]
- Defined in layout.ts:142

nodeSize

nodeSize(val: NodeSize<N, L>): Operator<N, L>
set node size accessor
Parameters
- val: NodeSize<N, L>
Returns Operator<N, L>
- Defined in layout.ts:136
nodeSize(): NodeSize<N, L>
get current node size

Returns NodeSize<N, L>
- Defined in layout.ts:138

tweaks

tweaks(): readonly Tweak<N, L>[]
get current tweaks

Returns readonly Tweak<N, L>[]
- Defined in layout.ts:132
tweaks(val: readonly Tweak<N, L>[]): Operator<N, L>
set tweaks
Parameters
- val: readonly Tweak<N, L>[]
Returns Operator<N, L>
- Defined in layout.ts:134