documentationfor yFiles for HTML 3.0.0.3

Properties

layoutAlgorithmin HierarchicalLayoutSubcomponentDescriptorGets or sets the ILayoutAlgorithm for the subgraph that is induced by the nodes associated with this descriptor.
interEdgeRouterin ComponentLayoutGets or sets the current edge routing algorithm for handling inter-edges between different components, which may exist when customizing the component assignment using custom componentIds
componentLayoutsin ComponentLayoutDataGets or sets the mapping from nodes to the ILayoutAlgorithm used to arrange the content of their component.
interEdgeRouterin GenericLayoutGridStageGets or sets the current edge routing algorithm for handling inter-edges.
coreLayoutin ILayoutStageGets or sets the core layout algorithm.
layoutin LayoutExecutorGets the ILayoutAlgorithm this instance is using.
coreLayoutin LayoutStageBaseGets or sets the core ILayoutAlgorithm that is wrapped by this stage.
interEdgeRouterin RecursiveGroupLayoutGets or sets the current edge routing algorithm for handling inter-edges.
groupNodeLayoutsin RecursiveGroupLayoutDataGets or sets the mapping from group nodes to the ILayoutAlgorithm used for their child nodes.
layoutsin SequentialLayoutGets the collection of layout algorithms that are executed sequentially.
recursiveGroupLayoutAlgorithmin TemporaryGroupDescriptorGets or sets the ILayoutAlgorithm that is considered by the RecursiveGroupLayout when arranging the nodes belonging to this temporary group.
edgeRouterin ClearAreaLayoutGets or sets the custom edge router instance that is applied to reroute edges.
edgeRouterin PartialLayoutGets or sets the custom edge router instance that is used for partial edges and edges between different subgraph components (so-called inter-edges).
nonSeriesParallelEdgeRouterin SeriesParallelLayoutGets or sets the edge routing algorithm used for the edges of a general graph that are not part of the series-parallel subgraph whose layout is calculated.
nonTreeEdgeRouterin TreeReductionStageGets or sets the edge routing algorithm that is applied to all non-tree edges.

Fields

COMPONENT_LAYOUT_DATA_KEYin ComponentLayoutA data key for arranging the nodes of each component with an individual layout algorithm.
FIX_CONTENT_LAYOUTin RecursiveGroupLayoutA constant that represents a ILayoutAlgorithm implementation that does nothing.
FIX_GROUP_LAYOUTin RecursiveGroupLayoutA constant that represents a ILayoutAlgorithm implementation that does nothing.
GROUP_NODE_LAYOUT_DATA_KEYin RecursiveGroupLayoutA data key for arranging the content of each group node with an individual layout algorithm.
NON_RECURSIVE_LAYOUTin RecursiveGroupLayoutA constant that represents a ILayoutAlgorithm implementation that delegates to the coreLayout.

Method Return Values

linkCoreLayouts (IEnumerable<ILayoutStage>, function(LayoutGraph):void?)in LayoutStageStackChains a collection of ILayoutStage instances together and configures them into a stack.

Method Parameters

applyLayout (ILayoutAlgorithm, LayoutData<INode,IEdge,ILabel,ILabel>?, TimeSpan?, TimeSpan?, ItemMapping<IPort,PortAdjustmentPolicy>?, ItemMapping<IPort,PortPlacementPolicy>?, ItemMapping<ILabel,PortLabelPolicy>?, ItemMapping<IModelItem,LayoutAnchoringPolicy>?, ItemMapping<ILabel,LabelPlacementPolicy>?, function(INode, INode):number?, function(IEdge, IEdge):number?)in IGraphRuns an ILayoutAlgorithm synchronously on the given graph.
HierarchicalLayoutSubcomponentDescriptor (ILayoutAlgorithm?, HierarchicalLayoutSubcomponentPlacementPolicy?)in HierarchicalLayoutSubcomponentDescriptorCreates a new HierarchicalLayoutSubcomponentDescriptor instance with the specified settings.
GenericLabeling ()in GenericLabelingCreates a new instance of GenericLabeling with default settings.
AlignmentStage (ILayoutAlgorithm?, )in AlignmentStageCreates a new AlignmentStage with the given algorithm as coreLayout or null if no core layout should be applied prior to the alignment stage.
BendSubstitutionStage (number?, ILayoutAlgorithm?, )in BendSubstitutionStageCreates a new BendSubstitutionStage instance with the given size as the width and height for the inserted proxy nodes.
ComponentLayout (ILayoutAlgorithm?, )in ComponentLayoutInitializes a new instance of the ComponentLayout class with an optional coreLayout.
ComponentLayoutData ()in ComponentLayoutData
ContextModificationStage (ILayoutAlgorithm?, )in ContextModificationStageCreates a new ContextModificationStage with the given algorithm as coreLayout or null if no core layout is specified.
CurveFittingStage (ILayoutAlgorithm?, )in CurveFittingStageCreates a new CurveFittingStage with an optional core layout algorithm.
GenericLayoutGridStage (ILayoutAlgorithm?, )in GenericLayoutGridStageCreates a new instance using the given coreLayout.
GivenCoordinatesLayout (ILayoutAlgorithm?, )in GivenCoordinatesLayoutCreates a new GivenCoordinatesLayout instance using the given coreLayout.
GroupHidingStage (ILayoutAlgorithm?, )in GroupHidingStageCreates an instance of GroupHidingStage with an optional coreLayout.
LayoutAnchoringStage (ILayoutAlgorithm?, )in LayoutAnchoringStageCreates a new LayoutAnchoringStage instance with an optional core layout algorithm.
LayoutExecutor (GraphComponent, ILayoutAlgorithm, )in LayoutExecutorInitializes a new instance of the LayoutExecutor class.
LayoutExecutor (GraphComponent, IGraph, ILayoutAlgorithm, )in LayoutExecutorInitializes a new instance of the LayoutExecutor class.
applyLayout (ILayoutAlgorithm, LayoutData<LayoutNode,LayoutEdge,LayoutNodeLabel,LayoutEdgeLabel>?)in LayoutGraphRuns an ILayoutAlgorithm synchronously on the given LayoutGraph, applying the given layoutData.
applyLayout (ILayoutAlgorithm, LayoutData<INode,IEdge,ILabel,ILabel>?)in LayoutGraphAdapterApplies an ILayoutAlgorithm to an IGraph, optionally applying some LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>.
LayoutStageBase (ILayoutAlgorithm?, )in LayoutStageBaseInitializes a new LayoutStageBase instance.
addPostprocessor (ILayoutAlgorithm)in LayoutStageStackAdds a layout algorithm as a post-processing stage to the stack.
addPreprocessor (ILayoutAlgorithm)in LayoutStageStackAdds a layout algorithm as a pre-processing stage to the stack.
appendCoreLayout (ILayoutAlgorithm)in LayoutStageStackAppends a core layout algorithm to the stack.
LineWrappingStage ()in LineWrappingStageCreates a new LineWrappingStage instance with default settings.
MinimumNodeSizeStage (ILayoutAlgorithm?, number?, number?, )in MinimumNodeSizeStageCreates a new MinimumNodeSizeStage instance using the given optional coreLayout and minimum width and height for the nodes.
OrientationStage (ILayoutAlgorithm?, LayoutOrientation?, )in OrientationStageCreates a new OrientationStage instance using the given optional coreLayout and layout orientation.
PlaceNodesAtBarycenterStage (ILayoutAlgorithm?, )in PlaceNodesAtBarycenterStageCreates a new PlaceNodesAtBarycenterStage instance using the given coreLayout.
PortPlacementStage (ILayoutAlgorithm?, )in PortPlacementStageCreates a new PortPlacementStage instance with an optional coreLayout.
RecursiveGroupLayout (ILayoutAlgorithm?, ILayoutGroupBoundsCalculator?, )in RecursiveGroupLayoutCreates a new instance of RecursiveGroupLayout.
RecursiveGroupLayoutData ()in RecursiveGroupLayoutData
RemoveCollinearBendsStage ()in RemoveCollinearBendsStageCreates a new RemoveCollinearBendsStage instance with default settings.
RemoveOverlapsStage ()in RemoveOverlapsStageCreates a new RemoveOverlapsStage instance with default settings.
ReverseEdgesStage (ILayoutAlgorithm?, )in ReverseEdgesStageCreates a new ReverseEdgesStage instance with an optional coreLayout.
SequentialLayout (ILayoutAlgorithm)in SequentialLayoutInitializes a new instance of the SequentialLayout class with an optional collection of layout algorithms.
SubgraphLayoutStage (ILayoutAlgorithm?, )in SubgraphLayoutStageCreates a new SubgraphLayoutStage instance with an optional coreLayout.
TemporaryGroupDescriptor (TemporaryGroupDescriptor?, ILayoutAlgorithm?, )in TemporaryGroupDescriptorCreates a new instance of TemporaryGroupDescriptor using the given descriptor as parent and the ILayoutAlgorithm that is considered by the RecursiveGroupLayout.
TemporaryGroupInsertionStage (ILayoutAlgorithm?, )in TemporaryGroupInsertionStageCreates a new TemporaryGroupInsertionStage with the given layout algorithm as coreLayout.
MultiPageLayout (ILayoutAlgorithm?, )in MultiPageLayoutCreates a new MultiPageLayout instance.
ClearAreaLayout ()in ClearAreaLayoutCreates a new instance of ClearAreaLayout with default settings.
PartialLayout (ILayoutAlgorithm?, )in PartialLayoutCreates a new instance of PartialLayout which uses the specified ILayoutAlgorithm instance as the core layout algorithm.
BundledEdgeRouter (ILayoutAlgorithm?, )in BundledEdgeRouterCreates a new BundledEdgeRouter instance with the given optional core layout algorithm and default settings.
CurveRoutingStage (ILayoutAlgorithm?, )in CurveRoutingStageCreates a new CurveRoutingStage instance using the given optional coreLayout.
EdgeRouter (ILayoutAlgorithm?, )in EdgeRouterCreates a new EdgeRouter instance with an optional coreLayout.
OctilinearRoutingStage (ILayoutAlgorithm?, )in OctilinearRoutingStageCreates a new instance of OctilinearRoutingStage using the given coreLayout.
OrganicEdgeRouter (ILayoutAlgorithm?, )in OrganicEdgeRouterCreates a new OrganicEdgeRouter with the given coreLayout.
ParallelEdgeRouter (ILayoutAlgorithm?, )in ParallelEdgeRouterCreates a new ParallelEdgeRouter instance with an optional coreLayout.
SelfLoopRouter (ILayoutAlgorithm?, )in SelfLoopRouterCreates a new SelfLoopRouter with an optional coreLayout.
StraightLineEdgeRouter (ILayoutAlgorithm?, )in StraightLineEdgeRouterCreates a new instance of StraightLineEdgeRouter with an optional coreLayout.
SeriesParallelLayout ()in SeriesParallelLayoutCreates a new SeriesParallelLayout instance with default settings.
TreeReductionStage (ILayoutAlgorithm?, )in TreeReductionStageCreates a new TreeReductionStage instance with the given core layout algorithm and default settings.
applyLayoutAnimated (ILayoutAlgorithm, TimeSpan?, LayoutData<INode,IEdge,ILabel,ILabel>?, TimeSpan?, TimeSpan?, boolean?, ItemMapping<IPort,PortAdjustmentPolicy>?, ItemMapping<IPort,PortPlacementPolicy>?, ItemMapping<ILabel,PortLabelPolicy>?, ItemMapping<IModelItem,LayoutAnchoringPolicy>?, Insets?, ItemMapping<ILabel,LabelPlacementPolicy>?, function(INode, INode):number?, function(IEdge, IEdge):number?)in GraphComponentRuns a layout on the graph of the GraphComponent and animates the transition.

Implementing Types

CircularLayoutThis layout algorithm arranges graphs in a circular fashion.
CompactDiskLayoutThis layout algorithm arranges a graph on a disk packing the nodes as dense as possible.
HierarchicalLayoutThis layout algorithm arranges graphs in a hierarchical fashion.
ILayoutStageAn ILayoutStage is an ILayoutAlgorithm that represents a stage of a multi-step layout process.
RadialGroupLayoutThis layout algorithm arranges grouped graphs in a recursive structure.
SequentialLayoutRepresents a layout that sequentially executes multiple layout algorithms.
TabularLayoutThis layout algorithm places nodes in a tabular fashion.
OrganicLayoutThis layout algorithm arranges graphs in an organic fashion.
OrthogonalLayoutThis layout algorithm arranges graphs in an orthogonal fashion.
ClearAreaLayoutThis layout algorithm clears a specified area by moving intersecting elements, while trying to minimize the changes in the given layout.
FillAreaLayoutThis layout algorithm tries to fill a specified area with graph elements by moving nearby elements towards it, with the goal to make the existing layout more compact and not changing it too much.
RadialLayoutThis layout algorithm arranges graphs in a radial fashion.
SeriesParallelLayoutThis layout algorithm arranges series-parallel graphs.
RadialTreeLayoutA tree layout algorithm that arranges the subtrees of the tree in a radial fashion.
TreeLayoutThis layout algorithm arranges graphs with a tree structure.
TreeMapLayoutThis layout algorithm produces tree map layouts.