getThumbnailImageElement Method (DocumentPage)

Summary

Gets an HTML Element representing a thumbnail raster image for this page.

Syntax

JavaScript Syntax

DocumentPage.prototype.getThumbnailImageElement = function(imageLoader)

TypeScript Syntax

getThumbnailImageElement(imageLoader: ImageLoader): JQueryPromise<any>;

Parameters

imageLoader

An optional ImageLoader instance to use instead of the internally-created one.

Return Value

A Promise object that may resolve successfully to an HTML Element, or fail if the raster thumbnail image cannot be returned because it does not exist for this DocumentPage.

Remarks

To only get the URL instead of loading the image, see GetThumbnailImageUrl.

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

GetThumbnailsGridElement can be used to return the thumbnails of more than one page using a single call. The LEADTOOLS Document Viewer uses GetThumbnailImageElement and GetThumbnailsGridElement for generating the thumbnails list of a document.

This method takes an optional imageLoader parameter for additional image load configuration. If an ImageLoader is provided, Run will not be called and it is the responsibility of the application to call it when needed. If an ImageLoader is not supplied, one is created internally and Run is called before this method exits. See Documents Image Loading for more information.

This request can pass arbitrary user data through ServiceUserData.

Refer to Image Loading Using LEADTOOLS Documents Library and Document Loading Using LEADTOOLS Documents Library for more information.

Requirements

Target Platforms

See Also