Specifies the orientation of substructures within an OrthogonalLayout.
Remarks
This enum provides different options for determining how substructures, such as trees, chains, or cycles, are oriented within the overall layout.
Type Details
- yFiles module
- algorithms
Constants
Automatically determines the orientation of substructures based on the layout context.
Remarks
The automatic orientation selection is determined by the layout algorithm, which evaluates factors such as existing edge connections and available space. This option provides the greatest flexibility and is recommended for achieving the most compact layout. The algorithm may, for instance, detect an unoccupied side of the root node and place the substructure on that side using the corresponding orientation (e.g., selecting LEFT_TO_RIGHT if the right side is free).
See Also
Specifies that substructures are oriented from bottom to top.
Specifies that substructures are oriented from left to right.
Specifies that substructures are oriented from right to left.
Specifies that substructures are oriented from top to bottom.
Static Methods
Converts the given argument to an enum constant of this enum type.
Remarks
Most notably, this method can convert an enum constant's name into the enum constant itself.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - SubstructureOrientation
- The value to convert to an enum constant.
Returns
- ↪SubstructureOrientation
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - SubstructureOrientation
- 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.