PathType

Show usages

An enumeration of all possible types that make up a GeneralPath

Type Details

yFiles module: view

Constants

CLOSE

: number

The type that is used to add a line from the current position to the last MOVE_TO position.

Remarks

This type uses no coordinate pair.

CUBIC_TO

: number

The type that is used to add a cubic Bézier curve from the current position to the next position using two intermediate control points.

Remarks

This type uses three coordinate pairs.

LINE_TO

: number

The type that is used to add a line from the current position to the next position.

Remarks

This type uses one coordinate pair.

MOVE_TO

: number

The type that is used to move the Stroke to the next position.

Remarks

This type uses one coordinate pair.

QUAD_TO

: number

The type that is used to add a quadratic Bézier curve from the current position to the next position using one control point.

Remarks

This type uses two coordinate pairs.

Static Methods

from

(value: PathType) : PathType

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

Returns

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

getName

(value: PathType) : string

Returns the name of the given enum constant.

Parameters

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

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