• Print  |
  • Feedback  |

TEMPLATE Procedure: Layout Statements (Experimental)

LAYOUT OVERLAY Statement


Assembles the results of nested ODS statistical graphs statements into a single axis area. The plots are drawn in the order in which they are specified, with the results of the last statement on top.
LAYOUT OVERLAY </ option(s)> ;
ODS -statgraph-statements;
ENDLAYOUT;


Usage Information

Restriction:

You can add one or more graphs to the graph area that the LAYOUT OVERLAY statement creates, however, all of the graphs will share the same set of axes.

Interaction:

When nested within another layout type, the OVERLAY layout generally defines the graph display for one cell of the parent layout. A separate OVERLAY layout is specified for each cell.

Tip:

The LAYOUT OVERLAY block is primarily used to specify plot statements, but it can also specify other statements from the TEMPLATE procedure. All statements that are specified in the block are displayed within the defined area.

Interaction:

Options that are specified in the LAYOUT OVERLAY statement often override the option settings that are specified on plot statements within the OVERLAY block. This does not apply to plot statements that are nested inside layouts within the overlay block.


Options

LAYOUT OVERLAY 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.
BORDER=boolean
Displays the border around the layout.
BORDERCOLOR= color | style-reference Specifies the border color of the layout.
BORDERPATTERN=line | style-reference Specifies the border pattern of the layout.
BORDERTHICKNESS=dimension Specifies the border thickness of the layout.
GRIDTRANSPARENCY=number Specifies the degree of the transparency of the grid lines.
HEIGHT= dimension Specifies the height of the layout area.
PADBOTTOM= dimension Specifies the amount of empty space that is at the bottom of the layout.
PADLEFT= dimension Specifies the amount of empty space that is on the left side of the layout.
PADRIGHT= dimension Specifies the amount of empty space that is on the right side of the layout.
PADTOP= boolean Specifies the amount of empty space that is at the top of the layout.
TRANSPARENCY= number Specifies the degree of the transparency of the background, grid, wall(s), and axis elements, if displayed in a graph.
WALLTRANSPARENCY= number Specifies the degree of the transparency of the plot wall(s).
WIDTH= dimension Specifies the width of the layout area.
X2AXISOPTS= ( axis-options ) Specifies one or more X2 axis options.
X2GRID= boolean Specifies whether the grid lines are drawn at the tick marks on the X2 axis.
X2OFFSETMAX= number Specifies an offset to add to the end that represents high data values on the secondary X (X2) axis.
X2OFFSETMIN= number Specifies an offset to add to the end that represents low data values on the secondary X (X2) axis.
XAXISOPTS= (axis-options) Specifies one or more X axis options.
XGRID= boolean
Specifies whether the grid lines are drawn at the tick marks on the X axis.
XOFFSETMAX= dimension Specifies an offset to add to the end that represents high data values on the primary X axis.
XOFFSETMIN= dimension Specifies an offset to add to the end that represents low data values on the primary X axis.
Y2AXISOPTS= (axis-option) Specifies one or more Y2 axis options.
Y2EQUATED= boolean Equates the axes so that one unit on the Y2 axis is equal in length to one unit on the X2 axis.
Y2GRID= boolean Specifies whether the grid lines are drawn at the tick marks on the Y2 axis.
Y2OFFSETMAX= dimension Specifies an offset to add to the end that represents high data values on the secondary Y (Y2) axis.
Y2OFFSETMIN= dimension Specifies an offset to add to the end that represents low data values on the secondary Y (Y2) axis.
YAXISOPTS= (axis-option) Specifies one or more Y axis options.
YEQUATED= boolean Equates the axes so that one unit on the Y axis is equal in length to one unit on the X axis.
YGRID= boolean Specifies whether the grid lines are drawn at the tick marks on the Y axis.
YOFFSETMAX= dimension Specifies an offset to add to the end that represents high data values on the primary Y axis.
YOFFSETMIN= dimension 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.
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.
See also: TRANSPARENCY= option
BORDER= boolean

displays the border around the layout.

Default: TRUE for the outermost layout statement. FALSE for nested layout statements.
BORDERCOLOR= color | style-reference

specifies the border color of the layout.

Default: Specified by the GraphBorderLines:Foreground style reference.
BORDERPATTERN= line | style-reference

specifies the border pattern of the layout.

Default: Specified by the GraphBorderLines:LineStyle style reference.
BORDERTHICKNESS= dimension

specifies the border thickness of the layout.

Default: 1 px
GRIDTRANSPARENCY= number

specifies the degree of the transparency of the grid lines.

Default: 0
Range: 0 (opaque) to 1 (entirely transparent)
Interaction: The GRIDTRANSPARENCY= option overrides the TRANSPARENCY= option for the grid lines.
See also: TRANSPARENCY= option
HEIGHT= dimension

specifies the height of the layout area.

Restriction: You can only specify the HEIGHT= option on the outermost layout statement.
PADBOTTOM= dimension

specifies the amount of empty space that is at the bottom of the layout.

Default: 5px for the outermost layout statement, 0 for nested layout statements.
PADLEFT= dimension

specifies the amount of empty space on the left side of the layout.

Default: 5px for the outermost layout statement, 0 for nested layout statements.
PADRIGHT= dimension

specifies the amount of empty space that is on the right side of the layout.

Default: 5px for the outermost layout statement, 0 for nested layout statements.
PADTOP= dimension

specifies the amount of empty space that is at the top of the layout.

Default: 5px for the outermost layout statement, 0 for nested layout statements.
TRANSPARENCY= number

specifies the degree of the transparency of the background, grid, wall(s), and axis elements, if displayed in a graph.

Default: 0
Range: 0 (opaque) to 1 (entirely transparent)
Interaction: You can specify the transparency of individual graph elements by using the BACKTRANSPARENCY=, GRIDTRANSPARENCY=, and WALLTRANSPARENCY= options. The value specified by the TRANSPARENCY= option is only applied to the transparencies that you do not specify individually.
Interaction: Individual plot statements specify the transparency of the data elements and the data labels that they modify.
WALLTRANSPARENCY= number

specifies the degree of the transparency of the plot wall(s).

Default: 0 for 2D graphs, 1 for 3D graphs
Range: 0 (opaque) to 1 (entirely transparent)
Interaction: The WALLTRANSPARENCY= option overrides the TRANSPARENCY= option for the graph wall(s).
See also: TRANSPARENCY= option
WIDTH= dimension

specifies the width of the layout area.

Restriction: You can only specify the WIDTH= option on the outermost layout statement.
X2AXISOPTS= ( axis-options )

specifies one or more X2 axis options.

Requirement: Axis options must be enclosed in parentheses and separated by spaces.
X2GRID=boolean

specifies whether the grid lines are drawn at the tick marks on the X2 axis.

Default: FALSE
Interaction: Default characteristics for the grid lines are specified from the following attributes on the GraphGridLines style element:
Color

Foreground

Thickness

LineThickness (default=1 px)

Pattern

LineStyle (default=1)

X2OFFSETMAX=dimension

specifies an offset to add to the end that represents high data values on the secondary X (X2) 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 discreet axis, the offset is added to the highest data value, which is always the highest tick value.

Default: Generated as suitable for all of the graphs in the overlay.
Range: 0-1
Interaction: For a continuous axis, the offset is added after any threshold adjustment is made to the axis.
Main discussion: THRESHOLDMAX= sub-option
X2OFFSETMIN=dimension

specifies an offset to add to the end that represents low data values on the secondary X (X2) 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 greater. For a discreet axis, the offset is added to the lowest data value, which is always the lowest tick value.

Default: Generated as suitable for all of the graphs in the overlay.
Range: 0-1
Interaction: For a continuous axis, the offset is added after any threshold adjustment is made to the axis.
Main discussion: THRESHOLDMAX= sub-option
XAXISOPTS= ( axis-options )

specifies one or more X axis options.

Requirement: Axis options must be enclosed in parentheses and separated by spaces.
Interaction: Overrides the XAXISOPTS= option for any plot statement that is within the LAYOUT OVERLAY block.
XGRID= boolean

specifies whether the grid lines are drawn at the tick marks on the X axis.

Default: FALSE
Interaction: . Default characteristics for the grid lines are specified from the following attributes on the GraphGridLines style element:
Color

Foreground

Thickness

LineThickness (default=1 px)

Pattern

LineStyle (default=1)

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 discreet 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.
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 greater. For a discreet axis, the offset is added to the lowest data value, which is always the lowest tick value.

Default: Generated as suitable for all of the graphs in the overlay.
Range: 0 - 1
Interaction: For a continuous axis, the offset is added after any threshold adjustment is made to the axis.
Main discussion: THRESHOLDMAX= sub-option
Y2AXISOPTS= ( axis-options )

specifies one or more Y2 axis options.

Requirement: Axis options must be enclosed in parentheses and separated by spaces.
Y2EQUATED= boolean

equates the axes so that one unit on the Y2 axis is equal in length to one unit on the X2 axis. Although the axes are equated, they may differ in length.

Y2GRID=boolean

specifies whether the grid lines are drawn at the tick marks on the Y2 axis.

Default: FALSE
Interaction: Default characteristics for the grid lines are specified from the following attributes on the GraphGridLines style element:
Color

Foreground

Thickness

LineThickness (default=1 px)

Pattern

LineStyle (default=1)

Y2OFFSETMAX=dimension

specifies an offset to add to the end that represents high data values on the secondary Y (Y2) 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 discreet axis, the offset is added to the highest data value, which is always the highest tick value.

Default: Generated as suitable for all of the graphs in the overlay.
Range: 0-1
Interaction: For a continuous axis, the offset is added after any threshold adjustment is made to the axis.
Main discussion: THRESHOLDMAX= sub-option
Y2OFFSETMIN=dimension

specifies an offset to add to the end that represents low data values on the secondary Y (Y2) 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 greater. For a discreet axis, the offset is added to the lowest data value, which is always the lowest tick value.

Default: Generated as suitable for all of the graphs in the overlay.
Range: 0-1
Interaction: For a continuous axis, the offset is added after any threshold adjustment is made to the axis.
Main discussion: THRESHOLDMAX= sub-option
YAXISOPTS= ( axis-options )

specifies one or more Y axis options.

Requirement: Axis options must be enclosed in parentheses and separated by spaces.
YEQUATED=boolean

equates the axes so that one unit on the Y axis is equal in length to one unit on the X axis. Although the axes are equated, they may differ in length.

YGRID= boolean

specifies whether the grid lines are drawn at the tick marks on the Y axis.

Default: FALSE
Interaction: Default characteristics for the grid lines are specified from the following attributes on the GraphGridLines style element:
Color

Foreground

Thickness

LineThickness (default=1 px)

Pattern

LineStyle (default=1)

YOFFSETMAX=dimension

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 discreet 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.
Main discussion: THRESHOLDMAX= sub-option
YOFFSETMIN=dimension

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 discreet 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.
Main discussion: THRESHOLDMAX= sub-option


Previous Page | Next Page | Top of Page