OEMultiPageImageFile

class OEMultiPageImageFile

The OEMultiPageImageFile class supports the creation of multi-page images. The dimensions and orientation of the pages are determined when an OEMultiPageImageFile object is created. Pages are created by calling the OEMultiPageImageFile.NewPage method. See Figure: Schematic representation of an OEMultiPageImageFile object.

Schematic representation of an OEMultiPageImageFile object

See also

• Multi Page Images chapter

• OEGetSupportedMultiPageImageFileExtensions function

Hint

We highly recommend to usage of the more convenient high-level OEReport class when generating multi-page images.

• Multi Page Reports section

• Depicting Molecules in Multi-Page example

• Depicting MDL Query Substructure Search Hits example

Constructors

OEMultiPageImageFile(width: float, height: float) -> OEMultiPageImageFile

Creates an OEMultiPageImageFile object with a specified page width and height. Both the width and the height parameters have to be positive (non-zero) numbers.

OEMultiPageImageFile(orientation: int, imagesize: int) -> OEMultiPageImageFile

Creates an OEMultiPageImageFile object with the given orientation and size.

orientation

Determine the orientation of the pages. This value has to be from the OEPageOrientation namespace.

imagesize

Determine the width and height of the pages. This value has to be from the OEPageSize namespace.

See also

• OEGetPageHeight function

• OEGetPageWidth function

GetOrientation

GetOrientation() -> int

Returns the orientation of the pages. The return value is taken from the OEPageOrientation namespace.

GetPage

GetPage(page: int) -> OEImage

Returns the \(p^{th}\) page .

p

This value has to be in the range from 1 to OEMultiPageImageFile.NumPages().

Note

If \(p\) page index is out of range, then the OEMultiPageImageFile.GetPage method returns a NULL pointer.

GetPageHeight

GetPageHeight() -> float

Returns the height of the pages.

GetPageWidth

GetPageWidth() -> float

Returns the width of the pages.

GetPages

GetPages() -> Iterable[OEImage]

Returns an iterator over all pages stored in the OEMultiPageImageFile object.

NewPage

NewPage() -> OEImage

Returns a new page as an OEImage object.

NumPages

NumPages() -> int

Returns the number of pages stored in the OEMultiPageImageFile object.