Class StackLayout

Extends GraphLayout to create a horizontal or vertical stack of the child vertices. The children do not need to be connected for this layout to work.

Example:

const layout = new StackLayout(graph, true);
layout.execute(graph.getDefaultParent());

Hierarchy (view full)

GraphLayout
- StackLayout

Constructors

constructor

new StackLayout(graph, horizontal?, spacing?, x0?, y0?, border?): StackLayout
Parameters
- graph: Graph
- horizontal: null | boolean = null
- spacing: null | number = null
- x0: null | number = null
- y0: null | number = null
- border: null | number = null
Returns StackLayout
Overrides GraphLayout.constructor
- Defined in view/layout/StackLayout.ts:42

Properties

allowGaps

allowGaps: boolean = false

If gaps should be allowed in the stack.

border

border: number = 0

Border to be added if fill is true.

borderCollapse

borderCollapse: boolean = true

If the strokeWidth should be ignored.

fill

fill: boolean = false

Boolean indicating if dimension should be changed to fill out the parent cell.

graph

graph: Graph

Reference to the enclosing Graph.

gridSize

gridSize: number = 0

Grid size for alignment of position and size.

horizontal

horizontal: boolean

Specifies the orientation of the layout.

keepFirstLocation

keepFirstLocation: boolean = false

Boolean indicating if the location of the first cell should be kept, that is, it will not be moved to x0 or y0.

marginBottom

marginBottom: number = 0

Top margin for the child area.

marginLeft

marginLeft: number = 0

Top margin for the child area.

marginRight

marginRight: number = 0

Top margin for the child area.

marginTop

marginTop: number = 0

Top margin for the child area.

parent

parent: null | Cell = null

The parent cell of the layout, if any

Default

null

resizeLast

resizeLast: boolean = false

If the last element should be resized to fill out the parent.

resizeParent

resizeParent: boolean = false

If the parent should be resized to match the width/height of the stack.

resizeParentMax

resizeParentMax: boolean = false

Use maximum of existing value and new value for resize of parent.

spacing

spacing: number

Specifies the spacing between the cells.

useBoundingBox

useBoundingBox: boolean = true

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

Default

true.

wrap

wrap: null | number = null

Value at which a new column or row should be created.

x0

x0: number

Specifies the horizontal origin of the layout.

y0

y0: number

Specifies the vertical origin of the layout.

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 mxGraphLayout.execute.
Parameters
- parent: Cell
Returns void
Overrides GraphLayout.execute
- Defined in view/layout/StackLayout.ts:281

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

getLayoutCells

getLayoutCells(parent): Cell[]
Returns the cells to be layouted.
Parameters
- parent: Cell
Returns Cell[]
- Defined in view/layout/StackLayout.ts:229

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

getParentSize

getParentSize(parent): Geometry
Returns the size for the parent container or the size of the graph container if the parent is a layer or the root of the model.
Parameters
- parent: Cell
Returns Geometry
- Defined in view/layout/StackLayout.ts:207

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

isHorizontal

isHorizontal(): boolean
Returns horizontal.

Returns boolean
- Defined in view/layout/StackLayout.ts:151

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
Implements mxGraphLayout.moveCell.
Parameters
- cell: Cell
- x: number
- y: number
Returns void
Overrides GraphLayout.moveCell
- Defined in view/layout/StackLayout.ts:158

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

setChildGeometry

setChildGeometry(child, geo): void
Sets the specific geometry to the given child cell.
Parameters
- child: Cell
  The given child of .
- geo: Geometry
  The specific geometry of Geometry.
Returns void
- Defined in view/layout/StackLayout.ts:450

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

snap

snap(value): number
Snaps the given value to the grid size.
Parameters
- value: number
Returns number
- Defined in view/layout/StackLayout.ts:266

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

updateParentGeometry

updateParentGeometry(parent, pgeo, last): void
Updates the geometry of the given parent cell.
Parameters
- parent: Cell
  The given parent of .
- pgeo: Geometry
  The new Geometry for parent.
- last: Geometry
  The last Geometry.
Returns void
- Defined in view/layout/StackLayout.ts:471

Class StackLayout

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StackLayout

Properties

allowGaps

border

borderCollapse

fill

graph

gridSize

horizontal

keepFirstLocation

marginBottom

marginLeft

marginRight

marginTop

parent

Default

resizeLast

resizeParent

resizeParentMax

spacing

useBoundingBox

Default

wrap

x0

y0

Methods

arrangeGroups

Parameters

Returns Cell[]

execute

Parameters

Returns void

getConstraint

Parameters

Returns any

getGraph

Returns Graph

getLayoutCells

Parameters

Returns Cell[]

getParentOffset

Parameters

Returns Point

getParentSize

Parameters

Returns Geometry

getVertexBounds

Parameters

Returns Rectangle

isAncestor

Parameters

Returns boolean

isEdgeIgnored

Parameters

Returns boolean

isHorizontal

Returns boolean

isVertexIgnored

Parameters

Returns boolean

isVertexMovable

Parameters

Returns boolean

moveCell

Parameters

Returns void

resizeCell

Parameters

Returns void

setChildGeometry

Parameters