PlotLine
- Updated2023-02-21
- 2 minute(s) read
int PlotLine (int panelHandle, int controlID, double x1, double y1, double x2, double y2, int color);
Purpose
Plots a line onto a graph control.
Specify the starting and ending points of the line in terms of x- and y-coordinates of the graph.
Supported Controls
You can use PlotLine with graph controls.
Parameters
| Input | ||||||||||||||||||||||||||||||||||||||||||||
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. | ||||||||||||||||||||||||||||||||||||||||||
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. | ||||||||||||||||||||||||||||||||||||||||||
| x1 | double | Horizontal coordinate of the starting point of the line. | ||||||||||||||||||||||||||||||||||||||||||
| y1 | double | Vertical coordinate of the starting point of the line. | ||||||||||||||||||||||||||||||||||||||||||
| x2 | double | Horizontal coordinate of the ending point of the line. | ||||||||||||||||||||||||||||||||||||||||||
| y2 | double | Vertical coordinate of the ending point of the line. | ||||||||||||||||||||||||||||||||||||||||||
| color | int | Specifies the color of the data to plot. An RGB value is a 4-byte integer with the hexadecimal format 0x00RRGGBB. RR, GG, and BB are the respective red, green, and blue components of the color value. The first sixteen colors in the table are the sixteen standard colors.
You also can use the User Interface Library function, MakeColor, to create an RGB value from red, green, and blue color components. To enter user-defined color values, select Options»Toggle Control Style in the function panel and manually enter the color value. |
||||||||||||||||||||||||||||||||||||||||||
Return Value
| Name | Type | Description | ||
| plotHandle | int | The handle of the new plot that you can use in subsequent function calls to reference the plot. If the handle is positive, the new plot was successfully added to the graph. Negative values indicate that an error occurred.
|
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later
Examples
Refer to the following examples that use the PlotLine function:
- userint\canvsbmk.cws
Open example - userint\graphlegend.cws
Open example