int PlotText (int panelHandle, int controlID, double xCoordinate, double yCoordinate, char text[], int font, int textColor, int backgroundColor);
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.
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.
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.
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. |
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.
|