ENVI::Refresh

The Refresh method enables and disables the refresh (drawing) of the ENVI window. This method is useful if you are doing a large number of updates and you do not want to see the intermediate steps.

Example

Copy and paste the following code into the IDL command line:

; Start the application

e = ENVI()

; Disable refresh until all layers created

e.Refresh, /DISABLE

; Open ENVIRaster

file = FILEPATH('qb_boulder_msi', ROOT_DIR=e.ROOT_DIR, $

  SUBDIRECTORY = ['data'])

raster = e.OpenRaster(file)

; Create Layers

view = e.GetView()

layer1 = view.CreateLayer(raster)

layer2 = view.CreateLayer(raster, /CIR)

layer3 = view.CreateLayer(raster, BANDS=[0])

layer4 = view.CreateLayer(raster, BANDS=[1])

Now refresh the ENVI display:

e.Refresh

Syntax

ENVI.Refresh [, Keywords=value]

Keywords

Keywords are applied only during the initial creation of the object.

DISABLE

Set this keyword to 1 to disable all refreshing of the window until the Refresh method is called again. If this keyword is not set (or is set to 0), the window is redrawn and refresh is turned back on if it was previously turned off.

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

Introduced

API Version

4.2