GOPTIONS Statement

The GOPTIONS statement temporarily sets default values for many graphics attributes and device parameters used by SAS/GRAPH procedures.

Used by:

all statements and procedures in a SAS session

Description

The GOPTIONS statement specifies values for graphics options. Graphics options control characteristics of the graph, such as size, colors, type fonts, fill patterns, and symbols. If GOPTIONS are specified, they override the default style. In addition, they affect the settings of device parameters, which are defined in the device entry. Device parameters control such characteristics as the appearance of the display, the type of output produced, and the destination of the output.

The GOPTIONS statement enables you to change these settings temporarily, either for a single graph or for the duration of your SAS session. You can use the GOPTIONS statement to do the following tasks:

• override default values for graphics options that control either graphics attributes or device parameters for a single graph or for an entire SAS session

• reset individual graphics options or all graphics options to their default values

• cancel definitions for AXIS, FOOTNOTE, PATTERN, SYMBOL, and TITLE statements

To change device parameters permanently, you must use the GDEVICE procedure to modify the appropriate device entry or to create a new one. See The GDEVICE Procedure for details.

To review the current settings of all graphics options, use the GOPTIONS procedure. See The GOPTIONS Procedure for details.

Syntax

options-list can be one or more options from any or all of the following categories:

• reset option

  RESET=ALL | GLOBAL | statement-name | (statement-name(s))

• options that affect the appearance of the display area and the graphics output

  	ASPECT=scaling-factor
  	ALTDESC | NOALTDESC
  	AUTOSIZE=ON | OFF | DEFAULT
  	BORDER | NOBORDER
  	CELL | NOCELL
  	GSIZE=lines
  	HORIGIN=horizontal-offset <IN | CM>
  	HPOS=columns
  	HSIZE=horizontal-size <IN | CM>
  	IBACK= fileref | "external-file"
  	IMAGESTYLE = TILE | FIT
  	IMAGEPRINT | NOIMAGEPRINT
  	ROTATE=LANDSCAPE | PORTRAIT
  	ROTATE | NOROTATE
  	TARGETDEVICE=target-device-entry
  	VORIGIN=vertical-offset <IN | CM>
  	VPOS=rows
  	VSIZE=vertical-size <IN | CM>
  	XMAX=width <IN | CM>
  	XPIXELS=width-in-pixels
  	YMAX=height <IN | CM>
  	YPIXELS=height-in-pixels

• options that affect color

  	CBACK=background-color
  	CBY=BY-line-color
  	COLORS=<(colors-list | NONE)>
  	CPATTERN=pattern-color
  	CSYMBOL=symbol-color
  	CTEXT=text-color
  	CTITLE=title-color
  	PENMOUNTS=active-pen-mounts
  	PENSORT | NOPENSORT

• options that control font selection or text appearance

  	CHARTYPE=hardware-font-chartype
  	FASTTEXT | NOFASTTEXT
  	FBY=BY-line-font
  	FCACHE=number-fonts-open
  	FONTRES=NORMAL | PRESENTATION
  	FTEXT=text-font
  	FTITLE=title-font
  	FTRACK=LOOSE | NONE | NORMAL | TIGHT | TOUCH | V5
  	HBY=BY-line-height <units>
  	HTEXT=text-height <units>
  	HTITLE=title-height <units>
  	RENDER=APPEND | DISK | MEMORY | NONE | READ
  	RENDERLIB=libref
  	SIMFONT=software-font

• options that set defaults for procedures and global statements

  	GUNIT=units
  	INTERPOL=interpolation-method
  	OFFSHADOW=(x <units>, y <units> | (x,y) <units>
  	V6COMP | NOV6COMP

• image animation options

  	DELAY=delay-time
  	DISPOSAL=NONE | BACKGROUND | PREVIOUS | UNSPECIFIED
  	INTERLACED | NONINTERLACED
  	ITERATION=iteration-count
  	TRANSPARENCY | NOTRANSPARENCY

• options that affect how your SAS/GRAPH program runs

  	DISPLAY | NODISPLAY
  	ERASE | NOERASE
  	GWAIT=seconds
  	GRAPHRC | NOGRAPHRC
  	IMAGEPRINT | NOIMAGEPRINT
  	PCLIP | NOPCLIP
  	POLYGONCLIP | NOPOLYGONCLIP

• options that control how output is sent to devices or files

  	ADMGDF | NOADMGDF
  	DEVADDR=device-address
  	DEVICE=device-entry
  	DEVMAP=device-map-name | NONE
  	EXTENSION="file-type"
  	FILECLOSE=DRIVERTERM | GRAPHEND
  	FILEONLY | NOFILEONLY
  	GACCESS=output-format | "output-format > destination"
  	GEND="string" <..."string-n">
  	GEPILOG="string" <..."string-n">
  	GOUTMODE=APPEND | REPLACE
  	GPROLOG="string" <..."string-n">
  	GPROTOCOL=module-name
  	GSFLEN=record-length
  	GSFMODE=APPEND | PORT | REPLACE
  	GSFNAME=fileref
  	GSFPROMPT | NOGSFPROMPT
  	GSTART="string" <..."string-n">
  	HANDSHAKE=HARDWARE | NONE | SOFTWARE | XONXOFF
  	KEYMAP=map-name | NONE
  	POSTGEPILOG="string"
  	POSTGPROLOG="string"
  	PREGEPILOG="string"
  	PREGPROLOG="string"
  	PROMPTCHARS="prompt-chars-hex-string"X

• options that specify hardware capabilities of the device

  	CHARACTERS | NOCHARACTERS
  	CIRCLEARC | NOCIRCLEARC
  	DASH | NODASH
  	DASHSCALE=scaling-factor
  	FILL | NOFILL
  	FILLINC=0...9999
  	LFACTOR=line-thickness-factor
  	PIEFILL | NOPIEFILL
  	POLYGONFILL | NOPOLYGONFILL
  	SYMBOL | NOSYMBOL

• options that control printer hardware features

  	AUTOCOPY | NOAUTOCOPY
  	AUTOFEED | NOAUTOFEED
  	BINDING=DEFAULTEDGE | LONGEDGE | SHORTEDGE
  	COLLATE | NOCOLLATE
  	DUPLEX | NODUPLEX
  	GCOPIES=(<current-copies><,max-copies>)
  	PAPERDEST=bin
  	PAPERFEED=feed-increment <IN | CM>
  	PAPERLIMIT=width <IN | CM>
  	PAPERSIZE="size-name" | (width,height)
  	PAPERSOURCE=tray
  	PAPERTYPE="type-name"
  	PPDFILE=fileref | "external-file"
  	REPAINT=redraw-factor
  	REVERSE | NOREVERSE
  	SPEED=pen-speed
  	UCC="control-characters-hex-string"X

• options that interact with the operating environment

  	DRVINIT="system-command(s)"
  	DRVTERM="system-command(s)"
  	PREGRAPH="system-command(s)"
  	POSTGRAPH="system-command(s)"
  	PROMPT | NOPROMPT

• options for mainframe systems

  	GCLASS=SYSOUT-class
  	GDDMCOPY=FSCOPY | GSCOPY
  	GDDMNICKNAME=nickname
  	GDDMTOKEN=token
  	GDEST=destination
  	GFORMS="forms-code"
  	GWRITER="writer-name"
  	TRANTAB=table | user-defined-table

Options

See Graphics Options and Device Parameters Dictionary for a complete description of all graphics options used by the GOPTIONS statement.

GOPTIONS statements are global and can be located anywhere in your SAS program. However, for the graphics options to affect the output from a procedure, the GOPTIONS statement must execute before the procedure.

With the exception of the RESET= option, graphics options can be listed in any order in a GOPTIONS statement. The RESET= option should be the first option in the GOPTIONS statement.

A graphics option remains in effect until you either specify the option in another GOPTIONS statement, or use the RESET= option to reset the values, or end the SAS session. When a session ends, the values of the graphics options return to their default values.

Graphics options are additive; that is, the value of a graphics option remains in effect until the graphics option is explicitly changed or reset or until you end your SAS session. Graphics options remain in effect even after you submit additional GOPTIONS statements specifying different options.

To reset an individual option to its default value, submit the option without a value (a null graphics option.) You can use a comma (but it is not required) to separate a null graphics option from the next one. For example, this GOPTIONS statement sets the values for background color, text height, and text font:

goptions cback=blue htext=6 pct ftext=albany;

To reset only the background color specification to the default and keep the remaining values, use this GOPTIONS statement:

goptions cback=;

To reset all graphic options to their default values, specify RESET=GOPTIONS:

goptions reset=goptions;

Alternatively, you can use RESET=ALL, but it also cancels any global statement definitions in addition to resetting all graphics options to default values.

You can control many graphics attributes through statement options, graphics options, device parameters, or a combination of these. SAS/GRAPH searches these places to determine the value to use, stopping at the first place that gives it an explicit value:

1. statement options

2. the value of the corresponding graphics option

3. the value of a device parameter found in the catalog entry for your device driver

Note:   Not every graphics attribute can be set in all three places. See the statement and procedure chapters for the options that can be used with each.  

Some graphics options are supported for specific devices or operating environments only. See the SAS Help facility for SAS/GRAPH or the SAS companion for your operating environment for more information.

Copyright © 2008 by SAS Institute Inc., Cary, NC, USA. All rights reserved.