In This Topic ▼

hitTest Method

Summary

Performs hit-testing on this AnnTextReviewObject.

Syntax

TypeScript

JavaScript

AnnTextReviewObject.prototype.hitTest = function( 
   point, 
   hitTestBuffer 
)

hitTest( 
   point: LeadPointD, 
   hitTestBuffer: number 
): boolean;

Parameters

point

The LeadPointD to be tested.

hitTestBuffer

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 AnnTextReviewObject.

Remarks

The 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

Reference

AnnTextReviewObject Class

AnnTextReviewObject Members

Leadtools.Annotations.Engine Namespace

Download our FREE evaluation

Help Version 22.0.2023.1.31

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies