Main Content

dolayout (biograph)

(To be removed) Calculate node positions and edge trajectories

The biograph object and its methods will be removed in a future release. Use graph or digraph instead.

Syntax

dolayout(BGobj)
dolayout(BGobj, 'Paths', PathsOnlyValue)

Arguments

BGobj Biograph object created by the biograph function (object constructor).
PathsOnlyValue Controls the calculation of only the edge paths, leaving the nodes at their current positions. Choices are true or false (default).

Description

dolayout(BGobj) calls the layout engine to calculate the optimal position for each node so that its 2-D rendering is clean and uncluttered, and then calculates the best curves to represent the edges. The layout engine uses the following properties of the biograph object:

  • LayoutType — Specifies the layout engine as 'hierarchical', 'equilibrium', or 'radial'.

  • LayoutScale — Rescales the sizes of the node before calling the layout engine. This gives more space to the layout and reduces the overlapping of nodes.

  • NodeAutoSize — Controls precalculating the node size before calling the layout engine. When NodeAutoSize is set to 'on', the layout engine uses the node properties FontSize and Shape, and the biograph object property LayoutScale to precalculate the actual size of each node. When NodeAutoSize is set to 'off', the layout engine uses the node property Size.

For more information on the above properties, see Properties of a Biograph Object.

dolayout(BGobj, 'Paths', PathsOnlyValue) controls the calculation of only the edge paths, leaving the nodes at their current positions. Choices are true or false (default).

Version History

Introduced before R2006a

expand all

Warns starting in R2022a

See Also

|