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

  • assign lanes to ordered nodes

    Parameters

    • ordered: readonly GraphNode<unknown, unknown>[]

      the nodes in to assign lanes to in order from top to bottom

    Returns void

Methods

check compressed dist

Methods

check

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

  • compressed(): boolean

  • get the current compressed setting

    Returns boolean

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

  • dist(): boolean

  • get whether the current layout minimized distance

    Returns boolean

Settings

Member Visibility

On This Page

Methods