1Gridall_params(3NCARG) NCAR GRAPHICS Gridall_params(3NCARG)
2
3
4
6 Gridall_params - This document briefly describes all Gridall internal
7 parameters.
8
10 GRIDAL has twenty-two internal parameters, each of which affects, in
11 some way, the behavior of the routines that draw backgrounds. The
12 current value of a parameter may be retrieved by calling GAGETC,
13 GAGETI, and/or GAGETR and it may be reset by calling GASETC, GASETI,
14 and/or GASETR; certain parameters may also be reset by calling other,
15 older, routines (GACOLR, LABMOD, TICKS, and TICK4).
16
17 Parameter descriptions, in alphabetical order, of all Gridall internal
18 parameters follow. Each description begins with a line giving the
19 parameter name and the intrinsic FORTRAN type of the parameter.
20
21 ´CAX´ - Integer
22 The polyline color index to be used for drawing the axes. A
23 negative value implies that no change is to be made in the
24 polyline color index before drawing the axes. The default value
25 of ´CAX´ is -1; its value may be changed by calling GASETI,
26 GASETR, or GACOLR (argument KAXS) .
27
28 ´CLB´ - Integer
29 The polyline/text color index to be used for drawing labels.
30 (Both are affected because the labels may be drawn using calls
31 to WTSTR or calls to PLCHHQ.) A negative value implies that no
32 change is to be made in the polyline and text color indices
33 before drawing the labels. The default value of ´CLB´ is -1; its
34 value may be changed by calling GASETI, GASETR, or GACOLR
35 (argument KLBL).
36
37 ´CMJ´ - Integer
38 The polyline color index to be used for major ticks and/or grid
39 lines. A negative value implies that no change is to be made in
40 the polyline color index before drawing major ticks/grid lines.
41 The default value of ´CMJ´ is -1; its value may be changed by
42 calling GASETI, GASETR, or GACOLR (argument KMJT).
43
44 ´CMN´ - Integer
45 The polyline color index to be used for minor ticks and/or grid
46 lines. A negative value implies that no change is to be made in
47 the polyline color index before drawing minor ticks/grid lines.
48 The default value of ´CMN´ is -1; its value may be changed by
49 calling GASETI, GASETR, or GACOLR (argument KMNT).
50
51 ´LTY´ - Integer
52 The labeling type. The value 0 implies that the SPPS routine
53 WTSTR is to be called to draw labels, the value 1 that the
54 Plotchar routine PLCHHQ is to be called. The default value of
55 ´LTY´ is 0; its value may be changed by calling GASETI or
56 GASETR.
57
58 ´WAX´ - Real
59 The line width to be used for drawing the axes. A value less
60 than or equal to zero implies that no change is to be made in
61 the line width scale factor before drawing the axes. The default
62 value of ´WAX´ is 0; its value may be changed by calling GASETI
63 or GASETR.
64
65 ´WLB´ - Real
66 The line width to be used for drawing labels. (Labels drawn
67 using calls to the Plotchar routine PLCHHQ are affected by this;
68 those drawn using calls to the SPPS routine WTSTR are not.) A
69 value less than or equal to zero implies that no change is to be
70 made in the line width scale factor before drawing the labels.
71 The default value of ´WLB´ is 0; its value may be changed by
72 calling GASETI or GASETR.
73
74 ´WMJ´ - Real
75 The line width to be used for major ticks and/or grid lines. A
76 value less than or equal to zero implies that no change is to be
77 made in the line width scale factor before drawing. The default
78 value of ´WMJ´ is 0; its value may be changed by calling GASETI
79 or GASETR.
80
81 ´WMN´ - Real
82 The line width to be used for minor ticks and/or grid lines. A
83 value less than or equal to zero implies that no change is to be
84 made in the line width scale factor before drawing. The default
85 value of ´WMN´ is 0; its value may be changed by calling GASETI
86 or GASETR.
87
88 ´XLF´ - Character
89 The format to be used for labels on the X axis. The character
90 string must begin with a left parenthesis and end with a right
91 parenthesis and it must not exceed ten characters in length.
92 Conversions of types E, F, G, and I are allowed. The default
93 value of ´XLF´ is ´(E10.3)´; its value may be changed by calling
94 GASETC or LABMOD (argument FMTX).
95
96 ´XLL´ - Integer
97 The length of each X-axis label. If ´XLL´ is given a non-zero
98 value "n" and LBLX is a string produced by the format ´XLF´,
99 then the label will be the substring LBLX(1:n). If, on the other
100 hand, ´XLL´ = 0, then the label will be the substring LBLX(m:n),
101 where LBLX(m:m) is the first non-blank character in LBLX and
102 LBLX(n:n) is the last non-blank character following LBLX(m:m).
103 Using a non-zero value for ´XLL´ causes labels to be centered
104 differently than if a zero value is used. The default value of
105 ´XLL´ is 0; its value may be changed by calling GASETI, GASETR,
106 or LABMOD (argument NUMX).
107
108 ´XLO´ - Real
109 The (vertical) distance of an X-axis label from the X axis.
110 Values between 0 and 1 are interpreted as fractions of the width
111 of the plotter frame, while values greater than 1 are
112 interpreted as plotter address units (PAUs). The value is
113 interpreted as the distance from the bottom edge of the viewport
114 to the nearest Y address of an X-axis label; negative values may
115 be used to put labels above the viewport. The value 0 is treated
116 as equivalent to 20 and the value 1 is treated as equivalent to
117 -20-h, where h is the height of the viewport in plotter address
118 units. The default value of ´XLO´ is 20, which means 20 PAUs;
119 its value may be changed by calling GASETI, GASETR, or LABMOD
120 (argument IYDC). (Note that the LABMOD argument IXDC
121 corresponds to ´YLO´ and that the LABMOD argument IYDC
122 corresponds to ´XLO´, which is perhaps somewhat
123 counterintuitive.)
124
125 ´XLS´ - Real
126 The size (width) of characters in X-axis labels. Values between
127 0 and 1 are interpreted as fractions of the width of the plotter
128 frame, while values greater than or equal to 1 are interpreted
129 as plotter address units (PAUs). The integral values 0., 1., 2.,
130 and 3. mean 8, 12, 16, and 24 PAUs, respectively. Values less
131 than zero are treated as zero. The default value of ´XLS´ is 10,
132 which means 10 PAUs; its value may be changed by calling GASETI,
133 GASETR, or LABMOD (argument ISZX).
134
135 ´XMJ´ - Real
136 The length of major ticks on the X axis. ABS(´XMJ´) specifies
137 the length of major ticks on the X axis; values between 0 and 1
138 are interpreted as fractions of the width of the plotter frame,
139 while values greater than or equal to 1 are interpreted as
140 plotter address units (PAUs). If ´XMJ´ is positive, the ticks
141 point inward; if ´XMJ´ is negative, the ticks point outward. The
142 default value of ´XMJ´ is 12, which means 12 PAUs; its value may
143 be changed by calling GASETI, GASETR, or TICKS (argument LMJX).
144
145 ´XMN´ - Real
146 The length of minor ticks on the X axis. ABS(´XMN´) specifies
147 the length of minor ticks on the X axis; values between 0 and 1
148 are interpreted as fractions of the width of the plotter frame,
149 while values greater than or equal to 1 are interpreted as
150 plotter address units (PAUs). If ´XMN´ is positive, the ticks
151 point inward; if ´XMN´ is negative, the ticks point outward. The
152 default value of ´XMN´ is 8, which means 8 PAUs; its value may
153 be changed by calling GASETI, GASETR, or TICKS (argument LMNX).
154
155 ´XOR´ - Integer
156 The orientation of X-axis labels. The value 0 implies the use of
157 horizontal labels, while the value 1 implies the use of vertical
158 labels. The default value is 0; its value may be changed by
159 calling GASETI, GASETR, or LABMOD (argument IXOR).
160
161 ´YLF´ - Character
162 The format to be used for labels on the Y axis. The character
163 string must begin with a left parenthesis and end with a right
164 parenthesis and it must not exceed ten characters in length.
165 Conversions of types E, F, G, and I are allowed. The default
166 value of ´YLF´ is ´(E10.3)´; its value may be changed by calling
167 GASETC or LABMOD (argument FMTY).
168
169 ´YLL´ - Integer
170 The length of each Y-axis label. If ´YLL´ is given a non-zero
171 value "n" and LBLY is a string produced by the format ´YLF´,
172 then the label will be the substring LBLY(1:n). If, on the other
173 hand, ´YLL´ = 0, then the label will be the substring LBLY(m:n),
174 where LBLY(m:m) is the first non-blank character in LBLY and
175 LBLY(n:n) is the last non-blank character following LBLY(m:m).
176 Using a non-zero value for ´YLL´ causes labels to be centered
177 differently than if a zero value is used. The default value of
178 ´YLL´is 0; its value may be changed by calling GASETI, GASETR,
179 or LABMOD (argument NUMY).
180
181 ´YLO´ - Real
182 The (horizontal) offset distance of a Y-axis label from the Y
183 axis. Values between 0 and 1 are interpreted as fractions of the
184 width of the plotter frame, while values greater than 1 are
185 interpreted as plotter address units (PAUs). The value is
186 interpreted as the distance from the left edge of the viewport
187 to the nearest X address of a Y-axis label; negative values may
188 be used to put labels to the right of the viewport. The value 0
189 is treated as equivalent to 20 and the value 1 is treated as
190 equivalent to -20-w, where w is the width of the viewport in
191 plotter address units. The default value of ´YLO´ is 20, which
192 means 20 PAUs; its value may be changed by calling GASETI,
193 GASETR, or LABMOD (argument IXDC). (Note that the LABMOD
194 argument IXDC corresponds to ´YLO´ and that the LABMOD argument
195 IYDC corresponds to ´XLO´, which is perhaps somewhat
196 counterintuitive.)
197
198 ´YLS´ - Real
199 The size (width) of characters in Y-axis labels. Values between
200 0 and 1 are interpreted as fractions of the width of the plotter
201 frame, while values greater than or equal to 1 are interpreted
202 as plotter address units (PAUs). The integral values 0., 1., 2.,
203 and 3. mean 8, 12, 16, and 24 PAUs, respectively. Values less
204 than zero are treated as zero. The default value of ´YLS´ is 10,
205 which means 10 PAUs; its value may be changed by calling GASETI,
206 GASETR, or LABMOD (argument ISZY).
207
208 ´YMJ´ - Real
209 The length of major ticks on the Y axis. ABS(´YMJ´) specifies
210 the length of major ticks on the Y axis; values between 0 and 1
211 are interpreted as fractions of the width of the plotter frame,
212 while values greater than or equal to 1 are interpreted as
213 plotter address units (PAUs). If ´YMJ´ is positive, the ticks
214 point inward; if ´YMJ´ is negative, the ticks point outward. The
215 default value of ´YMJ´ is 12, which means 12 PAUs; its value may
216 be changed by calling GASETI, GASETR, or TICKS (argument LMJY).
217
218 ´YMN´ - Real
219 The length of minor ticks on the Y axis. ABS(´YMN´) specifies
220 the length of minor ticks on the Y axis; values between 0 and 1
221 are interpreted as fractions of the width of the plotter frame,
222 while values greater than or equal to 1 are interpreted as
223 plotter address units (PAUs). If ´YMN´ is positive, the ticks
224 point inward; if ´YMN´ is negative, the ticks point outward. The
225 default value of ´YMN´ is 8, which means 8 PAUs; its value may
226 be changed by calling GASETI, GASETR, or TICKS (argument LMNY).
227
229 Online: gridall, gacolr, gagetc, gageti, gagetr, gasetc, gaseti,
230 gasetr, labmod, tick4, ticks.
231
232 Hardcopy: NCAR Graphics Fundamentals, UNIX Version
233
235 Copyright (C) 1987-2009
236 University Corporation for Atmospheric Research
237 The use of this Software is governed by a License Agreement.
238
239
240
241UNIX March 1993 Gridall_params(3NCARG)