Class mxCoordinateAssignment
java.lang.Object
com.mxgraph.layout.hierarchical.stage.mxCoordinateAssignment
- All Implemented Interfaces:
mxHierarchicalLayoutStage
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected class
Utility class that stores a collection of vertices and edge points within a certain area.protected class
A utility class used to track cells whilst sorting occurs on the weighted sum of their connected edges. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
The size of the vertical buffer in the center of inter-rank channels where edge control points should not be placedprotected double
The sum of x-displacements for the current iterationprotected boolean
Specifies if the STYLE_NOEDGESTYLE flag should be set on edges that are modified by the result.protected com.mxgraph.layout.hierarchical.stage.mxCoordinateAssignment.HierarchicalEdgeStyle
The style to apply between cell layers to edge segmentsprotected boolean
Whether or not to perform local optimisations and iterate multiple times through the algorithmprotected int
Padding added to resized parentsprotected double
The minimum x position node placement starts atprotected double
The minimum distance between cells on adjacent ranksprotected double
The minimum buffer between cells on the same rankprotected Map
<mxGraphHierarchyEdge, double[]> 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.protected mxHierarchicalLayout
Reference to the enclosing layout algorithmprotected double
The maximum x value this positioning lays up toprotected int
The number of heuristic iterations to runprotected int
The minimum distance for an edge jetty from a vertexprotected mxGraphAbstractHierarchyCell[][]
A store of connections to the layer above for speedprotected int
The position of the root ( start ) node(s) relative to the rest of the laid out graphprotected double
The distance between each parallel edge on each ranks for long edgesprotected int
The preferred horizontal distance between edges exiting a vertexprotected int
The preferred vertical offset between edges exiting a vertexprotected mxGraphAbstractHierarchyCell[][]
A store of connections to the layer below for speedprotected double[]
Internal cache of bottom-most value of Y for each rankprotected double[]
Internal cache of top-most values of Y for each rankprotected double[]
The width of all the ranksprotected double[]
The Y-coordinate of all the ranksprotected double
The buffer on either side of a vertex where edges must not connect.protected int
The rank that has the widest x positionprotected double
The X-coordinate of the edge of the widest rank -
Constructor Summary
ConstructorsConstructorDescriptionmxCoordinateAssignment
(mxHierarchicalLayout layout, double intraCellSpacing, double interRankCellSpacing, int orientation, double initialX, double parallelEdgeSpacing) Creates a coordinate assignment. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
adjustParents
(Set<Object> parentsChanged) Adjust parent cells whose child geometries have changed.protected void
calculateWidestRank
(mxGraph graph, mxGraphHierarchyModel model) Calculates the width rank in the hierarchy.void
A basic horizontal coordinate assignment algorithmdouble
double
double
int
boolean
protected void
Separates the x position of edges as they connect to verticesprotected void
minPath
(mxGraphHierarchyModel model) Straightens out chains of virtual nodes where possiblevoid
Utility method to display the x co-ordsprotected void
processReversedEdge
(mxGraphHierarchyEdge edge, Object realEdge) Hook to add additional processingprotected void
rankCoordinates
(int rankValue, mxGraph graph, mxGraphHierarchyModel model) Sets up the layout in an initial positioning.protected void
rankMedianPosition
(int rankValue, mxGraphHierarchyModel model, int nextRankValue) Performs median minimisation over one rank.protected boolean
repositionValid
(mxGraphHierarchyModel model, mxGraphAbstractHierarchyCell cell, int rank, double position) Determines whether or not a node may be moved to the specified x position on the specified rankprotected void
setCellLocations
(mxGraph graph, mxGraphHierarchyModel model) Sets the cell locations in the facade to those stored after this layout processing step has completed.protected void
Fixes the control pointsvoid
setFineTuning
(boolean fineTuning) void
setInterRankCellSpacing
(double interRankCellSpacing) void
setIntraCellSpacing
(double intraCellSpacing) void
setLimitX
(double limitX) void
setOrientation
(int orientation) protected void
Fixes the position of the specified vertex
-
Field Details
-
layout
Reference to the enclosing layout algorithm -
intraCellSpacing
protected double intraCellSpacingThe minimum buffer between cells on the same rank -
interRankCellSpacing
protected double interRankCellSpacingThe minimum distance between cells on adjacent ranks -
parallelEdgeSpacing
protected double parallelEdgeSpacingThe distance between each parallel edge on each ranks for long edges -
vertexConnectionBuffer
protected double vertexConnectionBufferThe buffer on either side of a vertex where edges must not connect. -
maxIterations
protected int maxIterationsThe number of heuristic iterations to run -
prefHozEdgeSep
protected int prefHozEdgeSepThe preferred horizontal distance between edges exiting a vertex -
prefVertEdgeOff
protected int prefVertEdgeOffThe preferred vertical offset between edges exiting a vertex -
minEdgeJetty
protected int minEdgeJettyThe minimum distance for an edge jetty from a vertex -
channelBuffer
protected int channelBufferThe size of the vertical buffer in the center of inter-rank channels where edge control points should not be placed -
jettyPositions
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 -
orientation
protected int orientationThe position of the root ( start ) node(s) relative to the rest of the laid out graph -
initialX
protected double initialXThe minimum x position node placement starts at -
limitX
protected double limitXThe maximum x value this positioning lays up to -
currentXDelta
protected double currentXDeltaThe sum of x-displacements for the current iteration -
widestRank
protected int widestRankThe rank that has the widest x position -
rankTopY
protected double[] rankTopYInternal cache of top-most values of Y for each rank -
rankBottomY
protected double[] rankBottomYInternal cache of bottom-most value of Y for each rank -
widestRankValue
protected double widestRankValueThe X-coordinate of the edge of the widest rank -
rankWidths
protected double[] rankWidthsThe width of all the ranks -
rankY
protected double[] rankYThe Y-coordinate of all the ranks -
fineTuning
protected boolean fineTuningWhether or not to perform local optimisations and iterate multiple times through the algorithm -
disableEdgeStyle
protected boolean disableEdgeStyleSpecifies if the STYLE_NOEDGESTYLE flag should be set on edges that are modified by the result. Default is true. -
edgeStyle
protected com.mxgraph.layout.hierarchical.stage.mxCoordinateAssignment.HierarchicalEdgeStyle edgeStyleThe style to apply between cell layers to edge segments -
nextLayerConnectedCache
A store of connections to the layer above for speed -
groupPadding
protected int groupPaddingPadding added to resized parents -
previousLayerConnectedCache
A store of connections to the layer below for speed
-
-
Constructor Details
-
mxCoordinateAssignment
public mxCoordinateAssignment(mxHierarchicalLayout layout, double intraCellSpacing, double interRankCellSpacing, int orientation, double initialX, double parallelEdgeSpacing) Creates a coordinate assignment.- Parameters:
intraCellSpacing
- the minimum buffer between cells on the same rankinterRankCellSpacing
- the minimum distance between cells on adjacent ranksorientation
- the position of the root node(s) relative to the graphinitialX
- the leftmost coordinate node placement starts at
-
-
Method Details
-
printStatus
public void printStatus()Utility method to display the x co-ords -
execute
A basic horizontal coordinate assignment algorithm- Specified by:
execute
in interfacemxHierarchicalLayoutStage
-
rankMedianPosition
Performs median minimisation over one rank.- Parameters:
rankValue
- the layer number of this rankmodel
- an internal model of the hierarchical layoutnextRankValue
- the layer number whose connected cels are to be laid out relative to
-
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:
rankValue
- the current rank being processedgraph
- the facade describing the input graphmodel
- an internal model of the hierarchical layout
-
calculateWidestRank
Calculates the width rank in the hierarchy. Also set the y value of each rank whilst performing the calculation- Parameters:
graph
- the facade describing the input graphmodel
- an internal model of the hierarchical layout
-
minPath
Straightens out chains of virtual nodes where possible- Parameters:
model
- an internal model of the hierarchical layout
-
repositionValid
protected boolean repositionValid(mxGraphHierarchyModel model, mxGraphAbstractHierarchyCell cell, int rank, double position) Determines whether or not a node may be moved to the specified x position on the specified rank- Parameters:
model
- the layout modelcell
- the cell being analysedrank
- the layer of the cellposition
- the x position being sought- Returns:
- whether or not the virtual node can be moved to this position
-
setCellLocations
Sets the cell locations in the facade to those stored after this layout processing step has completed.- Parameters:
graph
- the facade describing the input graphmodel
- an internal model of the hierarchical layout
-
adjustParents
Adjust parent cells whose child geometries have changed. The default implementation adjusts the group to just fit around the children with a padding. -
localEdgeProcessing
Separates the x position of edges as they connect to vertices- Parameters:
model
- an internal model of the hierarchical layout
-
setEdgePosition
Fixes the control points- Parameters:
cell
-
-
setVertexLocation
Fixes the position of the specified vertex- Parameters:
cell
- the vertex to position
-
processReversedEdge
Hook to add additional processing- Parameters:
edge
- The hierarchical model edgerealEdge
- The real edge in the graph
-
getInterRankCellSpacing
public double getInterRankCellSpacing()- Returns:
- Returns the interRankCellSpacing.
-
setInterRankCellSpacing
public void setInterRankCellSpacing(double interRankCellSpacing) - Parameters:
interRankCellSpacing
- The interRankCellSpacing to set.
-
getIntraCellSpacing
public double getIntraCellSpacing()- Returns:
- Returns the intraCellSpacing.
-
setIntraCellSpacing
public void setIntraCellSpacing(double intraCellSpacing) - Parameters:
intraCellSpacing
- The intraCellSpacing to set.
-
getOrientation
public int getOrientation()- Returns:
- Returns the orientation.
-
setOrientation
public void setOrientation(int orientation) - Parameters:
orientation
- The orientation to set.
-
getLimitX
public double getLimitX()- Returns:
- Returns the limitX.
-
setLimitX
public void setLimitX(double limitX) - Parameters:
limitX
- The limitX to set.
-
isFineTuning
public boolean isFineTuning()- Returns:
- Returns the fineTuning.
-
setFineTuning
public void setFineTuning(boolean fineTuning) - Parameters:
fineTuning
- The fineTuning to set.
-