YAXIS directive

Defines the y-axis in each window for high-resolution graphics.

Option

RESET = string

Whether to reset the axis definition to the default values (yes, no); default no

Parameters

WINDOW = scalars

Numbers of the windows

TITLE = texts

Title for the axis

TPOSITION = strings

Position of title (middle, end)

TDIRECTION = strings

Direction of title (parallel, perpendicular)

LOWER = scalars

Lower bound for axis

UPPER = scalars

Upper bound for axis

MARKS = scalars or variates

Distance between each tick mark (scalar) or positions of the marks along the axis (variate)

MPOSITION = strings

Positioning of the tick marks on the axis (inside, outside, across)

LABELS = texts

Labels at each major tick mark

LPOSITION = strings

Position of the axis labels (inside, outside)

LDIRECTION = strings

Direction of the axis labels (parallel, perpendicular)

NSUBTICKS = scalars

Number of subticks per interval (ignored if MARKS is a variate)

XORIGIN = scalars

Position on x-axis at which the axis is drawn

ZORIGIN = scalars

Position on z-axis at which the axis is drawn

PENTITLE = scalar

Pen to use to write the axis title

PENAXIS = scalar

Pen to use to draw the axis

PENLABELS = scalar

Pen to use to write the axis labels

ARROWHEAD = strings

Whether the axis should have an arrowhead (include, omit)

ACTION = strings

Whether to display or hide the axis (display, hide)

TRANSFORM = strings

Transformed scale for the axis (identity, log, log10, logit, probit, cloglog, square, exp, exp10, ilogit, iprobit, icloglog, root); default iden

LINKED = scalars

Linked axis whose definitions should be used for this axis in 2-dimensional graphs; default * i.e. none

MLOWER% = scalar

How large a margin to set between the lowest y-value and the lower value of the axis, if not set explicitly by LOWER (expressed as a percentage of the range of the y-values)

MUPPER% = scalar

How large a margin to set between the largest y-value and the upper value of the axis, if not set explicitly by UPPER (expressed as a percentage of the range of the y-values)

DECIMALS = scalars or variates

Number of decimal places to use for numbers printed at the marks

XOMETHOD = string

Method to use to set the position of the origin on the x-axis if not set explicitly by XORIGIN (upper, lower, center, centre)

ZOMETHOD = string

Method to use to set the position of the origin on the z-axis if not set explicitly by ZORIGIN (upper, lower, center, centre)

SAVE = pointers

Saves details of the current settings for the axis concerned

Description

There is a definition for the y-axis associated with each GenStat graphics window. This specifies how the y-axis is to be drawn when graphical output is produced in that window. The default definition for each axis requires some of the features to be determined from the data. Others have fixed defaults that are independent of the data. The YAXIS directive can be used to override the default action and specify particular aspects of the y-axis explicitly. (Similarly, directives XAXIS and ZAXIS modify the x- and z-axis definitions, respectively.) All the parameters of YAXIS are relevant when using DGRAPH, but for other directives only some of the parameters are used. The syntax of YAXIS is identical to that of XAXIS, except that YAXIS has an XORIGIN parameter which replaces the YORIGIN parameter of XAXIS.

The WINDOW parameter specifies the window whose axis definition is to be altered. WINDOW can be set to a list of window numbers, in which case the other parameter lists are cycled in parallel, in the usual way. By default, only those aspects specified by subsequent parameter lists are modified; any parameters that are not set will retain their current settings. Alternatively, you can specify option RESET=yes to reset the values of any parameters that are not set for each window, back to the default values that are set up by GenStat at the start of a job.

As in XAXIS, the LOWER, UPPER, MLOWER% and MUPPER% parameters can specify the lower and upper bounds for the axis, and the TITLE, TPOSITION and TDIRECTION parameter can define a title for the axis.

The XORIGIN parameter determines the value on the x-axis through which the axis is drawn. If its value is outside the x-axis bounds, the upper or lower bound is adjusted so that the axis will extend up to the specified origin. This applies whether you have set the bounds explicitly or have left GenStat to calculate them from the data. If XORIGIN is not set, the XOMETHOD parameter can specify how the position should be determined: either at the upper end of the x-axis, or the lower end, or in the centre. The initial default (if neither of these parameters has been specified) is to put the axis at the lower end. The ZORIGIN and ZOMETHOD parameters set the position of the origin on the z-axis in a similar way.

The MARKS, NSUBTICKS, LABELS and DECIMALS parameters also operate as in XAXIS, to specify the markings on the axis, and their associated labels. The MPOSITION, LPOSITION and LDIRECTION parameters again control the positioning of the tick marks and labels. For a y-axis, the outside setting implies that the tick marks are drawn to the left of the axis if the axis is on the left-half side of the plot, or to the right of the axis if it is on the right-hand side. As in XAXIS, the TRANSFORM parameter allows you to transform the physical scale of the axis on the graph.

The ARROWHEAD parameter again controls whether the axis is drawn with an arrowhead at the end, and parameters PENTITLE, PENAXIS and PENLABEL specify the pen to be used for the title, the axis and the labelling, respectively. ACTION allows you to hide the axis, LINKED allows you to take all the axis settings from a (linked) axis in another window, and SAVE allows you to save the current settings defined for the axis. Further details are given in the description of XAXIS.

Option: RESET.

Parameters: WINDOW, TITLE, TPOSITION, TDIRECTION, LOWER, UPPER, MARKS, MPOSITION, LABELS, LPOSITION, LDIRECTION, NSUBTICKS, XORIGIN, ZORIGIN, PENTITLE, PENAXIS, PENLABELS, ARROWHEAD, ACTION, TRANSFORM, LINKED, MLOWER%, MUPPER%, DECIMALS, XOMETHOD, ZOMETHOD, SAVE.