documentationfor yFiles for HTML 3.0.0.3

Usages of LayoutData

Properties

itemsin CompositeLayoutDataGets or sets a collection of composed layout data objects.
layoutDatain LayoutExecutorGets or sets the layout data that is applied when starting the executor.
layoutDatain LayoutExecutorAsyncGets or sets the layout data that is applied when starting the executor.

Method Return Values

combineWith (LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>)in LayoutDataCombines this instance with the given layout data.

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.
createCompositeLayoutData (LayoutData<INode,IEdge,ILabel,ILabel>)in IGraphReturns an instance of CompositeLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that combines the given layout data instances.
CompositeLayoutData (LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>)in CompositeLayoutDataCreates a new instance that combines the given items.
addLayoutData (LayoutData<LayoutNode,LayoutEdge,LayoutNodeLabel,LayoutEdgeLabel>)in ContextModificationStageAdds the specified layout data to be temporarily applied by this stage.
add (LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>)in GenericLayoutDataAdds the data from one or more other LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> instances to this instance.
combineWith (LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>)in LayoutDataCombines this instance with the given layout data.
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.
LayoutExecutorAsync (function(object):Promise<object>, GraphComponent, LayoutDescriptor?, LayoutData<INode,IEdge,ILabel,ILabel>?, )in LayoutExecutorAsyncCreates a new instance of a layout execution helper that will asynchronously perform the calculations and optionally animate the layout on the given graphComponent.
LayoutExecutorAsync (function(object):Promise<object>, IGraph, LayoutDescriptor?, LayoutData<INode,IEdge,ILabel,ILabel>?, )in LayoutExecutorAsyncCreates a new instance of a layout execution helper that will asynchronously perform the calculations and apply the results on the provided graph.
applyLayout (ILayoutAlgorithm, LayoutData<LayoutNode,LayoutEdge,LayoutNodeLabel,LayoutEdgeLabel>?)in LayoutGraphRuns an ILayoutAlgorithm synchronously on the given LayoutGraph, applying the given layoutData.
createCompositeLayoutData (LayoutData<LayoutNode,LayoutEdge,LayoutNodeLabel,LayoutEdgeLabel>)in LayoutGraphReturns an instance of CompositeLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that combines the given instances of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>.
applyLayout (ILayoutAlgorithm, LayoutData<INode,IEdge,ILabel,ILabel>?)in LayoutGraphAdapterApplies an ILayoutAlgorithm to an IGraph, optionally applying some LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>.
applyLayoutData (LayoutData<INode,IEdge,ILabel,ILabel>)in LayoutGraphAdapterHelper method that applies a given LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> for IGraph elements onto the layoutGraph using the mapping between the elements established by this instance.
pushLayer (LayoutData<LayoutNode,LayoutEdge,LayoutNodeLabel,LayoutEdgeLabel>?)in LayoutGraphContextPushes a new layer onto the context, optionally applying layout data.
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.

Extending Types

CircularLayoutDataSpecifies custom data for the CircularLayout.
CompactDiskLayoutDataSpecifies custom data for the CompactDiskLayout.
HierarchicalLayoutDataSpecifies custom data for the HierarchicalLayout.
GenericLabelingDataSpecifies custom data for the GenericLabeling.
AlignmentStageDataSpecifies custom data for the AlignmentStage.
BasicPortDataSpecifies custom data for constraining the port placement.
ComponentLayoutDataSpecifies custom data for the ComponentLayout.
CompositeLayoutDataCombines several LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> instances.
GenericLayoutDataThis class provides a way to easily pass custom item-specific data to the LayoutGraph which is used during the layout algorithm execution.
GenericLayoutGridStageDataSpecifies the layout data for the GenericLayoutGridStage.
GivenCoordinatesLayoutDataSpecifies custom layout data for the GivenCoordinatesLayout.
LayoutAnchoringStageDataSpecifies custom data for the LayoutAnchoringStage.
LayoutGridDataSpecifies one or multiple LayoutGrids for a layout.
PlaceNodesAtBarycenterStageDataSpecifies custom data for the PlaceNodesAtBarycenterStage.
PortDataSpecifies custom data for constraining the port placement.
RadialGroupLayoutDataSpecifies custom data for the RadialGroupLayout.
RecursiveGroupLayoutDataSpecifies custom data for the RecursiveGroupLayout.
RemoveOverlapsStageDataSpecifies custom data for the RemoveOverlapsStage.
ReverseEdgesStageDataSpecifies custom data for the ReverseEdgesStage.
SubgraphLayoutStageDataSpecifies custom data for the SubgraphLayoutStage.
TabularLayoutDataSpecifies custom data for the TabularLayout.
TemporaryGroupInsertionDataSpecifies custom data for the TemporaryGroupInsertionStage.
MultiPageLayoutDataSpecifies custom data for the MultiPageLayout and automatically takes care of handling item IDs, providing a translation back to original items, via methods like getOriginalItem .
InteractiveOrganicLayoutDataSpecifies custom data for the InteractiveOrganicLayout.
OrganicLayoutDataSpecifies custom data for the OrganicLayout.
OrthogonalLayoutDataSpecifies custom data for the OrthogonalLayout.
ClearAreaLayoutDataSpecifies custom data for the ClearAreaLayout.
FillAreaLayoutDataSpecifies custom data for the FillAreaLayout.
PartialLayoutDataSpecifies custom data for the PartialLayout.
RadialLayoutDataSpecifies custom data for the RadialLayout.
BundledEdgeRouterDataSpecifies the layout data for the BundledEdgeRouter.
CurveRoutingStageDataSpecifies the layout data for the CurveRoutingStage.
EdgeRouterDataSpecifies custom data for the EdgeRouter.
EdgeRouterScopeDataThis custom data provides several ways to modify the scope of the EdgeRouter with regard to the routed edges.
EdgeScopeDataThis custom data provides two item collections to specify the scope of layout algorithms with regard to edges.
OrganicEdgeRouterDataSpecifies custom data for the OrganicEdgeRouter.
ParallelEdgeRouterDataSpecifies custom data for the ParallelEdgeRouter.
StraightLineEdgeRouterDataSpecifies custom data for the StraightLineEdgeRouter.
SeriesParallelLayoutDataSpecifies custom data for the SeriesParallelLayout.
RadialTreeLayoutDataSpecifies custom data for the RadialTreeLayout.
TreeLayoutDataSpecifies custom data for the TreeLayout.
TreeMapLayoutDataSpecifies custom data for the TreeMapLayout.
TreeReductionStageDataSpecifies custom data for the TreeReductionStage.