Defines the different types of LayoutPortCandidates.
Type Details
- yFiles module
- algorithms
See Also
Constants
A LayoutPortCandidate specifying that the port has the same fixed position relative to the center of the node as in the input.
Remarks
For example, for an edge with a FIXED_FROM_SKETCH port at its source side, the port position is equal to sourcePortOffset.
See Also
A LayoutPortCandidate specifying that the port has a fixed position relative to the center of the node.
A LayoutPortCandidate specifying that the port may be placed anywhere on the specified side.
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 - PortCandidateType
- The value to convert to an enum constant.
Returns
- ↪PortCandidateType
- 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 - PortCandidateType
- 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.