# PlotLine

Plots a line segment in the image.

Inputs

The PlotLine function Functions are tools that are available in Spreadsheet for processing and analyzing acquisitions or other results. You can add functions to your Spreadsheet job to create tool chains and produce results for specific applications. has the following syntax:

PlotLine(Image, X0, Y0, X1, Y1, Name, Color, Show, StartPointAdornment, EndPointAdornment)

See the table for a description of the available parameters:

Parameter | Description
Image | Reference to a cell containing an Image structure. The default value is $A$1.
Line | Specifies the image coordinates of the Line to be plotted.
X 0 | The X coordinate of the first endpoint of the line.
Y 0 | The Y coordinate of the first endpoint of the line.
X 1 | The X coordinate of the second of the line.
Y 1 | The Y coordinate of the second of the line.
Name | Specifies a text label to display with the graphic on the image.
Color | Specifies the color of the plotted graphic. Default: 0x32CD32, LimeGreen; max: 0xFFFFFF. Configure different colors by providing the hexadecimal color code in the formula bar or selecting a color from the color picker on the tool property sheet.
Show | Specifies the display mode for the graphic overlay on the image.
0 = OFF | The graphic is hidden, except when the cell containing the function is highlighted in the spreadsheet.
1 = ON (default) | The graphic is displayed at all times.
Start Point Adornment | Specifies the adornment for the starting point of the line.
0 = None (default)
1 = Arrowhead
End Point Adornment | Specifies the adornment for the ending point of the line.
0 = None (default)
1 = Arrowhead

Outputs

Returns | A Plot data structure containing the graphic.