LabWindows/CVI

Table of Contents
  • LabWindows/CVI Fundamentals
  • Creating Applications
  • Distributing Applications
  • Library Reference
  • Programmer Reference
  • Hardware Information

PlotLine

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.

Value Code
VAL_RED 0xFF0000L
VAL_GREEN 0x00FF00L
VAL_BLUE 0x0000FFL
VAL_CYAN 0x00FFFFL
VAL_MAGENTA 0xFF00FFL
VAL_YELLOW 0xFFFF00L
VAL_DK_RED 0x800000L
VAL_DK_BLUE 0x000080L
VAL_DK_GREEN 0x008000L
VAL_DK_CYAN 0x008080L
VAL_DK_MAGENTA 0x800080L
VAL_DK_YELLOW 0x808000L
VAL_LT_GRAY 0xC0C0C0L
VAL_DK_GRAY 0x808080L
VAL_BLACK 0x000000L
VAL_WHITE 0xFFFFFFL
VAL_PANEL_GRAY 0xC0C0C0L
VAL_GRAY 0xA0A0A0L
VAL_OFFWHITE 0xE0E0E0L
VAL_TRANSPARENT 0x1000000L

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.

Note  If ATTR_DATA_MODE is set to VAL_DISCARD, the function returns 0.

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

Log in to get a better experience