INSET Statement: CAPABILITY Procedure

Dictionary of Options

The following sections provide detailed descriptions of options for the INSET statement. Terms used in this section are illustrated in Figure 5.20.

Figure 5.20: The Inset

General Options

You can specify the following general options:

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 5.23 for an example.

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. See Figure 5.19 or Output 5.15.1 for an example.

GUTTER=value

specifies the gutter width in percent screen units for an inset located in the top or bottom margin of ODS Graphics output. The gutter is the space between columns of (label, value) pairs in an inset. The default value is four. This option is ignored if ODS Graphics is disabled.

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. If all the keywords listed in the INSET statement are secondary keywords corresponding to a fitted curve on a histogram, a default header is displayed that indicates the distribution and identifies the curve. See Figure 5.19 for an example of a specified header and Output 5.15.1 for an example of the default header for a fitted normal curve.

NCOLS=n

specifies the number of columns of (label, value) pairs displayed in an inset located in the top or bottom margin of ODS Graphics output. The default value is three. This option is ignored if ODS Graphics is disabled.

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.

Note: In this release of the CAPABILITY procedure, you cannot specify coordinates with the POSITION= option when producing ODS Graphics output.

Options for Traditional Graphics

You can specify the following options if you are producing traditional graphics:

CFILL=color | BLANK

specifies the color of the background (including the header background if you do not specify the CFILLH= option). See Output 5.15.1 for an example.

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 curves, histogram bars, or specification 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

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

CFRAME=color

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

CHEADER=color

specifies 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

specifies the color of the drop shadow. See Output 5.16.1 for an example. By default, if you do not specify the CSHADOW= option, a drop shadow is not displayed.

CTEXT=color CT=color

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

FONT=font

specifies 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.

HEIGHT=value

specifies the height of the text.

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 5.24 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.