In This Topic ▼

getImageResized Method

Summary

Gets this page as a raster image with the specified size.

Syntax

TypeScript

JavaScript

DocumentPage.prototype.getImageResized = function( 
   width, 
   height 
)

getImageResized( 
   width: number, 
   height: number 
): string;

Parameters

width

Requested width in pixels.

height

Requested height in pixels.

Return Value

The URL to an image of this page.

Remarks

This method will be deprecated. Use GetImageResizedUrl 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.