Adams Basic Package > Adams View > View Command Language > xy_plots > xy_plots legend create

xy_plots legend create

Allows you to create a legend on an xy plot.

Format:

 
xy_plots legend create
legend_name =
a new legend
height =
real
width =
real
location =
real
placement =
plot_legend_place2
visible =
boolean
border =
boolean
fill =
boolean

Example:

 
xy_plots legend create &
xy_plots legend create legend_name =
legend_object__1 &
xy_plots legend create height =
10 &
xy_plots legend create width =
10 &
xy_plots legend create placement =
top_right &
xy_plots legend create visible =
yes

Description:

 
Parameter
Value Type
Description
legend_name
A New Legend
Specifies the name of the legend
height
Real
Specifies a height for the info window
width
Real
Specifies a width for the info window
location
Real
Enter two real values, specifying the x, y location of the legend.
placement
Plot_legend_place2
Specifies whether the axis is on the top, bottom, left, or right of the plot graph or directly as part of the plot area itself.
visible
Boolean
Sets whether or not the legend is visible
border
Boolean
Sets whether or not a border appears around the legend
fill
Boolean
Sets the transparency of the legend background
axis_limits_display
on_off_no_opinion
Specifies whether the axis limits are to be displayed (for each legend entry) or otherwise. Applicable only for legends with the placement type specified as 'plot'
units_display
on_off_no_opinion
Specifies whether the units are to be displayed (for each legend entry) or otherwise. Applicable only for legends with the placement type specified as 'plot'
scientific_notation
Integer
This controls the lower and upper powers of ten where the format for real numbers switches from a fixed point format to scientific notation. Applicable to the axis limits display.
trailing_zeros
On_off
This controls whether or not trailing zeros are printed for real numbers. Applicable to the axis limits display.
decimal_places
Integer
This controls how many places are written after the decimal point for real numbers. The default value is ten decimal places. Applicable to the axis limits display.

Extended Definition:

1. Specify a height for the info window. The value should be a real number between 0.0 and 2.0, where 2.0 represents the height of the Adams View window. Therefore, a value of 1.0 will set the info window to be half as high as the Adams View window.
2. Specify a width for the info window. The value should be a real number between 0.0 and 2.0, where 2.0 represents the width of the Adams View window. Therefore, a value of 1.0 will set the info window to be half as wide as the Adams View window.
3. Enter two real values, specifying the x, y location of the legend. The coordinate system is the same as is used to define the size of the plot, in the command xy_plots attributes graph_area.
4. Sets whether or not the legend is visible:
■yes (the default) indicates that the legend will be visible.
■no indicates that the legend will be invisible.
5. Sets whether or not a border appears around the legend:
■yes (the default) indicates that a border appears.
■no indicates that a border is not present.
6. Sets the transparency of the legend background.
■yes (the default) indicates the legend is opaque and covers any information behind it.
■no indicates that the legend is transparent. Any plot information behind the legend shows through.