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)

GraphLayout
- CompositeLayout

Constructors

constructor

new CompositeLayout(graph, layouts, master?): CompositeLayout
Constructs a new layout using the given layouts. The graph instance is required for creating the transaction that contains all layouts.
Parameters
- graph: Graph
  Reference to the enclosing Graph.
- layouts: GraphLayout[]
  Array of GraphLayouts.
- Optionalmaster: GraphLayout
  Optional layout that handles moves. If no layout is given, then the first layout of the above array is used to handle moves.
Returns CompositeLayout
Overrides GraphLayout.constructor
- Defined in view/layout/CompositeLayout.ts:48

Properties

graph

graph: Graph

Reference to the enclosing Graph.

layouts

layouts: GraphLayout[]

Holds the array of GraphLayouts that this layout contains.

`Optional`master

master?: GraphLayout

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

parent

parent: null | Cell = null

The parent cell of the layout, if any

Default

null

useBoundingBox

useBoundingBox: boolean = true

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

Default

true.

Methods

arrangeGroups

arrangeGroups(cells, border, topBorder, rightBorder, bottomBorder, leftBorder): 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[]
Inherited from GraphLayout.arrangeGroups
- Defined in view/layout/GraphLayout.ts:422

execute

execute(parent): void
Implements GraphLayout#execute by executing all layouts in a single transaction.
Parameters
- parent: Cell
Returns void
Overrides GraphLayout.execute
- Defined in view/layout/CompositeLayout.ts:79

getConstraint

getConstraint(key, cell, edge?, source?): 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
Inherited from GraphLayout.getConstraint
- Defined in view/layout/GraphLayout.ts:116

getGraph

getGraph(): Graph
Returns the graph that this layout operates on.

Returns Graph
Inherited from GraphLayout.getGraph
- Defined in view/layout/GraphLayout.ts:99

getParentOffset

getParentOffset(parent): Point
Determines the offset of the given parent to the parent of the layout
Parameters
- parent: null | Cell
Returns Point
Inherited from GraphLayout.getParentOffset
- Defined in view/layout/GraphLayout.ts:259

getVertexBounds

getVertexBounds(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
Inherited from GraphLayout.getVertexBounds
- Defined in view/layout/GraphLayout.ts:378

isAncestor

isAncestor(parent, child, traverseAncestors?): 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
Inherited from GraphLayout.isAncestor
- Defined in view/layout/GraphLayout.ts:189

isEdgeIgnored

isEdgeIgnored(edge): 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
Inherited from GraphLayout.isEdgeIgnored
- Defined in view/layout/GraphLayout.ts:232

isVertexIgnored

isVertexIgnored(vertex): 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
Inherited from GraphLayout.isVertexIgnored
- Defined in view/layout/GraphLayout.ts:222

isVertexMovable

isVertexMovable(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
Inherited from GraphLayout.isVertexMovable
- Defined in view/layout/GraphLayout.ts:212

moveCell

moveCell(cell, x, y): void
Calls move on master or the first layout in layouts.
Parameters
- cell: Cell
- x: number
- y: number
Returns void
Overrides GraphLayout.moveCell
- Defined in view/layout/CompositeLayout.ts:68

resizeCell

resizeCell(cell, bounds, prev?): 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
Inherited from GraphLayout.resizeCell
- Defined in view/layout/GraphLayout.ts:83

setEdgePoints

setEdgePoints(edge, points): 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
Inherited from GraphLayout.setEdgePoints
- Defined in view/layout/GraphLayout.ts:284

setEdgeStyleEnabled

setEdgeStyleEnabled(edge, value): void
Disables or enables the edge style of the given edge.
Parameters
- edge: Cell
- value: any
Returns void
Inherited from GraphLayout.setEdgeStyleEnabled
- Defined in view/layout/GraphLayout.ts:244

setOrthogonalEdge

setOrthogonalEdge(edge, value): void
Disables or enables orthogonal end segments of the given edge.
Parameters
- edge: Cell
- value: any
Returns void
Inherited from GraphLayout.setOrthogonalEdge
- Defined in view/layout/GraphLayout.ts:251

setVertexLocation

setVertexLocation(cell, x, y): 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
Inherited from GraphLayout.setVertexLocation
- Defined in view/layout/GraphLayout.ts:322

traverse

traverse(__namedParameters): 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));
});
```
Parameters
- __namedParameters: GraphLayoutTraverseArgs
Returns void
Inherited from GraphLayout.traverse
- Defined in view/layout/GraphLayout.ts:148

Class CompositeLayout

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CompositeLayout

Properties

graph

layouts

Optionalmaster

parent

Default

useBoundingBox

Default

Methods

arrangeGroups

Parameters

Returns Cell[]

execute

Parameters

Returns void

getConstraint

Parameters

Returns any

getGraph

Returns Graph

getParentOffset

Parameters

Returns Point

getVertexBounds

Parameters

Returns Rectangle

isAncestor

Parameters

Returns boolean

isEdgeIgnored

Parameters

Returns boolean

isVertexIgnored

Parameters

Returns boolean

isVertexMovable

Parameters

Returns boolean

moveCell

Parameters

Returns void

resizeCell

Parameters

Returns void

setEdgePoints

Parameters

Returns void

setEdgeStyleEnabled

Parameters

Returns void

setOrthogonalEdge

Parameters

Returns void

setVertexLocation

Parameters

Returns null | Rectangle

traverse

Parameters

Returns void

Settings

On This Page

`Optional`master