Class CommitLayout

Computes the Layout for DirectionNode graphs.

See

Hierarchy

CommitLayout

Index

Constructors

Properties

_painter bodySize firstSize layoutPhase needsPosition node? paintGroup? root? rootPaintGroup secondSize

Methods

commitLayout commitLayoutPhaseOne commitLayoutPhaseThree commitLayoutPhaseTwo crank initExtent painter reset startingNode

Constructors

constructor

new CommitLayout(node: DirectionNode<any>, painter: LayoutPainter): CommitLayout
Creates a new run of the layout algorithm.
Parameters
- node: DirectionNode<any>
  
  the root node
- painter: LayoutPainter
  
  the painter used for sizing and painting information.
Returns CommitLayout
- Defined in DirectionNode/Layout/CommitLayout/CommitLayout.ts:37

Properties

`Private` _painter

_painter: LayoutPainter

`Protected` bodySize

bodySize: number[]

`Protected` firstSize

firstSize: number[]

`Protected` layoutPhase

layoutPhase: number

`Protected` needsPosition

needsPosition: boolean

`Protected` `Optional` node

node?: DirectionNode<any>

`Protected` `Optional` paintGroup

paintGroup?: DirectionNode<any>

`Protected` `Optional` root

root?: DirectionNode<any>

`Protected` rootPaintGroup

rootPaintGroup: DirectionNode<any>

`Protected` secondSize

secondSize: number[]

Methods

`Protected` commitLayout

commitLayout(node: DirectionNode<any>): boolean
Parameters
- node: DirectionNode<any>
Returns boolean
- Defined in DirectionNode/Layout/CommitLayout/CommitLayout.ts:82

`Protected` commitLayoutPhaseOne

commitLayoutPhaseOne(): boolean
Returns boolean
- Defined in DirectionNode/Layout/CommitLayout/CommitLayout.ts:199

`Protected` commitLayoutPhaseThree

commitLayoutPhaseThree(): boolean
Returns boolean
- Defined in DirectionNode/Layout/CommitLayout/CommitLayout.ts:309

`Protected` commitLayoutPhaseTwo

commitLayoutPhaseTwo(): boolean
Returns boolean
- Defined in DirectionNode/Layout/CommitLayout/CommitLayout.ts:268

crank

crank(): boolean
Traverse the graph depth-first, committing each node's layout in turn.

Returns
true if the algorithm needs more cranks.

Returns boolean
- Defined in DirectionNode/Layout/CommitLayout/CommitLayout.ts:343

`Protected` initExtent

initExtent(node: DirectionNode<any>, inDirection: Direction, length: number, size: number, offset: number): void
Parameters
- node: DirectionNode<any>
- inDirection: Direction
- length: number
- size: number
- offset: number
Returns void
- Defined in DirectionNode/Layout/CommitLayout/CommitLayout.ts:45

`Protected` painter

painter(): LayoutPainter
Returns LayoutPainter
- Defined in DirectionNode/Layout/CommitLayout/CommitLayout.ts:78

reset

reset(node: DirectionNode<any>): void
Parameters
- node: DirectionNode<any>
Returns void
- Defined in DirectionNode/Layout/CommitLayout/CommitLayout.ts:59

startingNode

startingNode(): DirectionNode<any>
Returns DirectionNode<any>
- Defined in DirectionNode/Layout/CommitLayout/CommitLayout.ts:74

Generated using TypeDoc