Syntax

[C/C++:]
void ggDrawAxesTitle(char string[ ], float yorx, int xory, int pos1, int pos2);

[F90:]
subroutine ggDrawAxesTitle(string, yorx, xory, pos1, pos2)

character*(*), intent(in) :: string
real, intent(in) :: yorx
integer, intent(in) :: xory, pos1, pos2

Arguments

string
Variable or constant holding the title

yorx
Value representing the Y or X user space coordinate positioning the title text

xory
Flag determining the axis to be titled

= GXAXIS

Title the current X axis

= GYAXIS

Title the current Y axis

pos1
Justification of string relative to yorx

= GBOTTOM

Title written with the bottom of the characters at yorx = GTOP%%Title written with the top of the characters at yorx

pos2
The position of the title relative to the axis

= GLEFT

Title justified to the left of the axis

= GCENTRE

Title justified to the centre of the axis

= GRIGHT

Title justified to the right of the axis

Description

The routine ggDrawAxesTitle() outputs a title held in string with reference to either the X or Y axis.

yorx is the Y or X coordinate positioning the title. If the X axis is being titled, the Y coordinate of the text is constant and contained in yorx, and the X coordinate is determined by the flags pos1 and pos2. If the Y axis is being titled, yorx contains the X coordinate of the text and pos1,pos2 determines the Y coordinate.

xory determines the axis being titled, and the positioning of the title. For the X axis the position determined by yorx can specify the top of the characters in the title or the bottom of the characters. For the Y axis, the characters are rotated through 90 degrees so that the top of each character is the leftmost point of the character as drawn, and the bottom of each character is the rightmost point of the character as drawn.

pos2 determines the justification of the title relative to the axis. X axis titles are written to be read from left to right, and Y axis titles are written with the first character lowest.

The title need not be written along the axis itself. For example, a title can be written at the top of a graph by using the routine with pos1 = GXAXIS and yorx set to a Y coordinate above the top of the graph. ggDrawGraphTitle() provides additional graph titling facilities.

See Also

ggDrawAxesTitle Usage
ggDrawGraphTitle

---