• Print  |
  • Feedback  |

TEMPLATE Procedure: Text Statements (Preproduction)

GRADIENTLEGEND Statement

Specifies and inserts a legend for graphs with a range of data into a layout area.
GRADIENTLEGEND 'graph-name' < / option(s)>;

Restriction:

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

  • When you specify a GRADIENTLEGEND 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 GRADIENTLEGEND 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 Argument

graph-name

specifies the plot to be represented by the legend. The plot is identified by the default graph name or the name specified by the NAME= option on that plot statement.

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

GRADIENTLEGEND Options
Option Description
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.
HALIGN= LEFT | CENTER | RIGHT Specifies the horizontal alignment of the legend.
LABELCOUNT= integer Specifies the number of values that the gradient legend must use to label the data range.
LABELCOUNTHINT= integer Recommends a number of values for the gradient legend to use to label the data range.
ORIENT= HORIZONTAL | VERTICAL Specifies the orientation of the legend.
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.
TRANSPARENCY= number Specifies the degree of the transparency of the legend background, the legend text, and the gradient band.
VALIGN= TOP | CENTER | BOTTOM Specifies the vertical alignment of the legend.

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
HALIGN= LEFT | CENTER | RIGHT

specifies the horizontal alignment of the legend.

Default: CENTER
LABELCOUNT= integer

specifies the number of values that the gradient legend must use to label the data range .

Default: derived from the data range
Restriction: The integer must be greater than 0.
Tip: The legend uses even intervals to label the range.
LABELCOUNTHINT= integer

recommends a number of values for the gradient legend to use to label the data range.

Default: derived from the data range
Restriction: The integer must be greater than 0.
Tip: The legend uses even intervals to label the range.
ORIENT= HORIZONTAL | VERTICAL

specifies the orientation of the legend.

Default: VERTICAL
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
TRANSPARENCY= number

specifies the degree of the transparency of the legend background, the legend text, and the gradient band.

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

specifies the vertical alignment of the legend.

Default: CENTER

Previous Page | Next Page | Top of Page