Direction

Show usages

Direction provides four main directions and some methods to work with them.

Inheritance Hierarchy

Direction

Type Details

yfiles module: layout-core
yfiles-umd modules: All layout modules, view-layout-bridge
Legacy UMD name: yfiles.layout.Direction

There is exactly one immutable object for each direction.

Properties

horizontal

: boolean

Gets whether or not this direction is horizontal (RIGHT or LEFT).

mirror

: Direction

Gets the mirror direction.

Remarks

The new direction is turned 180 degrees compared to this instance.

Throws

Exception({ name: 'ArgumentError' }): if the current direction value is invalid

turnCCW

: Direction

Gets the direction that follows this direction in counterclockwise order.

Remarks

The new direction is turned 90 degrees in counterclockwise direction compared to this instance.

Throws

Exception({ name: 'ArgumentError' }): if the current direction value is invalid

turnCW

: Direction

Gets the direction that follows this direction in clockwise order.

Remarks

The new direction is turned 90 degrees in clockwise direction compared to this instance.

Throws

Exception({ name: 'ArgumentError' }): if the current direction value is invalid

vertical

: boolean

Gets whether or not this direction is vertical (UP or DOWN).

Methods

getDirection

() : number

Returns the direction encoded as an integer value.

Returns

↪number: 0 for direction UP, 1 for RIGHT, 2 for DOWN, and 3 for LEFT

toString

() : string

Returns a string representation of the direction.

Returns

↪string: ^ for UP, > for RIGHT, v for DOWN, and < for LEFT.

Throws

Exception({ name: 'ArgumentError' }): if the current direction value is invalid

Constants

DOWN

: Direction

Decodes the down direction.

LEFT

: Direction

Decodes the left direction.

RIGHT

: Direction

Decodes the right direction.

UP

: Direction

Decodes the up direction.

Direction

Type Details

Properties

horizontal

mirror

Remarks

Throws

turnCCW

Remarks

Throws

turnCW

Remarks

Throws

vertical

Methods

getDirection

Returns

toString

Returns

Throws

Constants

DOWN

See Also

LEFT

See Also

RIGHT

See Also

UP

See Also