Enumeration for the different possible validity states.
Type Details
- yFiles module
- view
Constants
The candidate cannot be used to create a port, instead getPortCandidateAt needs to be called to obtain a IPortCandidate that is either VALID or INVALID.
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 - PortCandidateValidity
- The value to convert to an enum constant.
Returns
- ↪PortCandidateValidity
- 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 - PortCandidateValidity
- 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.