getRulerLengthAsStringFromPoints Method

Summary

Gets the length of the ruler between two points as a string.

Syntax
TypeScript
JavaScript
AnnProtractorObject.prototype.getRulerLengthAsStringFromPoints = function( 
   startPoint, 
   endPoint, 
   calibrationScale 
) 
getRulerLengthAsStringFromPoints( 
   startPoint: LeadPointD, 
   endPoint: LeadPointD, 
   calibrationScale: number 
): string; 

Parameters

startPoint

The starting point of the ruler.

endPoint

The ending point of the ruler.

calibrationScale

The ratio of the horizontal resolution (dots per inch or DPI) to the vertical resolution.

For most images, the ratio is 1.

Return Value

The length of the ruler as a string based on the calibrationScale.

Requirements

Target Platforms

Help Version 20.0.2020.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Engine Assembly