Optional Arguments

Options in a STAR statement affect all of the graphs that are produced by that statement. You can specify as many options as you want and list them in any order. For details about specifying colors, see Using Colors in SAS/GRAPH Programs.

ACROSS=number-of-columns

draws number-of-columns stars across the procedure output area. The ACROSS= option is ignored unless you also use the GROUP= option. If number-of-columns calls for more stars than fit horizontally in the graphics area of the output device, no stars are drawn and an error message is written to the SAS log.

If you also use the DOWN= option, the star charts are drawn in left-to-right and top-to-bottom order.

ANGLE=degrees

starts the first slice at the specified angle. A value of 0 for degrees corresponds to the three o'clock position. Degrees can be either positive or negative. Positive values move the starting position counterclockwise; negative values move the starting position clockwise.

If the star chart uses spines instead of slices, degrees specifies the angle of the position halfway between the first spine and the last spine.

By default, ANGLE=0, which places the first spine or the center of the first slice of the star at the 0 degree position. Successive star spines or slices are drawn counterclockwise from the starting position.

ANNOTATE=Annotate-data-set

specifies a data set to annotate all graphs that are produced by the GCHART procedure. To annotate individual graphs, use the ANNOTATE= option in the action statement.

Alias:ANNO=

Note:Annotate coordinate systems 1, 2, 7, and 8 (data system coordinates) are not valid with block, pie, donut, or star charts.

See:Using Annotate Data Sets

ASCENDING

arranges the bars in ascending order of the value of the chart statistic. By default, bars are arranged in ascending order of midpoint value, without regard to the lengths of the bars. ASCENDING reorders the bars from shortest to longest. In horizontal bar charts the ordering is top to bottom; in vertical bar charts the ordering is left to right.

Interactions:If you also use the GROUP= option, the reordering is performed separately for each group, so the order of the midpoints might be different for each group.

The ASCENDING option overrides any midpoint order specified with the MIDPOINTS= option or specified in the ORDER= option in an AXIS statement assigned to the midpoint axis.

CFILL=fill-color

specifies one color for all slices in the chart, regardless of whether the fill is solid or hatch. For the PIE and DONUT statements, it is possible that no pattern is specified in the pattern statement or with the FILL= option. In this case the procedure starts with the default solid fill and then, beginning with P2N0, uses each default pie hatch pattern with the specified color. For the outline color, the procedure uses the default color, which is retrieved from the current style. However, if the NOGSTYLE option is specified, the procedure uses the first color in the device's color list. Use the COUTLINE= option to specify a different outline color. The CFILL= option overrides any other pattern color specification and controls the color of all slices.

Style reference:Color attribute of the GraphData1 element

COUTLINE=star-outline-color | SAME

specifies the color for the circle that surrounds the star chart and for the slice outlines or spines. SAME specifies that the outline color of a slice is the same as the interior pattern color. Specifying COUTLINE=SAME affects only slice outlines and has no effect on the color of the circle.

The default circle and outline color are both specified in the current style. However, if the NOGSTYLE option is specified, then the default circle color is the first color in the device's color list (the foreground color). In addition, the default slice outline color is determined as follows:

• If you do not specify a PATTERN statement, the default outline color is the color defined in the current style.
• If you specify the NOGSTYLE option and no PATTERN statement, the default outline color is black for the Java or ActiveX devices. Otherwise, the default outline color is the foreground color. If you specify an EMPTY PATTERN statement, then the default outline color is the same as the fill color.

Style reference:Color attribute of the GraphOutlines element

See:Selecting Patterns for the Star Charts

About Patterns

Example:Charting a Discrete Numeric Variable in a Star Chart

CTEXT=text-color

specifies a color for all text on the axes and legend. This includes axis labels, tick mark values, legend labels, and legend value descriptions. The GCHART procedure looks for the text color in the following order:

1. colors specified for labels and values on assigned AXIS and LEGEND statements, which override the CTEXT= option specified in the STAR statement.
2. the color specified by the CTEXT= option in the STAR statement.
3. the color specified by the CTEXT= option in a GOPTIONS statement.
4. the color specified in the current style. Or, if the NOGSTYLE option is specified, then the default color is black for the Java and ActiveX devices and the first color in the color list for all other devices.

The LEGEND statement's VALUE= color is used for legend values, and its LABEL= color is used for legend labels.

The AXIS statement's VALUE= color is used for axis values, and its LABEL= color is used for axis labels. However, if the AXIS statement specifies only general axis colors with its COLOR= option, the CTEXT= color overrides the general COLOR= specification and is used for axis labels and values. The COLOR= color is still used for all other axis colors, such as tick marks.

Style reference:Color attributes for the GraphLabelText and the GraphValueText elements

Note:If you use a BY statement in the procedure, the color of the BY variable labels is controlled by the CBY= option in the GOPTIONS statement.

DESCENDING

arranges the bars in descending order of the value of the chart statistic. By default, bars are arranged in ascending order of midpoint value, without regard to the lengths of the bars. DESCENDING reorders the bars from longest to shortest. In horizontal bar charts the ordering is top to bottom; in vertical bar charts the ordering is left to right. If you also use the GROUP= option, the reordering is performed separately for each group, so the order of the midpoints might be different for each group.

The DESCENDING option overrides any midpoint order that is specified either with the MIDPOINTS= option or the ORDER= option in an AXIS statement assigned to the midpoint axis.

DESCRIPTION=“description”

specifies a description of the output. The maximum length for description is 256 characters. The description does not appear in the output. The descriptive text is shown in each of the following:

• the chart description for Web output (depending on the device driver). See Chart Descriptions for Web Presentations for more information.
• the Table of Contents that is generated when you use the CONTENTS= option on an ODS HTML statement, assuming that the output is generated while the contents page is open.
• the description and the properties for the output in the Results window.
• the description and properties for the catalog entry in the SAS Explorer.
• the Description field of the PROC GREPLAY window.

The description can include the #BYLINE, #BYVAL, and #BYVAR substitution options, which work as they do when used on TITLE, FOOTNOTE, and NOTE statements. Refer to Substituting BY Line Values in a Text String. The 256-character limit applies before the substitution takes place for these options. Thus, if in the SAS program the description text exceeds 256 characters, it is truncated to 256 characters, and then the substitution is performed.

Alias:DES=

Default:STAR CHART OF chart-variable

DISCRETE

treats a numeric chart variable as a discrete variable rather than as a continuous variable. The GCHART procedure creates a separate midpoint and, hence, a separate star slice for each unique value of the chart variable. If the variable has a format associated with it, each format value is treated as a separate value.

The LEVELS=number-of-midpoints option is ignored when you use the DISCRETE option. The MIDPOINTS= option overrides the DISCRETE option.

Example:Charting a Discrete Numeric Variable in a Star Chart

DOWN=number-of-rows

draws number-of-rows stars vertically in the procedure output area. The DOWN= option is ignored unless you also use the GROUP= option. If number-of-rows calls for more stars than fit vertically in the graphics area of the output device, no stars are drawn and an error message is written to the SAS log.

If you also use the ACROSS= option, the stars are drawn in left-to-right and top-to-bottom order.

FILL=SOLID | X

specifies the fill pattern for all slices in the star chart:

SOLID

rotates a solid fill through the list of colors available in the default style as many times as necessary. SOLID is the default.

Alias:S

X

rotates a single hatch pattern through the list of colors defined in the current style. If the NOGSTYLE option is specified, it rotates the hatch pattern through the device color list as many times as necessary. If you do not specify the colors= goption, the fill skips the first color in the color list.

FILL= overrides any pattern that is specified in PATTERN statements.

By default, the outline color is the color defined by the current style. If the NOGSTYLE option is specified, the outline color is the first color in the device's color list. If PATTERN statements are used to specify colors, the slice outline color matches the slice fill color.

If any PATTERN statements have been defined, the colors in the PATTERN definitions are used, in order, before the default style color rotation.

Style reference:Color attribute of the GraphData1 element

Example:Charting a Discrete Numeric Variable in a Star Chart

FREQ=numeric-variable

specifies a variable whose values weight the contribution of each observation in the computation of the chart statistic. Each observation is counted the number of times that are specified by the value of numeric-variable for that observation. If the value of numeric-variable is missing, 0, or negative, the observation is not used in the statistic calculation. Non-integer values of numeric-variable are truncated to integers.

The FREQ= option is valid with all chart statistics.

Because you cannot use TYPE=PERCENT or TYPE=FREQ with the SUMVAR= option, you must use FREQ= to calculate percentages and frequencies based on a sum.

The statistics are not affected by applying a format to numeric-variable.

See:Calculating Weighted Statistics

GROUP=variable

organizes the data according to values of group-variable and produces a separate star chart for each unique value of group-variable. Group-variable can be either character or numeric and is always treated as a discrete variable. Missing values for group-variable are treated as a valid group.

By default, the charts are produced in ascending order of group variable value and each is drawn on a separate page or display. Therefore, the effect of GROUP= is essentially the same as using a BY statement. The exception is that GROUP= causes the midpoints with the same value to use the same color and fill pattern. To place more than one star chart on a page or display, use the ACROSS= or DOWN= options, or both.

HTML=variable

identifies the variable in the input data set whose values create links or data tips or both. The variable values are either links or data tips or both that are created in the HTML file generated by the ODS statement. The links are URLs pointing to Web pages to display when the user clicks (drills down) on elements in the graph. Data tips are detailed information or data values that are displayed as pop-up text when a mouse pointer is positioned over elements in the graph.

Restriction:Not supported by Java or ActiveX

See:Overview of Enhancing Web Presentations

HTML_LEGEND=variable

identifies the variable in the input data set whose values create links. Input data set variable values create links that are associated with a legend value and point to the URL to display when the user clicks (drills down) on the value.

Restriction: Only star charts with slices support drill-down functionality

See:Overview of Enhancing Web Presentations

LEGEND=LEGEND<1...99>

assigns the specified LEGEND definition to the legend generated by the SUBGROUP= option. The LEGEND= option itself does not generate a legend.

The LEGEND= option is ignored if any of the following are true:

• The SUBGROUP= option is not used.
• The specified LEGEND definition is not in effect.
• The NOLEGEND option is used.
• The PATTERNID= option is set to any value other than SUBGROUP. That is, the value of PATTERNID= is BY or GROUP or MIDPOINT.

To create a legend based on the chart midpoints instead of the subgroups, use the chart variable as the subgroup variable:

block city / subgroup=city;

Restriction:The Java and ActiveX devices do not support all LEGEND statement options.

See: the LEGEND Statement for more information

SUBGROUP=subgroup-variable

Example:Grouping and Subgrouping a Block Chart

LEVELS=number-of-midpoints | ALL

specifies number of midpoints to be graphed for a chart variable. After you specify the number of midpoints that you want, the range for each numeric midpoint is calculated automatically using the algorithm described in Terrell and Scott (1985). If you specify LEVELS=ALL, then all unique numeric or character midpoint values are graphed. If your data contains a large number of unique midpoint values (more than 200), then you can use the XPIXELS and YPIXELS GOPTIONS. This enables the device driver to render a larger (and more readable) graph. The LEVELS=number-of-midpoints option is ignored if any of the following are true:

• The chart variable is character type.
• The DISCRETE option is used.
• The MIDPOINTS= option is used.

MATCHCOLOR

uses the slice pattern color for all slice labels. MATCHCOLOR overrides the color that is specified in the CTEXT= option. If the chart uses spines instead of slices, the spine color is used for the slice label and value text.

MIDPOINTS=value-list

specifies the midpoint values for the slices. The way you specify value-list depends on the type of variable:

• For numeric chart variables, value-list is either an explicit list of values, or a starting and an ending value with an interval increment, or a combination of both forms:

  • n <...n>
  • n TO n <BY increment>
  • n <...n> TO n <BY increment> <n <...n>>

  If a numeric variable has an associated format, the specified values must be the unformatted values.

  If you omit the DISCRETE option, then numeric values are treated as continuous, which means that the following is true by default:

  • The lowest midpoint consolidates all data points from negative infinity to the median of the first two midpoints.
  • The highest midpoint consolidates all data points from the median of the last two midpoints up to infinity.
  • All other values in value-list specify the median of a range of values, and the GCHART procedure calculates the midpoint values.

  If you include the DISCRETE option, each value in value-list specifies a unique numeric value.
• For character chart variables, value-list is a list of unique character values enclosed in quotation marks and separated by blanks:

  'value-1' <...'value-n'>

  If a character variable has an associated format, the specified values must be the formatted values.

For a complete description of value-list, see the value-list in the AXIS statement.

See:Understanding Midpoints

MIDPOINTS=OLD

generates default midpoints using the Nelder algorithm (Applied Statistics 25:94–7, 1976). The MIDPOINTS=OLD option is ignored unless the chart variable is numeric

MISSING

accepts a missing value as a valid midpoint for the chart variable. By default, observations with a missing value are ignored. Missing values are always valid for the group variable.

NAME='entry-name'

specifies the name of the GRSEG catalog entry and the name of the graphics output file, if one is created. The name can be up to 256 characters long, but the GRSEG name is truncated to eight characters. Uppercase characters are converted to lowercase, and periods are converted to underscores. The default name is GCHART. If the name duplicates an existing name, then SAS/GRAPH adds a number to the name to create a unique name (for example, GCHART1).

If the name specified is exactly eight characters long, then the last character of the image output filename is replaced with a number. For example, myimages is changed to myimage1.

See:About Filename Indexing

NOCONNECT

draws only star spines without connecting lines. By default, the spines are connected to form slices.

Example:Charting a Discrete Numeric Variable in a Star Chart

NOGROUPHEADING

suppresses the headings normally printed above each star when you use the GROUP= option.

NOHEADING

suppresses the heading normally printed at the top of each page or display of star chart output.

Example:Charting a Discrete Numeric Variable in a Star Chart

NOLEGEND

suppresses the legend automatically generated by the SUBGROUP= option. The NOLEGEND option is ignored if the SUBGROUP= option is not used.

PERCENT=ARROW | INSIDE | NONE | OUTSIDE

prints the percentage represented by each slice using the specified labeling method. For a description of the option values see Selecting and Positioning Spine and Slice Labels. By default, PERCENT=NONE (percentage is not displayed).

SLICE=ARROW | INSIDE | NONE | OUTSIDE

controls the position and style of the slice name (midpoint value) for each slice. For a description of the option values, see Selecting and Positioning Spine and Slice Labels. By default, SLICE=OUTSIDE (the name is outside the slice).

STARMAX=max-value

scales the chart so that the outside (or edge) of the circle represents the value that is specified by max-value. By default, the value for STARMAX= is the maximum chart statistic value.

STARMIN=min-value

scales the chart so that the center of the circle represents the value that is specified by min-value. By default, STARMIN=0. If the chart statistic has negative values, by default the value for the STARMIN= option is the minimum chart statistic value.

SUMVAR=numeric-variable

specifies a numeric variable for sum or mean calculations. The GCHART procedure calculates the sum or, if requested, the mean of the value of numeric-variable for each midpoint. The resulting statistics are represented by the size of the slice and displayed beside each slice.

When you use the SUMVAR= option, the TYPE= option must be either SUM or MEAN. With the SUMVAR= option, the default is TYPE=SUM.

Example:Specifying the Sum Statistic in a Star Chart

TYPE=statistic

specifies the chart statistic.

• If the SUMVAR= option is not used, statistic can be one of the following:

  FREQ

  frequency (the default)

  PERCENT PCT

  percentage

  If the SUMVAR= option is used, statistic can be one of the following:

  SUM

  sum (the default)

  MEAN

  mean

Because you cannot use TYPE=FREQ or TYPE=PERCENT with the SUMVAR= option, you must use FREQ= to calculate percentages or frequencies based on a sum.

See:About Chart Statistics

Calculating Weighted Statistics

URL=character-variable

specifies a character variable whose values are URLs. The variable values are URLs for Web pages to display when the user clicks (drills down) on elements in the graph.

Restrictions: This option affects graphics output that is created through the ODS HTML destination only.

Not supported by Java or ActiveX

Interaction:If you specify both the HTML= and the URL= options, then the URL= option is ignored

See:Overview of Enhancing Web Presentations

Example: GIF Output with Drill-Down Links

VALUE=ARROW | INSIDE | NONE | OUTSIDE

controls the position and style of the slice value (chart statistic) for each slice.

Default:VALUE=OUTSIDE (the value is outside of the slice)

See:Selecting and Positioning Spine and Slice Labels for a description of the option values

WOUTLINE=slice-outline-width

specifies the width of the outline in pixels. The WOUTLINE= option affects the slice outlines.

Style reference:LineThickness attribute of the GraphOutlines element