The RectangleObject Class

class PyPDF2.generic.RectangleObject(arr: Union[RectangleObject, Tuple[float, float, float, float]])

Bases: ArrayObject

This class is used to represent page boxes in PyPDF2. These boxes include:

• artbox

• bleedbox

• cropbox

• mediabox

• trimbox

property bottom: FloatObject

ensureIsNumber(value: Any) → Union[FloatObject, NumberObject]

getHeight() → Decimal

getLowerLeft() → Tuple[Decimal, Decimal]

getLowerLeft_x() → FloatObject

getLowerLeft_y() → FloatObject

getLowerRight() → Tuple[Decimal, Decimal]

getLowerRight_x() → FloatObject

getLowerRight_y() → FloatObject

getUpperLeft() → Tuple[Decimal, Decimal]

getUpperLeft_x() → FloatObject

getUpperLeft_y() → FloatObject

getUpperRight() → Tuple[Decimal, Decimal]

getUpperRight_x() → FloatObject

getUpperRight_y() → FloatObject

getWidth() → Decimal

property height: Decimal

indirect_reference: Optional[IndirectObject]

property left: FloatObject

property lowerLeft: Tuple[Decimal, Decimal]

property lowerRight: Tuple[Decimal, Decimal]

property lower_left: Tuple[Decimal, Decimal]

Property to read and modify the lower left coordinate of this box in (x,y) form.

property lower_right: Tuple[Decimal, Decimal]

Property to read and modify the lower right coordinate of this box in (x,y) form.

property right: FloatObject

scale(sx: float, sy: float) → RectangleObject

setLowerLeft(value: Tuple[float, float]) → None

setLowerRight(value: Tuple[float, float]) → None

setUpperLeft(value: Tuple[float, float]) → None

setUpperRight(value: Tuple[float, float]) → None

property top: FloatObject

property upperLeft: Tuple[Decimal, Decimal]

property upperRight: Tuple[Decimal, Decimal]

property upper_left: Tuple[Decimal, Decimal]

Property to read and modify the upper left coordinate of this box in (x,y) form.

property upper_right: Tuple[Decimal, Decimal]

Property to read and modify the upper right coordinate of this box in (x,y) form.

property width: Decimal