Short Name: FP.Get Image
Requires: Base Development System
Class: VI Methods
To Use: Create a method.
Returns an image of the front panel as a flattened pixmap. Use the Front Panel:Get Image Scaled method to return an image of the front panel and scale it proportionally according to the maximum width and height you wire to the method.
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 Front Panel:Get 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. If you do not want to display the front panel but want the image to reflect value changes, create a Property Node from any 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.
|visible area only||No||Indicates if the front panel image includes just the objects in the visible area of the front panel (TRUE) or all the front panel objects (FALSE). The default is TRUE.|
|Image Depth||No||Indicates the color depth, or number of supported colors, of the image: 1 (1-bit, black and white), 4 (4-bit, 16 colors), 8 (8-bit, 256 colors), or 24 (24-bit, true color). The default is 8.|
|Image Data||Yes||Information about the image so you can use the Draw Flattened Pixmap VI to draw it as a picture or use the Graphics Formats VIs to save the image to a file.
This cluster is similar to the image data output of the Read JPEG File, Read PNG File, and Read BMP File VIs.|
The following table lists the characteristics of this method.
|Data type||No return value|
|Available in Run-Time Engine||Yes (Read/Write)|
|Available in Real-Time Operating System||No|
|Settable when the VI is running||Yes|
|Loads the front panel into memory||Yes|
|Need to authenticate before use||No|
|Loads the block diagram into memory||No|
|Remote access allowed||Yes|
|Must wait until user interface is idle||Yes|
|Available with control VIs||Yes|
|Available with global VIs||Yes|
|Available with strict type definitions||No|
|Available with polymorphic VIs||Yes|