Dictionary of Options

The following entries provide detailed descriptions of options for the INSET statement. The notes Traditional Graphics and ODS Graphics identify options that apply only to traditional graphics and ODS Graphics output, respectively. Terms used in this section are illustrated in Figure 4.31.

Figure 4.31: The Inset

The Inset


CFILL=color | BLANK

Traditional Graphicsspecifies the color of the background (including the header background if you do not specify the CFILLH= option).

If you do not specify the CFILL= option, then by default, the background is empty. This means that items that overlap the inset (such as needles representing group data or decision limits) show through the inset. If you specify any value for the CFILL= option, then overlapping items no longer show through the inset. Specify CFILL=BLANK to leave the background uncolored and also to prevent items from showing through the inset.

CFILLH=color

Traditional Graphicsspecifies the color of the header background. By default, if you do not specify a CFILLH= color, the CFILL= color is used.

CFRAME=color

Traditional Graphicsspecifies the color of the frame. By default, the frame is the same color as the axis of the plot.

CHEADER=color

Traditional Graphicsspecifies the color of the header text. By default, if you do not specify a CHEADER= color, the CTEXT= color is used.

CSHADOW=color
CS=color

Traditional Graphicsspecifies the color of the drop shadow. See Figure 4.30 for an example. By default, if you do not specify the CSHADOW= option, a drop shadow is not displayed.

CTEXT=color
CT=color

Traditional Graphicsspecifies the color of the text. By default, the inset text color is the same as the other text on the plot.

DATA

specifies that data coordinates are to be used in positioning the inset with the POSITION= option. The DATA option is available only when you specify POSITION$=(x,y)$, and it must be placed immediately after the coordinates $(x,y)$. For details, see the entry for the POSITION= option or Positioning the Inset Using Coordinates. See Figure 4.34 for an example.

FONT=font

Traditional Graphicsspecifies the font of the text. By default, the font is SIMPLEX if the inset is located in the interior of the plot, and the font is the same as the other text displayed on the plot if the inset is located in the exterior of the plot.

FONT=SMALL

ODS Graphicschanges the fonts used in the inset. By default, the font associated with the GraphLabelText style element is used for the inset header and that associated with the GraphValueText style element is used for text in the body of the inset. When you specify FONT=SMALL, the GraphValueText font is used in the header and the GraphDataText font is used in the inset body.

FORMAT=format

specifies a format for all the values displayed in an inset. If you specify a format for a particular statistic, then this format overrides the format you specified with the FORMAT= option.

HEADER= 'string'

specifies the header text. The string cannot exceed 40 characters. If you do not specify the HEADER= option, no header line appears in the inset.

HEIGHT=value

Traditional Graphicsspecifies the height of the text in screen percent units.

HEIGHT=SMALL

ODS Graphicsreduces the size of the text in the inset. By default, the GraphLabelText style element determines the size of inset header text and the GraphValueText style element determines the size of text in the body of the inset. When you specify HEIGHT=SMALL, the GraphValueText size is used for the inset header and the GraphDataText size is used in the inset body.

HTRANSPARENCY=value

ODS Graphicsspecifies the inset header background transparency for ODS Graphics output. The value must be between 0 and 1, where 0 is completely opaque and 1 is completely transparent. The default inset header background transparency is 0.65.

NOFRAME

suppresses the frame drawn around the text.

POSITION=position
POS=position

determines the position of the inset. The position can be a compass point keyword, a margin keyword, or a pair of coordinates $(x,y)$. You can specify coordinates in axis percent units or axis data units. For more information, see Details: INSET Statement. By default, POSITION=NW, which positions the inset in the upper left (northwest) corner of the display.

REFPOINT=BR | BL | TR | TL
RP=BR | BL | TR | TL

specifies the reference point for an inset that is positioned by a pair of coordinates with the POSITION= option. Use the REFPOINT= option with POSITION= coordinates. The REFPOINT= option specifies which corner of the inset frame you want positioned at coordinates $(x,y)$. The keywords BL, BR, TL, and TR represent bottom left, bottom right, top left, and top right, respectively. See Figure 4.35 for an example. The default is REFPOINT=BL.

If you specify the position of the inset as a compass point or margin keyword, the REFPOINT= option is ignored. For more information, see Positioning the Inset Using Coordinates.

TRANSPARENCY=value

ODS Graphicsspecifies the inset background transparency for ODS Graphics output. The value must be between 0 and 1, where 0 is completely opaque and 1 is completely transparent. The default inset background transparency is 0.05.