GINO Graphics Suite - GINOGRAF v9.5  

ggEnqDateAxesScaling

Syntax

[C/C++:]
void ggEnqDateAxesScaling(int *scale, int *dincr, char dbeg[ ], char dend[ ], int xory);
[F90:]
subroutine ggEnqDateAxesScaling(scale, dincr, dbeg, dend, xory)

integer, intent(out) :: scale, dincr
character*(*), intent(out) :: dbeg, dend
integer, intent(in) :: xory

Arguments

scale
Axis scaling type

< 0 Current axis is numerically scaled
= GLINEARTYPE1 }
= GLINEARTYPE2 } Date axis scaling type
= GLINEARTYPE3 }

dincr
The increment being used for major tick marks on the date axis

= GDECADE Decade (10 years)
= GYEAR Year
= GMONTH Month
= GWEEK Week (7 days starting on Monday)
= GDAY Day

dbeg
Date at the beginning of the date axis

dend
Date at the end of the date axis

xory
Flag determining which date settings are returned

= GXAXIS The X axis setting is returned
= GYAXIS The Y axis setting is returned

Description

The routine ggEnqDateAxesScaling() returns the current date axis scaling information for either the X or Y axis as set up by ggSetDateAxesScaling().

The values returned are not necessarily those requested by ggSetDateAxesScaling() as that routine may select an appropriate date interval or adjust the start and end dates on the axis according to the requested scaling type. The values returned are therefore those that represent the actual axis to be, or already drawn.

The start and end dates are returned as character strings of 10 characters, in the current input date format as set by ggSetDateFormat().

This routine should only be called in association with a corresponding call to ggSetDateAxesScaling() for the same axis. If the requested axis scaling has been defined through a call to ggSetAxesScaling() (ie. numeric scaling). scale will return with a negative value and other values are meaningless.

See Also

ggEnqDateAxesScaling Usage
ggSetAxesScaling
ggSetDateFormat
ggSetDateAxesScaling