xy_plots template modify
Allows you to modify an XY plot template.
Format:
xy_plots template modify |
|---|
plot_name = | an existing plot |
new_plot_name = | a new plot |
title = | string |
subtitle = | string |
vlabel = | string |
vscale_type = | axis_units |
vdivs = | integer |
vinc = | real |
vlim = | real |
hlabel = | string |
hscale_type = | axis_units |
hdivs = | integer |
hinc = | real |
hlim = | real |
dependent_axis_type = | dependent_axis |
grid_lines = | on_off |
secondary_grid_lines = | on_off |
time_limits = | real |
legend = | boolean |
primary_haxis = | an existing axis |
primary_vaxis = | an existing axis |
auto_graph_area = | boolean |
auto_position = | boolean |
Example:
xy_plots template modify & |
|---|
xy_plots template create plot_name = | plot__1 & |
xy_plots template create vdivs = | 1 & |
xy_plots template create vinc = | 2 & |
xy_plots template create dependent_axis_type = | horizontal & |
xy_plots template create auto_graph_area = | yes & |
xy_plots template create legend = | no & |
xy_plots template modify primary_haxis = | haxis & |
xy_plots template modify primary_vaxis = | vaxis & |
xy_plots template modify auto_position = | yes |
Description:
Parameter | Value Type | Description |
|---|
plot_name | An Existing Plot | A plot name is a string of characters that identifies a plot |
new_plot_name | A New Plot | Specifies the new name of the new plot template |
title | String | This parameter allows the specification of the XY plot title |
subtitle | String | This parameter allows the specification of the XY plot subtitle |
vlabel | String | This parameter allows you to specify a text string that will be displayed to the left of the vertical axis. |
vscale_type | Axis_Units | This parameter allows you to specify the type of scale that is displayed on the vertical axis. |
vdivs | Integer | This parameter is used to set the number of divisions on the vertical axis of an xy plot |
vinc | Real | This parameter is used to set the tic mark increment on the vertical axis. |
vlim | Real | This parameter is used to set the minimum and maximum limits to be displayed on the vertical axis. This parameter accepts two (2) values separated by a comma (,) |
hlabel | String | This parameter allows you to specify a text string that will be displayed below the horizontal axis |
hscale_type | Axis_Units | This parameter allows you to specify the type of scale that is displayed on the horizontal axis |
hdiv | Integer | This parameter is used to set the number of divisions on the horizontal axis of an xy plo |
hinc | Real | This parameter is used to set the tic mark increment on the horizontal axis |
hlim | Real | This parameter is used to set the minimum and maximum limits to be displayed on the horizontal axis |
dependent_axis_type | Dependant_Axis | Determines where the dependent axis on the plot will be placed (vertical or horizontal). |
grid_lines | On_Off | This parameter controls the visibility of the plot grid lines |
secondary_grid_lines | On_Off | Controls the visibility of secondary grid lines, which appear at specified intervals between the primary grid lines |
time_limits | Real | This parameter allows you to fit the plot to the data corresponding to a certain range of time |
legend | Boolean | This parameter controls the visibility of the XY plot legend |
primary_haxis | An Existing Axis | This parameter controls the visibility of the XY plot legend |
primary_vaxis | An Existing Axis | Specifies the primary vertical axis for a plot |
auto_graph_area | Boolean | Determines whether or not Adams View automatically fits the plot border to the view (yes or no). |
auto_position | Boolean |
Extended Definition:
1. The plot template is analogous to a piece of paper that the horizontal axis label, vertical axes label, legend, title, and subtitle will be drawn on. This command allows the modification of the following XY plot attributes: plot name, plot title, subtitle, axis labels, axis limits, time limits, grid on/off, legend on/off, and angular units.
Note: | If there are multiple horizontal or vertical axes, these attributes are only applied to the template's primary axes. |
2. Plot names are assigned when plots are created. After a plot has been created, it may be referenced by its name until it is deleted. A plot may NOT have the same name as another plot.
A plot_name may be arbitrarily long and a combination of letters of the alphabet and numbers may be used. The leading character must be a letter.
3. Specifies the new name of the new plot template. You may use this name later to refer to this plot template. Adams View will not allow you to have two plots with the same name, so you must provide a unique name.
Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be of any length. For more information, see
Using Extended Names.
By enclosing the name in double quotes, you may use other printable characters, or start the name with a numeral. If a name contains characters, or starts with a numeral, you must always quote the name when entering it.
Note: | You can specify the parentage of an entity (e.g. what part "owns" a marker or a geometry element) when you CREATE it by changing the name. If you enter just the entity name, then the default parent will be assigned by Adams View. If you type in the full name, then you may override the default parent. In most cases, when creating an entity, Adams View will provide a default name. The default name that Adams View provides will specify the parentage that it has assumed. |
You may, of course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity can be assigned to it.
4. The title is a "quoted" character string that will be displayed at the top of the XY plot. The title will be scaled and centered automatically.
Unlike plot names, titles need not be unique. A title may be arbitrarily long and a combination of letters of the aphabet and numbers may be used.
5. The subtitle is a character string that will be displayed at the top of the XY plot beneath the title. If the XY plot does not have a title, but does have a subtitle, the subtitle will be displayed anyway. The subtitle will be scaled and centered automatically. Unlike plot names, subtitles need not be unique. There is no limit to the length of a title that can be input to the system. However, very long subtitles may not fit in plot and may run off the end. This is an optional parameter and if not entered, no subtitle will be displayed.
This parameter must be entered within quote marks.
6. The text string can be ofunlimited length (however, it may not all fit in the plot) and must be enclosed in quotes. Any alpha-numeric string with letters A-Z, a-z and numbers 0-9 are accepted. This parameter is optional and if not entered no label will be displayed.
7. The curves are scaled appropriately. Adams View supports linear, logarithmic, and db (decibel). This parameter is optional and if not entered, a linear scale will be used.
8. The text string can be of unlimited length (however, it may not all fit on the plot) and must be enclosed in quotes. Any alpha-numeric string with letters A-Z, a-z and numbers 0-9 are accepted. This parameter is optional and if not entered no label will be displayed.
9. The number of tic marks will be VDIVS + 1. For example, if you request VDIVS=3 the vertical axis will be drawn with 4 tic marks. The VDIVS parameter is mutually exclusive with the "VINC" parameter. This parameter is optional and if not entered the axes will be auto-scaled upon creation of the curve and five divisions will be used. VDIVS is an integer.
10. The tic mark increment is the distance between the tic marks relative to the data components being plotted. The number of tic marks will be calculated by Adams View and will depend upon the scale and range of the data components being plotted. The VINC value is a real number and must be greater than zero. The VINC parameter is mutually exclusive with the "VDIVS" parameter. This parameter is optional and if not entered the axes will be auto-scaled upon creation of the curve, and five divisions will be used.
11. vlim arameter accepts two (2) values separated by a comma (,). The first value is the lower limit, and the second, the upper limit. This parameter is be used to limit the amount of curve displayed on an xy_plot or "zoom in" on a particular portion of a curve or curves.
12. The text string can be of unlimited length (however, it may not all fit on the plot) and must be enclosed in quotes. Any alpha-numeric string with letters A-Z, a-z and numbers 0-9 are accepted. This parameter is optional and if not entered no label will be displayed.
13. The curves are scaled appropriately. Adams View supports linear, logarithmic, and db (decibel). This parameter is optional and if not entered a linear scale will be used.
14. The number of tic marks will be HDIVS + 1. For example, if you request HDIVS=3 the horizontal axis will be drawn with 4 tic marks. The HDIVS parameter is mutually exclusive with the "HINC" parameters. This parameter is optional and if not entered, the axes will be auto-scaled upon creation of the curve and five divisions will be used.
15. The tic mark increment is the distance between the tic marks relative to the data components being plotted. The number of tic marks will be calculated by Adams View and will depend upon the scale and range of the data components being plotted. The HINC parameter is mutually exclusive with the "HDIVS" parameter. This parameter is optional and if not entered, the axes will be auto-scaled upon creation of the curve and five divisions will be used. HINC must be a real number greater than 0.0.
16. hlim arameter accepts two (2) values separated by a comma (,). The first value is the lower limit, and the second the upper limit. This parameter is be used to limit the amount of curve displayed on an xy_plot or "zoom in" on a particular portion of a curve or curves.
17. Grid lines are a set of vertical and horizontal lines that are extensions of the tic marks on the vertical and horizontal axes. Grid lines provide for more accurate interpretation of the data on an XY plot. ON indicates that the grid lines will be visible, OFF indicates that the grid lines will be invisible. This parameter is optional and in not entered grid lines will be displayed on the xy_plot.
18. Controls the visibility of secondary grid lines, which appear at specified intervals between the primary grid lines.
On indicates that the grid lines are visible.
Off indicates that the grid lines are invisible.
19. If time_limits parameter is specified when the plot template is created or modified, both, the vertical and horizontal axes, will be scaled to fit the time limits requested. One of the axes need not be TIME in order to use this parameter. If one of the axes is TIME, the lower an upper limits specified in this parameter will appear on that axis as its lower and upper limits.
20. The XY plot legend displays a label beside a key describing that curve. The label will be the Adams request statement comment if one is found. If no request comment is found, a label is created by concatenating the data specified in the haxis_data and vaxis_data parameters that comprise that curve. The key will look like the curve with respect to color, line type, and line thickness. The plot legend is displayed at the top of the XY plot template. This parameter is optional and YES (the default) indicates that the legend will be visible, NO indicates that the legend will be visible, NO indicates that the legend will be invisible.
21. Adams View uses it when performing cursor tracking and to draw the plot grid.