# Overlay Element (Overlay Text) (G Dataflow)

Version:

Overlays text on an image.

## group name

Group to which you want to add the overlay information.

If no name is specified, the overlay information is added to the default group.

## image in

Reference to the source image.

## origin

Location on the image to overlay the text.

This parameter is dependent on the values of horizontal alignment and vertical alignment.

X-coordinate.

Y-coordinate.

Text to overlay.

## font options

Cluster that enables the user to choose the font, size, style, and alignment of the text.

This cluster contains the following elements:

### Desired Font (Application)

Character type of the text.

The following values are possible:

Name Description
User-specified Font Specify the attributes of a font to use. If no font is specified, the default font is used.
Application Font Uses the application font, which is the font used on the Controls and Functions palettes and on text in new objects on the front panel or block diagram.
System Font Uses the system font, which is the font used in menus.
Dialog Font Uses the dialog font, which is the font used in dialog boxes.

Default: Application Font

### [User-specified Font]

Cluster containing the specific font characteristics for the text to draw.

The specification is ignored unless desired font is set to [user-specified font].

#### Font Name

Font to use for the string.

#### Size

Size of the font in points.

#### Strikeout?

Boolean value that can cause the text to appear in strikeout.

 True Text will appear in strikeout. False Text will not appear in strikeout.

#### Italic?

Boolean value that can cause the text to appear in italic.

 True Text will appear in italic. False Text will not appear in italic.

#### Underline?

Boolean value that can cause the text to appear underlined.

 True Text will appear underlined. False Text will not appear underlined.

#### Outline?

Boolean value that can cause the text to appear in outline.

 True Text will appear in outline. False Text will not appear in outline.

Boolean value that can cause the text to appear in shadow.

 True Text will appear in shadow. False Text will not appear in shadow.

#### Bold?

Boolean value that can cause the text to appear in bold.

 True Text will appear in bold. False Text will not appear in bold.

#### Rotation Angle

Orientation of the text in the image. rotation angle supports rotated text for TrueType fonts only.

### Horizontal Alignment

Horizontal alignment of the text.

The following values are possible:

Name Value Description
Left 0

(Default) Left-aligns the text.

Center 1

Center-aligns the text.

Right 2

Right-aligns the text.

### Vertical Alignment

Vertical alignment of the text.

The following values are possible:

Name Value Description
Bottom 0

(Default) Aligns the text along the bottom.

Top 1

Aligns the text along the top.

Baseline 2

Aligns the text along the baseline.

## error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

## text color

Color of the text.

## background color

Background color of the text overlay.

## image out

Reference to the destination image.

If image dst is connected, image dst out is the same as image dst. Otherwise, image dst out refers to the image referenced by image src.

## error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

## Characteristics of Overlays

Overlays are nondestructive, which means that they do not overwrite the underlying pixel values. You can save overlay information with an image by using the Read Image and Vision Information node. If you want to replace the underlying pixel values with the overlay values, use the Merge Overlay node.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application