Syntax
[C/C++:]
void ggAddReferenceLine(char string[ ], float xyval, int labjus, int labclock, int hv, int xory);
[F90:]
subroutine ggAddReferenceLine(string, xyval, labjus, labclock, hv, xory)
character*(*), intent(in) :: string
real, intent(in) :: xyval
integer, intent(in) :: labjus, labclock, hv, xory
Arguments
string
Variable or constant holding the title
xyval
X or Y axis intercept value in graphical axes coordinates
labjus
Position of text string around reference line
|
= GFARLEFT |
Beyond lower limit, labclock is ignored |
|
= GLEFT |
Left justified at lower limit |
|
= GRIGHT |
Right justified at upper limit |
|
= GFARRIGHT |
Beyond upper limit, labclock is ignored |
labclock
Side of reference line to position text string
|
= GCLOCKWISE |
Position the text string on the clockwise side of the reference line |
|
= GANTICLOCKWISE |
Position the text string on the anti-clockwise side of the reference line |
hv
Flag determining the orientation of the annotation
|
= GXAXIS |
Parallel to X axis (zero degrees) |
|
= GYAXIS |
Parallel to Y axis (90 degrees) |
xory
Specified axis
Description
The routine ggAddReferenceLine() draws a reference line across a graph at a specified value and labels it with a supplied text string.
The argument
xory determines which axes the specified value
xyval refers to and the reference line is drawn parallel to the opposite axes according to its current position and length. The supplied text string is then placed at one of the eight positions determined by the value of
labjus and oriented according to the value of
hv.
If the value
xyval does not occur within the limits of the selected axes, neither the reference line or the text label is output. If the text position is out of range, a warning message is output and the default position is used.
See Also
ggAddReferenceLine Usage
