getImage Method

Summary

Gets this page as a raster image.

Syntax

JavaScript Syntax

DocumentPage.prototype.getImage = function()

TypeScript Syntax

getImage(): string;

Return Value

The URL to an image of this page.

Remarks

This method will be deprecated. Use GetImageUrl instead.

getImageUrl is used to get a raster image representation of this page. All document types support this method and it will always return a value object.

This method works as follows (the "item" is a raster image with the specified resolution):

If an item was found in the cache, it is returned right away.
If this is an original page in the source document file (the value of OriginalPageNumber is not -1), then the image object is loaded from the original page.
If this is not an original page in the source document file (the value of OriginalPageNumber is not 1), then a new image object is created based on the page size and resolution and the default values in DocumentImages.
The image object is saved to the cache before it is returned. Next time this method is called, the image will be returned from the cache directly without loading it from the file or creating a new instance.

If this document type supports loading raster images at any resolution (the value of DocumentImages.IsResolutionsSupported is true, then this method will return the image using the current page Resolution value.

If the value of ImageScale is a value greater than 1, then the result raster image will have a size that is equal to Size / ImageScale.

The LEADTOOLS Document Viewer uses this method to obtain the raster image for the page when the view mode is "Raster Image".

The LEADTOOLS Document Converter uses this method to obtain the raster image for the page when converting using OCR or when adding the overlay image of a page if needed.

Refer to Loading Using LEADTOOLS Documents Library for more information.

Example

For an example, refer to LoadFromUri.

Requirements

Target Platforms