Error processing SSI file
LEADTOOLS Leadtools.Documents (Leadtools.Documents assembly)

GetThumbnailsGridElement Method

Show in webframe
1-based number of the first page number in the document.
1-based number of the last page number in the document.
The maximum width of the grid in pixels.
An optional ImageLoader instance to use instead of the internally-created one.
Gets a composite raster image of one or more page thumbnails.
Syntax
 function Leadtools.Documents.DocumentImages.getThumbnailsGridElement( 
   firstPageNumber ,
   lastPageNumber ,
   maximumGridWidth ,
   imageLoader 
)

Parameters

ParameterTypeDescription
firstPageNumberint1-based number of the first page number in the document.
lastPageNumberint1-based number of the last page number in the document.
maximumGridWidthintThe maximum width of the grid in pixels.
imageLoaderImageLoaderAn optional ImageLoader instance to use instead of the internally-created one.

Return Value

TypeDescription
jQueryApi.IDeferred A Promise object that may resolve succesfully to an HTML Element, or fail if the thumbnails grid raster image cannot be returned because it does not exist.
Remarks

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

GetThumbnailsGridUrl can be used to obtain the thumbnails of one or more pages in a single call. The result image will contain the images in a grid layout. The grid with will be less than or equal to maximumGridWidth in pixels and the height is determined automatically from the number of images to obtain.

The LEADTOOLS Document Viewer can use GetThumbnailsGridUrl to speed up obtaining the thumbnails of the pages in the document instead of iterating each page and calling GetThumbnailImageUrl.

Note that this method does not update the LEADTOOLS cache.

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.

Example
Refer to GetImageElement for an example.
See Also

Reference

DocumentImages Object
DocumentImages Members

Error processing SSI file