PLTaxisCross	TCL UTILITIES USER MANUAL	PLTaxisCross

SYNOPSIS

Tick mark and annotate crosshair plot axis

PACKAGE

TCLPLT

NAME

PLTaxisCross

USAGE

PLTaxisCross

pID Axis TMode LMode Level {Pos} {LJust} {Label}

INPUT DEFINITIONS

pID	-	The identifier of the plot whose axis is to be modified.
Axis	-	The axis to be modified. This can either be Xb or Yl. Xt or Yr can be used when LMode is AXIS and the output is being made against the rectangular bounding plot box.
TMode	-	Flag indicating if any tick marks are to be output. This can be: NONE - No tick mark output ALLMAJOR - Output all the major tick marks along Axis ALLMINOR - Output all the minor tick marks along Axis BOTH - Output all the major and minor tick marks along Axis ONEMAJOR - Output one the major tick mark along Axis at Pos ONEMINOR - Output one the minor tick mark along Axis at Pos
LMode	-	Flag indicating if any labels are to be output. Output labels can be output relative either to the crosshair axes or to the plot bounding box. This is defaulted to the bounding box but can be changed by calling PLTinfoChg and setting the base axis (BASEX or BASEY to BASE. The LMode options are: NONE - No label output AUTO - Output labels for all the major tick marks along Axis AXIS - Label Axis, putting the Label at Pos at the specified Level and with the specified justification LJust. MANUAL - Used with ONEMAJOR or ONEMINOR to indicate that the tick mark being output should be annotated with the supplied Label.
Level	-	The output level in characters of any annotation. For annotation associated with tick marks level is measured from the point of the fartheset tick mark extension from the axis being annotated. For axis labeling level is measured from the farthest tick mark annotation along that axis being annotated.
Pos	-	An optional input which is defaulted to 0.0. This is used when drawing single tick marks to locate the position along the axis where the tick mark is to be placed. When labeling an axis it defines the position along the axis where the label is to be anchored.
LJust	-	An optional input which gives the justification to use when outputting annotation. The default is center. Other recognized options are left and right. Left places the right edge of the label at Pos while right places the left edge of the label at Pos.
Label	-	An optional input which provided the label to output when LMode is set to either AXIS or MANUAL. It is defaulted to "".

RETURN DEFINITION

None

DESCRIPTION

PLTaxisCross is a low level procedure for putting tick marks and annotation on a plot axis in a crosshair plot. It is one of the procedures used by PlotOutline to annotate plot axes and is generally used outside of PlotOutline to add additional annotation to plots but could be used to fully tick mark and annotate a plot in place of PlotOutline.
PLTaxisCross will place tick marks and/or annotation on the axis specified in Axis in the plot identified by pID. Tick marks are output according to TMode and can only be output against the Axis Xb or Yl. If TMode is set to NONE then there are no tick marks output. Single major or minor tick marks can be output by setting TMode to either ONEMAJOR or ONEMINOR respectively; all of the major or minor tick marks by setting TMode to either ALLMAJOR or ALLMINOR respectively; or all the tick marks by setting TMode to BOTH. In the case of ONEMAJOR or ONEMINOR the tick mark is output at Pos.
Annotation can be output either on its own or in conjunction with tick marks. It is output relative to either the crosshair axes or a set of virtual axis represented by the pox bounding the plot. The default location is relative to the bounding box which can be changed by invoking PLTinfoChg and setting the base axis (BASEX or BASEY to BASE. The output mode is set in LMode. MANUAL mode is used in conjunction with ONEMAJOR or ONEMINOR with the label specified in Label output in conjunction with tick mark. The label placement is made in accordance with LJust and Level. Positive level values outputs the label outside the plot box and negative level values outputs the label inside the plot box. Level is measured in characters from the farthest extending inwards (negative level) or outwards (positive level) tick mark when outputting relative to the crosshair axis otherwise its measured from the edge of the bounding box. The AUTO annotation mode is similar to MANUAL except that it produces all of the numerical annotation for major tick marks (even if they have not been or are not being drawn). AXIS mode annotation is again like MANUAL mode using both Pos and Level for positioning and LJust for alignment. The difference is that in AXIS based annotation Level is measured from the from the farthest extending inwards (negative level) or outwards (positive level) numerical annotation.

ERRORS

None Generated

C BACKING

No

EXAMPLE(S)

EXAMPLE 1:Usage examples showing annotation relative to the crosshair axes and the bounding box.

Apr 18, 2007