ProjectItem class/Icon property

From LabVIEW Wiki
Jump to: navigation, search
VI Server Property Information
Property ID 35B53C03
Scope Basic Development Environment
Data Name Icon
Short Name* Icon
Long Name* Icon
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 74
Owning Class Name ProjectItem Class
Data Type Common Cluster TypeDef data type

Common Cluster TypeDef

Property Node Icon
Available in Real-Time Operating SystemNo
Available in Run-Time EngineYes
Loads the block diagram into memoryNo
Loads the front panel into memoryNo
Need to authenticate before useNo
PermissionsRead Only
Remote access allowedYes
Settable when the VI is runningNo

Gets the icon of the project item in the Project Explorer window using the Icon cluster, which limits size and color depth.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
Name Description
Image Type Reserved for future use.
Image Depth Specifies the color depth of the image, which is the number of bits to use to describe the color of each pixel in the image. Valid values include 1, 4, 8, and 24 bits per pixel. Image Depth affects how LabVIEW interprets the values of Image and Colors.
Image A 1-D array of bytes that describes the color of each pixel in the image in raster order. The value of Image Depth determines how LabVIEW interprets the value of this input.

If Image Depth is 24, each pixel has three bytes to describe its color. The first byte for each pixel describes the red value, the second byte describes the green value, and the third byte describes the blue value.

If Image Depth is 8, each pixel has one byte to describe its color. The value of each bit corresponds to an element in Colors, which stores 32-bit RGB values where the most-significant byte is zero, followed in order by red, green, and blue values. Valid values include 0 through 255.

If Image Depth is 4, the behavior is similar to when Image Depth is 8 except valid values in image include 0 through 15.

If Image Depth is 1, any value of zero in Image corresponds to element 0 in Colors. All other values correspond to element 1 in Colors.

Mask An array of bytes in which each bit describes mask information for a pixel. The first byte describes the first eight pixels, the second byte describes the next eight pixels, and so on. If a bit is zero, LabVIEW draws the corresponding pixel as transparent. If the array is empty, LabVIEW draws all pixels without transparency. If the array does not contain a bit for each pixel in the image, LabVIEW draws any pixels missing from the array without transparency.
Colors An array of RGB color values that correspond to the values in image. The value of Image Depth determines how LabVIEW interprets the value of this input.

If Image Depth is 24, LabVIEW ignores this input.

If Image Depth is 8, the array can have 256 elements.

If Image Depth is 4, the array can have 16 elements.

If Image Depth is 1, the array can have 2 elements.

Rectangle A cluster that contains coordinates that describe the bounding rectangle in which you want to draw the image. The VI clips the image to the width and height of the rectangle. The bottom and right edges of the rectangle bounds do not contain image pixels. Horizontal coordinates increase to the right, and vertical coordinates increase to the bottom.
  • Left—The horizontal coordinate of the left edge of the rectangle.
  • Top—The vertical coordinate of the top edge of the rectangle.
  • Right—The horizontal coordinate of the right edge of the rectangle.
  • Bottom—The vertical coordinate of the bottom edge of the rectangle.



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

See Also

External Links