Interface LaneOpt

a lane operator that assigns lanes to minimize edge crossings.

Create with laneOpt.

interface LaneOpt {
    check(val: OptChecking): LaneOpt;
    check(): OptChecking;
    compressed(val: boolean): LaneOpt;
    compressed(): boolean;
    dist(val: boolean): LaneOpt;
    dist(): boolean;
    (ordered: readonly GraphNode<unknown, unknown>[]): void;
}

Hierarchy (View Summary)

Lane<unknown, unknown>
- LaneOpt

LaneOpt(ordered: readonly GraphNode<unknown, unknown>[]): void
Parameters
- ordered: readonly GraphNode<unknown, unknown>[]
Returns void
- Defined in grid/lane/opt.ts:20

Index

Methods

check compressed dist

Methods

check

check(val: OptChecking): LaneOpt
set the large dag handling

Setting to anything but "fast" will allow running on larger dags, but the layout may run forever, or crash the vm.

(default: "fast")
Parameters
- val: OptChecking
Returns LaneOpt
- Defined in grid/lane/opt.ts:53
check(): OptChecking
Return the handling of large graphs.

Returns OptChecking
- Defined in grid/lane/opt.ts:55

compressed

compressed(val: boolean): LaneOpt
set whether to used compressed output

If output is compressed then the number of crossings will be minimized subject to the fewest number of lanes necessary.

(default: false)
Parameters
- val: boolean
Returns LaneOpt
- Defined in grid/lane/opt.ts:29
compressed(): boolean
get the current compressed setting

Returns boolean
- Defined in grid/lane/opt.ts:31

dist

dist(val: boolean): LaneOpt
set whether to also minimize distance between connected nodes

This adds more variables and constraints so will take longer, but will likely produce a better layout.

(default: true)
Parameters
- val: boolean
Returns LaneOpt
- Defined in grid/lane/opt.ts:41
dist(): boolean
get whether the current layout minimized distance

Returns boolean
- Defined in grid/lane/opt.ts:43