xy_axis_assign_method_get | (axis_name, method) |
Description: | ||
This function gets the labels assignment method. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
STRING | method[20] | This value returns the labels assignment method for the specified axis. This value can return “automatic”, “manual”, “semiauto”, and “range”. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_assign_method_set | (axis_name, method) |
Description: | ||
This function sets the labels assignment method. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
STRING | method[20] | This value specifies the label assignment method to be used for the specified axis. This value can be set to “automatic”, “manual”, “semiauto”, and “range”. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
10000307 | The specified assignment method for the axis is invalid. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_color_get | (axis_name, color_index) |
Description: | ||
This function gets the axis color index. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
INTEGER | color_index | This value returns the color index for the specified axis. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_color_set | (axis_name, color_index) |
Description: | ||
This function sets the axis color index. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
INTEGER | color_index | This value specifies the color index for the specified axis. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000010 | The color index has returned an invalid value. | |
10000302 | A current axis has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
Color Value | Color Description | Color Value | Color Description |
0 | Black | 8 | Dark Orange |
1 | Red | 9 | Light Orange |
2 | Light Green | 10 | Dark Green |
3 | Yellow | 11 | Green |
4 | Blue | 12 | Dark Blue |
5 | Dark Cyan | 13 | Light Blue |
6 | Lightest Blue | 14 | Cyan |
7 | white | 15 | Light Cyan |
xy_axis_display_labels_get | (axis_name, label_flag) |
Description: | ||
This function gets the display labels flag. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
LOGICAL | label_flag | This value returns the display labels flag. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_display_labels_set | (axis_name, label_flag) |
Description: | ||
This function sets the display labels flag. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
LOGICAL | label_flag | This value specifies the display labels flag. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
10000305 | The specified axis display flag is invalid. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_display_title_get | (axis_name, title_flag) |
Description: | ||
This function gets the display title flag. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
LOGICAL | title_flag | This value returns the display title flag. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_display_title_set | (axis_name, title_flag) |
Description: | ||
This function sets the display title flag. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
LOGICAL | title_flag | This value specifies the display title flag. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_grid_display_get | (axis_name, grid_type) |
Description: | ||
This function gets the grid display type. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
STRING | grid_type[31] | This value returns the grid display type for the specified axis. The following values can be returned: “Primary”, “Secondary”, “PrimarySecondary”, “Both”, or “None”. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_grid_display_set | (axis_name, grid_type) |
Description: | ||
This function sets the grid display type. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
STRING | grid_type[31] | This value specifies the grid display type for the specified axis. This value can be set to “Primary”, “Secondary”, “PrimarySecondary”, “Both”, or “None”. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
10000500 | The specified display type for grid lines is invalid. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_grid_get | (axis_name, prim_sec, curve_style, thickness, color_index) |
Description: | ||
This function gets the grid line attributes. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
STRING | prim_sec[31] | This value specifies the primary or secondary grid line. This value can be set to “Primary”, “Secondary”, “PrimarySecondary”, or “Both”. |
Output: | ||
STRING | curve_style[31] | This value returns the grid line curve style. This value can return “Solid”, “Dotted”, “DotDash”, “ShortDash”, “LongDash”, or “OddDash”. |
INTEGER | thickness | This value returns the grid line thickness. |
INTEGER | color_index | This value returns the grid line color. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_grid_set | (axis_name, prim_sec, curve_style, thickness, color_index) |
Description: | ||
This function sets the grid line attributes. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
STRING | prim_sec[31] | This value specifies the primary or secondary grid line. This value can be set to “Primary”, “Secondary”, “PrimarySecondary”, or “Both”. |
STRING | curve_style[31] | This value specifies the grid line curve style. This value can be set to: “Solid”, “Dotted”, “DotDash”, “ShortDash”, “LongDash”, or “OddDash”. |
INTEGER | thickness | This value specifies the grid line thickness. This value must be greater than 0 and less than 51. |
INTEGER | color_index | This value specifies the grid line color. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000010 | The color index has returned an invalid value. | |
10000013 | Invalid option given to XY routine. | |
10000201 | The specified line style is invalid. Please choose another from the option menu. | |
10000302 | A current axis has not been defined. | |
10000501 | The specified thickness for grid lines is invalid. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
Color Value | Color Description | Color Value | Color Description |
0 | Black | 8 | Dark Orange |
1 | Red | 9 | Light Orange |
2 | Light Green | 10 | Dark Green |
3 | Yellow | 11 | Green |
4 | Blue | 12 | Dark Blue |
5 | Dark Cyan | 13 | Light Blue |
6 | Lightest Blue | 14 | Cyan |
7 | white | 15 | Light Cyan |
xy_axis_label_color_get | (axis_name, label_color) |
Description: | ||
This function gets the label color index. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
INTEGER | label_color | This value returns the label color index for the specified axis. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_label_color_set | (axis_name, label_color) |
Description: | ||
This function sets the label color index. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name |
INTEGER | label_color | This value specifies the label color index for the specified axis. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000010 | The color index has returned an invalid value. | |
10000302 | A current axis has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
Color Value | Color Description | Color Value | Color Description |
0 | Black | 8 | Dark Orange |
1 | Red | 9 | Light Orange |
2 | Light Green | 10 | Dark Green |
3 | Yellow | 11 | Green |
4 | Blue | 12 | Dark Blue |
5 | Dark Cyan | 13 | Light Blue |
6 | Lightest Blue | 14 | Cyan |
7 | white | 15 | Light Cyan |
xy_axis_label_format_get | (axis_name, label_format) |
Description: | ||
This function gets the label format value. (float, exponential, integer, power). | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
STRING | label_format[31] | This value returns the label format for the specified axis. This value can return “Fixed”, “Exponential”, “Integer”, or “Power”. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_label_format_set | (axis_name, label_format) |
Description: | ||
This function sets the label format (float, exponential, integer). | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
STRING | label_format[31] | This value specifies the label format for the specified axis. This value can be set to: “Fixed”, “Exponential”, “Integer”, or “Power”. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
10000310 | The specified label format for the axis is invalid. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_label_type_get | (axis_name, label_type) |
Description: | ||
This function gets the label type (linear/logarithm). | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
STRING | label_type[31] | This value returns the label type for the specified axis. This value can return “Linear” or “Logarithmic”. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_label_type_set | (axis_name, label_type) |
Description: | ||
This function sets the label type (linear/logarithm). | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
STRING | label_type[31] | This value specifies the label type for the specified axis. This value can be set to “Linear”, or “Logarithmic”. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
10000308 | The specified label type for the axis is invalid. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_labels_get | (axis_name, labels) |
Description: | ||
This function gets the labels for the specified axis. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
REAL | labels() | This value returns an array of labels for the specified axis. This array must be allocated with enough offsets to contain the entire list. Use the function xy_axis_labels_get_count() to get the number of offsets required. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_labels_get_count | (axis_name, nlabels) |
Description: | ||
This function gets the number of labels defined for the specified axis. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
INTEGER | nlabels | This value returns the number of labels defined for the specified axis. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_labels_set | (axis_name, labels) |
Description: | ||
This function sets the labels for the specified axis. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
REAL | labels() | This value specifies an array of labels for the specified axis. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_linestyle_get | (axis_name, line_style) |
Description: | ||
This function gets the axis line style. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
STRING | line_style[30] | This value returns the curve style for the specified axis. This value can return “Solid”, “Dotted”, “DotDash”, “ShortDash”, “LongDash”, or “OddDash”. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_linestyle_set | (axis_name, line_style) |
Description: | ||
This function sets the axis line style. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
STRING | line_style[30] | This value specifies the curve style for the specified axis. This value can be set to: “Solid”, “Dotted”, “DotDash”, “ShortDash”, “LongDash”, or “OddDash”. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000201 | The specified line style is invalid. Please choose another from the option menu. | |
10000302 | A current axis has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_location_get | (axis_name, display_location) |
Description: | ||
This function gets the display location. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
STRING | display_location[16] | This value returns the location of the axis. This value can return “TopBottom”, “Top”, “Bottom”, “LeftRight”, “Left”, “Right”, or “None”. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_location_set | (axis_name, display_location) |
Description: | ||
This function sets the display location. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
STRING | display_location[16] | This value specifies the location of the axis. This value can be set to “TopBottom”, “Top”, “Bottom”, “LeftRight”, “Left”, “Right”, or “None”. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
10000304 | The specified axis display location is invalid. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_nvalues_get | (axis_name, num_vals) |
Description: | ||
This function gets the number of values for the specified axis. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
INTEGER | num_vals | This value returns the number of values for the specified axis. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_nvalues_set | (axis_name, num_vals) |
Description: | ||
This function sets the number of values for the specified axis. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
INTEGER | num_vals | This value specifies the number of values for the specified axis. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
10000306 | The specified number of values for the axis is invalid. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_sig_digits_get | (axis_name, sig_digits) |
Description: | ||
This function gets the number of significant digits. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
INTEGER | sig_digits | This value returns the number of significant digits for the specified axis. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_sig_digits_set | (axis_name, sig_digits) |
Description: | ||
This function sets the number of significant digits. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
INTEGER | sig_digits | This value specifies the number of significant digits for the specified axis. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_thickness_get | (axis_name, thickness) |
Description: | ||
This function gets the axis thickness. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
INTEGER | thickness | This value returns the axis thickness. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_thickness_set | (axis_name, thickness) |
Description: | ||
This function sets the axis thickness. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
INTEGER | thickness | This value specifies the axis thickness. This value must be greater than 0 and less than 101. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
10000303 | The specified thickness for the axis is invalid. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_tic_display_get | (axis_name, ticmark_type) |
Description: | ||
This function gets the ticmark display type (none/primary/secondary). | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
STRING | ticmark_type[31] | This value returns the ticmark display type for the specified axis. The value returned can be “Primary”, “Secondary”, “PrimarySecondary”, or “None”. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_tic_display_set | (axis_name, ticmark_type) |
Description: | ||
This function sets the ticmark display type. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
STRING | ticmark_type[31] | This value specifies the ticmark display type for the specified axis. This value can be set to “Primary”, “Secondary”, “PrimarySecondary”, or “None”. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
10000309 | The specified display type for the axis is invalid. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_tic_get | (axis_name, prim_sec, location, thickness, color_index) |
Description: | ||
This function gets the ticmark attributes. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
STRING | prim_sec[31] | This value specifies the primary or secondary ticmark. This value can be set to “Primary”, “Secondary”, or “Both”. |
Output: | ||
STRING | location[31] | This value returns the location of the ticmark. This value can return “Inside”, or “Outside”. |
INTEGER | thickness | This value returns the ticmark thickness. This value should be greater than 0 and less than 51. |
INTEGER | color_index | This value returns the ticmark color. See the remarks below for more information. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
Color Value | Color Description | Color Value | Color Description |
0 | Black | 8 | Dark Orange |
1 | Red | 9 | Light Orange |
2 | Light Green | 10 | Dark Green |
3 | Yellow | 11 | Green |
4 | Blue | 12 | Dark Blue |
5 | Dark Cyan | 13 | Light Blue |
6 | Lightest Blue | 14 | Cyan |
7 | white | 15 | Light Cyan |
xy_axis_tic_numsec_get | (axis_name, num_sec_tick) |
Description: | ||
This function gets the number of secondary ticmarks. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
INTEGER | num_sec_tick | This value returns the number of secondary ticmarks found. This value should be greater than 0 and less than 51. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
13000064 | XY axis not found |
xy_axis_tic_numsec_set | (axis_name, num_sec_tick) |
Description: | ||
This function sets the number of secondary ticmarks. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
INTEGER | num_sec_tick | This value specifies the number of secondary ticmarks. This value should be greater than 0 and less than 51. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000302 | A current axis has not been defined. | |
10000400 | The specified number of ticmarks for the axis is invalid. 50 > number_of_ticmarks > 1. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
xy_axis_tic_set | (axis_name, prim_sec, location, thickness, color_index) |
Description: | ||
This function sets the ticmark attributes. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
STRING | prim_sec[] | This value specifies the primary or secondary ticmark. |
STRING | location[] | This value specifies the location of the ticmark. |
INTEGER | thickness | This value specifies the ticmark thickness. |
INTEGER | color_index | This value specifies the ticmark color. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000010 | The color index has returned an invalid value. | |
10000013 | Invalid option given to XY routine. | |
10000302 | A current axis has not been defined. | |
10000303 | The specified thickness for the axis is invalid. | |
10000304 | The specified axis display location is invalid. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
Color Value | Color Description | Color Value | Color Description |
0 | Black | 8 | Dark Orange |
1 | Red | 9 | Light Orange |
2 | Light Green | 10 | Dark Green |
3 | Yellow | 11 | Green |
4 | Blue | 12 | Dark Blue |
5 | Dark Cyan | 13 | Light Blue |
6 | Lightest Blue | 14 | Cyan |
7 | white | 15 | Light Cyan |
xy_axis_title_get | (axis_name, title, font_size, title_color) |
Description: | ||
This function gets the title attributes. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
Output: | ||
STRING | title[256] | This value returns the title text for the specified axis. |
INTEGER | font_size | This value returns the font size of the title text. This value will be set to 8, 10, 12, 14, 18, or 24. |
INTEGER | title_color | This value returns the title color for the specified axis. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000013 | Invalid option given to XY routine. | |
13000064 | XY axis not found |
xy_axis_title_set | (axis_name, title, font_size, title_color) |
Description: | ||
This function sets the title attributes. | ||
Input: | ||
STRING | axis_name[31] | This value specifies the axis name. |
STRING | title[256] | This value specifies the title text for the specified axis. |
INTEGER | font_size | This value specifies the font size of the title text. |
INTEGER | title_color | This value specifies the title color for the specified axis. See the remarks below for more information. This value can be set to 8, 10, 12, 14, 18, or 24. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000006 | The XY font name typed in is invalid. Please input a valid font name. | |
10000009 | The specified text is invalid. Please input a valid text string. | |
10000010 | The color index has returned an invalid value. | |
10000013 | Invalid option given to XY routine. | |
13000004 | Duplicate entry exists in table | |
13000064 | XY axis not found | |
13000214 | No corresponding message available |
Color Value | Color Description | Color Value | Color Description |
0 | Black | 8 | Dark Orange |
1 | Red | 9 | Light Orange |
2 | Light Green | 10 | Dark Green |
3 | Yellow | 11 | Green |
4 | Blue | 12 | Dark Blue |
5 | Dark Cyan | 13 | Light Blue |
6 | Lightest Blue | 14 | Cyan |
7 | white | 15 | Light Cyan |
xy_curve_color_get | (curve_name, color_index) |
Description: | ||
This function gets the curve color index. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
INTEGER | color_index | This value returns the color index for the specified curve. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_color_set | (curve_name, color_index) |
Description: | ||
This function sets the curve color index. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
INTEGER | color_index | This value specifies the color index for the specified curve. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000010 | The color index has returned an invalid value. | |
10000104 | A current curve has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
Color Value | Color Description | Color Value | Color Description |
0 | Black | 8 | Dark Orange |
1 | Red | 9 | Light Orange |
2 | Light Green | 10 | Dark Green |
3 | Yellow | 11 | Green |
4 | Blue | 12 | Dark Blue |
5 | Dark Cyan | 13 | Light Blue |
6 | Lightest Blue | 14 | Cyan |
7 | white | 15 | Light Cyan |
xy_curve_display_symbol_get | (curve_name, symbol_flag) |
Description: | ||
This function gets the display symbol flag. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
LOGICAL | symbol_flag | This value returns the display symbol flag. This value will be set to TRUE if the curve symbols are to be displayed, FALSE if they are not. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_display_symbol_set | (curve_name, symbol_flag) |
Description: | ||
This function sets display symbol flag. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
LOGICAL | symbol_flag | This value specifies, when set to TRUE, that the curve symbols should be displayed, FALSE if they are not. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_endpt_get | (curve_name, end_point) |
Description: | ||
This function gets the last data point to be displayed. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
INTEGER | end_point | This value returns the end point for the specified curve. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_endpt_set | (curve_name, end_point) |
Description: | ||
This function sets the last data point to be displayed. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
INTEGER | end_point | This value specifies the end point for the specified curve. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
10000107 | The specified ending point is invalid. Please input another ending point in the databox. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_freq_get | (curve_name, frequency) |
Description: | ||
This function gets the display frequency of data points for the curve. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
INTEGER | frequency | This value returns the display frequency value for the specified curve. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_freq_set | (curve_name, frequency) |
Description: | ||
This function sets the display frequency of data points for the curve. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
INTEGER | frequency | This value specifies the display frequency value for the specified curve. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
10000108 | The specified frequency is invalid. Please input another frequency in the databox. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_func_get | (curve_name, fit_function) |
Description: | ||
This function gets the curve fit function. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
STRING | fit_function[30] | This value returns the curve fit function. This value can return “Linear”, “Scatter”, “Spline”, or “LeastSquares”. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_func_set | (curve_name, fit_function) |
Description: | ||
This function sets the curve fit function. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
STRING | fit_function[30] | This value specifies the curve fit function. This value can be set to “Linear”, “Scatter”, “Spline”, or “LeastSquares”. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
10000200 | The specified fit function is invalid. Please choose another. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_linestyle_get | (curve_name, curve_style) |
Description: | ||
This function gets the curve style. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
STRING | curve_style[31] | This value returns the curve style. This value can return “Solid”, “Dotted”, “DotDash”, “ShortDash”, “LongDash”, or “OddDash”. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_linestyle_set | (curve_name, curve_style) |
Description: | ||
This function sets the curve style. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
STRING | curve_style[31] | This value specifies the curve style. This value can be set to “Solid”, “Dotted”, “DotDash”, “ShortDash”, “LongDash”, or “OddDash”. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
10000201 | The specified line style is invalid. Please choose another from the option menu. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_nlppc_get | (curve_name, num_line_seg) |
Description: | ||
This function gets the number of curves per parametric cubic for least squares fit. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
INTEGER | num_line_seg | This value returns the number of line segments generated per parametric cubic curve. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_nlppc_set | (curve_name, num_line_seg) |
Description: | ||
This function sets the number of curves per parametric cubic for least squares fit. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
INTEGER | num_line_seg | This value specifies the number of line segments generated per parametric cubic curve. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_num_pc_get | (curve_name, num_curves) |
Description: | ||
This function gets the number of parametric cubic curves. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
INTEGER | num_curves | This value returns the number of parametric cubic curves generated. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_num_pc_set | (curve_name, num_curves) |
Description: | ||
This function sets the number of parametric cubic curves. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
INTEGER | num_curves | This value specifies the number of parametric cubic curves to generate. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_rename | (curve_name, new_name) |
Description: | ||
This function renames a curve. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the current name of the curve. |
STRING | new_name[] | This value specifies the new name to be assigned. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000102 | The specified curve name is invalid. | |
10000104 | A current curve has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_startpt_get | (curve_name, start_point) |
Description: | ||
This function gets the first data point to be displayed. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
INTEGER | start_point | This value returns the start point for the specified curve. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_startpt_set | (curve_name, start_point) |
Description: | ||
This function sets the first data point to be displayed. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
INTEGER | start_point | This value specifies the start point for the specified curve. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
10000106 | The specified starting point is invalid. Please input another starting point in the databox. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_symbol_color_get | (curve_name, symbol_color) |
Description: | ||
This function gets the symbol color. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
INTEGER | symbol_color | This value returns the symbol color for the specified curve. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_symbol_color_set | (curve_name, symbol_color) |
Description: | ||
This function sets symbol color. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name |
INTEGER | symbol_color | This value specifies the symbol color for the specified curve. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
Color Value | Color Description | Color Value | Color Description | |
0 | Black | 8 | Dark Orange | |
1 | Red | 9 | Light Orange | |
2 | Light Green | 10 | Dark Green | |
3 | Yellow | 11 | Green | |
4 | Blue | 12 | Dark Blue | |
5 | Dark Cyan | 13 | Light Blue | |
6 | Lightest Blue | 14 | Cyan | |
7 | white | 15 | Light Cyan |
xy_curve_symbol_get | (curve_name, symbol) |
Description: | ||
This function gets the symbol. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
STRING | symbol[30] | This value returns the symbol for the specified curve. See the remarks below for more information. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
“Dot” | “Circle” | “FillCircle” | |
“X” | “Plus” | “Square” | |
“Fillsquare” | “Triangle” | “FillTriangle” | |
”Diamond” | “FillDiamond” | “Arrowhead” | |
“FillArrowhead” | “Hexagon” | “FillHexagon” |
xy_curve_symbol_set | (curve_name, symbol) |
Description: | ||
This function sets the symbol. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
STRING | symbol[30] | This value specifies the symbol for the specified curve. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
10000109 | The specified symbol is invalid. Please choose another symbol from the option menu. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
“Dot” | “Circle” | “FillCircle” | |
“X” | “Plus” | “Square” | |
“Fillsquare” | “Triangle” | “FillTriangle” | |
”Diamond” | “FillDiamond” | “Arrowhead” | |
“FillArrowhead” | “Hexagon” | “FillHexagon” |
xy_curve_symbol_size_get | (curve_name, symbol_size) |
Description: | ||
This function gets the symbol size. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
INTEGER | symbol_size | This value returns the symbol size for the specified curve. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_symbol_size_set | (curve_name, symbol_size) |
Description: | ||
This function sets symbol size. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
INTEGER | symbol_size | This value specifies the symbol size for the specified curve. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_text_get | (curve_name, text, text_color) |
Description: | ||
This function gets the text attributes. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
STRING | text[256] | This value returns the text for the specified curve. |
INTEGER | text_color | This value returns the color index of the text. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_text_set | (curve_name, text, text_color) |
Description: | ||
This function sets the text attributes. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
STRING | text[256] | This value specifies the text for the specified curve. |
INTEGER | text_color | This value specifies the color index of the text. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000009 | The specified text is invalid. Please input a valid text string. | |
10000010 | The color index has returned an invalid value. | |
10000104 | A current curve has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
Color Value | Color Description | Color Value | Color Description |
0 | Black | 8 | Dark Orange |
1 | Red | 9 | Light Orange |
2 | Light Green | 10 | Dark Green |
3 | Yellow | 11 | Green |
4 | Blue | 12 | Dark Blue |
5 | Dark Cyan | 13 | Light Blue |
6 | Lightest Blue | 14 | Cyan |
7 | white | 15 | Light Cyan |
xy_curve_thickness_get | (curve_name, thickness) |
Description: | ||
This function gets the curve thickness. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
INTEGER | thickness | This value returns the curve thickness. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_thickness_set | (curve_name, thickness) |
Description: | ||
This function sets the curve thickness. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
INTEGER | thickness | This value specifies the curve thickness. This value must be greater than 0 and less than 51. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
10000202 | The specified curve thickness is invalid. Please choose another from the slider. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_xdelta_get | (curve_name, x_delta) |
Description: | ||
This function gets the value of X increment to use when only Y data has been given. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
REAL | x_delta | This value returns the X increment value to use when only Y data is given. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_xdelta_set | (curve_name, x_delta) |
Description: | ||
This function sets the value of X increment to use when only Y data has been given. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
REAL | x_delta | This value specifies the X increment value to use when only Y data is given. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_xinit_get | (curve_name, x_init) |
Description: | ||
This function gets the initial value of X to use as data for curve when only Y data has been given. If X,Y pairs are given, then this value will not be used. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
REAL | x_init | This value returns the X initial value to use when only Y data is given. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_xinit_set | (curve_name, x_init) |
Description: | ||
This function sets the initial value of X to use as data for curve when only Y data has been given. If X,Y pairs are given, then this value will not be used. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
REAL | x_init | This value specifies the X initial value to use when only Y data is given. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_xscale_get | (curve_name, x_factor) |
Description: | ||
This function gets the X scale factor. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
REAL | x_factor | This value returns the X scale factor for the specified curve. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_xscale_set | (curve_name, x_factor) |
Description: | ||
This function sets the X scale factor. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
REAL | x_factor | This value specifies the X scale factor for the specified curve. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_curve_yscale_get | (curve_name, y_factor) |
Description: | ||
This function gets the Y scale factor. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
Output: | ||
REAL | y_factor | This value returns the Y scale factor for the specified curve. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000067 | XY curve not found |
xy_curve_yscale_set | (curve_name, y_factor) |
Description: | ||
This function sets the Y scale factor. | ||
Input: | ||
STRING | curve_name[31] | This value specifies the curve name. |
REAL | y_factor | This value specifies the Y scale factor for the specified curve. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000104 | A current curve has not been defined. | |
13000004 | Duplicate entry exists in table | |
13000067 | XY curve not found |
xy_legend_attrib_get | (location, width, height, bgcolor) |
Description: | ||
This function gets the legend attributes. | ||
Input: | ||
None. | ||
Output: | ||
REAL | location(2) | This value returns the location of the legend. Offset 1 will specify the X location and offset 2 will specify the Y location. These values can range from 0.0 to 100.0. |
REAL | width | This value returns the width of the legend. |
REAL | height | This value returns the height of the legend. |
INTEGER | bgcolor | This value returns the background color of the legend. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000705 | There is no current window specified. | |
13000063 | XY window not found | |
13000065 | XY legend not found |
xy_legend_attrib_set | (location, width, height, bgcolor) |
Description: | ||
This function sets the legend attributes. | ||
Input: | ||
REAL | location(2) | This value specifies the location of the legend. Offset 1 will specify the X location and offset 2 will specify the Y location. These values can range from 0.0 to 100.0. |
REAL | width | This value specifies the width of the legend. |
REAL | height | This value specifies the height of the legend. |
INTEGER | bgcolor | This value specifies the background color of the legend. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000007 | The X and Y location must both be in %. This is a percentage of the XY window from the top left corner. Please input valid X and Y locations. | |
10000010 | The color index has returned an invalid value. | |
10000705 | There is no current window specified. | |
13000004 | Duplicate entry exists in table | |
13000063 | XY window not found | |
13000065 | XY legend not found |
Color Value | Color Description | Color Value | Color Description | |
0 | Black | 8 | Dark Orange | |
1 | Red | 9 | Light Orange | |
2 | Light Green | 10 | Dark Green | |
3 | Yellow | 11 | Green | |
4 | Blue | 12 | Dark Blue | |
5 | Dark Cyan | 13 | Light Blue | |
6 | Lightest Blue | 14 | Cyan | |
7 | white | 15 | Light Cyan |
xy_legend_border_get | (style, border_color) |
Description: | ||
This function gets the border attributes. | ||
Input: | ||
None. | ||
Output: | ||
STRING | style[30 | This value returns the curve style of the legend. This value can return “Solid”, “Dotted”, “DotDash”, “ShortDash”, “LongDash”, or “OddDash”. |
INTEGER | border_color | This value returns the border color index of the legend. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
13000063 | XY window not found | |
13000065 | XY legend not found |
xy_legend_border_set | (style, border_color) |
Description: | ||
This function sets the border attributes. | ||
Input: | ||
STRING | style[30] | This value specifies the curve style of the legend. This value can be set to “Solid”, “Dotted”, “DotDash”, “ShortDash”, “LongDash”, or “OddDash”. |
INTEGER | border_color | This value specifies the border color index of the legend. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000010 | The color index has returned an invalid value. | |
10000201 | The specified line style is invalid. Please choose another from the option menu. | |
13000004 | Duplicate entry exists in table | |
13000063 | XY window not found | |
13000065 | XY legend not found |
Color Value | Color Description | Color Value | Color Description | |
0 | Black | 8 | Dark Orange | |
1 | Red | 9 | Light Orange | |
2 | Light Green | 10 | Dark Green | |
3 | Yellow | 11 | Green | |
4 | Blue | 12 | Dark Blue | |
5 | Dark Cyan | 13 | Light Blue | |
6 | Lightest Blue | 14 | Cyan | |
7 | white | 15 | Light Cyan |
xy_legend_display_border_get | (border_flag) |
Description: | ||
This function gets the display border flag. | ||
Input: | ||
None. | ||
Output: | ||
LOGICAL | border_flag | This value returns the display border status value. When this value is set to TRUE, the display border for the legend will be shown. If this value is set to FALSE, the display border for the legend will not be shown. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
13000063 | XY window not found | |
13000065 | XY legend not found |
xy_legend_display_border_set | (border_flag) |
Description: | ||
This function sets the display border flag. | ||
Input: | ||
LOGICAL | border_flag | This value specifies, when set to TRUE that the display border for the legend will be shown. If this value is set to FALSE, the display border for the legend will not be shown. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
13000004 | Duplicate entry exists in table | |
13000063 | XY window not found | |
13000065 | XY legend not found |
xy_legend_display_get | (legend_flag) |
Description: | ||
This function gets the display legend flag. | ||
Input: | ||
None. | ||
Output: | ||
LOGICAL | legend_flag | This value returns the display legend status value. When this value is set to TRUE, the display legend will be shown. If this value is set to FALSE, the display legend will not be shown. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
13000063 | XY window not found | |
13000065 | XY legend not found |
xy_legend_display_set | (legend_flag) |
Description: | ||
This function sets the display legend flag. | ||
Input: | ||
LOGICAL | legend_flag | This value specifies, when set to TRUE that the display legend will be shown. If this value is set to FALSE, the display legend will not be shown. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
13000004 | Duplicate entry exists in table | |
13000063 | XY window not found | |
13000065 | XY legend not found |
xy_legend_display_title_get | (title_flag) |
Description: | ||
This function gets the display title flag. | ||
Input: | ||
None. | ||
Output: | ||
LOGICAL | title_flag | This value returns the display title flag for the legend. When this value is set to TRUE, the display legend title will be shown. If this value is set to FALSE, the display legend title will not be shown. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
13000063 | XY window not found | |
13000065 | XY legend not found |
xy_legend_display_title_set | (title_flag) |
Description: | ||
This function sets the display title flag. | ||
Input: | ||
LOGICAL | title_flag | This value specifies, when set to TRUE that the display legend title will be shown. If this value is set to FALSE, the display legend title will not be shown. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
13000004 | Duplicate entry exists in table | |
13000063 | XY window not found | |
13000065 | XY legend not found |
xy_legend_text_get | (legend_text, text_color) |
Description: | ||
This function gets the text attributes for the legend. | ||
Input: | ||
None. | ||
Output: | ||
STRING | legend_text[256] | This value returns the text for the legend. |
INTEGER | text_color | This value returns the color index of the text. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
13000063 | XY window not found | |
13000065 | XY legend not found |
xy_legend_text_set | (legend_text, text_color) |
Description: | ||
This function sets the text attributes for the legend. | ||
Input: | ||
STRING | legend_text[256] | This value specifies the text for the legend. |
INTEGER | text_color | This value specifies the color index of the text. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000009 | The specified text is invalid. Please input a valid text string. | |
10000010 | The color index has returned an invalid value. | |
13000004 | Duplicate entry exists in table | |
13000063 | XY window not found | |
13000065 | XY legend not found |
Color Value | Color Description | Color Value | Color Description |
0 | Black | 8 | Dark Orange |
1 | Red | 9 | Light Orange |
2 | Light Green | 10 | Dark Green |
3 | Yellow | 11 | Green |
4 | Blue | 12 | Dark Blue |
5 | Dark Cyan | 13 | Light Blue |
6 | Lightest Blue | 14 | Cyan |
7 | white | 15 | Light Cyan |
xy_title_current_set | (title_name) |
Description: | ||
This function sets the current title. | ||
Input: | ||
STRING | title_name[256] | This value specifies the current title name. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000005 | The specified XY title name is invalid. Please Input a valid title name that is 31 characters or less and contains no embedded blanks. | |
13000068 | XY title not found |
xy_title_font_get | (title_name, font_size) |
Description: | ||
This function gets the text font size. | ||
Input: | ||
STRING | title_name[256] | This value specifies the title name. |
Output: | ||
INTEGER | font_size | This value returns the font size of the specified title. This value can return 8, 10, 12, 14, 18, or 24. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000101 | The specified title does not exist in the database. | |
13000068 | XY title not found |
xy_title_font_set | (title_name, font_size) |
Description: | ||
This function sets the text font size. | ||
Input: | ||
STRING | title_name[256] | This value specifies the title name. |
INTEGER | font_size | This value specifies the font size of the specified title. This value can be set to 8, 10, 12, 14, 18, or 24. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000006 | The XY font name typed in is invalid. Please input a valid font name. | |
10000101 | The specified title does not exist in the database. | |
13000004 | Duplicate entry exists in table | |
13000068 | XY title not found |
xy_title_rename | (title_name, new_name) |
Description: | ||
This function renames a title. | ||
Input: | ||
STRING | title_name[] | This value specifies the current name of the title. |
STRING | new_name[] | This value specifies the new name to be assigned. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000005 | The specified XY title name is invalid. Please Input a valid title name that is 31 characters or less and contains no embedded blanks. | |
10000100 | There is no current title defined. | |
13000004 | Duplicate entry exists in table | |
13000068 | XY title not found |
xy_title_text_get | (title_name, text, location, text_color) |
Description: | ||
This function gets the text attributes. | ||
Input: | ||
STRING | title_name[256] | This value specifies the title name. |
Output: | ||
STRING | text[256] | This value returns the text of the specified title. |
REAL | location(2) | This value returns the location of the text. Offset 1 will specify the X location and offset 2 will specify the Y location. These values can range from 0.0 to 100.0. |
INTEGER | text_color | This value returns the color index of the text. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000101 | The specified title does not exist in the database. | |
13000068 | XY title not found |
xy_title_text_set | (title_name, text, location, text_color) |
Description: | ||
This function sets the text attributes. | ||
Input: | ||
STRING | title_name[256] | This value specifies the title name. |
STRING | text[256] | This value specifies the text of the specified title. |
REAL | location(2) | This value specifies the location where the text is to be placed. Offset 1 will specify the X location and offset 2 will specify the Y location. These values can range from 1.0 to 100.0. |
INTEGER | text_color | This value specifies the color index of the text. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000007 | The X and Y location must both be in %. This is a percentage of the XY window from the top left corner. Please input valid X and Y locations. | |
10000009 | The specified text is invalid. Please input a valid text string. | |
10000010 | The color index has returned an invalid value. | |
10000101 | The specified title does not exist in the database. | |
13000004 | Duplicate entry exists in table | |
13000068 | XY title not found |
Color Value | Color Description | Color Value | Color Description |
0 | Black | 8 | Dark Orange |
1 | Red | 9 | Light Orange |
2 | Light Green | 10 | Dark Green |
3 | Yellow | 11 | Green |
4 | Blue | 12 | Dark Blue |
5 | Dark Cyan | 13 | Light Blue |
6 | Lightest Blue | 14 | Cyan |
7 | white | 15 | Light Cyan |
xy_window_background_color_get | (window_name, bgcolor) |
Description: | ||
This function gets the graph background color. | ||
Input: | ||
STRING | window_name[31] | This value specifies the window name. |
Output: | ||
INTEGER | bgcolor | This value returns the background color for the specified window. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000705 | There is no current window specified. | |
13000063 | XY window not found |
xy_window_background_color_set | (window_name, bgcolor) |
Description: | ||
This function sets the graph background color. | ||
Input: | ||
STRING | window_name[31] | This value specifies the window name. |
INTEGER | bgcolor | This value specifies the background color for the specified window. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000705 | There is no current window specified. | |
13000004 | Duplicate entry exists in table | |
13000063 | XY window not found |
Color Value | Color Description | Color Value | Color Description |
0 | Black | 8 | Dark Orange |
1 | Red | 9 | Light Orange |
2 | Light Green | 10 | Dark Green |
3 | Yellow | 11 | Green |
4 | Blue | 12 | Dark Blue |
5 | Dark Cyan | 13 | Light Blue |
6 | Lightest Blue | 14 | Cyan |
7 | white | 15 | Light Cyan |
xy_window_border_color_get | (window_name, border_color) |
Description: | ||
This function gets the display border color. | ||
Input: | ||
STRING | window_name[31] | This value specifies the window name. |
Output: | ||
INTEGER | border_color | This value returns the display border color for the specified window. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000705 | There is no current window specified. | |
13000063 | XY window not found |
xy_window_border_color_set | (window_name, border_color) |
Description: | ||
This function sets the display border color. | ||
Input: | ||
STRING | window_name[31] | This value specifies the window name. |
INTEGER | border_color | This value specifies the display border color for the specified window. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000705 | There is no current window specified. | |
13000004 | Duplicate entry exists in table | |
13000063 | XY window not found |
Color Value | Color Description | Color Value | Color Description |
0 | Black | 8 | Dark Orange |
1 | Red | 9 | Light Orange |
2 | Light Green | 10 | Dark Green |
3 | Yellow | 11 | Green |
4 | Blue | 12 | Dark Blue |
5 | Dark Cyan | 13 | Light Blue |
6 | Lightest Blue | 14 | Cyan |
7 | white | 15 | Light Cyan |
xy_window_border_linestyle_get | (window_name, curve_style) |
Description: | ||
This function gets the border curve style. | ||
Input: | ||
STRING | window_name[31] | This value specifies the window name. |
Output: | ||
STRING | curve_style[31] | This value returns the border curve style for the specified window. This value can return “Solid”, “Dotted”, “DotDash”, “ShortDash”, “LongDash”, or “OddDash”. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000012 | Internal XY string lookup failure. | |
10000705 | There is no current window specified. | |
13000063 | XY window not found |
xy_window_border_linestyle_set | (window_name, curve_style) |
Description: | ||
This function sets the border curve_style. | ||
Input: | ||
STRING | window_name[31] | This value specifies the window name. |
STRING | curve_style[31] | This value specifies the border curve style for the specified window. This value can be set to: “Solid”, “Dotted”, “DotDash”, “ShortDash”, “LongDash”, or “OddDash”. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000201 | The specified line style is invalid. Please choose another from the option menu. | |
10000705 | There is no current window specified. | |
13000004 | Duplicate entry exists in table | |
13000063 | XY window not found |
xy_window_border_thickness_get | (window_name, thickness) |
Description: | ||
This function gets the border thickness. | ||
Input: | ||
STRING | window_name[31] | This value specifies the window name. |
Output: | ||
INTEGER | thickness | This value returns the window border thickness. The value returned will be greater than 0 and less than 101. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000705 | There is no current window specified. | |
13000063 | XY window not found |
xy_window_border_thickness_set | (window_name, thickness) |
Description: | ||
This function sets the border thickness. | ||
Input: | ||
STRING | window_name[31] | This value specifies the window name. |
INTEGER | thickness | This value specifies the window border thickness. This value must be greater than 0 and less than 101. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000705 | There is no current window specified. | |
13000004 | Duplicate entry exists in table | |
13000063 | XY window not found |
xy_window_display_border_get | (window_name, border_flag) |
Description: | ||
This function gets the display graph border flag. | ||
Input: | ||
STRING | window_name[31] | This value specifies the window name. |
Output: | ||
LOGICAL | border_flag | This value returns the display graph border flag for the specified window. When this value is TRUE, the display graph border should be displayed. When this value is set to FALSE, the display graph border should not be displayed. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000705 | There is no current window specified. | |
13000063 | XY window not found |
xy_window_display_border_set | (window_name, border_flag) |
Description: | ||
This function sets the display graph border flag. | ||
Input: | ||
STRING | window_name[31] | This value specifies the window name. |
LOGICAL | border_flag | This value specifies, when set to TRUE, that the display graph border should be shown. When this value is set to FALSE, the display graph border should not be shown. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
10000705 | There is no current window specified. | |
13000004 | Duplicate entry exists in table | |
13000063 | XY window not found |
xy_window_id_get | (window_name, window_id) |
Description: | ||
This function gets the ID of a window from the name. | ||
Input: | ||
STRING | window_name[31] | This value specifies the name of the xy window. |
Output: | ||
INTEGER | window_id | This value returns the id of the xy window. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
13000063 | XY window not found |