ARROW Function

Draws an arrow annotation from the specified (X1, Y1) coordinates to the specified (X2,Y2) coordinates.

Syntax

FUNCTION= “ARROW”;

Required Variables

X1= numeric-value
specifies the first X coordinate of the annotation.
Default:none
X2= numeric-value
specifies the second X coordinate of the annotation.
Default:none
Y1= numeric-value
specifies the first Y coordinate of the annotation.
Default:none
Y2= numeric-value
specifies the second Y coordinate of the annotation.
Default:none

Optional Variables

DIRECTION= “BOTH” | “IN” | “OUT”
specifies the direction for arrows.
“BOTH”
Places the arrowhead at both ends of the line.
“IN”
Places the arrowhead at the source (X1 or Y1 coordinate) of the line.
“OUT”
Places the arrowhead at the tail end (X2 or Y2 coordinate) of the line.
Default:OUT
DISCRETEOFFSET= numeric-value
specifies an amount to offset the annotation from a discrete value in data space. Specify a value from -0.5 (left offset) to +0.5 (right offset).
Default:0.0 (no offset)
DRAWSPACE= “draw-space-value
specifies the drawing space and units for the annotation. DRAWSPACE can be used rather than specify individual values for X1SPACE, X2SPACE, Y1SPACE, and Y2SPACE.
draw-space-value can be one of the following:
  • DATAPERCENT
  • DATAPIXEL
  • DATAVALUE
  • GRAPHPERCENT
  • GRAPHPIXEL
  • LAYOUTPERCENT
  • LAYOUTPIXEL
  • WALLPERCENT
  • WALLPIXEL
Default:GRAPHPERCENT (unless overridden by a coordinate draw space, such as X1SPACE)
Restriction:For the SGPANEL and SGSCATTER procedures, only GRAPHPERCENT, GRAPHPIXEL, LAYOUTPERCENT, and LAYOUTPIXEL values are valid.
See:For more information about these values, see Drawing Space Values.
LAYER= “BACK” | “FRONT”
specifies whether the annotation is drawn in front of (FRONT) or behind (BACK) the graph.
Default:FRONT
LINECOLOR= “color” | “style-attribute
specifies a line color for the annotation. You can specify a color or a style element attribute. Here is an example of a style attribute:
GraphData2:Color
You can specify colors using the same color schemes that are supported by SAS/GRAPH software. For more information, see Color-Naming Schemes in SAS/GRAPH: Reference.
Default:COLOR attribute in the graph’s current style
LINEPATTERN= “line-pattern
specifies a line pattern for the annotation. You can reference SAS patterns by number or by name. For a list of line patterns, see Line Patterns.
Default:LineStyle attribute in the graph’s current style
LINETHICKNESS= n
specifies the thickness of the line. You cannot specify the unit of measure. The default unit of pixels is always used.
Default:LineThickness attribute in the graph’s current style
SCALE= numeric-value
specifies a scale factor for the arrowheads. Specify a positive number.
Default:determined by the procedure
SHAPE= BARBED | CLOSED | FILLED | OPEN
specifies the shape of the arrowheads. Specify one of the following:
BARBED
a solid triangle with an indent at the base. barbed arrowhead
CLOSED
an outline of a triangle.closed arrowhead
FILLED
a solid triangle.filled arrowhead
OPEN
a triangle that resembles the letter "V".Open arrowhead
Default:OPEN
TRANSPARENCY= numeric-value
specifies the degree of transparency for the annotation. Specify a value from 0.0 (completely opaque) to 1.0 (completely transparent).
Default:0.0
X1SPACE= “draw-space-value
specifies the drawing space of the annotation’s first X coordinate.
draw-space-value can be one of the following:
  • DATAPERCENT
  • DATAPIXEL
  • DATAVALUE
  • GRAPHPERCENT
  • GRAPHPIXEL
  • LAYOUTPERCENT
  • LAYOUTPIXEL
  • WALLPERCENT
  • WALLPIXEL
Default:GRAPHPERCENT
Restriction:For the SGPANEL and SGSCATTER procedures, only GRAPHPERCENT, GRAPHPIXEL, LAYOUTPERCENT, and LAYOUTPIXEL values are valid.
Note:If you do not also specify the X2SPACE= value, then the second X coordinate uses the default drawing space.
See:For more information about these values, see Drawing Space Values.
X2SPACE= “draw-space-value
specifies the drawing space of the annotation’s second X coordinate.
draw-space-value can be one of the following:
  • DATAPERCENT
  • DATAPIXEL
  • DATAVALUE
  • GRAPHPERCENT
  • GRAPHPIXEL
  • LAYOUTPERCENT
  • LAYOUTPIXEL
  • WALLPERCENT
  • WALLPIXEL
Default:GRAPHPERCENT
Restriction:For the SGPANEL and SGSCATTER procedures, only GRAPHPERCENT, GRAPHPIXEL, LAYOUTPERCENT, and LAYOUTPIXEL values are valid.
Note:If you do not also specify the X1SPACE= value, then the first X coordinate uses the default drawing space.
See:For more information about these values, see Drawing Space Values.
XAXIS= “X” | “X2”
specifies which X axis to use for data space annotations.
Default:X
XC1= “text-string”
specifies the character X coordinate of an annotation.
Default:none
XC2= “text-string”
specifies the second character X coordinate of an annotation.
Default:none
Y1SPACE= “draw-space-value
specifies the drawing space of the annotation’s second Y coordinate.
draw-space-value can be one of the following:
  • DATAPERCENT
  • DATAPIXEL
  • DATAVALUE
  • GRAPHPERCENT
  • GRAPHPIXEL
  • LAYOUTPERCENT
  • LAYOUTPIXEL
  • WALLPERCENT
  • WALLPIXEL
Default:GRAPHPERCENT
Restriction:For the SGPANEL and SGSCATTER procedures, only GRAPHPERCENT, GRAPHPIXEL, LAYOUTPERCENT, and LAYOUTPIXEL values are valid.
Note:If you do not also specify the Y2SPACE= value, then the second Y coordinate uses the default drawing space.
See:For more information about these values, see Drawing Space Values.
Y2SPACE= “draw-space-value
specifies the drawing space of the annotation’s second Y coordinate.
draw-space-value can be one of the following:
  • DATAPERCENT
  • DATAPIXEL
  • DATAVALUE
  • GRAPHPERCENT
  • GRAPHPIXEL
  • LAYOUTPERCENT
  • LAYOUTPIXEL
  • WALLPERCENT
  • WALLPIXEL
Default:GRAPHPERCENT
Restriction:For the SGPANEL and SGSCATTER procedures, only GRAPHPERCENT, GRAPHPIXEL, LAYOUTPERCENT, and LAYOUTPIXEL values are valid.
Note:If you do not also specify the Y1SPACE= value, then the first Y coordinate uses the default drawing space.
See:For more information about these values, see Drawing Space Values.
YAXIS= “Y” | “Y2”
specifies which Y axis to use for data space annotations.
Default:Y
YC1= “text-string”
specifies the character Y coordinate of an annotation.
Default:none
YC2= “text-string”
specifies the second character Y coordinate of an annotation.
Default:none