New to Telerik UI for WPF? Start a free 30-day trial

LayoutBase<TNodeData, TLinkData>

Class

The base class for all layout algorithms.

Definition

Namespace:Telerik.Windows.Diagrams.Core

Assembly:Telerik.Windows.Diagrams.Core.dll

Type Parameters:

TNodeData

TLinkData

Syntax:

public abstract class LayoutBase<TNodeData, TLinkData> where TNodeData : new() where TLinkData : new()

Inheritance: objectLayoutBase<TNodeData, TLinkData>

Derived Classes: SugiyamaLayoutTreeLayout

Constructors

LayoutBase()

Initializes a new instance of the LayoutBase<TNodeData, TLinkData> class.

protected LayoutBase()

Methods

BuildContainerHierarchy(IGraph)

Builds the container hierarchy with the virtual root holding the top-containers. If no containers are present this will return null.

public static Graph<TNodeData, TLinkData> BuildContainerHierarchy(IGraph diagramControl)

Parameters:diagramControlIGraph

The diagram control.

Returns:

Graph<TNodeData, TLinkData>

GridLayoutComponents(IEnumerable<Graph<TNodeData, TLinkData>>, double, Size, Size)

Organizes the components in a grid.

protected void GridLayoutComponents(IEnumerable<Graph<TNodeData, TLinkData>> components, double maxWidth, Size margin, Size componentsMargin)

Parameters:componentsIEnumerable<Graph<TNodeData, TLinkData>>

The components.

maxWidthdouble

The width of the grid.

marginSize

The margin or offset from the top and left of the surface for the collection of components.

componentsMarginSize

The individual components margin.

IterateContainerLayout(Node<ContainerGraph<TNodeData, TLinkData>, object>, object, ref List<Node<TNodeData, TLinkData>>)

Iterates the container layout to the child containers by organizing first the lowest level containers up to the given container.

protected void IterateContainerLayout(Node<ContainerGraph<TNodeData, TLinkData>, object> containerGraphNode, object settings, ref List<Node<TNodeData, TLinkData>> result)

Parameters:containerGraphNodeNode<ContainerGraph<TNodeData, TLinkData>, object>

The container to organize, including its children.

settingsobject

The settings to use.

resultList<Node<TNodeData, TLinkData>>

Layout(ContainerGraph<TNodeData, TLinkData>, object)

Layout of the specified container without iterating into possible children containers.

public abstract void Layout(ContainerGraph<TNodeData, TLinkData> containerGraph, object settings)

Parameters:containerGraphContainerGraph<TNodeData, TLinkData>

The container to be organized.

settingsobject

The settings.

Layout(IGraph, object)

Starts a layout pass.

public abstract void Layout(IGraph diagramControl, object settings)

Parameters:diagramControlIGraph

The diagram control which needs to be laid out.

settingsobject

The parameterization of the layout.

MoveToCurrentOffset(GraphBase<Node<TNodeData, TLinkData>, Edge<TNodeData, TLinkData>>, Point, bool)

Moves the diagram to the computed offset.

protected Point MoveToCurrentOffset(GraphBase<Node<TNodeData, TLinkData>, Edge<TNodeData, TLinkData>> layoutGraph, Point extra, bool moveLinks = false)

Parameters:layoutGraphGraphBase<Node<TNodeData, TLinkData>, Edge<TNodeData, TLinkData>>

The graph which has been laid out.

extraPoint

An extra offset.

moveLinksbool

If set to true the links will be moved as well.

Returns:

Point

MoveToOffset(GraphBase<Node<TNodeData, TLinkData>, Edge<TNodeData, TLinkData>>, Size, bool)

Moves the component to the given offset.

protected Point MoveToOffset(GraphBase<Node<TNodeData, TLinkData>, Edge<TNodeData, TLinkData>> layoutGraph, Size offset, bool moveLinks = false)

Parameters:layoutGraphGraphBase<Node<TNodeData, TLinkData>, Edge<TNodeData, TLinkData>>

The layout graph.

offsetSize

The offset.

moveLinksbool

If set to true links will be moved as well.

Returns:

Point