Interface LaneGreedy

a lane operator that assigns lanes greedily, but quickly.

Create with laneGreedy.

interface LaneGreedy {
    bidirectional(val: boolean): LaneGreedy;
    bidirectional(): boolean;
    compressed(val: boolean): LaneGreedy;
    compressed(): boolean;
    topDown(val: boolean): LaneGreedy;
    topDown(): boolean;
    (ordered: readonly GraphNode<unknown, unknown>[]): void;
}

Hierarchy (View Summary)

  • Lane<unknown, unknown>
    • LaneGreedy
  • LaneGreedy(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

bidirectional compressed topDown

Methods

bidirectional

  • bidirectional(val: boolean): LaneGreedy

  • set whether to assign bidirectional indices

    The first node will be assigned lane zero. If bidirectional, the lanes can fan out in either direction from there, otherwise new lanes will always be added to the right.

    (default: false)

    Parameters

    • val: boolean

    Returns LaneGreedy

  • bidirectional(): boolean

  • get the current bidirectional setting

    Returns boolean

compressed

  • compressed(val: boolean): LaneGreedy

  • set whether to used compressed output

    If output is compressed a free lane will be chosen over minimizing edge lengths. This can sometimes create cluttered layouts, but they will be less wide.

    (default: true)

    Parameters

    • val: boolean

    Returns LaneGreedy

  • compressed(): boolean

  • get the current compressed setting

    Returns boolean

topDown

  • topDown(val: boolean): LaneGreedy

  • set whether the greedy assignment should be top-down or bottom-up.

    These produce slightly different results with the way the nodes are assigned.

    (default: true)

    Parameters

    • val: boolean

    Returns LaneGreedy

  • topDown(): boolean

  • get whether the current operator is set to assign top-down..

    Returns boolean

Settings

Member Visibility

On This Page

Methods