1Gridall(3NCARG)                  NCAR GRAPHICS                 Gridall(3NCARG)
2
3
4

NAME

6       Gridall - Allows one to draw backgrounds for X/Y plots. Included are
7       routines for drawing grids, perimeters, and pairs of axes. Internal
8       parameters of Gridall control such things as the color indices and line
9       width scale factors used to draw various parts of the background, the
10       formats to be used for labels, the sizes of the characters to be used
11       for labels, the amount by which labels are to be offset from the axes,
12       and the routine to be called to draw the labels (the SPPS routine WTSTR
13       or the Plotchar routine PLCHHQ).
14

SYNOPSIS

16       Each of the routines GRID, GRIDL, HALFAX, PERIM, PERIML, and GRIDAL
17       draws a background of some sort within the part of the plotter frame
18       occupied by the current GKS viewport, as follows:
19
20       ·      GRID draws an unlabeled grid.
21
22       ·      GRIDL draws a labeled grid.
23
24       ·      HALFAX draws a pair of intersecting axes.
25
26       ·      PERIM draws an unlabeled perimeter.
27
28       ·      PERIML draws a labeled perimeter.
29
30       ·      GRIDAL draws any of the above.
31
32
33       The positioning of ticks and grid lines is determined partly by the
34       arguments of these routines and partly by the nature of the current
35       mapping from the "user" coordinate system to the "fractional"
36       coordinate system, as determined by the current definitions of the GKS
37       viewport and window and by the values of two internal parameters of the
38       package SPPS: ´LS´ and ´MI´. Numeric labels reflect values in the
39       "user" coordinate system.
40
41       Note: Calling the SPPS routine SET defines the GKS viewport and window
42       and the values of the parameters ´LS´ and ´MI´.  The parameter ´LS´
43       determines whether the mappings of user coordinates to fractional
44       coordinates are linear or logarithmic and the parameter ´MI´ determines
45       whether the mappings are mirror-imaged or not.
46
47       Each of the internal parameters of Gridall has a three-character
48       mnemonic name of the form ´xxx´. Each of the routines GAGETC, GAGETI,
49       GAGETR, GASETC, GASETI, and GASETR is intended either to retrieve the
50       value of a specific internal parameter of Gridall or to give a new
51       value to it, as follows:
52
53       ·      GAGETC is called with the name of an internal parameter of type
54              CHARACTER and a character variable in which the value of the
55              parameter is to be returned.
56
57       ·      GAGETI is called with the name of an internal parameter of type
58              INTEGER or REAL and an integer variable in which the integer
59              equivalent of the value of the parameter is to be returned.
60
61       ·      GAGETR is called with the name of an internal parameter of type
62              INTEGER or REAL and a real variable in which the real equivalent
63              of the value of the parameter is to be returned.
64
65       ·      GASETC is called with the name of an internal parameter of type
66              CHARACTER and a character expression that is to become the new
67              value of the parameter.
68
69       ·      GASETI is called with the name of an internal parameter of type
70              INTEGER or REAL and an integer expression that is to become the
71              new value of the parameter.
72
73       ·      GASETR is called with the name of an internal parameter of type
74              INTEGER or REAL and a real expression that is to become the new
75              value of the parameter.
76
77
78       These six routines allow one to access all of the internal parameters
79       of Gridall in a manner consistent with other NCAR Graphics utilities
80       and are intended to replace some older routines, each of which allows
81       access to a limited subset of the internal parameters. However, the
82       older routines are still available and will remain so for the
83       foreseeable future:
84
85       ·      GACOLR sets the value of internal parameters that control the
86              color of various parts of the background.
87
88       ·      LABMOD sets the value of internal parameters that affect the
89              appearance of labels.
90
91       ·      TICKS and TICK4 set the value of internal parameters that
92              determine the length and direction of ticks.
93

C-BINDING SYNOPSIS

95       c_grid
96       c_gridl
97       c_halfax
98       c_perim
99       c_periml
100       c_gridal
101       c_gagetc
102       c_gageti
103       c_gagetr
104       c_gasetc
105       c_gaseti
106       c_gasetr
107       c_gacolr
108       c_labmod
109       c_ticks
110       c_tick4
111

USER-MODIFIABLE INTERNAL ROUTINES

113       None.
114

ACCESS

116       To use Gridall C or Fortran routines, load the NCAR Graphics libraries
117       ncarg, ncarg_gks, and ncarg_c, preferably in that order.
118

MESSAGES

120       Various error conditions can occur in Gridall.  Each of these results
121       in a call to the error-handling routine SETER, with a final argument
122       indicating that the error is recoverable; by default, an error message
123       is printed and execution is terminated, but, if you turn on error
124       recovery (as described in the "man" page for "error_handling"), you can
125       get control back.
126
127       The error messages are as follows; all should be more or less self-
128       explanatory.
129
130            GACOLR - UNCLEARED PRIOR ERROR
131            GAGETC - UNCLEARED PRIOR ERROR
132            GAGETC - UNRECOGNIZED PARAMETER NAME
133            GAGETI - UNCLEARED PRIOR ERROR
134            GAGETR - UNCLEARED PRIOR ERROR
135            GAGETR - UNRECOGNIZED PARAMETER NAME
136            GASETC - UNCLEARED PRIOR ERROR
137            GASETC - UNRECOGNIZED PARAMETER NAME
138            GASETI - UNCLEARED PRIOR ERROR
139            GASETR - UNCLEARED PRIOR ERROR
140            GASETR - UNRECOGNIZED PARAMETER NAME
141            GRID - UNCLEARED PRIOR ERROR
142            GRIDAL - ERROR EXIT FROM GQCLIP
143            GRIDAL - ERROR EXIT FROM GQLWSC
144            GRIDAL - ERROR EXIT FROM GQPLCI
145            GRIDAL - ERROR EXIT FROM GQTXCI
146            GRIDAL - UNCLEARED PRIOR ERROR
147            GRIDL - UNCLEARED PRIOR ERROR
148            HALFAX - UNCLEARED PRIOR ERROR
149            LABMOD - UNCLEARED PRIOR ERROR
150            PERIM - UNCLEARED PRIOR ERROR
151            PERIML - UNCLEARED PRIOR ERROR
152            TICK4 - UNCLEARED PRIOR ERROR
153            TICKS - UNCLEARED PRIOR ERROR
154

SEE ALSO

156       Online: gridall_params, gacolr, gagetc, gageti, gagetr, gasetc, gaseti,
157       gasetr, grid, gridal, gridl, halfax, labmod, perim, periml, tick4,
158       ticks, ncarg_cbind.
159
160       Hardcopy: NCAR Graphics Fundamentals, UNIX Version
161
163       Copyright (C) 1987-2007
164       University Corporation for Atmospheric Research
165
166       This documentation is free software; you can redistribute it and/or
167       modify it under the terms of the GNU General Public License as
168       published by the Free Software Foundation; either version 2 of the
169       License, or (at your option) any later version.
170
171       This software is distributed in the hope that it will be useful, but
172       WITHOUT ANY WARRANTY; without even the implied warranty of
173       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
174       General Public License for more details.
175
176       You should have received a copy of the GNU General Public License along
177       with this software; if not, write to the Free Software Foundation,
178       Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
179
180
181
182UNIX                              March 1993                   Gridall(3NCARG)
Impressum