Class CompositeLayout

Allows to compose multiple layouts into a single layout.

The master layout is the layout that handles move operations if another layout than the first element in GraphLayouts should be used. The master layout is not executed as the code assumes that it is part of layouts.

Example:

const first = new FastOrganicLayout(graph);
const second = new ParallelEdgeLayout(graph);
const layout = new CompositeLayout(graph, [first, second], first);
layout.execute(graph.getDefaultParent());

Hierarchy (view full)

Constructors

Properties

graph: Graph

Reference to the enclosing Graph.

layouts: GraphLayout[]

Holds the array of GraphLayouts that this layout contains.

master?: GraphLayout

Reference to the GraphLayouts that handles moves. If this is null then the first layout in is used.

parent: null | Cell = null

The parent cell of the layout, if any

null
useBoundingBox: boolean = true

Boolean indicating if the bounding box of the label should be used if it iss available.

true.

Methods

  • Returns the constraint for the given key and cell. The optional edge and source arguments are used to return inbound and outgoing routing- constraints for the given edge and vertex. This implementation always returns the value for the given key in the style of the given cell.

    Parameters

    • key: string

      Key of the constraint to be returned.

    • cell: Cell

      Cell whose constraint should be returned.

    • Optionaledge: Cell

      Optional Cell that represents the connection whose constraint should be returned. Default is null.

    • Optionalsource: boolean

      Optional boolean that specifies if the connection is incoming or outgoing. Default is null.

    Returns any

  • Returns true if the given parent is an ancestor of the given child.

    Parameters

    • parent: Cell

      Cell that specifies the parent.

    • child: null | Cell

      Cell that specifies the child.

    • OptionaltraverseAncestors: boolean

      boolean whether to

    Returns boolean

  • Returns a boolean indicating if the given Cell is movable or bendable by the algorithm. This implementation returns true if the given cell is movable in the graph.

    Parameters

    • cell: Cell

      Cell whose movable state should be returned.

    Returns boolean

  • Sets the new position of the given cell taking into account the size of the bounding box if useBoundingBox is true. The change is only carried out if the new location is not equal to the existing location, otherwise the geometry is not replaced with an updated instance. The new or old bounds are returned (including overlapping labels).

    Parameters

    • cell: Cell

      Cell whose geometry is to be set.

    • x: number

      Integer that defines the x-coordinate of the new location.

    • y: number

      Integer that defines the y-coordinate of the new location.

    Returns null | Rectangle

  • Traverses the (directed) graph invoking the given function for each visited vertex and edge. The function is invoked with the current vertex and the incoming edge as a parameter. This implementation makes sure each vertex is only visited once. The function may return false if the traversal should stop at the given vertex.

    Example:

    GlobalConfig.logger.show();
    const cell = graph.getSelectionCell();
    graph.traverse(cell, false, function(vertex, edge)
    {
    GlobalConfig.logger.debug(graph.getLabel(vertex));
    });

    Parameters

    • __namedParameters: GraphLayoutTraverseArgs

    Returns void