Dimensions

class oci.ai_document.models.Dimensions(**kwargs)

Bases: object

The width and height of a page.

Attributes

UNIT_INCH A constant which can be used with the unit property of a Dimensions.
UNIT_PIXEL A constant which can be used with the unit property of a Dimensions.
height [Required] Gets the height of this Dimensions.
unit [Required] Gets the unit of this Dimensions.
width [Required] Gets the width of this Dimensions.

Methods

__init__(**kwargs) Initializes a new Dimensions object with values from keyword arguments.
UNIT_INCH = 'INCH'

A constant which can be used with the unit property of a Dimensions. This constant has a value of “INCH”

UNIT_PIXEL = 'PIXEL'

A constant which can be used with the unit property of a Dimensions. This constant has a value of “PIXEL”

__init__(**kwargs)

Initializes a new Dimensions object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • width (float) – The value to assign to the width property of this Dimensions.
  • height (float) – The value to assign to the height property of this Dimensions.
  • unit (str) – The value to assign to the unit property of this Dimensions. Allowed values for this property are: “PIXEL”, “INCH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
height

[Required] Gets the height of this Dimensions. The height of a page.

Returns:The height of this Dimensions.
Return type:float
unit

[Required] Gets the unit of this Dimensions. The unit of length.

Allowed values for this property are: “PIXEL”, “INCH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The unit of this Dimensions.
Return type:str
width

[Required] Gets the width of this Dimensions. the width of a page.

Returns:The width of this Dimensions.
Return type:float