E3De::DeleteAnnotation

The DeleteAnnotation method allows you to delete a text annotation from the display.

This method has been deprecated.

Example

The following example uses the DataSample.ini project created in the Create and Process a Project Tutorial. Have the project open in ENVI LiDAR.

; Get the ENVI LiDAR session

e = E3De(/CURRENT)

; Delete the annotation

e.DeleteAnnotation, [593842, 5289520, 340], ERROR=error

; Close any open lidar objects

e.Close

Syntax

E3De.DeleteAnnotation, Location [, ERROR=variable] [, SPATIALREF=E3DLidarspatialref]

Arguments

Location

The location of the annotation to delete. A 3x1 array, [x, y, z].

Keywords

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.

SPATIALREF

An instance of an E3DLidarSpatialRef. Use this keyword to specify the coordinate system of the location of the annotation.

Version History

3.2	Introduced
ENVI 5.3	Obsolete