VEGAS JS

Namespace: Orientation

graphics. Orientation

The graphics.Orientation enumeration defines layout orientation options.

Members

<static> ALL :array

All the orientations defines in the graphics.Orientation enumeration.

Type:
  • array
Example
Orientation.ALL =[    Orientation.NONE ,    Orientation.BOTTOM_TO_TOP ,    Orientation.LEFT_TO_RIGHT ,    Orientation.RIGHT_TO_LEFT ,    Orientation.TOP_TO_BOTTOM ,    Orientation.LEFT_TO_RIGHT_BOTTOM_TO_TOP ,    Orientation.LEFT_TO_RIGHT_TOP_TO_BOTTOM ,    Orientation.RIGHT_TO_LEFT_BOTTOM_TO_TOP ,    Orientation.RIGHT_TO_LEFT_TOP_TO_BOTTOM];

<static> BOTTOM_TO_TOP :number

Constant indicating a bottom-to-top layout orientation (4).

Type:
  • number
Default Value:
  • 4

<static> LEFT_TO_RIGHT :number

Constant indicating a left-to-right layout orientation (1).

Type:
  • number
Default Value:
  • 1

<static> LEFT_TO_RIGHT_BOTTOM_TO_TOP :number

Constant indicating a left-to-right layout orientation (5).

Type:
  • number
Default Value:
  • 5

<static> LEFT_TO_RIGHT_TOP_TO_BOTTOM :number

Constant indicating a left-to-right and top-to-bottom layout orientation (9).

Type:
  • number
Default Value:
  • 9

<static> NONE :number

Constant indicating a none layout orientation, use the default orientation (0).

Type:
  • number
Default Value:
  • 0

<static> RIGHT_TO_LEFT :number

Constant indicating a right-to-left layout orientation (2).

Type:
  • number
Default Value:
  • 2

<static> RIGHT_TO_LEFT_BOTTOM_TO_TOP :number

Constant indicating a right-to-left layout orientation (6).

Type:
  • number
Default Value:
  • 6

<static> RIGHT_TO_LEFT_TOP_TO_BOTTOM :number

Constant indicating a right-to-left and top-to-bottom layout orientation (10).

Type:
  • number
Default Value:
  • 10

<static> TOP_TO_BOTTOM :number

Constant indicating a bottom-to-top layout orientation (8).

Type:
  • number
Default Value:
  • 8

Methods

<static> toString(value, byDefault)

Stringify the specific Orientation numeric value passed in argument.

Parameters:
Name Type Description
value number

The value of the specific Orientation to stringify.
byDefault string

The default string representation if the value is not valid.
Returns:

the string representation of the specific Orientation numeric value passed in argument.

Example
trace( Orientation.toString(Orientation.BOTTOM_TO_TOP)) ; // "btt"trace( Orientation.toString(Orientation.LEFT_TO_RIGHT)) ; // "ltr"trace( Orientation.toString(Orientation.RIGHT_TO_LEFT)) ; // "rtl"

<static> validate(value)

Returns true if the passed-in uint argument is a valid Orientation value else returns false.

Parameters:
Name Type Description
value number

The numeric value to evaluate.
Returns:

true if the passed-in uint argument is a valid Orientation value else returns false.