RECTANGLE Function

Draws a rectangle annotation around the specified (X1, Y1) coordinates using the specified height and width. By default, the (X1, Y1) coordinates constitute the center of the rectangle, though you can change this behavior using the ANCHOR option.
Tip: An easy way to draw a square is to specify PIXEL for the HEIGHTUNIT and WIDTHUNIT variables and then provide the same value for the HEIGHT and WIDTH.
Syntax

Syntax

FUNCTION= “RECTANGLE”;

Required Variables

HEIGHT= numeric-value
specifies the height of the annotation. Specify a positive number greater than zero. You can use the HEIGHTUNIT variable to specify the unit of measurement.
Default:none
WIDTH= numeric-value
specifies the width of the annotation. Specify a positive number greater than zero. You can use the WIDTHUNIT variable to specify the unit of measurement.
Default:none
X1= numeric-value
specifies the X coordinate of the annotation.
Default:none
Y1= numeric-value
specifies the Y coordinate of the annotation.
Default:none

Optional Variables

ANCHOR= “TOPLEFT” | “TOP” | “TOPRIGHT” | “RIGHT” | “BOTTOMRIGHT” | “BOTTOM” | “BOTTOMLEFT” | “LEFT” | “CENTER”
specifies the anchor position of the annotation. This point is placed on the specified X1 and Y1 positions.
Default:CENTER
CORNERRADIUS= numeric-value
specifies the roundness of the corners of rectangles. Specify a value from 0.0 (completely rectangular) to 1.0 (oval).
Default:0.0
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)
DISPLAY= “ALL” | “FILLED” | “OUTLINE”
specifies the fill and outline properties. You can specify that the annotation be filled (FILLED), have an outline (OUTLINE), or both (ALL).
Default:OUTLINE
DRAWSPACE= “draw-space-value”
specifies the drawing space and units for the annotation. DRAWSPACE can be used rather than specify X1SPACE and Y1SPACE individually.
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.
FILLCOLOR= “color” | “style-attribute”
specifies a fill 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
Interaction:This option takes effect only if the DISPLAY option is specified as FILLED or ALL.
FILLTRANSPARENCY= numeric-value
specifies the transparency for the fill portion of an annotation. Specify a value from 0.0 (completely opaque) to 1.0 (completely transparent).
Default:0.0
HEIGHTUNIT= “DATA” | “PERCENT” | “PIXEL”
specifies the dimension unit to use for the HEIGHT value.
Default:PERCENT
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
ROTATE= degrees
rotates the annotation. Specify a number between 0 and 360.
Default:0
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
WIDTHUNIT= “DATA” | “PERCENT” | “PIXEL”
specifies the dimension unit to use for the WIDTH value.
Default:PERCENT
X1SPACE= “draw-space-value”
specifies the drawing space of the annotation’s 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.
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
Y1SPACE= “draw-space-value”
specifies the drawing space of the annotation’s 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.
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
Copyright © SAS Institute Inc. All rights reserved.