@maxgraph/core
    Preparing search index...

    Class PartitionLayout

    Extends GraphLayout for partitioning the parent cell vertically or horizontally by filling the complete area with the child cells. A horizontal layout partitions the height of the given parent whereas a non-horizontal layout partitions the width. If the parent is a layer (that is, a child of the root node), then the current graph size is partitioned. The children do not need to be connected for this layout to work.

    Example:

    const layout = new PartitionLayout(graph, true, 10, 20);
    layout.execute(graph.getDefaultParent());

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    border graph horizontal parent resizeVertices spacing useBoundingBox

    Methods

    arrangeGroups execute getConstraint getGraph getParentOffset getVertexBounds isAncestor isEdgeIgnored isHorizontal isVertexIgnored isVertexMovable moveCell resizeCell setEdgePoints setEdgeStyleEnabled setOrthogonalEdge setVertexLocation traverse

    Constructors

    Properties

    border: number

    Integer that specifies the absolute inset in pixels for the parent that contains the children. Default is 0.

    graph: Graph

    Reference to the enclosing Graph.

    horizontal: boolean

    Boolean indicating the direction in which the space is partitioned. Default is true.

    parent: null | Cell = null

    The parent cell of the layout, if any

    null
    resizeVertices: boolean = true

    Boolean that specifies if vertices should be resized. Default is true.

    spacing: number

    Integer that specifies the absolute spacing in pixels between the children. Default is 0.

    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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods