The GKPI Procedure

DIAL, HBULLET, HSLIDER, HTRAFFICLIGHT, SPEEDOMETER, VTRAFFICLIGHT, VBULLET, and VSLIDER Statements

Creates a chart in one of seven display types.

Requirements:	The ACTUAL= value and the BOUNDS= list are required.
Global statements:	TITLE, FOOTNOTE
Supports:	Drill-down functionality

Description

The DIAL, HBULLET, HSLIDER, HTRAFFICLIGHT, SPEEDOMETER, VTRAFFICLIGHT, VBULLET, and VSLIDER statements specify the type of graphic to be used to display the key performance indicator. One of the following display types is required:

DIAL: specifies a dial.
HBULLET | BULLET: specifies a horizontal bullet graph (a horizontal bar with a horizontal line that represents the actual KPI value).
HSLIDER | SLIDER: specifies a horizontal bar with a triangle that marks the actual KPI value.
HTRAFFICLIGHT: specifies a horizontal traffic light.
SPEEDOMETER: specifies a speedometer.
VTRAFFICLIGHT| TRAFFICLIGHT: specifies a vertical traffic light.
VBULLET: specifies a vertical bullet graph (a vertical bar with a vertical line that represents the actual KPI value).
VSLIDER: specifies a vertical bar with a triangle that marks the actual KPI value.

See Overview for examples of each display type.

Syntax

option(s) can be one or more options from any or all of the following categories:

appearance options

	ACTIVECOLORS=(color_1 color_2 color_3 ...color_n-1)
	AFONT=(<f="fontname</BOLD></ITALICS>"> <c=color> <h=text-height<units>>)
	AVALUE \| NOAVALUE
	BFONT=(<f="fontname</BOLD></ITALICS>"> <c=color> <h=text-height<units>>)
	BVALUE \| NOBVALUE
	COLORS=(color_1 color_2 color_3 ...color_n-1)
	FORMAT="SAS-format"
	LABEL= "string"
	LFONT=(<f="fontname</BOLD></ITALICS>"> <c=color> <h=text-height<units>> <j=justification>)
	LOWBOUNDARY \| NOLOWBOUNDARY
	TARGET= data-value
	TYPE=FULL \| HALF \| QUARTER

output file description options

DESCRIPTION="description"

NAME="name"

Required Arguments

ACTUAL= data-value: specifies the actual value of the key performance indicator. The actual data value can fall outside the bounds specified with the BOUNDS= option, but the GKPI procedure will display the actual value indicator at the outermost edge of the KPI chart. If you specify a missing value (ACTUAL=.), then the GKPI procedure does not generate a KPI chart.
BOUNDS=(bound_1 bound_2 bound_3 ...bound_n): specifies a list of defined boundary values. The values can be negative or positive, but you must specify the list in either ascending or descending order. Separate each boundary value with a blank space.

See Specifying Segment Boundaries and Actual KPI Values for more information.

Options

You can specify as many options as needed and list them in any order.

ACTIVECOLORS=(color_1 color_2 color_3 ...color_n-1)

specifies the list of active colors for each segment (the colors that you want to use for each segment when that segment contains the actual KPI value). You do not have to specify a color for each segment in the KPI chart. The default colors shown in GKPI Procedure Default Colors (or the colors specified by the COLORS= option) are used for each segment for which active colors are not specified. The number of entries in the ACTIVECOLORS= list cannot exceed the number of segments that are defined; that is, the maximum number of active colors is one less than the number of entries in the BOUNDS= list. Separate each color with either a blank space or a comma.

See Controlling Segment Colors for more information.

AFONT=(<f="fontname"</BOLD></ITALICS>> <c=color> <h=text-height<units>>)

specifies the name, color, and text height for the font used for the actual KPI value label. For example AFONT=(f="Comic Sans MS" c=red h=15pt) . See Specifying Fonts for more information.

Style reference:

Font attribute of the GraphLabelText element

AVALUE | NOAVALUE

specifies whether to display the actual KPI value label.

Alias:	AVAL \| NOAVAL
Default:	AVALUE

BFONT=(<f="fontname"</BOLD></ITALICS>> <c=color> <h=text-height<units>>)

specifies the name, color, and text height of the font used for the boundary and tick mark values. For example, BFONT=(font="Arial" color=H14055FF height=.25in) . See Specifying Fonts for more information.

If you increase the size of the font to the point where labels would collide, then the intermediate labels are not displayed. The GKPI procedure displays only the lowest and highest boundary labels.

Style reference:

Font attribute of the GraphValueText element

BVALUE | NOBVALUE

specifies whether to display the boundary values.

Alias:	BVAL \| NOBVAL
Default:	BVALUE

COLORS=(color_1 color_2 color_3 ...color_n-1)

specifies the list of inactive colors for each segment (the colors that you want to be used for each segment when that segment does not contain the actual KPI value). You must specify a color for each segment in the KPI chart. That is, the number of entries in the COLORS= list must be one less than the number of entries in the BOUNDS= list. Separate each color with either a blank space or a comma.

For all KPI charts except traffic lights, if you define two to five segments, the GKPI procedure applies a default set of colors ranging from red to green. If you define only one or more than five segments, the default color for all segments is gray.

For traffic lights, the default color for all segments is gray. This option is ignored by the TRAFFICLIGHT statement if the ACTIVECOLORS= option is specified.

See Controlling Segment Colors for more information.

DESCRIPTION= "description"

specifies the description of the output. The maximum length for the description is 256 characters. The description does not appear on the graph. The default is "Key performance indicator".

The descriptive text is shown in the "description" portion of each of the following:

the Results window.
the Table of Contents that is generated when you use the CONTENTS= option on an ODS HTML statement.
the chart description for Web output. See Chart Descriptions for Web Presentations for more information.

Alias:

DES=

FORMAT="SAS-format"

specifies a SAS format for the boundary and actual values. The default format is BEST. For example, you can use format="percent8.0" to display values as percentages or format="datetime7." to display SAS datetime values in the format ddmmmyy.

[Speedometer showing values formatted as percentages and slider showing boundary values formatted as dates]

See SAS Formats Supported for Java for more information.

LABEL= "string"

specifies a label for the graphic. The label is displayed at the top of graph, beneath the title, if a title is specified.

Note: By default, labels are displayed at the top center of the graphics output area, and the KPI chart is displayed in the center of the output area. To reduce the space between labels and the KPI chart, reduce the size of the graphics output area by specifying the XPIXELS=/YPIXELS= or HSIZE=/VSIZE= options on the GOPTIONS statement. See The Graphics Output and Device Display Areas for more information. [cautionend]

LFONT=(<f="fontname"</BOLD></ITALICS>> <c=color> <h=text-height<units>> <j=justification>)

specifies the name, color, and text height of the font to use for the label that is specified by the LABEL= option. You can also specify whether the label is left-justified, centered, or right-justified within the graphics output area. For example: LFONT=(f="Albany AMT/italics" c=cornflowerblue height=.25cm j=right) . See the description of LABEL= and Specifying Fonts for more information.

Style reference:

Font attribute of the GraphLabelText element

LOWBOUNDARY | NOLOWBOUNDARY

specifies whether the KPI chart displays as if the KPI value falls in the lower range segment or the upper range segment when the actual KPI value falls directly on a segment boundary. This option controls the color that is used for dial centers, traffic lights, and actual value indicators. It also controls which segment is displayed in the active color, if an active color list is specified. The default is LOWBOUNDARY, which tells the GKPI procedure to use the color of the lower range segment. If you specify NOLOWBOUNDARY, then PROC GKPI uses the color of the higher range segment. LOWBOUND And NOLOWBOUND Effect on Indicator Colors illustrates the effect of this option on dial centers and on the actual KPI value indicator in a horizontal slider when both a segment boundary and the actual KPI value is 30.

LOWBOUND And NOLOWBOUND Effect on Indicator Colors

[LOWBOUND And NOLOWBOUND Effect on Indicator Colors]

Alias:	LOWBOUND \| NOLOWBOUND
Default:	LOWBOUNDARY

NAME="name"

specifies the name of the graphics output file. The name can be up to 256 characters long, and uppercase characters are converted to lowercase. The default name is graph.png . If the name duplicates an existing name, then SAS/GRAPH adds a number to the name to create a unique name--for example, graph1.png .

Restriction:	Valid for SPEEDOMETER statement only
Default:	FULL

	DESCRIPTION="description"
	NAME="name"