• Print  |
  • Feedback  |

TEMPLATE Procedure: Text Statements (Preproduction)

DISCRETELEGEND Statement

Specifies and inserts a legend for graphs with specific values into a layout area.
DISCRETELEGEND 'graph-name' <... 'graph-name' >< / option(s)>;

Usage Information

Restriction:

A DISCRETELEGEND statement must be specified within a LAYOUT, HEADER, SIDEBAR, or CELL statement block. You can specify a DISCRETELEGEND statement inside or outside of a nested statement block:

  • When you specify a DISCRETELEGEND statement inside of a nested LAYOUT, HEADER, SIDEBAR, or CELL statement block, then the legend is placed inside of the component that the nested statement block creates.

  • When you specify a DISCRETELEGEND statement outside of a nested LAYOUT, HEADER, SIDEBAR, or CELL statement block, then the legend is placed outside of the component that the nested statement block creates.

Required Arguments

graph-name

specifies the default graph name or the name specified by the NAME= option if it is specified by a plot statement.

Requirement: graph-name must be enclosed in quotation marks.
Options

GRADIENTLEGEND Options
Option Description
ACROSS= integer Specifies the number of units in a row that are placed horizontally before the next row is started.
BACKGROUND= color | style-reference Specifies the background color of the legend.
BACKTRANSPARENCY= number Specifies the degree of the transparency of the legend background color.
BORDER= boolean
 Specifies the border that is around the legend.
BORDERCOLOR= color Specifies the border color of the legend.
BORDERPATTERN=line Specifies the border pattern of the legend.
BORDERTHICKNESS=dimension Specifies the border thickness of the legend.
DOWN=integer Specifies the number of units in a row that are placed vertically before the next column is started.
FOREGROUND= color | style-reference Specifies the text color of the legend.
HALIGN= LEFT | CENTER | RIGHT Specifies the horizontal alignment of the legend.
ORDER= ROWMAJOR | COLUMNMAJOR Specifies the order of the legend entries.
PADBOTTOM= dimension Specifies the amount of empty space that is at the bottom of the legend.
PADLEFT= dimension Specifies the amount of empty space that is on the left side of the legend.
PADRIGHT= dimension Specifies the amount of empty space that is on the right side of the legend.
PADTOP= boolean Specifies the amount of empty space that is at the top of the legend.
TITLE= 'string' Specifies the title of the legend.
TITLEBORDER= boolean Specifies a border around the legend title that separates the title from the legend body.
TRANSPARENCY= number Specifies the degree of the transparency of the legend title, the legend text, and the legend symbols.
VALIGN= TOP | CENTER | BOTTOM Specifies the vertical alignment of the legend.

ACROSS= integer

specifies the number of units in a row that are placed horizontally before the next row is started.

Default: The entries are placed to best fit the available area.
Restriction: Ignored if ORDER= COLUMNMAJOR
Restriction: integer must be greater than 0.
Tip: A unit typically consists of two entries, such as a marker symbol and an associated value.
BACKGROUND= color | style-reference

specifies the background color of the legend.

Default: Specified by the GraphLegendBackground:Background style reference.
BACKTRANSPARENCY= number

specifies the degree of the transparency of the legend 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 that is around the legend.

Default: FALSE
BORDERCOLOR= color | style-reference

specifies the border color of the legend.

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

specifies the border pattern of the legend.

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

specifies the border thickness of the legend.

Default: 1 px
DOWN= integer

specifies the number of units in a row that are placed vertically before the next column is started.

Default: The entries are placed to best fit the available area.
Restriction: Ignored if ORDER= ROWMAJOR
Restriction: integer must be greater than 0.
Tip: A unit typically consists of two entries, such as a marker symbol and an associated value.
FOREGROUND= color | style-reference

specifies the text color of the legend.

Default: Specified by the GraphValueText:Foreground style reference.
HALIGN= LEFT | CENTER | RIGHT

specifies the horizontal alignment of the legend.

Default: CENTER
ORDER= ROWMAJOR | COLUMNMAJOR

specifies the order of the legend entries.

Default: ROWMAJOR
PADBOTTOM=dimension

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

Default: 0
PADLEFT= dimension

specifies the amount of empty space that is on the left side of the legend.

Default: 3 px
PADRIGHT= dimension

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

Default: 3 px
PADTOP= dimension

Specifies the amount of empty space that is at the top of the legend.

Default: 0
TITLE= 'string'

specifies the title of the legend.

Default: no title
Requirement: string must be enclosed in quotation marks.
TITLEBORDER= boolean

specifies a border around the legend title that separates the title from the legend body.

Default: FALSE
Tip: The line pattern and the thickness of the border are specified by the GraphBorderLine style definition.
TRANSPARENCY= number

specifies the degree of the transparency of the legend background, the legend text, and the legend symbols.

Default: 0
Range: 0 (opaque) to 1 (entirely transparent)
Tip: You can specify a different transparency for the background, the text, and the related symbols by using the BACKTRANSPARENCY= option for the background. The TRANSPARENCY= option will then only apply to the text and the symbols.
VALIGN= TOP | CENTER | BOTTOM

specifies the vertical alignment of the legend.

Default: CENTER

Previous Page | Next Page | Top of Page