In This Topic ▼

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;

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.

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

Requirements

Help Version 23.0.2024.3.4

Leadtools.Annotations.Engine Assembly