Gridall_params(3NCARG)

🌸 NAME 🌸

Gridall_params — the 3NCARG page that gives you the full rundown on every single Gridall internal parameter. Yes, every one. Sit down, bestie, we're doing this. 💖

✨ DESCRIPTION ✨

okay so first thing you need to know: GRIDAL has twenty-two internal parameters. Twenty-two! And every single one of them affects, in some way or another, the behavior of the routines that draw backgrounds. That's the whole point of them. 👑

Wanna know what a parameter is currently set to? Just call GAGETC, GAGETI, and/or GAGETR and it will tell you. Wanna reset it? GASETC, GASETI, and/or GASETR have your back. And some of them can also be reset by calling a few older routines — yes, the classics: GACOLR, LABMOD, TICKS, and TICK4. Vintage. 💅

Below, in alphabetical order, are the descriptions of all the Gridall internal parameters. Each description kicks off with a line giving the parameter name and the intrinsic FORTRAN type of that parameter, because we are thorough and we are not playing around. 🎀

---

• CAX — Integer

The polyline color index used for drawing the axes. A negative value means no change is made to the polyline color index before the axes get drawn. Default is -1. You can change it with GASETI, GASETR, or GACOLR (argument KAXS).

• CLB — Integer

The polyline/text color index used for drawing labels. (Both get affected, because labels might be drawn with calls to WTSTR or with calls to PLCHHQ.) A negative value means no change is made to the polyline and text color indices before the labels get drawn. Default is -1. Change it with GASETI, GASETR, or GACOLR (argument KLBL).

• CMJ — Integer

The polyline color index used for major ticks and/or grid lines. A negative value means no change is made to the polyline color index before major ticks/grid lines get drawn. Default is -1. Change it with GASETI, GASETR, or GACOLR (argument KMJT).

• CMN — Integer

The polyline color index used for minor ticks and/or grid lines. A negative value means no change is made to the polyline color index before minor ticks/grid lines get drawn. Default is -1. Change it with GASETI, GASETR, or GACOLR (argument KMNT).

• LTY — Integer

The labeling type. A value of 0 means the SPPS routine WTSTR gets called to draw labels. A value of 1 means the Plotchar routine PLCHHQ gets called instead. Default is 0. Change it with GASETI or GASETR.

• WAX — Real

The line width used for drawing the axes. A value less than or equal to zero means no change is made to the line width scale factor before the axes get drawn. Default is 0. Change it with GASETI or GASETR.

• WLB — Real

The line width used for drawing labels. (Labels drawn with calls to the Plotchar routine PLCHHQ are affected by this; labels drawn with calls to the SPPS routine WTSTR are not.) A value less than or equal to zero means no change is made to the line width scale factor before the labels get drawn. Default is 0. Change it with GASETI or GASETR.

• WMJ — Real

The line width used for major ticks and/or grid lines. A value less than or equal to zero means no change is made to the line width scale factor before drawing. Default is 0. Change it with GASETI or GASETR.

• WMN — Real

The line width used for minor ticks and/or grid lines. A value less than or equal to zero means no change is made to the line width scale factor before drawing. Default is 0. Change it with GASETI or GASETR.

• XLF — Character

The format used for labels on the X axis. The character string must begin with a left parenthesis and end with a right parenthesis, and it must not exceed ten characters in length. Conversions of types E, F, G, and I are allowed. Default is (E10.3). Change it with GASETC or LABMOD (argument FMTX).

• XLL — Integer

The length of each X-axis label. If XLL is given a non-zero value n and LBLX is a string produced by the format XLF, then the label will be the substring LBLX(1:n). If, on the other hand, XLL = 0, then the label will be the substring LBLX(m:n), where LBLX(m:m) is the first non-blank character in LBLX and LBLX(n:n) is the last non-blank character following LBLX(m:m). Heads up: using a non-zero value for XLL causes labels to be centered differently than if a zero value is used. Default is 0. Change it with GASETI, GASETR, or LABMOD (argument NUMX).

• XLO — Real

The (vertical) distance of an X-axis label from the X axis. Values between 0 and 1 are interpreted as fractions of the width of the plotter frame, while values greater than 1 are interpreted as plotter address units (PAUs). The value is interpreted as the distance from the bottom edge of the viewport to the nearest Y address of an X-axis label; negative values may be used to put labels above the viewport. The value 0 is treated as equivalent to 20, and the value 1 is treated as equivalent to -20-h, where h is the height of the viewport in plotter address units. Default is 20, which means 20 PAUs. Change it with GASETI, GASETR, or LABMOD (argument IYDC).

🫠 okay so a lil note here: the LABMOD argument IXDC corresponds to YLO, and the LABMOD argument IYDC corresponds to XLO — which is perhaps somewhat counterintuitive. iykyk.

• XLS — Real

The size (width) of characters in X-axis labels. Values between 0 and 1 are interpreted as fractions of the width of the plotter frame, while values greater than or equal to 1 are interpreted as plotter address units (PAUs). The integral values 0., 1., 2., and 3. mean 8, 12, 16, and 24 PAUs, respectively. Values less than zero are treated as zero. Default is 10, which means 10 PAUs. Change it with GASETI, GASETR, or LABMOD (argument ISZX).

• XMJ — Real

The length of major ticks on the X axis. ABS(XMJ) specifies the length of major ticks on the X axis; values between 0 and 1 are interpreted as fractions of the width of the plotter frame, while values greater than or equal to 1 are interpreted as plotter address units (PAUs). If XMJ is positive, the ticks point inward; if XMJ is negative, the ticks point outward. Default is 12, which means 12 PAUs. Change it with GASETI, GASETR, or TICKS (argument LMJX).

• XMN — Real

The length of minor ticks on the X axis. ABS(XMN) specifies the length of minor ticks on the X axis; values between 0 and 1 are interpreted as fractions of the width of the plotter frame, while values greater than or equal to 1 are interpreted as plotter address units (PAUs). If XMN is positive, the ticks point inward; if XMN is negative, the ticks point outward. Default is 8, which means 8 PAUs. Change it with GASETI, GASETR, or TICKS (argument LMNX).

• XOR — Integer

The orientation of X-axis labels. A value of 0 means horizontal labels, a value of 1 means vertical labels. Default is 0. Change it with GASETI, GASETR, or LABMOD (argument IXOR).

• YLF — Character

The format used for labels on the Y axis. The character string must begin with a left parenthesis and end with a right parenthesis, and it must not exceed ten characters in length. Conversions of types E, F, G, and I are allowed. Default is (E10.3). Change it with GASETC or LABMOD (argument FMTY).

• YLL — Integer

The length of each Y-axis label. If YLL is given a non-zero value n and LBLY is a string produced by the format YLF, then the label will be the substring LBLY(1:n). If, on the other hand, YLL = 0, then the label will be the substring LBLY(m:n), where LBLY(m:m) is the first non-blank character in LBLY and LBLY(n:n) is the last non-blank character following LBLY(m:m). Same energy as XLL: a non-zero value for YLL causes labels to be centered differently than if a zero value is used. Default is 0. Change it with GASETI, GASETR, or LABMOD (argument NUMY).

• YLO — Real

The (horizontal) offset distance of a Y-axis label from the Y axis. Values between 0 and 1 are interpreted as fractions of the width of the plotter frame, while values greater than 1 are interpreted as plotter address units (PAUs). The value is interpreted as the distance from the left edge of the viewport to the nearest X address of a Y-axis label; negative values may be used to put labels to the right of the viewport. The value 0 is treated as equivalent to 20, and the value 1 is treated as equivalent to -20-w, where w is the width of the viewport in plotter address units. Default is 20, which means 20 PAUs. Change it with GASETI, GASETR, or LABMOD (argument IXDC).

🫠 and yes, the same lil note again: the LABMOD argument IXDC corresponds to YLO, and the LABMOD argument IYDC corresponds to XLO — which is perhaps somewhat counterintuitive.

• YLS — Real

The size (width) of characters in Y-axis labels. Values between 0 and 1 are interpreted as fractions of the width of the plotter frame, while values greater than or equal to 1 are interpreted as plotter address units (PAUs). The integral values 0., 1., 2., and 3. mean 8, 12, 16, and 24 PAUs, respectively. Values less than zero are treated as zero. Default is 10, which means 10 PAUs. Change it with GASETI, GASETR, or LABMOD (argument ISZY).

---

and bestie… that's the Y's starting to roll in, and we are not done yet 👀

• YMJ — Real 💖

Okay bestie, this one is the length of the major ticks on the Y axis, and the way it works is chef's kiss simple: ABS of YMJ gives you that length. So like, how do you actually read it?

• values sitting between 0 and 1 get read as fractions of the width of the plotter frame 🎀
• values greater than or equal to 1 get read as plotter address units (PAUs) ✨

Sign vibes matter here, fr fr — if YMJ is positive, the ticks point inward; if YMJ is negative, they point outward. No in-between, it's giving binary.

Default? <yellow>12</yellow>, which means 12 PAUs. And if you wanna change it, you call GASETI, GASETR, or TICKS (that's the LMJY argument, iykyk).

• YMN — Real 💜

Same energy, different axis behavior — this is the length of the minor ticks on the Y axis. ABS of YMN specifies that length, and the rules are identical to its major-tick sibling:

• values between 0 and 1 → fractions of the width of the plotter frame 🌸
• values greater than or equal to 1 → plotter address units (PAUs) ⭐

YMN positive = ticks point inward. YMN negative = ticks point outward. Periodt.

The default value of YMN is <yellow>8</yellow>, which means 8 PAUs 🦋. Wanna switch it up? Call GASETI, GASETR, or TICKS (argument LMNY this time, don't mix them up 😭).

---

🔍 SEE ALSO 🔍

Online: gridall, gacolr, gagetc, gageti, gagetr, gasetc, gaseti, gasetr, labmod, tick4, ticks.

Hardcopy: NCAR Graphics Fundamentals, UNIX Version 📚

---

📜 COPYRIGHT 📜

Copyright (C) 1987-2009 University Corporation for Atmospheric Research The use of this Software is governed by a License Agreement.

---

and that's the whole page bestie, we ate and left absolutely zero crumbs 💅✨ This legendary lil' manual page is from the UNIX manual, dated March 1993, and its source/version tag is Gridall_params(3NCARG) 👑 mwah, go forth and tick those axes 🎀🫶