The TreeLayoutPortAssigner provides some simple port assignment styles for the TreeLayout.
Remarks
Ports are either CENTERed on the node, distributed at one side of the node, or placed considering LayoutPortCandidates.
Default Values of Properties
| borderToPortGapRatio | 0.5 | |
| mode | CENTER | |
| reversedPortOrder | false | The normal order is used for the ports. |
Type Details
- yFiles module
- algorithms
While the respective ISubtreePlacer preserves the chosen ports, certain implementations may not be capable of generating the complex edge routes needed, potentially resulting in visually unappealing connections.
Constructors
Creates a new TreeLayoutPortAssigner instance.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- mode - TreeLayoutPortAssignmentMode
- An optional port assignment specifier. The default value is CENTER.
- ratio - number
- The ratio of the distance between outer ports and the border to the distance between any two ports. The default value is
0.5. - borderToPortGapRatio - number
- The ratio of the border gap (distance between the outer ports to the node border) to the port gap (distance between adjacent ports). This option sets the borderToPortGapRatio property on the created object.
- reversedPortOrder - boolean
- Whether or not the port assignment should reverse the order of the ports. This option sets the reversedPortOrder property on the created object.
Throws
- Exception({ name: 'ArgumentError' })
- if an unknown mode is specified or if the specified ratio is negative
Properties
Gets or sets the ratio of the border gap (distance between the outer ports to the node border) to the port gap (distance between adjacent ports).
Remarks
The ratio must have a positive value. When the ratio is
0, the ports will be distributed along the whole side of the node without a gap between the last port and the corner.Default Value
The default value is
0.5.Property Value
the ratio of the border gap (gap between ports and border) to the port gap (gap between two ports)
Throws
- Exception({ name: 'ArgumentError' })
- if the specified ratio is negative
Sample Graphs
This setting only affects DISTRIBUTED port assignment.
Gets or sets the mode that describes how ports are placed.
Default Value
The default value is
Property Value
one of the predefined port assignment specifiers
While ISubtreePlacer implementations preserve the assigned ports, some may not generate suitable edge routes when ports are distributed. For distributed ports, SingleLayerSubtreePlacer typically yields the best results.
Gets or sets whether or not the port assignment should reverse the order of the ports.
Remarks
The normal order is from left to right and from top to bottom. It will be reversed if this option is enabled.
Default Value
The default value is
false.The normal order is used for the ports.
Property Value
true if the order of the ports is reversed, false otherwiseSample Graphs
This setting only affects DISTRIBUTED port assignment.
Methods
Assigns relative coordinates to the source port of the outgoing edge to a child of the given node.
Remarks
This method is called by assignPorts for each outgoing edge of the given node. It may be overridden to assign a custom location to the source port of outgoing edges.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- graph - LayoutGraph
- the input graph
- node - LayoutNode
- the node
- edge - LayoutEdge
- the edge to the child node
- index - number
- the zero-based index of the child edge
See Also
This implementation considers LayoutPortCandidates despite the port assignment mode.
Assigns relative coordinates to the target port of the incoming edge from the parent of the given node.
Remarks
This method is called by assignPorts if the given node has a parent node. It may be overridden to assign a custom location to the target port of the incoming edge.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- graph - LayoutGraph
- the input graph
- node - LayoutNode
- the node
- edge - LayoutEdge
- the edge from the parent node
See Also
This implementation considers LayoutPortCandidates despite the port assignment mode.
Places the ports of edges connecting to the given node according to the port assignment mode.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- graph - LayoutGraph
- the input graph
- node - LayoutNode
- the node whose adjacent edges' ports should be placed
See Also
Implements
Retrieves the source LayoutPortCandidate for the given edge.
Remarks
This method is called by assignChildEdgeSourcePort.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- edge - LayoutEdge
- the edge
Returns
See Also
Retrieves the target LayoutPortCandidate for the given edge.
Remarks
This method is called by assignParentEdgeTargetPort.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- edge - LayoutEdge
- the edge