aspectRatioCorrection Property

Summary

Manual aspect ratio correction value

Syntax

JavaScript Syntax

Object.defineProperty(ImageViewer.prototype, 'aspectRatioCorrection', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

aspectRatioCorrection: number;

Property Value

The manual aspect ratio correction value. Default value is 1.

Remarks

Changing the value of this property will fire the PropertyChanged and TransformChanged events.

When displaying images, sometimes it is necessary to set a manual aspect ratio correction to compensate for irregular screen resolution (pixel size). For example, if you display an image that is 100 by 100 pixels on most monitors, the image will not be an exact square on screen because most monitors have pixels that are rectangular in shape. Setting the AspectRatioCorrection value can fix this issue.

The AspectRatioCorrection is multiplied by the current vertical scale factor of the control YScaleFactor at all times regardless of the SizeMode value.

Example

This example shows the effect changing AspectRatioCorrection have on how the image is displayed.

Run the demo, now as you click the Example button, the aspect ratio alternates between 1, 2 and 0.5

Start with the ImageViewer example, remove all the code inside the example function (search for the "// TODO: add example code here" comment) and insert the following code:

JavaScript Example

alert("Current _imageViewer.AspectRatioCorrection is " + this._imageViewer.aspectRatioCorrection); 
// Now, change the AspectRatioCorrection to the default 
this._imageViewer.aspectRatioCorrection = 1;

Requirements

Target Platforms

Reference

ImageViewer Class

ImageViewer Members

Leadtools.Controls Namespace

Help Version 19.0.2017.10.27

Leadtools.Controls Assembly

Introduction

Getting Started

Namespaces

Leadtools.Controls Namespace

Assemblies