Node labeling policies defining how node labels are handled by layout algorithms with radial layout styles that support integrated node labeling.
Type Details
- yFiles module
- algorithms
Constants
The GenericLabeling algorithm is applied as a post-processing step of the main layout algorithm to the node labels.
Node labeling policy for ray-like label placement at nodes with zero or one child node or nodes that are placed on the perimeter of a circular component.
Remarks
Labels belonging to nodes with zero or exactly one successor (thus forming a sort of chain) will not be oriented horizontally but ray-like; they get the same orientation as their nodes' incoming edge. For the circular layout, nodes that are placed on the perimeter of a circular component and have neighbors connected only to this component will also be placed ray-like. The labels of the other nodes will be oriented horizontally and placed at the center of the corresponding node.
RadialTreeLayout places the label of nodes in the inner circles ray-like inside the nodes with the same orientation as their nodes' incoming edge. RadialLayout places these labels outside the nodes with the same angle as the nodes.
CircularLayout places the label of nodes that belong to the perimeter of a circle ray-like outside the node with the same orientation as their nodes' incoming edge. If the partition style is BCC_COMPACT or BCC_ISOLATED, the labels of the nodes that are connected to more than one circular components will be also placed horizontally, even if they are placed on the perimeter of the circle. Labels of nodes that belong on a chain will be placed ray-like but inside the node with the same orientation as their nodes' incoming edge.
RadialGroupLayout places the labels of inner nodes ray-like inside the nodes with the same orientation as their placement relative to their parent node. The labels of leaves are placed outside the nodes with the same angle as the leaves' placement relative to their parent node.
Sample Graphs
Node labeling policy for ray-like label placement at nodes with zero children or nodes that are placed on the perimeter of a circular component.
Remarks
RadialTreeLayout places the labels corresponding to leaf nodes outside the node (without overlaps) with the same orientation as their nodes' incoming edge. RadialLayout places these labels also outside the nodes with the same angle as the nodes. CircularLayout places the label of nodes with no children or of nodes that belong to the perimeter of a circle and have neighbors at the same circle ray-like outside the node with the same orientation as their nodes' incoming edge. The labels of the other nodes will be oriented horizontally and placed at the center of the corresponding node.
RadialGroupLayout places the labels of inner nodes horizontally at the center of the corresponding node. The labels of leaves are placed outside the nodes with the same angle as the leaves' placement relative to their parent node.
Sample Graphs
Static Methods
Converts the given argument to an enum constant of this enum type.
Remarks
Parameters
A map of options to pass to the method.
- value - RadialNodeLabelPlacement
- The value to convert to an enum constant.
Returns
- ↪RadialNodeLabelPlacement
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Parameters
A map of options to pass to the method.
- value - RadialNodeLabelPlacement
- The numeric value of an enum constant.
Returns
- ↪string
- The name of the enum constant.
Throws
- Exception({ name: 'Error' })
- If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.