|
User Documentation |
|||||||||
prev file | next file | ||||||||||
SUMMARY: fields | routine DETAILS: routine | ||||||||||
./plotter click.pro
click |
function click([frame=string], [veldef=string], [/nocrosshair], [/noshow], [label=string]) |
Get cursor position when the user presses a mouse button. Positions are translated to include channels, frequency, and velocity in the requested reference frame and velocity definition. The return value is a named structure (cvfstruct) containing the following fields:
print,click() ; or c = click() v = c.velo ; velocity at frame and velocity definition in header
Keywords | |
frame |
The desired reference frame for the velocity and frequency values. The list of possible choices can be found in the documentation for frame_velocity. This defaults to the frame currently in use in the plotter. |
veldef |
The velocity definition to use in converting the cursor x position. This must be one of OPTICAL, RADIO or TRUE. This defaults to the veldef currently in use in the plotter. |
nocrosshair |
When set, this function will ensure that the plotter's crosshair is on until the click is received. At that point, the plotter's crosshair will be returned to its state before click was invoked. If not set, the plotters crosshair state will not be changed. |
noshow |
If set, then the plotter will not be brought to the foreground (shown). |
label |
A label to use in the "Left Click:" field of the plotter. Defaults to "Click a Mouse Button". |