ArrowType

Show usages

Defines common default arrow types for Arrow.

Type Details

yFiles module: view

Constants

CHEVRON

: number

An arrow shaped like a chevron.

CROSS

: number

A cross-shaped arrow.

DELTOID

: number

A deltoid curve-shaped arrow.

DIAMOND

: number

A diamond-shaped arrow.

ELLIPSE

: number

An elliptical arrow.

KITE

: number

A kite-shaped arrow.

NONE

: number

No arrow.

OPEN

: number

An arrow shaped like an angle bracket.

STEALTH

: number

An arrow that is notched on the side opposite its tip.

TRIANGLE

: number

A triangular arrow.

Static Methods

from

(value: ArrowType) : ArrowType

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 - ArrowType: The value to convert to an enum constant.

Returns

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

getName

(value: ArrowType) : string

Returns the name of the given enum constant.

Parameters

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

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