Get Panel Image Method

Inherits from VI Methods.

Returns the panel image as a bitmap and color table. Wire the image, colors, and bounds outputs to the Draw Flattened Pixmap VI to view the front panel image. If a front panel is not visible, LabVIEW does not update the values in the objects on the front panel. If you call a VI whose front panel is not visible and you use the Get Panel Image method to create an image of the front panel, the image does not reflect any value changes that occurred when you ran the VI. If you want the image to reflect value changes, make sure the front panel is open before any values change. You also can wire a Property Node to any front panel terminal on the block diagram of the VI for which you want to create a front panel image. You also can use the Append Front Panel Image to Report VI to create an image of a front panel and append it to a report.

The following table lists the parameters for this method.

ParametersDescription
Visible Area OnlySet whether the Panel image includes just the objects in the visible area of the front panel or all the front panel objects.
image depthSelect the color depth (number of supported colors) of the image: 1 (one-bit, black and white), 4 (four-bit, 16-color), 8 (eight-bit, 256-color), or 24 (24-bit, true-color).
imageReturns the panel image.
colorsSpecifies the colors that appear in the image.
BoundsSets the area of the panel image.

The following table lists the flags for this method.

Is settable when the VI is runningNo
Requires the block diagram to be loadedNo
Is available on local LabVIEW onlyNo
Requires the front panel to be loadedYes
Must wait until user interface is idleYes
Is available with control VIsYes
Is available with global VIsYes
Is available with strict type definitionsNo
Is available with polymorphic VIsYes
Available in Run-Time EngineYes (Read/Write)