PortSides

Show usages

Specifies the possible sides of a node where ports can be located.

Type Details

yFiles module: algorithms

Constants

ANY

: number

A combination of all possible side specifiers indicating that edges can connect to any side of a node.

BOTTOM

: number

A port side specifier indicating a port on the bottom side of a node.

END_IN_FLOW

: number

A port side specifier indicating a port lying on the last side of the node relative to the main flow of the overall layout.

Remarks

The exact side is domain-specific.

LEFT

: number

A port side specifier indicating a port on the left side of a node.

LEFT_IN_FLOW

: number

A port side specifier indicating a port lying left of the direction of the main flow of the overall layout.

Remarks

The exact side is domain-specific.

RIGHT

: number

A port side specifier indicating a port on the right side of a node.

RIGHT_IN_FLOW

: number

A port side specifier indicating a port lying right of the direction of the main flow of the overall layout.

Remarks

The exact side is domain-specific.

START_IN_FLOW

: number

A port side specifier indicating a port lying on the first side of the node relative to the main flow of the overall layout.

Remarks

The exact side is domain-specific.

TOP

: number

A port side specifier indicating a port on the top side of a node.

Static Methods

from

(value: PortSides) : PortSides

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.

value - PortSides: The value to convert to an enum constant.

Returns

↪PortSides: The enum constant that corresponds to the given argument.

getName

(value: PortSides) : string

Returns the name of the given enum constant.

Parameters

options - Object
A map of options to pass to the method.

value - PortSides: 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.