Syntax
[C/C++:]
void ggAddStepChartValues(int nsteps, GSTEPCHART *steps, float base, int sfl, int xory);
[F90:]
subroutine ggAddStepChartValues(nsteps, steps, base, sfl, xory)
integer, intent(in) :: nsteps, sfl, xory
type(GSTEPCHART), intent(in) :: steps
real, intent(in) :: base
Arguments
nsteps
The number of steps to be annotated
steps
Array of dimension
nsteps, giving the start and finish width and height values of all the columns in the Step Chart
base
The base value of all steps
sfl
Flag determining the value being output
|
= GSTART |
Start of step (ie, steps.s) |
|
= GFINISH |
End of step (ie, steps.f) |
|
= GWIDTH |
Step width (ie, steps.f - steps.s) |
|
= GHEIGHT |
Step height (ie, steps.h) |
|
= GHEIGHTABOVEBASE |
Step height above base
(ie, steps.h - base) |
xory
Flag determining on which axis the values are plotted
Description
The routine ggAddStepChartValues() displays the step, widths or heights, with respect to the current axes as set up by the last axis definition calls or through a previous call to ggPlotStepChart().
xory determines which direction the steps are displayed, thus if
xory=GXAXIS the
steps.s and
steps.f values are displayed on the X axis and
steps.h values are displayed on the Y axis. If ggAddStepChartValues() follows a call to ggPlotStepChart(),
xory should be set to GXAXIS. Annotation of individual points about a Step Chart can be achieved using ggAddGraphValues().
The most recent call to ggSetValueAttribs() determines the position of the annotation about each area as well as the angle, justification and offset of the value string. The default is to position the required value at the centre of each area represented by the step, that is between
steps.s and
steps.f and between
steps.h and the base.
steps.s,
steps.f and width values are output according to the format of the
xory axis, where as height values are output according to the format of the other axis. The format is set by the most recent call to ggSetAxesAnnotation(). Prefix and suffix strings defined by the most recent call to ggSetValueTags() are appended to the numerical output.
If
sfl is out or range, a warning message is output and the step heights values are displayed.
See Also
ggAddStepChartValues UsageggAddGraphValuesggPlotStepChartggSetValueAttribsggSetValueTags
