Skip to main content

CheckDisplayed

CheckDisplayed [/A/W=winName ] waveName [, waveName ]...

The CheckDisplayed operation determines if named waves are displayed or otherwise used in a host window or subwindow.

Flags

/AChecks all graphs, tables, page layout, panels, and Gizmo windows.
/W=winNameChecks only the named window.
When identifying a subwindow with winName, see Subwindow Syntax for details on forming the window hierarchy.

Details

If neither /A nor /W are used, CheckDisplayed checks only the top graph, table, page layout, panel, or Gizmo window.

CheckDisplayed sets the variable V_flag on a bitwise basis according to which waves are displayed.

Waves that are not directly displayed in a window can still be used by it. For example, CheckDisplayed returns 1 for the following case: waves associated with hidden traces, color index waves, waves used to specify error bars, and waves used to draw polygons including in page layouts and control panels as well as graphs.

Example

// Checks Graph0 to see if aWave, bWave, and cWave are displayed in it.
// Sets bit 0 of V_flag if aWave is displayed.
// Sets bit 1 of V_flag if bWave is displayed.
// Sets bit 2 of V_flag if cWave is displayed.
CheckDisplayed/W=Graph0 aWave,bWave,cWave

See Also

Setting Bit Parameters for details about bit settings.