Skip to main content

GetPageImage

Returns the page image.

Syntax​

expression.GetPageImage(nPage, oParams);

expression - A variable that represents an Api class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
nPageRequirednumberThe page index.
oParamsOptionalobject{}The image parameters.
oParams.maxSizeOptionalnumberThe size of the larger image side in pixels.
oParams.annotationsOptionalbooleanfalseSpecifies whether the annotations will be rendered.
oParams.fieldsOptionalbooleanfalseSpecifies whether the fields will be rendered.
oParams.drawingsOptionalbooleanfalseSpecifies whether the drawings will be rendered.
oParams.withInfoOptionalbooleanfalseReturn an object with the image plus the page size instead of a bare data URL.

Returns​

string | Object