getThumbnailImage Method (DocumentPage)

Summary

Gets a thumbnail representation of this page.

Syntax

JavaScript Syntax

DocumentPage.prototype.getThumbnailImage = function()

TypeScript Syntax

getThumbnailImage(): string;

Return Value

URL to an image that represents the thumbnail of this page.

Remarks

This method will be deprecated. Use GetThumbnailImageUrl instead.

This method uses the value set in DocumentImages.ThumbnailPixelSize to determine the size of the thumbnail image. The returned image data will have 24 bits per pixel.

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

If an item was found in the cache, it is returned right away.
GetImageUrl is used to create the thumbnail image.
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.

DocumentImages.GetThumbnailsGridUrl can be used to return the thumbnails of more than one page using a single call.

The LEADTOOLS Document Viewer uses DocumentPage.GetThumbnailImageUrl and DocumentImages.GetThumbnailsGridUrl for generating the thumbnails list of a document.

Refer to Loading Using LEADTOOLS Documents Library for more information.

Requirements

Target Platforms

See Also

Reference

DocumentPage Class

DocumentPage Members

Leadtools.Documents Namespace