I

ILayoutStage

Show Usages
An ILayoutStage is an ILayoutAlgorithm that represents a stage of a multi-step layout process.
ImplementsInheritance Hierarchy

Remarks

A stage delegates the coreLayout process to another ILayoutAlgorithm.

Implementing classes may perform pre-processing steps before the coreLayout gets called and post-processing steps afterwards.

Conceptually layout stages can be chain together via the coreLayout property and then perform an execution stack where the first/outermost element in the stack gets to pre-process the graph first, and post-process the graph last.

When multiple stages are chained together the innermost stage is the "core" of the layout and runs after all pre-processing steps and before all post-processing steps in the stack.

See Also

Developer's Guide

API

LayoutStageStack, linkCoreLayouts

Members

Show:

Properties

coreLayout

: ILayoutAlgorithm
abstract
Gets or sets the core layout algorithm.
This algorithm is wrapped by this stage. It is invoked in applyLayout. This ILayoutStage may add pre- and post-processing steps before and after calling the core layout algorithm's main method.
abstract

Property Value

the core layout algorithm

See Also

Developer's Guide

enabled

: boolean
abstract
Gets or sets a value that determines whether this stage should do anything but execute the coreLayout.

By default, when constructed, stages should be enabled. Users may disable a stage's functionality by setting this property to false.

Stages that can guarantee that the graph will not change can choose to not even execute the coreLayout when disabled.

abstract

See Also

Developer's Guide

Methods

applyLayout

(graph: LayoutGraph)
abstract
Main layout routine that assigns new layout information to the given graph.
abstract

Parameters

graph: LayoutGraph
the input graph to process

See Also

Developer's Guide