GINO Graphics Suite - GINOGRAF v9.5  

ggSetValueAttribs

Syntax

[C/C++:]
void ggSetValueAttribs(int xpos, int ypos, float xory, float xoff, float yoff, float angstr, int jstmb, int jslcr);
[F90:]
subroutine ggSetValueAttribs(xpos, ypos, xory, xoff, yoff, angstr, jstmb, jslcr)

integer, intent(in) :: xpos, ypos, jstmb, jslcr
real, intent(in) :: xory, xoff, yoff, angstr

Arguments

xpos
Position of data value control point in horizontal direction

= GOUTSIDELEFT left of lower value, left of data value
= GINSIDELEFT right of lower value, left of data value
= GCENTRE centre of area, at data value
= GINSIDERIGHT left of upper value, right of data value
= GOUTSIDERIGHT right of upper value, right of data value
= GSPECIFIED positioned at xory

ypos
Position of data value control point in vertical direction

= GOUTSIDEBOTTOM below lower value, below data value
= GINSIDEBOTTOM above lower value, below data value
= GMIDDLE middle of area, at data value
= GINSIDETOP below upper value, above data value
= GOUTSIDETOP above upper value, above data value
= GSPECIFIED positioned at xory

xory
Position of data value control point in graphical coordinates, if xpos or ypos = GSPECIFIED

xoff, yoff
Offset from control point in user space coordinates

angstr
Data value string angle measured in degrees (anti-clockwise) from the 3 o'clock position

jstmb
Vertical justification of data value

= GBOTTOM Bottom justified - string above control point
= GMIDDLE Middle justified - string centred at control point
= GTOP Top justified - string below control point

jslcr
Horizontal justification of data value

= GLEFT Left justified
= GCENTRE Centre justified
= GRIGHT Right justified

Description

The routine ggSetValueAttribs() sets the attributes for the display of data values output by the ggAddxxxValues() routines. By default, values are positioned centrally over the coordinate position of the value itself (for ggAddGraphValues()) or in the centre of the column or area  being annotated (for ggAddAreaChartValues(), ggAddBarChartValues(), ggAddHistogramValues(), ggAddStepChartValues()).

xpos and ypos (together with xory) set alternative positions of a control point about which the offset, angle and justification are taken. For xpos = GINSIDERIGHT / GINSIDELEFT / GOUTSIDERIGHT / GOUTSIDELEFT  or ypos = GINSIDEBOTTOM / GINSIDETOP / GOUTSIDEBOTTOM / GOUTSIDETOP the control point is positioned one character width or height away from the upper or lower limit of the column or area. If xpos or ypos  equals GSPECIFIED the control point is positioned at the specified xory coordinate on the respective axis. Where xpos or ypos is set to GSPECIFIED on a discrete axis (ie, where ggAddBarChartValues() or ggAddHistogramValues() are being used), the default (xpos or ypos=GCENTRE / GMIDDLE) is assumed. If both xpos and ypos are equal to GSPECIFIED  for ggAddGraphValues(), ggAddAreaChartValues() or ggAddStepChartValues(), all the values are displayed at X=xory, Y=xory.

As there are no upper and lower limits when the routine ggAddGraphValues() is used, where xpos and ypos are negative, the control point is positioned to the left or below the coordinate position and where positive values of xpos and ypos are used (except GSPECIFIED) the control point is positioned to the right or above the coordinate position. The control point is effectively shifted by  a character width or a character height in the respective direction away from each of the coordinate positions.

The control point can be shifted by an additional amount using the offsets xoff and yoff. These values are in user space coordinates and provide a means of finely adjusting the position of the data values.

The data value strings may be rotated by angstr about the control point and justified in either a vertical or horizontal direction using jstmb and jslcr. The justification is performed with respect to the angle that the data value is output.

Values may be appended by a prefix and/or suffix string to improve annotation with the routine ggSetValueTags(). If strings are appended, the whole string is treated as a single entity for justification purposes.

See Also

ggSetValueAttribs Usage
ggEnqValueAttribs
ggSetValueTags