Options
All
  • Public
  • Public/Protected
  • All
Menu

Sets the horizontal locations of node and edge dummy nodes on each layer. Uses median down and up weighings as well as heuristics to straighten edges as far as possible.

Hierarchy

Index

Constructors

constructor

Properties

channelBuffer

channelBuffer: number

The size of the vertical buffer in the center of inter-rank channels where edge control points should not be placed

default

4

currentXDelta

currentXDelta: number

The sum of x-displacements for the current iteration

fineTuning

fineTuning: number

Whether or not to perform local optimisations and iterate multiple times through the algorithm.

default

true

groupPadding

groupPadding: number

Padding added to resized parents

default

10

initialX

initialX: number

The minimum x position node placement starts at

interRankCellSpacing

interRankCellSpacing: number

The minimum distance between cells on adjacent ranks.

default

100

intraCellSpacing

intraCellSpacing: number

The minimum buffer between cells on the same rank.

default

30

jettyPositions

jettyPositions: Record<string, number[]>

Map of internal edges and (x,y) pair of positions of the start and end jetty for that edge where it connects to the source and target vertices. Note this should technically be a WeakHashMap, but since JS does not have an equivalent, housekeeping must be performed before using. i.e. check all edges are still in the model and clear the values. Note that the y co-ord is the offset of the jetty, not the absolute point

layout

Reference to the enclosing mxHierarchicalLayout.

limitX

limitX: number

The maximum x value this positioning lays up to

maxIterations

maxIterations: number

The number of heuristic iterations to run

default

8

minEdgeJetty

minEdgeJetty: number

The minimum distance for an edge jetty from a vertex

default

12

nextLayerConnectedCache

nextLayerConnectedCache: any

A store of connections to the layer above for speed

orientation

orientation: string

The position of the root ( start ) node(s) relative to the rest of the laid out graph.

default

mxConstants.DIRECTION_NORTH

parallelEdgeSpacing

parallelEdgeSpacing: number

The distance between each parallel edge on each ranks for long edges.

default

10

prefHozEdgeSep

prefHozEdgeSep: number

The preferred horizontal distance between edges exiting a vertex

default

5

prefVertEdgeOff

prefVertEdgeOff: number

The preferred vertical offset between edges exiting a vertex.

default

2

previousLayerConnectedCache

previousLayerConnectedCache: any

A store of connections to the layer below for speed

rankBottomY

rankBottomY: number[]

Internal cache of bottom-most value of Y for each rank

rankTopY

rankTopY: number[]

Internal cache of top-most values of Y for each rank

rankWidths

rankWidths: number[]

The width of all the ranks

rankY

rankY: number[]

The Y-coordinate of all the ranks

widestRank

widestRank: number

The rank that has the widest x position

widestRankValue

widestRankValue: number

The X-coordinate of the edge of the widest rank

Methods

calculateWidestRank

calculatedWeightedValue

  • calculatedWeightedValue(currentCell: mxCell, collection: mxCell[]): number
  • Calculates the priority the specified cell has based on the type of its cell and the cells it is connected to on the next layer

    Parameters

    • currentCell: mxCell

      the cell whose weight is to be calculated

    • collection: mxCell[]

      the cells the specified cell is connected to

    Returns number

execute

  • execute(parent: mxCell): void

initialCoords

  • Sets up the layout in an initial positioning. The ranks are all centered as much as possible along the middle vertex in each rank. The other cells are then placed as close as possible on either side.

    Parameters

    • facade: any

      the facade describing the input graph

    • model: mxGraphHierarchyModel

      an internal model of the hierarchical layout

    Returns void

localEdgeProcessing

medianPos

medianXValue

  • medianXValue(connectedCells: mxCell[], rankValue: number): number

minNode

minPath

printStatus

  • printStatus(): void

processReversedEdge

rankCoordinates

  • Sets up the layout in an initial positioning. All the first cells in each rank are moved to the left and the rest of the rank inserted as close together as their size and buffering permits. This method works on just the specified rank.

    Parameters:

    Parameters

    • rankValue: number

      the current rank being processed

    • graph: any

      the facade describing the input graph

    • model: mxGraphHierarchyModel

      an internal model of the hierarchical layout

    Returns void

rankMedianPosition

repositionValid

setCellLocations

setEdgePosition

  • setEdgePosition(cell: mxCell): void

setVertexLocation

  • setVertexLocation(cell: mxCell): void

Generated using TypeDoc