In This Topic ▼

thumbnailPixelSize Property

Summary

Size to use when getting the thumbnail image of a page.

Syntax

TypeScript

JavaScript

Object.defineProperty(DocumentImages.prototype, 'thumbnailPixelSize', 
   get: function(), 
   set: function(value) 
)

thumbnailPixelSize: LeadSizeD;

Property Value

The size to use in pixels when getting the thumbnail image of a page. Default value is 128 by 128 pixels.

Remarks

ThumbnailPixelSize is used by DocumentPage.GetThumbnailImageUrl to calculate the size of the raster image returned as a thumbnail of the page.

The actual size is calculated to be the maximum value that fits inside ThumbnailPixelSize while keeping the aspect ratio, for example, if ThumbnailPixelSize is 128 by 128 and the page size is 2000 by 1000 pixels then the returned thumbnail image size is 128 by 64 pixels.

Requirements

Target Platforms