documentationfor yFiles for HTML 2.6

Properties

topLayoutin FamilyTreeLayoutGets or sets the layout algorithm that is responsible for the layout between family groups.
coreLayoutin BendConverterGets or sets the core layout algorithm that is wrapped by this ILayoutStage.
interEdgeRouterin FixGroupLayoutStageGets or sets the edge routing algorithm that is applied to route the inter-edges.
interEdgeRouterin GenericPartitionGridStageGets or sets the current edge routing algorithm for handling inter-edges.
coreLayoutin GraphTransformerGets or sets the core layout algorithm.
layoutAlgorithmin HierarchicLayoutSubcomponentDescriptorGets or sets the ILayoutAlgorithm for the subgraph that is induced by the nodes associated with this descriptor.
coreLayoutin ILayoutStageGets or sets the core layout algorithm.
coreLayoutin LabelLayoutTranslatorGets or sets the core layout algorithm that is wrapped by this ILayoutStage.
layoutin LayoutExecutorGets the ILayoutAlgorithm this instance is using.
coreLayoutin LayoutStageBaseGets or sets the core layout algorithm 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 or sets the chain of layout algorithms.
recursiveGroupLayoutAlgorithmin TemporaryGroupDescriptorGets or sets the layout algorithm that is considered by the RecursiveGroupLayout when arranging the nodes belonging to this temporary group.
shuffleLayoutin RecursiveShuffleLayoutGets or sets the ILayoutAlgorithm instance that is used for removing node overlaps.
coreLayoutin RemoveOverlapsStageGets or sets the core layout algorithm that is wrapped by this stage and is applied before removing node overlaps.
coreLayoutin ShuffleLayoutGets or sets the core layout algorithm.
coreLayoutin SplitEdgeStageGets or sets the core layout algorithm.
edgeRouterin ClearAreaLayoutGets or sets the custom edge router instance that is applied to reroute edges.
coreLayoutin PartialLayoutGets or sets the ILayoutAlgorithm instance that is applied to each subgraph component.
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).
edgeDistributionStrategyin ChannelEdgeRouterGets or sets the strategy for the edge distribution step.
pathFinderStrategyin ChannelEdgeRouterGets or sets the strategy for the path finding step.
coreLayoutin OrganicEdgeRouterGets or sets the core layout algorithm which arranges the graph before edge routing.
nonSeriesParallelEdgeLabelingAlgorithmin SeriesParallelLayoutGets or sets the labeling algorithm that is applied to all edge labels that belong to non-series-parallel 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.
coreLayoutin TreeComponentLayoutGets or sets the core layout algorithm.
treeComponentCoreLayoutin TreeComponentLayoutGets or sets the layout algorithm that is applied to tree components.
nonTreeEdgeLabelingAlgorithmin TreeReductionStageGets or sets the labeling algorithm that is applied to all edge labels that belong to non-tree edges.
nonTreeEdgeRouterin TreeReductionStageGets or sets the edge routing algorithm that is applied to all non-tree edges.

Fields

LAYOUT_DP_KEYin LayoutMultiplexerA data provider key for assigning layout algorithms to the nodes.
GROUP_NODE_LAYOUT_DP_KEYin RecursiveGroupLayoutA data provider key for arranging the content of each group node with an individual layout algorithm.
NULL_LAYOUTin RecursiveGroupLayoutA constant that represents a ILayoutAlgorithm implementation that does nothing.

Method Return Values

getCoreLayout (LayoutGraph)in LayoutMultiplexerReturns the core layout algorithm associated with the nodes contained in the given graph.
createStraightLineRouter ()in TreeReductionStageCreates a routing algorithm that routes edges as a single straight segment.

Method Parameters

FamilyTreeLayout ()in FamilyTreeLayoutCreates a new instance of FamilyTreeLayout with default settings.
applyLayout (ILayoutAlgorithm, LayoutData?, boolean?, boolean?, boolean?, boolean?, boolean?, boolean?, PortAdjustmentPolicy?, ItemMapping<ILabel,PortLabelPolicy>?, Insets?, LabelPreferredPlacementPolicy?)in IGraphRuns an ILayoutAlgorithm synchronously on the given graph.
TopLevelGroupToSwimlaneStage ()in TopLevelGroupToSwimlaneStageCreates a new instance of TopLevelGroupToSwimlaneStage with the default settings.
GenericLabeling ()in GenericLabelingCreates a new instance of GenericLabeling with default settings.
MISLabelingBase ()in MISLabelingBaseCreates a new MISLabelingBase instance with default settings.
AlignmentStage (ILayoutAlgorithm?, )in AlignmentStageCreates a new AlignmentStage with the given algorithm as core layout algorithm or null if no core layout should be applied prior to the alignment stage.
BendConverter (ILayoutAlgorithm)in BendConverterCreates a new instance of BendConverter with the given core layout algorithm.
BufferedLayout (ILayoutAlgorithm?)in BufferedLayoutCreates a new BufferedLayout instance using the given core layout algorithm.
ComponentLayout (ILayoutAlgorithm?, )in ComponentLayoutCreates a new ComponentLayout instance with an optional core layout algorithm.
CurveFittingLayoutStage (ILayoutAlgorithm?, )in CurveFittingLayoutStageCreates a new CurveFittingLayoutStage with an optional core layout algorithm.
FixGroupLayoutStage (ILayoutAlgorithm?, )in FixGroupLayoutStageCreates a new instance of FixGroupLayoutStage with an optional core layout algorithm.
FixNodeLayoutStage (ILayoutAlgorithm?, )in FixNodeLayoutStageCreates a new FixNodeLayoutStage instance with an optional core layout algorithm.
FixPortLocationStage (ILayoutAlgorithm?, )in FixPortLocationStageCreates a new FixPortLocationStage with an optional core layout algorithm.
GenericPartitionGridStage (ILayoutAlgorithm?, )in GenericPartitionGridStageCreates a new instance using the given core layout algorithm.
GivenCoordinatesStage (ILayoutAlgorithm?)in GivenCoordinatesStageCreates a new GivenCoordinatesStage instance using the given core layout algorithm.
GraphLayoutLineWrapper ()in GraphLayoutLineWrapperCreates a new GraphLayoutLineWrapper instance with default settings.
GraphTransformer ()in GraphTransformerCreates a new instance of GraphTransformer with default settings.
HideGroupsStage (ILayoutAlgorithm?, )in HideGroupsStageCreates an instance of HideGroupsStage with an optional core layout algorithm.
HierarchicLayoutSubcomponentDescriptor (ILayoutAlgorithm?, HierarchicLayoutSubcomponentPlacementPolicy?)in HierarchicLayoutSubcomponentDescriptorCreates a new HierarchicLayoutSubcomponentDescriptor instance with the specified settings.
IsolatedGroupComponentLayout (ILayoutAlgorithm?, )in IsolatedGroupComponentLayoutCreates an instance of IsolatedGroupComponentLayout with the given layout algorithm as core layout algorithm.
LabelLayoutTranslator ()in LabelLayoutTranslatorCreates a new LabelLayoutTranslator instance with default settings.
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?)in LayoutGraphAdapterApplies a layout algorithm to an IGraph, optionally applying some LayoutData.
LayoutStageBase (ILayoutAlgorithm?)in LayoutStageBaseCreates a new ILayoutStage instance with an optional core layout algorithm.
MinimumNodeSizeStage (ILayoutAlgorithm, number, number)in MinimumNodeSizeStageCreates a new MinimumNodeSizeStage instance using the given core layout algorithm along with a specific minimum width and height for the nodes.
MinimumNodeSizeStage (ILayoutAlgorithm)in MinimumNodeSizeStageCreates a new MinimumNodeSizeStage instance using the given core layout algorithm.
NormalizeGraphElementOrderStage (ILayoutAlgorithm?)in NormalizeGraphElementOrderStageCreates a new NormalizeGraphElementOrderStage instance with an optional core layout algorithm.
OrientationLayout (ILayoutAlgorithm?, )in OrientationLayoutCreates a new OrientationLayout instance using the given core layout algorithm.
OrientationLayout (LayoutOrientation, )in OrientationLayoutCreates a new OrientationLayout instance using the given orientation.
PartitionLayout ()in PartitionLayoutCreates a new PartitionLayout instance with default settings.
PlaceNodesAtBarycenterStage (ILayoutAlgorithm?, )in PlaceNodesAtBarycenterStageCreates a new PlaceNodesAtBarycenterStage instance using the given core layout algorithm.
PortCalculator (ILayoutAlgorithm?)in PortCalculatorCreates a new PortCalculator instance with an optional core layout algorithm.
PortPlacementStage (ILayoutAlgorithm?, )in PortPlacementStageCreates a new PortPlacementStage instance with an optional core layout algorithm.
RecursiveGroupLayout (ILayoutAlgorithm?, ILayoutGroupBoundsCalculator?, )in RecursiveGroupLayoutCreates a new instance of RecursiveGroupLayout with default settings using the given layout algorithm and ILayoutGroupBoundsCalculator implementation.
RecursiveGroupLayoutData ()in RecursiveGroupLayoutDataCreates a new instance of RecursiveGroupLayoutData which helps configuring RecursiveGroupLayout.
RemoveCollinearBendsStage ()in RemoveCollinearBendsStageCreates a new RemoveCollinearBendsStage instance with default settings.
ReverseEdgesStage (ILayoutAlgorithm?)in ReverseEdgesStageCreates a new ReverseEdgesStage instance with an optional core layout algorithm.
SelfLoopRouter (ILayoutAlgorithm?, )in SelfLoopRouterCreates a new SelfLoopRouter with an optional core layout algorithm.
SequentialLayout ()in SequentialLayoutCreates a new SequentialLayout instance with an empty chain of layout algorithms.
appendLayout (ILayoutAlgorithm)in SequentialLayoutAppends the given layout algorithm to the end of the chain.
appendLayouts (ICollection<ILayoutAlgorithm>)in SequentialLayoutAppends the specified list of layout algorithms to the end of the chain.
SubgraphLayout (ILayoutAlgorithm?, )in SubgraphLayoutCreates a new SubgraphLayout instance with an optional core layout algorithm.
TemporaryGroupDescriptor (TemporaryGroupDescriptor?, ILayoutAlgorithm?, )in TemporaryGroupDescriptorCreates a new instance of TemporaryGroupDescriptor using the given descriptor as parent and the layout algorithm that is considered by the RecursiveGroupLayout.
TemporaryGroupNodeInsertionStage (ILayoutAlgorithm?)in TemporaryGroupNodeInsertionStageCreates a new TemporaryGroupNodeInsertionStage with the given layout algorithm as core layout algorithm.
MultiPageLayout (ILayoutAlgorithm, )in MultiPageLayoutCreates a new MultiPageLayout instance.
OrganicPartitionGridLayoutStage (ILayoutAlgorithm)in OrganicPartitionGridLayoutStageCreates a new instance of OrganicPartitionGridLayoutStage with the given layout algorithm as core algorithm.
OrganicRemoveOverlapsStage (ILayoutAlgorithm?, )in OrganicRemoveOverlapsStageCreates a new instance of OrganicRemoveOverlapsStage with an optional core layout algorithm.
RecursiveShuffleLayout (ILayoutAlgorithm?, )in RecursiveShuffleLayoutCreates a new RecursiveShuffleLayout instance with an optional core layout algorithm.
RemoveOverlapsStage (number, )in RemoveOverlapsStageCreates a new RemoveOverlapsStage instance with a given minimum node distance.
ShuffleLayout ()in ShuffleLayoutCreates a new instance of ShuffleLayout with default settings.
SplitEdgeStage ()in SplitEdgeStageCreates a new SplitEdgeStage with default settings.
CompactOrthogonalLayout ()in CompactOrthogonalLayoutCreates a new CompactOrthogonalLayout instance with default settings.
ClearAreaLayout ()in ClearAreaLayoutCreates a new instance of ClearAreaLayout with default settings.
configureEdgeRouter (ILayoutAlgorithm)in ClearAreaLayoutThis method is called each time when edges are rerouted with the given edge router.
PartialLayout (ILayoutAlgorithm?, )in PartialLayoutCreates a new instance of PartialLayout which uses the specified ILayoutAlgorithm instance as the core layout algorithm.
configureEdgeRouter (ILayoutAlgorithm)in PartialLayoutThis method is called each time when edges are routed with an edge router.
BusRouter ()in BusRouterCreates a new instance of BusRouter with default settings.
ChannelEdgeRouter ()in ChannelEdgeRouterCreates a new ChannelEdgeRouter instance with default settings.
CurveRoutingStage (ILayoutAlgorithm?)in CurveRoutingStageCreates a new CurveRoutingStage instance using the given optional core layout algorithm.
EdgeBundlingStage (ILayoutAlgorithm?)in EdgeBundlingStageCreates a new EdgeBundlingStage instance with the given optional core layout algorithm and default settings.
EdgeRouter (ILayoutAlgorithm?, )in EdgeRouterCreates a new EdgeRouter instance with an optional core layout algorithm.
OrganicEdgeRouter (ILayoutAlgorithm?, )in OrganicEdgeRouterCreates a new OrganicEdgeRouter with the given core layout algorithm.
OrthogonalPatternEdgeRouter ()in OrthogonalPatternEdgeRouterCreates a new instance of OrthogonalPatternEdgeRouter with default settings.
OrthogonalSegmentDistributionStage ()in OrthogonalSegmentDistributionStageCreates a new instance of OrthogonalSegmentDistributionStage with default settings.
ParallelEdgeRouter (ILayoutAlgorithm?, )in ParallelEdgeRouterCreates a new ParallelEdgeRouter instance with an optional core layout algorithm.
PolylineLayoutStage (ILayoutAlgorithm?, )in PolylineLayoutStageCreates a new instance of PolylineLayoutStage using the given core layout algorithm.
StraightLineEdgeRouter (ILayoutAlgorithm?, )in StraightLineEdgeRouterCreates a new instance of StraightLineEdgeRouter with an optional core layout algorithm.
SeriesParallelLayout ()in SeriesParallelLayoutCreates a new SeriesParallelLayout instance with default settings.
TreeComponentLayout (ILayoutAlgorithm, )in TreeComponentLayoutCreates a new TreeComponentLayout instance using the specified layouter for arranging the subtrees.
TreeReductionStage (ILayoutAlgorithm?, )in TreeReductionStageCreates a new TreeReductionStage instance with the given core layout algorithm and default settings.
morphLayout (ILayoutAlgorithm, TimeSpan?, LayoutData?, boolean?, boolean?, boolean?, boolean?, boolean?, boolean?, boolean?, boolean?, boolean?, PortAdjustmentPolicy?, ItemMapping<ILabel,PortLabelPolicy>?, Insets?, LabelPreferredPlacementPolicy?)in GraphComponentRuns a layout on the graph of the GraphComponent and animates the transition.

Implementing Types

ILayoutStageA ILayoutStage is a layout algorithm that represents a stage of a larger layout process.
MultiStageLayoutAn abstract base class for layout algorithms that provides services to simplify and decompose the input graph before it is passed to the core layout algorithm itself.
SequentialLayoutA SequentialLayout allows for chaining multiple layout algorithms.
TabularLayoutThis layout algorithm places nodes in a tabular fashion.
InteractiveOrganicLayoutThis algorithm arranges graphs in an organic fashion and offers special functionality to interact with the graph while the algorithm is running.
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.
TreeMapLayoutThis layout algorithm produces tree map layouts.