PlotText

int PlotText (int panelHandle, int controlID, double xCoordinate, double yCoordinate, char text[], int font, int textColor, int backgroundColor);

Purpose

Plots a text string onto a graph control.

The origin of the text is the lower left corner of the string. You specify the origin of the text in terms of the x- and y-coordinates of the graph.

If the ATTR_SHIFT_TEXT_PLOTS graph attribute is non-zero, the text origin is within the graph area, and the text does not entirely fit within the graph, the text shifts to the left and/or down until it is completely visible. If ATTR_SHIFT_TEXT_PLOTS is zero, the text does not shift.

Parameters

Input
Name Type Description
panelHandle integer Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID integer 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 NewCtrl or DuplicateCtrl.
xCoordinate double-precision Horizontal position at which to place the left edge of the text within the graph. The default value is 0.0.

Normally, the xCoordinate corresponds to the left edge of the text. However, if the text origin is within the graph area and the complete text cannot fit within the plot area, the text shifts to the left until it is completely visible.
yCoordinate double-precision Vertical position at which to place the bottom edge of the text within the graph. The default value is 0.0.

Normally, the yCoordinate corresponds to the bottom edge of the text. However, if the text origin is within the graph area and the complete text cannot fit within the plot area, the text shifts down until it is completely visible.
text string String to plot.
font integer The text font. Refer to the table of predefined metafonts for valid fonts.
textColor integer The color of the plotted text.

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

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.
backgroundColor integer The background color of the plotted text.

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 integer 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.
Code Error Message String
xx Plot handle (success)