Edit this page

Telerik.Web.UI.DiagramLayout

Defines the diagram's Layout settings

Inheritance Hierarchy

  • System.Object
  • Telerik.Web.StateManager : IMarkableStateManager, IStateManager
  • Telerik.Web.UI.DiagramLayout : IDefaultCheck

Properties

Enabled Boolean

Gets or Sets whether the Layout should be applied to the diagram.

EndRadialAngle Double

Defines where the circle/arc ends. The positive direction is clockwise and the angle is in degrees. This setting is specific to the radial tree layout.

GridSettings DiagramGrid

Define the grid layout of the Diagram. The content is divided into components that are arranged in a grid layout according to the provided settings.

HorizontalSeparation Double

Either the distance between the siblings if the tree is up/down or between levels if the tree is left/right. In tipOver tree layout this setting is used only for the direct children of the root

Iterations Double

The number of times that all the forces in the diagram are being calculated and balanced. The default is set at 300, which should be enough for diagrams up to a hundred nodes. By increasing this parameter you increase the correctness of the simulation but it does not always lead to a more stable topology. In some situations a diagram simply does not have a stable minimum energy state and oscillates (globally or locally) between the minima. In such a situation increasing the iterations will not result in a better topology.In situations where there is enough symmetry in the diagram the increased number of iterations does lead to a better layout. In the example below the 100 iterations was not enough to bring the grid to a stable state while 300 iterations did bring all the nodes in such a position that the (virtual) energy of the diagram is a minimum.This setting is specific to the force-directed layout

LayerSeparation Double

The height (in a vertical layout) or width (in a horizontal layout) between the layers.

NodeDistance Double

In the force-directed layout this setting defines the optimal length between 2 nodes, which directly correlates to the state of the link between them. If a link is longer than there will be a force pulling the nodes together, if the link is shorter the force will push the nodes apart. The optimal length is more and indication in the algorithm than a guarantee that all nodes will be at this distance. The result of the layout is really a combination of the incidence structure of the diagram, the initial topology (positions of the nodes) and the number of iterations.In the layered layout it defines the minimum distance between nodes on the same level. Due to the nature of the algorithm this distance will only be respected if the the whole crossing of links and optimimzation does not induce a shift of the siblings.This setting is specific to the force-directed layout and layered layout

RadialFirstLevelSeparation Double

Controls the distance between the root and the immediate children of the root. This setting is specific to the radial tree layout.

RadialSeparation Double

Defines the radial separation between the levels (except the first one which is defined by the aforementioned radialFirstLevelSeparation). This setting is specific to the radial tree layout.

StartRadialAngle Double

Defines where the circle/arc starts. The positive direction is clockwise and the angle is in degrees. This setting is specific to the radial tree layout.

Subtype LayoutSubtype

The subtype further defines the layout type by specifying in greater detail the behaviour expected by the layout algorithm.

TipOverTreeStartLevel Double

Specifies the start level when the subtype is tipOver.

Type LayoutType

The type of the layout algorythm to use.

UnderneathHorizontalOffset Double

Defines the horizontal offset from a child with respect to its parent. This setting is specific to the tipOver tree layout.

UnderneathVerticalSeparation Double

Defines the vertical separation between siblings and sub-branches. This setting is specific to the tipOver tree layout.

UnderneathVerticalTopOffset Double

Defines the vertical separation between a parent and its first child. This offsets the whole set of children with respect to its parent. This setting is specific to the tipOver tree layout.

VerticalSeparation Double

Either the distance between levels if the tree is up/down or between siblings if the tree is left/right. This property is not used in tipOver tree layout but rather replaced with three additional ones - underneathVerticalTopOffset, underneathVerticalSeparation and underneathHorizontalOffset