PLTinfoChg TCL UTILITIES USER MANUAL PLTinfoChg
SYNOPSIS
Change plot tick mark and annotation parameters
PACKAGE
TCLPLT
NAME
PLTinfoChg
USAGE
PLTinfoChg  pID Axis Heading Item V
INPUT DEFINITIONS
pID - The plot identifier under which the plot parameters are being changed. PLTinfoChg can be called prior to invoking DefinePlot to associatd pID with a graphics window.
Axis - The axis whose parameters are being changed. This can be: Xb, Yl, Xt or Yr, the bottom X axis, left-hand Y axis, top X axis or right-hand Y axis respectively; ALL, all of the plot axes, X the upper and lower X axes (Xb and Xt), Y, the left-hand and right-hand Y axes (Yb and Yt), XYP, the primary plot axes (Xb and Yl) and XYS the secondary plot axes (Xt and Yr).
Heading - On of the three areas under which the plot parameters are defined. This can be TICKS, NUMBERS or AXIS. If Heading is AXIS the Axis input to the procedure is ignored.
Item - The plot tick mark or annotation parameters being changed. A list of the parameters is given under the procedure description below.
V - The new plot parameter setting.
RETURN DEFINITION
None
DESCRIPTION
PLTinfoChg changes tick mark or annotation parameter along on Axis in the plot identified by pID. There are a number of parameters which are split up into three Headings. This include parameters which affect tick marks, numerical annotation, and the plot axes. A complete listing of the parameters which can be changed are given in the table below along with their default setting, and a brief description. When default values differ with the plot format they are given in the order BOX, CROSSHAIR, POLAR, and MAP.
HEADING PARAMETER DEFAULTS DESCRIPTION
TICKS MJPOSITION INSIDE
STRADDLE
SPAN
-
The format used to output the major tick marks. This can be INSIDE, OUTSIDE, STRADDLE, or SPAN. It is not used in MAP plot formats. INSIDE formated ticks start at the axis and point to the interior to the plot, OUTSIDE formated ticks start at the axis and point to the exterior to the plot, STRADDLE formated ticks straddle the plot axis, and SPAN formated ticks run across the full interior of the plot.
TICKS MNPOSITION INSIDE
STRADDLE
SPAN
-
The format used to output the minor tick marks. This can be INSIDE, OUTSIDE, STRADDLE, or SPAN. It is not used in MAP plot formats. INSIDE formated ticks start at the axis and point to the interior to the plot, OUTSIDE formated ticks start at the axis and point to the exterior to the plot, STRADDLE formated ticks straddle the plot axis, and SPAN formated ticks run across the full interior of the plot.
TICKS MJLENGTH 0.05 The length of a major tick mark. A length of 1.0 will span the entire plot along the direction of the shortest axis. In a POLAR format plot the tick length is converted to degrees by multiplying the length by 360.0. In non-POLAR plots ticks of a common lenght should have the same physical length on both axis regardless of the aspect ratio of the plot. This parameter is not used in MAP based plots.
TICKS MNLENGTH 0.015 The length of a minor tick mark. A length of 1.0 will span the entire plot along the direction of the shortest axis. In a POLAR format plot the tick length is converted to degrees by multiplying the length by 360.0. In non-POLAR plots ticks of a common lenght should have the same physical length on both axis regardless of the aspect ratio of the plot. This parameter is not used in MAP based plots.
TICKS MJNUMBER 10
10
5
-
The number of a divisions in the axis which are separated by major tick marks. This parameter is not used in MAP based plots. In POLAR format plots the number of intervals along the angular axis is defaulted to 8. Five is the default along the radial axis.
TICKS MNNUMBER 5 The number of a divisions between major tick marks. These are delineated by minor tick marks. This parameter is not used in MAP based plots.
TICKS MJCOLOR 255 The index into the color table to the color used to draw the major tick marks.
TICKS MNCOLOR 255 The index into the color table to the color used to draw the minor tick marks.
TICKS MJSTART "" The start position of the first major tick mark. Default is to start at the axis edge in BOX plots plots, at the origin in CROSSHAIR and POLAR plots. This paramter is used in conjunction with the parameter MJSTEP which needs to be changed from its default setting. When set this pair of parameters overrides the MJNUMBER parameter setting.
TICKS MJSTEP "" The increment to use between major tick marks. If set, this overrides the MJNUMBER setting. The option is used in conjunction with MJSTART. In MAP plots this parameter is defaulted to 15.0 along the longitudinal axis (Xb) and 30.0 along the latitudianl axis (Yb).
TICKS MINPHI -180.0 Only valid for MAP based plots, this parameter gives the minimum extent of the tick marks running in the longitudinal direction.
TICKS MAXPHI 180.0 Only valid for MAP based plots, this parameter gives the maximum extent of the tick marks running in the longitudinal direction.
TICKS MINTHETA -90.0 Only valid for MAP based plots, this parameter gives the minimum extent of the tick marks running in the latitudinal direction.
TICKS MAXTHETA 90.0 Only valid for MAP based plots, this parameter gives the maximum extent of the tick marks running in the latitudinal direction.
TICKS NSTERM 90.0 Only valid for MAP based plots, this parameter gives the north and south extent of the tick marks running in the latitudinal direction. This is equivalent to setting MAXTHETA to a value V and MINTHETA to -V.
NUMBERS NPOSITION OUTSIDE The location of numerical annotation along the axis. This can be either INSIDE to place the annotation interior to the plot or OUTSIDE to place the annotation exterior to the plot.
NUMBERS NFORMAT %.1f or expon The format used to output numerical labels along the axis. The default is set to %.1f on LINEAR scaled axis and expon on LOG scaled axis. expon outputs just the exponent. The format can be an recognized C output format.
NUMBERS NCOLOR 255 The index into the color table to the color used when outputting numerical annotation.
NUMBERS NSIZE 15 The point size to use when outputting numerical annotation.
NUMBERS NFONT HOLD The font to use when outputting numerical annotation. HOLD indicates the currently defined font.
NUMBERS NENDS NONE The action to take when annotating the first and last major tick mark along an axis. The settings can be: NONE to output both labels, MIN to not annotate the first major tick mark, MAX to not annotate the last tick mark, and BOTH to annotate neither the first nor last tick mark.
NUMBERS TCOLOR 255 The index into the color table to the color used when outputting text annotation.
NUMBERS TSIZE 15 The point size to use when outputting text annotation.
NUMBERS TFONT HOLD The font to use when outputting text annotation. HOLD indicates the currently defined font.
NUMBERS TPOSITION OUTSIDE The location of text annotation along the axis. This can be either INSIDE to place the annotation interior to the plot or OUTSIDE to place the annotation exterior to the plot.
AXIS FORMAT BOX The format of the plot. This is; BOX for the rectangular box-like format with an upper and lower X axis and a right-hand and left-hand Y axis; POLAR for polar plots; CROSSHAIR crossed axis plots; and MAP for longitude, latitude plots. The latter needs to have the plotting coordinate system set to the map coordinate system being used.
AXIS COLOR 255 The index into the color table to the color used when drawing the plot axes.
AXIS ORIGINX 0.0 Used only in the CROSSHAIR plot format, this is the X location of where the X and Y axis cross.
AXIS ORIGINY 0.0 Used only in the CROSSHAIR plot format, this is the Y location of where the X and Y axis cross.
AXIS BASEX BBOX Used only in the CROSSHAIR plot format this indicates the location of the X axis numerical and text annotation. The options are CROSS to output the annotation relative to the crosshair X axis or BBOX to output the annotation relative to the bottom edge of the plot bounding box.
AXIS BASEY BBOX Used only in the CROSSHAIR plot format this indicates the location of the Y axis numerical and text annotation. The options are CROSS to output the annotation relative to the crosshair Y axis or BBOX to output the annotation relative to the left edge of the plot bounding box.
ERRORS
None Generated
C BACKING
No
EXAMPLE(S)
EXAMPLE 1: Examples of different plot parameter settings.
# READ the GUI preference settings

GUIprefsRead

# SET a window size

set GphInfo(xsScrL) 600
set GphInfo(ysScrL) 500
set GphInfo(xScrL) 600
set GphInfo(yScrL) 500

# START graphics

GraphicsOn TK RainBow

# ESTABLISH a graphics windows 

GenWindow 0 0.15 0.15 0.0 0.85 0.85 0.0 -6.0 -6.0 0.0 6.0 6.0 0.0

# SET up plot 0

DefinePlot 0 0 -1 -1 

# GIVE it green axes, red major tick marks and yellow minor tick marks

PLTinfoChg 0 ALL AXIS COLOR $GphInfo(Green)
PLTinfoChg 0 ALL TICKS MJCOLOR $GphInfo(Red)
PLTinfoChg 0 ALL TICKS MNCOLOR $GphInfo(Yellow)

# GIVE top X axis 5 major tick marks with 10 minor one.

PLTinfoChg 0 Xt TICKS MJNUMBER  5
PLTinfoChg 0 Xt TICKS MNNUMBER 10

# MAKE the annotation on the top X axis cyan on the top axis and change
#   the numerical annotation to %.2f

PLTinfoChg 0 Xt NUMBERS NCOLOR $GphInfo(Cyan)
PLTinfoChg 0 Xt NUMBERS NFORMAT %.2f

# ON the bottom X axis put the first major tick mark at -5.5 and let them
#    span 1.5

PLTinfoChg 0 Xb TICKS MJSTART -5.5
PLTinfoChg 0 Xb TICKS MJSTEP   1.5

# ON the left Y axis omit the top label. 

PLTinfoChg 0 Yl NUMBERS NENDS MAX

# SET the minor tick marks on the the left Y to lie outside the plot
#   and let the major tick marks on the right Y axis straddle the axis.

PLTinfoChg 0 Yl TICKS MNPOSITION OUTSIDE
PLTinfoChg 0 Yr TICKS MJPOSITION STRADDLE

# PUT the numerical labeling inside the plot on the right Y and drop the
#   top and bottom axis label

PLTinfoChg 0 Yr NUMBERS NPOSITION INSIDE
PLTinfoChg 0 Yr NUMBERS NENDS BOTH

# CHANGE the axis point size to 10 on the Y left axis

PLTinfoChg 0 Yl NUMBERS TSIZE 10

# CHANGE the Y axis font to fixed and the X to luxi serif 

PLTinfoChg 0 X NUMBERS TFONT "luxi serif"
PLTinfoChg 0 Y NUMBERS TFONT fixed

# PUT up the plot with ticks and annotation

PlotOutlines 0 [list XBOTTOM 1.0 YLEFT 1.0 XTOP 1.0 YRIGHT 1.0] \
               [list BOTH BOTH BOTH BOTH]
      
Apr 19, 2007