ENVIView::HitTest

The HitTest function method returns an array of visualizations located at a mouse event or within a user-specified box.

Example

See the code example for Mouse Event Handlers.

Syntax

Result = ENVIView.HitTest(X, Y [, DIMENSIONS=array])

Return Value

This function method returns an array of visualizations located at a mouse event or within a user-specified box. Use the returned references to manipulate the graphics.

Arguments

X

The X location, in view coordinates, to use for the hit test.

Y

The Y location, in view coordinates, to use for the hit test.

Keywords

DIMENSIONS

A two-element array with the X and Y dimensions of a box (used for a hit test) centered on the location specified by the X and Y arguments.

ERROR

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

Version History

ENVI 5.1

Introduced

API Version

4.2

See Also

ENVIView