In This Topic ▼

getThumbnailsGridUrl Method

Summary

Gets a URL to a composite image for one or more page thumbnails.

Syntax

TypeScript

JavaScript

DocumentImages.prototype.getThumbnailsGridUrl = function( 
   firstPageNumber, 
   lastPageNumber, 
   maximumGridWidth 
)

getThumbnailsGridUrl( 
   firstPageNumber: number, 
   lastPageNumber: number, 
   maximumGridWidth: number 
): string;

Parameters

firstPageNumber

1-based number of the first page number in the document.

lastPageNumber

1-based number of the last page number in the document.

maximumGridWidth

The maximum width of the grid in pixels.

Return Value

A URL to a raster image that contains the thumbnails in a grid layout.

Remarks

To load an image instead of only creating a URL, see getThumbnailsGridElement.

Thumbnail grids 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, left to right by row; each image will be of size thumbnailPixelSize. The grid width will be less than or equal to maximumGridWidth in pixels. The number of columns is calculated by dividing maximumGridWidth by the thumbnailPixelSize width. The grid height and number of rows is determined by the columns and total number of images to obtain.

The total number of images to obtain is calculated from firstPageNumber and lastPageNumber. If lastPageNumber is 0 or -1, the last page number in the document will be used; in this case, all pages from firstPageNumber to the end of the document will be returned in the thumbnail grid.

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

Sample

Consider the following parameters:

In this example, we will load 10 images (specified by firstPageNumber and lastPageNumber). Each image will be 100 pixels by 100 pixels. Because maximumGridWidth is 300, and the width of a single image is 100, we will have 3 columns. Because we have 10 images and 3 columns, we can calculate that we will need four rows. Our images will look like this:

Full Image - 3 columns, 4 rows 
+----+----+----+ 
| 1  | 2  | 3  | 
+----+----+----+ 
| 4  | 5  | 6  | 
+----+----+----+ 
| 7  | 8  | 9  | 
+----+----+----+ 
| 10 | __ | __ | 
+----+----+----+