MatrixOrder

Show usages

Enumeration constant for use in Matrix operations.

Type Details

yFiles module: view

Constants

APPEND

: number

Constant that defines an append operation for matrix multiplications.

Remarks

Appending a matrix T to another matrix M results in the operation M′ = T M. Essentially, this means that T is applied after M when applying M′ to a vector.

PREPEND

: number

Constant that defines a prepend operation for matrix multiplications.

Remarks

Prepending a matrix T to another matrix M results in the operation M′ = M T. Essentially, this means that T is applied before M when applying M′ to a vector.

Static Methods

from

(value: MatrixOrder) : MatrixOrder

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

Returns

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

getName

(value: MatrixOrder) : string

Returns the name of the given enum constant.

Parameters

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

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