E

ShowPortCandidates
flags

Defines whether to show the visualization of start and end port candidates during interactive edge creation.

Remarks

This enumeration is used by showPortCandidates.

See Also

API

showPortCandidates

Members

No filters for this type

Constants

Show port candidates for both the start and the end of the newly created edge.
Show port candidates for possible ends of the newly created edge.
Don't show any port candidates.
Show port candidates to start the edge creation at.

Static Methods

Converts the given argument to an enum constant of this enum type.
Most notably, this method can convert an enum constant's name into the enum constant itself.
static

Parameters

value: ShowPortCandidates
The value to convert to an enum constant.

Return Value

ShowPortCandidates
The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
static

Parameters

value: ShowPortCandidates
The numeric value of an enum constant.

Return Value

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.