Class OrientationField

The clockwise rotation to apply (in degrees) to make the image upright.

Hierarchy (View Summary)

BaseField
- OrientationField

Index

Constructors

Properties

pageId reconstructed value

Methods

compare toString arraySum

Constructors

constructor

new OrientationField(constructor: OrientationFieldConstructor): OrientationField
Parameters
- constructor: OrientationFieldConstructor
  Constructor parameters.
Returns OrientationField
Overrides BaseField.constructor
- Defined in src/v1/parsing/common/orientation.ts:19

Properties

pageId

pageId: number

Page id.

reconstructed

reconstructed: boolean

true when the field was reconstructed or computed using other fields.

value

value: number

Degrees of the rotation.

Methods

compare

compare(other: BaseField): boolean
Compares two field values for semantic equality.
Parameters
- other: BaseField
Returns boolean
Inherited from BaseField.compare
- Defined in src/v1/parsing/standard/base.ts:54

toString

toString(): string
Default string representation.

Returns string
Overrides BaseField.toString
- Defined in src/v1/parsing/common/orientation.ts:35

`Static`arraySum

arraySum(array: BaseField[]): number
Parameters
- array: BaseField[]
  Array of Fields
Returns number
Sum of all the Fields values in the array
Inherited from BaseField.arraySum
- Defined in src/v1/parsing/standard/base.ts:67