Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DoubleTreeLayout

This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the extensions or extensionsTS folders. See the Extensions intro page for more information.

Hierarchy

Perform two TreeLayouts, one going rightwards and one going leftwards. The choice of direction is determined by the mandatory predicate directionFunction, which is called on each child Node of the root Node.

You can also set vertical to true if you want the DoubleTreeLayout to perform TreeLayouts both downwards and upwards.

At the current time this only handles graphs for which there is a single root node -- i.e. where there is only one Node for which Node.findTreeParentNode returns null.

If you want to experiment with this extension, try the Double Tree sample.

Index

Properties

bottomRightOptions : Partial<TreeLayout> | null

directionFunction : function(node: Node): boolean

  • This function is called on each child node of the root node in order to determine whether the subtree starting from that child node will grow towards larger coordinates or towards smaller ones. The value must be a function and must not be null. It must return true if isPositiveDirection should return true; otherwise it should return false.

topLeftOptions : Partial<TreeLayout> | null

vertical : boolean

  • When false, the layout should grow towards the left and towards the right; when true, the layout show grow upwards and downwards. The default value is false.

Methods

Protected createTreeLayout

Override doLayout

  • Perform two TreeLayouts by splitting the collection of Parts into two separate subsets but sharing only a single root Node.

    Parameters

    Returns void

Protected isPositiveDirection

  • isPositiveDirection(child: Node): boolean
  • This predicate is called on each child node of the root node, and only on immediate children of the root. It should return true if this child node is the root of a subtree that should grow rightwards or downwards, or false otherwise.

    Parameters

    Returns boolean

    true if grows towards right or towards bottom; false otherwise

Protected separatePartsForLayout

  • This is called by doLayout to split the collection of Nodes and Links into two Sets, one for the subtrees growing towards the left or upwards, and one for the subtrees growing towards the right or downwards.

    Parameters

    Returns void