View source for VI class/Front Panel.Get Image Scaled method

{{VIServerMethod
| classid = 2
| methodid = 426
| scope=basic
| dataname = FP.Get Image Scaled
| shortname = FP.Get Image Scaled
| longname = Front Panel:Get Image Scaled
| datatypeimage = none
| datatype = No return value
| invokenodeimage = VI-Front Panel-Get Image Scaled.png
| availableinrealtime = Yes
| availableinruntime = Yes (Read/Write)
| availablewithcontrolvis = Yes
| availablewithglobalvis = Yes
| availablewithpolyvis = Yes
| availablewithstricttypedefs = No
| loadsbd = No
| loadsfp = Yes
| mustwait = Yes
| needsauthentication = No
| remoteallowed = Yes
| settablewhenrunning = Yes
|}}
{{TOCright}}
Returns an image of the front panel and scales it proportionally according to the maximum width and height you wire to the method. This method is similar to the [[Front Panel:Get Image]] 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 Scaled 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, wire a [[Property Node]] to 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.
==Parameters==
{| class="wikitable" 
|-
! scope="column" style="text-align:Center;" | Data type
! scope="column" style="text-align:Left;" | Name
! scope="column" style="text-align:Left;" | Required
! scope="column" style="text-align:Left;" | Description
|-
! scope="row" style="text-align:Center;" | [[File:Boolean.png|frameless|border|Boolean|link=Boolean data type]]
| '''Visible Area Only'''
| No 
| 
|-
! scope="row" style="text-align:Center;" | [[File:I32.png|frameless|border|I32|link=I32 data type]]
| '''Image Depth'''
| No 
| Sets 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 <code>8</code>.
|-
! scope="row" style="text-align:Center;" | [[File:Common Cluster TypeDef Indicator.png|frameless|border|Common Cluster TypeDef|link=Common Cluster TypeDef data type]]
| '''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.
|-
! scope="row" style="text-align:Center;" | [[File:I32.png|frameless|border|I32|link=I32 data type]]
| '''Maximum Width'''
| No 
| 
|-
! scope="row" style="text-align:Center;" | [[File:I32.png|frameless|border|I32|link=I32 data type]]
| '''Maximum Height'''
| No 
| 
|}

== Uses ==
{{ambox|text=Specific use cases for this method.}}

== History ==
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
! Version
! Change(s)
|-
|[[File:LV2018.png|frameless|border|64x64px|LabVIEW 2018|link=LabVIEW 2018]]
|More info to come.
|}
== See Also ==
{{ambox|text=Add links to internal wiki pages that would also help.}}

== External Links ==
{{ambox|text=Add links to external resources that would also help.}}

[[Category:VI Server Method]]