Class TreeInfo

Represents the behavior and appearance of the tree layout configuration for the Layout.

Inheritance

System.Object

TreeInfo

Namespace: Syncfusion.Blazor.Diagram

Assembly: Syncfusion.Blazor.dll

Syntax

public class TreeInfo : Object

Remarks

The TreeInfo class provides comprehensive settings for configuring tree-based layouts, including hierarchical arrangements, subtree alignments, and routing behaviors.

This class is primarily used with tree layout types to define how nodes are positioned, aligned, and connected within the tree structure.

Examples

Example usage of TreeInfo configuration:

TreeInfo treeInfo = new TreeInfo()
{
    Orientation = Orientation.TopToBottom,
    AlignmentType = SubTreeAlignmentType.Center,
    Offset = 50.0,
    EnableRouting = true,
    Children = new List<string> { "child1", "child2", "child3" },
    Level = 2,
    HasSubTree = true
};

Constructors

TreeInfo()

Declaration

public TreeInfo()

Properties

AlignmentType

Gets or sets the type of subtree alignments in the layout structure.

Declaration

public SubTreeAlignmentType AlignmentType { get; set; }

Property Value

Type	Description
SubTreeAlignmentType	A SubTreeAlignmentType value specifying how subtrees are aligned within the layout. The default value is Center.

Assistants

Gets or sets the collection of assistant node identifiers in the tree structure.

Declaration

public List<string> Assistants { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	A System.Collections.Generic.List<> of System.String containing the identifiers of assistant nodes. The default value is an empty collection.

Children

Gets or sets the collection of child node identifiers in the tree structure.

Declaration

public List<string> Children { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>	A System.Collections.Generic.List<> of System.String containing the identifiers of child nodes. The default value is an empty collection.

EnableRouting

Gets or sets a value indicating whether the routing functionality is enabled.

Declaration

public bool EnableRouting { get; set; }

Property Value

Type	Description
System.Boolean	A System.Boolean indicating whether route connections are enabled between nodes. The default value is false.

EnableSubTree

Gets or sets a value indicating whether the subtree functionality is enabled.

Declaration

public bool EnableSubTree { get; set; }

Property Value

Type	Description
System.Boolean	A System.Boolean indicating whether subtree operations are enabled. The default value is false.

HasSubTree

Gets or sets a value indicating whether the node has a subtree structure.

Declaration

public bool HasSubTree { get; set; }

Property Value

Type	Description
System.Boolean	A System.Boolean indicating whether the current node contains a subtree. The default value is false.

IsRootInverse

Gets or sets a value indicating whether the root node arrangement is inverted.

Declaration

public bool IsRootInverse { get; set; }

Property Value

Type	Description
System.Boolean	A System.Boolean indicating whether the root node positioning is inverted. The default value is false.

Level

Gets or sets the hierarchical level of the tree node.

Declaration

public int Level { get; set; }

Property Value

Type	Description
System.Int32	An System.Int32 representing the depth level of the node in the tree hierarchy.

Offset

Gets or sets the position offset of the node to be arranged.

Declaration

public double Offset { get; set; }

Property Value

Type	Description
System.Double	A System.Double representing the positional offset value for node arrangement.

Orientation

Gets or sets the orientation that arranges the child nodes with the parent based on its directional type.

Declaration

public Orientation Orientation { get; set; }

Property Value

Type	Description
Orientation	An Orientation value specifying the arrangement direction of child nodes relative to their parent. The default value is Orientation.TopToBottom.

Remarks

This property determines whether the tree expands horizontally or vertically from the root node.

Rows

Gets or sets the number of rows in the tree layout.

Declaration

public Nullable<int> Rows { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	A nullable System.Int32 representing the row count for tree arrangement. The default value is null.