Class TreeLayoutSettings

Defines the parameters when applying a tree layout (or one of its variations).

Inheritance
System.Object
TreeLayoutSettings
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Diagrams.Core
Assembly: Telerik.Windows.Diagrams.Core.dll

Syntax

public sealed class TreeLayoutSettings

Constructors

TreeLayoutSettings()

Initializes a new instance of the TreeLayoutSettings class.

Declaration
public TreeLayoutSettings()

Properties

AnimateTransitions

Gets or sets whether layout changes are animated.

Declaration
public bool AnimateTransitions { get; set; }
Property Value
System.Boolean

ComponentMargin

Gets or sets the component margin.

Declaration
public Size ComponentMargin { get; set; }
Property Value
System.Windows.Size

The component margin.

ComponentsGridWidth

Gets or sets the width of the components grid.

Declaration
public double ComponentsGridWidth { get; set; }
Property Value
System.Double

The width of the components grid.

EndRadialAngle

Gets or sets the end angle of the radial layout.

Declaration
public double EndRadialAngle { get; set; }
Property Value
System.Double

The start radial angle in radians. The default is two times Pi.
Remarks

The radial layout allows you to use a sector instead of the full 360 degrees. This end angle defines the end of this sector.

HorizontalSeparation

The horizontal distance between siblings.

Declaration
public double HorizontalSeparation { get; set; }
Property Value
System.Double

IgnoreContainers

Gets or sets whether the shape containers are ignored when laying out the graph. If false the shape containers will be considered as ordinary shapes in the tree layout process. You can additionally set the LayoutContainerChildren flag to perform a separate layout pass on the content of the containers. On the other hand, if this property is set to true the LayoutContainerChildren flag will have no effect since the layout process will be oblivious to the containers.

Declaration
public bool IgnoreContainers { get; set; }
Property Value
System.Boolean

See Also

IgnoreInvisible

Gets or sets whether the non-visible diagram items have to be taken into account. If set to true shapes with Visibility not set to Visible will be ignored.

Declaration
public bool IgnoreInvisible { get; set; }
Property Value
System.Boolean

KeepComponentsInOneRadialLayout

When using radial layout on a forest one can either apply the layout to the trees connected via a fictive common root or apply the radial to each tree and layout each component on a grid.

Declaration
public bool KeepComponentsInOneRadialLayout { get; set; }
Property Value
System.Boolean

true if the trees need to be in one diagram layout; otherwise, false.

LayoutContainerChildren

Gets or sets a value indicating whether the content of the containers is processed on top of the global layout. This flag has only an effect if IgnoreContainers is set to false.

Declaration
public bool LayoutContainerChildren { get; set; }
Property Value
System.Boolean

See Also

RadialFirstLEvelSeparation

The radial distance between the root and the first level.

Declaration
public double RadialFirstLEvelSeparation { get; set; }
Property Value
System.Double

RadialSeparation

The radial separation between layers.

Declaration
public double RadialSeparation { get; set; }
Property Value
System.Double

Roots

Gets the roots of the forest.

Declaration
public IList<IShape> Roots { get; }
Property Value
System.Collections.Generic.IList<IShape>

Remarks

A forest is a collection of tree graphs. If you have one or multiple roots you can add them to this collection and they will be taken at the root for the layout. If not then the most probable tree root will be analyzed (on the basis of the longest path in the graph).

StartRadialAngle

Gets or sets the start angle of the radial layout.

Declaration
public double StartRadialAngle { get; set; }
Property Value
System.Double

The start radial angle in radians. The default is zero.
Remarks

The radial layout allows you to use a sector instead of the full 360 degrees. This start angle defines the beginning of this sector.

TipOverTreeStartLevel

Gets or sets the level from which the tip-over arrangement should be applied. A value of zero means that the children underneath the root will have a tip-over arrangement, a value of one means the grand-children of the root will have this applied and so on.

Declaration
public int TipOverTreeStartLevel { get; set; }
Property Value
System.Int32

TotalMargin

Gets or sets the margin of the whole diagram.

Declaration
public Size TotalMargin { get; set; }
Property Value
System.Windows.Size

The total margin.

TreeLayoutType

Gets or sets the type of the layout.

Declaration
public TreeLayoutType TreeLayoutType { get; set; }
Property Value
TreeLayoutType

The type of the layout.

UnderneathHorizontalOffset

The horizontal offset of the children when in TipOverTree layout mode.

Declaration
public double UnderneathHorizontalOffset { get; set; }
Property Value
System.Double

UnderneathVerticalSeparation

The horizontal separation of the children when in TipOverTree layout mode.

Declaration
public double UnderneathVerticalSeparation { get; set; }
Property Value
System.Double

UnderneathVerticalTopOffset

The vertical offset of the first child when in TipOverTree layout mode.

Declaration
public double UnderneathVerticalTopOffset { get; set; }
Property Value
System.Double

VerticalDistance

Gets or sets the distance between layers.

Declaration
public double VerticalDistance { get; set; }
Property Value
System.Double

VerticalSeparation

The vertical distance between parent and child.

Declaration
public double VerticalSeparation { get; set; }
Property Value
System.Double

Extension Methods