• Print  |
  • Feedback  |

TEMPLATE Procedure: Plot Statements (Preproduction)

CONTOURPLOTPARM Statement

Displays a contour plot representing a response variable evaluated over a grid of X and Y values, and typically is used to create a contour plot of a bivariate density estimate.
CONTOURPLOTPARM X= numeric-column | expression Y= numeric-column | expression Z= numeric-column | expression < / option(s)> ;

Usage Information

Contour Plot

[Contour Plot]

Tip:

By default, the CONTOURPLOTPARM statement assumes that the X-Y grid is complete and does not contain any missing or irregular values. If the grid is not complete, then set the GRIDDED= option to FALSE so that the plot calculates the values needed to complete into a grid with a bounding rectangle.

Required Arguments

X

specifies the X coordinates for the grid.

Y

specifies the Y coordinates for the grid.

Z

specifies the contour response values.

Options

CONTOURPLOTPARM Options
Option Description
BACKGROUND= color | style-reference Specifies the background color of the graph.
BACKTRANSPARENCY= number Specifies the degree of the transparency of the background color.
DISPLAY= LINE | FILL | BLOCK | GRADIENT Specifies the type of contour display.
GRIDDED= boolean Specifies whether the X and Y values are equally spaced in a rectangular grid.
NAME= 'string' Assigns a name to a plot statement for reference in other template statements.
NHINT= integer Specifies the suggested number of contour levels for the Z variable.
NLEVELS= integer Specifies the actual number of contour levels for the Z variable.
XAXIS= X | X2 Specifies whether data is mapped to the primary X axis or the secondary X (X2) axis.
XAXISOPTS= ( axis-options ) Specifies one or more X axis options.
XOFFSETMAX= number Specifies an offset to add to the end that represents high data values on the primary X axis.
XOFFSETMIN= number Specifies an offset to add to the end that represents low data values the primary X axis.
YAXIS= Y | Y2 Specifies whether data is mapped to the primary Y axis or the secondary Y (Y2) axis.
YAXISOPTS= ( axis-options ) Specifies one or more Y axis options.
YOFFSETMAX= number Specifies an offset to add to the end that represents high data values on the primary Y axis.
YOFFSETMIN= number Specifies an offset to add to the end that represents low data values on the primary Y axis.

BACKGROUND= color | style-reference

specifies the background color of the graph.

Default: Specified by the GraphBackground:Background style reference.
Interaction: Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block.
BACKTRANSPARENCY= number

specifies the degree of the transparency of the background color.

Default: 0
Range: 0 (opaque) to 1 (entirely transparent)
Interaction: The BACKTRANSPARENCY= option overrides the TRANSPARENCY= option for the background.
Interaction: Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block.
See also: TRANSPARENCY= option
DISPLAY= LINE | FILL | BLOCK | GRADIENT

specifies the type of contour display.

LINE

specifies simple contour lines.

FILL

specifies that the space between the contours is filled and has no lines.

BLOCK

displays blocks of color at each coordinate.

GRADIENT

displays a smooth gradient of color between contour levels. The colors of the gradient are specified by the ThreeColorRamp style element.

Default: LINE
GRIDDED= boolean

specifies whether X and Y values are equally spaced in a rectangular grid.

Default: TRUE
Tip: If GRIDDED=FALSE, then additional calculations are performed.
Tip: For information on the algorithm used to calculate the grid, see Barnes, Stanley L., "Mesoscale Objective Map Analysis Using Weighted Time-Series Observations," United States National Oceanic and Atmospheric Administration, Environmental Research Labs, Norman, OK, Technical Memorandum (NOAA TM ERLNSSL-62), March 1973.
NAME= 'string'

assigns a name to a plot statement for reference in other template statements.

Restriction: The string specified by the NAME= option must be unique within the template.
Restriction: The string specified by the NAME= option cannot contain embedded spaces.
Tip: The NAME= option is used mostly in the DISCRETELEGEND statement in order to coordinate the use of colors, marker symbols, and line patterns between the graph and the legend.
Tip: string is case sensitive.
NHINT= integer

specifies the suggested number of contour levels for the Z variable.

Default: 5
Tip: The actual number of levels is adjusted to provide an appropriate number of levels for the data.
NLEVELS= integer

specifies the actual number of contour levels for the Z variable.

Interaction: The NLEVELS= option overrides the NHINT= option.
XAXIS= X | X2

specifies whether data is mapped to the primary X axis or to the secondary X (X2) axis.

Default: X
Interaction: Outside of a LAYOUT OVERLAY block, an individual plot can have only one X axis. The XAXIS= option of a plot specifies whether the axis is in the primary (bottom) or secondary (top) position. The XAXISOPTS= option of a plot specifies whether the axis is displayed and specifies the axis characteristics.

Within a LAYOUT OVERLAY block, multiple plots can share a primary axis and a secondary axis. The primary and secondary axes can have different scales, and the XAXIS= option for a particular plot can map data to either axis. The XAXISOPTS= and X2AXISOPTS= options of a LAYOUT OVERLAY statement specify whether the axes are displayed, and specify the axis characteristics.

XAXISOPTS= ( axis-options )

specifies one or more X axis options.

Requirement: The list of axis options must be enclosed in parentheses and separated by spaces.
Interaction: Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block.
XOFFSETMAX= number

specifies an offset to add to the end that represents high data values on the primary X axis. The offset is expressed as a decimal proportion of the full axis length. For a continuous axis, the offset is added to the highest data value or highest tick value, whichever is greater. For a discrete axis, the offset is added to the highest data value, which is always the highest tick value.

Default: Generated as suitable for the graph.
Range: 0 - 1
Interaction: For a continuous axis, the offset is added after any threshold adjustment is made to the axis.
Interaction: Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block.
Main discussion: THRESHOLDMAX= sub-option.
XOFFSETMIN= number

specifies an offset to add to the end that represents low data values on the primary X axis. The offset is expressed as a decimal proportion of the full axis length. For a continuous axis, the offset is added to the lowest data value or lowest tick value, whichever is less. For a discrete axis, the offset is added to the lowest data value, which is always the lowest tick value.

Default: Generated as suitable for the graph.
Range: 0 - 1
Interaction: For a continuous axis, the offset is added after any threshold adjustment is made to the axis.
Interaction: Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block.
Main discussion: THRESHOLDMAX= sub-option.
YAXIS= Y | Y2

specifies whether data is mapped to the primary Y axis or to the secondary Y (Y2) axis.

Default: Y
Interaction: Outside of a LAYOUT OVERLAY block, an individual plot can have only one Y axis. The YAXIS= option of a plot specifies whether the axis is in the primary (left) or secondary (right) position. The YAXISOPTS= option of a plot specifies whether the axis is displayed and specifies the axis characteristics.

Within a LAYOUT OVERLAY block, multiple plots can share a primary axis and a secondary axis. The primary and secondary axes can have different scales, and the YAXIS= option for a particular plot can map data to either axis. The YAXISOPTS= and Y2AXISOPTS= options of a LAYOUT OVERLAY statement specify whether the axes are displayed, and specify the axis characteristics.

YAXISOPTS= ( axis-options )

specifies one or more Y axis options.

Requirement: The list of axis options must be enclosed in parentheses and separated by spaces.
Interaction: Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block.
YOFFSETMAX= number

specifies an offset to add to the end that represents high data values on the primary Y axis. The offset is expressed as a decimal proportion of the full axis length. For a continuous axis, the offset is added to the highest data value or highest tick value, whichever is greater. For a discrete axis, the offset is added to the highest data value, which is always the highest tick value.

Default: Generated as suitable for the graph.
Range: 0 - 1
Interaction: For a continuous axis, the offset is added after any threshold adjustment is made to the axis.
Interaction: Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block.
Main discussion: THRESHOLDMAX= sub-option.
YOFFSETMIN= number

specifies an offset to add to the end that represents low data values on the primary Y axis. The offset is expressed as a decimal proportion of the full axis length. For a continuous axis, the offset is added to the lowest data value or lowest tick value, whichever is less. For a discrete axis, the offset is added to the lowest data value, which is always the lowest tick value.

Default: Generated as suitable for the graph.
Range: 0-1
Interaction: For a continuous axis, the offset is added after any threshold adjustment is made to the axis.
Interaction: Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block.
Main discussion: THRESHOLDMAX= sub-option.

Previous Page | Next Page | Top of Page