hitTest Method

Summary

Performs hit-testing on this AnnRectangleObject.

Syntax
TypeScript
JavaScript
AnnRectangleObject.prototype.hitTest = function( 
   point, 
   hitTestBuffer 
) 
hitTest( 
   point: LeadPointD, 
   hitTestBuffer: number 
): boolean; 

Parameters

point

The LeadPointD to be tested.

hitTestBuffer

The threshold buffer value, in pixels.

Return Value

A value that represents the hit-test value; or null if the test point is not on top of this AnnObject.

Remarks

point should be in physical coordinates.

hitTestBuffer is used to make the test point "bigger" to compensate for errors and provide smoother hit-testing. For example, if buffer is 2, a square with a length of 4 pixels around testPoint will be used to perform the hit-testing.

By default, an annotation object will return true if hit-testing was satisfied. Derived objects can override this method to fine tune the return value.

Requirements

Target Platforms

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

Leadtools.Annotations.Engine Assembly