In This Topic ▼

imageScale Property

Summary

Gets the scale value used when retuning image objects of this page.

Syntax

TypeScript

JavaScript

Object.defineProperty(DocumentPage.prototype, 'imageScale', 
   get: function() 
)

readonly imageScale: number;

Property Value

The scale value used when retuning image objects of this page.

Remarks

This value is calculated for each page based on the value of MaximumImagePixelSize. The default value is 1 when the value of MaximumImagePixelSize is the default of 0 which means no scaling. If the value is any other, then ImageScale can be a value equal to or greater than 1 depending on the original page pixel size. Refer to MaximumImagePixelSize for more information.

Requirements

Target Platforms