Search


Ploticus > Scripts >
proc annotate


proc annotate may be used to place arbitrary text, arrows, circles, or ellipses at specific locations, in either absolute space or scaled space. Annotation may include one or two arrows. See also the gallery annotations examples.




Hints

Specify positions in scaled units if possible.. this protects you from underlying position shift. You can get absolute locations by previewing a graph in X11 mode and clicking with the mouse... coordinates will be written to standard error for each click... Then cut/paste these into your script file for annotations. To place multiple pieces of text (from field(s) in a data file for example), proc scatterplot may be a better way to go than proc annotate.




Attributes

text     multiline text

    The text to be displayed. Terminates with a blank line. Text may also come from a file or command (see below).
    Example: 
    text:	Value
	as of 1/15/99

textdetails textdetails

    Allows control of details pertaining to the text, such as alignment, color, size, and font. Example: textdetails: align=C size=9

location     x y

    The text will be placed at this location. By default the text will be centered around X, and the bottom of the first line will be at Y. Absolute units are assumed; append (s) to one or both values to indicate scaled units.
    Example: location: 2.2(s) 3.0

clip     yes | no

    Default is no. If yes, the annotation may be cut off at the edge of the cropped graphic. Useful in cases where an annotation may be out of bounds, and you'd rather omit it than increase the cropped size to include it. (2.30+)




Backing box or ellipse

Annotation may have a backing box (the default) or an ellipse. It may be shaded and/or outlined.

ellipse     yes | no

    Default is no. If yes, an elliptical backing region will be drawn instead of a box.

backcolor     color

    If specified, a shaded box or ellipse will be rendered in the specified color. Any annotation text will be rendered on top of the shaded region. Specify outline to encompass the backing region with a line.

outline     linedetails

    If specified, the backing box or ellipse will be outlined with a line of this type. May be used with or without backcolor.
    Example: outline: yes (do a default box)
    Example: outline: color=yellow width=1.0

box     Same as outline above. (Deprecated)

boxmargin     n

    If specified, increase the size of any backing box or ellipse by n absolute units on all four sides. A negative value decreases the size.
    Example: boxmargin: 0.15

backadjust     a b c d

    Allows adjustments to be made to the default backing box or backing ellipse. To adjust a backing box, a will be added to the left side, b will be added to the bottom side, c will be added to the right side, and d will be added to the top. To adjust a backing ellipse, a will be added to the ellipse width and b will be added to the ellipse height; c and d should be given as 0. a b c d are in inches (or cm). New in version 2.40
    For example, to stretch the default backing box to make it wider but no taller use: backadjust: -0.2 0 0.2 0

backdim     a b c d

    This allows size and location of background box (or ellipse) to be explicitly given, for situations where the automatic methods don't give satisfactory results. For backing box, a b defines the upper left location of the box, c determines the width, and d the height. For ellipse, a b defines the center, c the width, and d the height a and b are locvalues, while c and d are always inches (or cm).




Arrows

arrowhead     x y

    If specified, an arrow will be drawn pointing at this location. The tail of the arrow will be placed automatically if arrowtail is not specified. Absolute units are assumed; append (s) to one or both values to indicate scaled units.
    Example: arrowhead: 2012(s) 85(s)

arrowhead2     x y

    Same as arrowhead above, for a second arrow.

arrowdetails     linedetails

    Allows control of details pertaining to the arrows, such as line thickness and color.

arrowheadsize     n

    Controls the size of the arrowhead. n is the length of the arrowhead in absolute units (default 0.1 inches). This attribute may be set to 0 to suppress arrowhead and just draw line.

arrowtail     x y

    If specified, tail of 1st arrow will be at this point. Useful if automatic placement does not give acceptable results.

arrowtail2     x y

    If specified, tail of 2nd arrow will be at this point. Useful if automatic placement does not give acceptable results.




Clickmap and mouseover

clickmapurl     url

    If generating an HTML clickmap on the attribute box, this specifies a url. See HTML clickmap for more details and examples.
    Example: clickmapurl: http://abc.com/docs/explanation.html

clickmaplabel     label

clickmaplabeltext     multiline text

    Same as clickmaplabel but multiline text. Must be terminated with a blank line.




Optional bevel / drop shadow

A bevel or drop shadow can be rendered along with a backing box (but not a backing ellipse).

bevelsize     n

shadowsize     n

    Width of visible portion of optional drop shadow in absolute units. Default is 0.0 (no drop shadow).

hibevelcolor     color

    Color of upper and lefttmost bevels. Default is gray(0.6)

lowbevelcolor     color

    Color of lower and rightmost bevels. Default is gray(0.8)

shadowcolor     color

    Color of drop shadow. Default is black.




Misc.

verttext     yes | no

    If yes, text will be rendered vertically, from low to high. This is a limited implementation; backing box does not work with vertical text, nor does automatic arrow tail placement (arrow tail must be specified).

fromfile     filename

    If specified, the text will be read from this file. This filename is expanded by a shell.
    Security concern: user-supplied values (such as CGI user variables) should not be used to build this filename.

fromcommand     shell command

    If specified, this shell command will be executed to yield text on its standard output. Reminder: User-supplied values (such as CGI user variables) should not be used to build the shell command.

 


Ploticus 2.42 ... May 2013 Terms of use /