VI class/Front Panel.Get Image method

From LabVIEW Wiki
Jump to: navigation, search
VI Server Method Information
Method ID 423
Scope Basic Development Environment
Data Name FP.Get Image
Short Name* FP.Get Image
Long Name* Front Panel:Get Image
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 2
Owning Class Name VI Class
Return Data Type No return value
Invoke Node Front Panel:Get Image
Available in Real-Time Operating SystemNo
Available in Run-Time EngineYes (Read/Write)
Available with control VIsYes
Available with global VIsYes
Available with polymorphic VIsYes
Available with strict type definitionsNo
Loads the block diagram into memoryNo
Loads the front panel into memoryYes
Must wait until user interface is idleYes
Need to authenticate before useNo
Remote access allowedYes
Settable when the VI is runningYes

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.


Data type Name Required Description
Boolean Visible Area Only No
I32 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.
Common Cluster TypeDef Image Data No 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.



Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links