Class GraphLayout

constructor

• new GraphLayout(graph: Graph): GraphLayout

  Parameters

  • graph: Graph

  Returns GraphLayout

graph

parent

null
Copy

useBoundingBox

true.
Copy

arrangeGroups

• arrangeGroups(
      cells: Cell[],
      border: number,
      topBorder: number,
      rightBorder: number,
      bottomBorder: number,
      leftBorder: number,
  ): Cell[]

  Shortcut to Graph#updateGroupBounds with moveGroup set to true.

  Parameters

  • cells: Cell[]
  • border: number
  • topBorder: number
  • rightBorder: number
  • bottomBorder: number
  • leftBorder: number

  Returns Cell[]

execute

• execute(parent: Cell): void

  Executes the layout algorithm for the children of the given parent.

  Parameters

  • parent: Cell

    Cell whose children should be layed out.

  Returns void

getConstraint

• getConstraint(key: string, cell: Cell, edge?: Cell, source?: boolean): any

  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

getGraph

• getGraph(): Graph

  Returns the graph that this layout operates on.

  Returns Graph

getParentOffset

• getParentOffset(parent: null | Cell): Point

  Determines the offset of the given parent to the parent of the layout

  Parameters

  • parent: null | Cell

  Returns Point

getVertexBounds

• getVertexBounds(cell: Cell): Rectangle

  Returns an Rectangle that defines the bounds of the given cell or the bounding box if useBoundingBox is true.

  Parameters

  • cell: Cell

  Returns Rectangle

isAncestor

• isAncestor(
      parent: Cell,
      child: null | Cell,
      traverseAncestors?: boolean,
  ): boolean

  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

isEdgeIgnored

• isEdgeIgnored(edge: Cell): boolean

  Returns a boolean indicating if the given Cell should be ignored by the algorithm. This implementation returns false for all vertices.

  Parameters

  • edge: Cell

    Cell whose ignored state should be returned.

  Returns boolean

isVertexIgnored

• isVertexIgnored(vertex: Cell): boolean

  Returns a boolean indicating if the given Cell should be ignored by the algorithm. This implementation returns false for all vertices.

  Parameters

  • vertex: Cell

    Cell whose ignored state should be returned.

  Returns boolean

isVertexMovable

• isVertexMovable(cell: Cell): 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

moveCell

• moveCell(cell: Cell, x: number, y: number): void

  Notified when a cell is being moved in a parent that has automatic layout to update the cell state (eg. index) so that the outcome of the layout will position the vertex as close to the point (x, y) as possible.

  Empty implementation.

  Parameters

  • cell: Cell

    Cell which has been moved.
  • x: number

    X-coordinate of the new cell location.
  • y: number

    Y-coordinate of the new cell location.

  Returns void

resizeCell

• resizeCell(cell: Cell, bounds: Rectangle, prev?: Cell): void

  Notified when a cell is being resized in a parent that has automatic layout to update the other cells in the layout.

  Empty implementation.

  Parameters

  • cell: Cell

    Cell which has been moved.
  • bounds: Rectangle

    Rectangle that represents the new cell bounds.
  • Optionalprev: Cell

  Returns void

setEdgePoints

• setEdgePoints(edge: Cell, points: null | Point[]): void

  Replaces the array of Point in the geometry of the given edge with the given array of Point.

  Parameters

  • edge: Cell
  • points: null | Point[]

  Returns void

setEdgeStyleEnabled

• setEdgeStyleEnabled(edge: Cell, value: any): void

  Disables or enables the edge style of the given edge.

  Parameters

  • edge: Cell
  • value: any

  Returns void

setOrthogonalEdge

• setOrthogonalEdge(edge: Cell, value: any): void

  Disables or enables orthogonal end segments of the given edge.

  Parameters

  • edge: Cell
  • value: any

  Returns void

setVertexLocation

• setVertexLocation(cell: Cell, x: number, y: number): null | Rectangle

  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

traverse

• traverse(__namedParameters: GraphLayoutTraverseArgs): void

  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));
  });
  Copy

  Parameters

  • __namedParameters: GraphLayoutTraverseArgs

  Returns void