The features described in this topic are obsolete
and should not be used in new IDL code.

LIVE_CONTROL

The LIVE_CONTROL procedure allows you to set the properties of (or elements within) a visualization in a LIVE tool from the IDL command line. See LIVE_Tools for additional discussion of the routines that control the LIVE_ tools.

Note
The LIVE tools do not utilize the !X, !Y, and !Z conventions. Setting these system variables will have no effect on LIVE tool display.

Syntax

LIVE_CONTROL, [Name] [, /DIALOG] [, ERROR=variable] [, /NO_DRAW] [, PROPERTIES=structure] [, /SELECT] [, /UPDATE_DATA] [, WINDOW_IN=string]

Arguments

Name

If keywords DIALOG and/or PROPERTIES are used, Name is a string (case-insensitive) containing the name of a window visualization or graphic to operate on. WINDOW_IN will default to the window or buffer, if only one is present in the IDL session.

If keyword UPDATE_DATA is used, Name must be an IDL variable with the same name as one already used in the given window or buffer (WINDOW_IN). In this case there is no default. If UPDATE_DATA is not set, the parameter must be a name of a window, visualization or visualization element.

Keywords

DIALOG

Set this keyword to have the editable properties dialog of the visualization or graphic appear.

ERROR

Set this keyword to a named variable to contain the returned error message (string). An empty string is returned if no errors occurred during the operation. By default, errors are reported via a GUI.

Note
If a named variable is passed in this keyword and an error occurs, the error GUI will not be displayed.

NO_DRAW

Set this keyword to inhibit the visualization window from drawing. This is useful if multiple visualizations and/or annotations are being created via calls to other LIVE_Tools in order to reduce unwanted draws and help speed the display.

PROPERTIES

Set this keyword to a properties structure with which to modify the given visualization or graphic. The structure should contain one or more tags as returned from a LIVE_INFO call on the same type of item.

UPDATE_DATA

Set this keyword to force the window to update all of its visualizations that contain the given data passed in the parameter to LIVE_CONTROL.

WINDOW_IN

Set this keyword equal to a name (string, case-sensitive) of a LIVE tool window or a LIVE tool buffer. The WIN tag of the REFERENCE_OUT structure from the creation of the LIVE tool will provide the window or buffer name. Window names are also visible in visualization window titlebars. If only one LIVE tool window (or buffer) is present in the IDL session, this keyword will default to it.

Examples

; Create a dataset to display: 
X=indgen(10) 
 
; Plot the dataset: 
LIVE_PLOT, X 
 
; Modify the dataset: 
X=X+2 
 
; Replace old values of X: 
LIVE_CONTROL, X, /UPDATE_DATA

Version History

Introduced: 5.1