Providing software solutions since 1976
| TEMPLATE Procedure: Plot Statements (Experimental) |
LINEPARM Statement
Displays a straight line specified by slope and intercept parameters, and typically is used to add a line to a plot.
| LINEPARM XINTERCEPT= number | numeric-column | expression < / option(s)> ; |
LINEPARM XINTERCEPT = number |
numeric-column |
expression
|
LINEPARM YINTERCEPT= number |
numeric-column |
expression
|
| Usage Information |
Line Parm
![[Line Parm]](./images/lineparm.gif)
| Requirement: |
A LINEPARM plot must be contained within a LAYOUT OVERLAY block and the LINEPARM plot must be used with another plot that is derived from data values that provide boundaries for the graph area. For example, it can be used with a scatter plot or a histogram. |
| Interaction: |
If you specify the GROUP= option, then the group value must be a column (string or numeric) with unique values that do not contain missing values. For each row with a group variable value, there must be a numeric column value that does not contain missing values for the intercept and slope, if the slope is used. Under these circumstances, a line is drawn for each group value. |
| Interaction: |
The LINEPARM statement creates a straight line with a specified X or Y intercept. The statement can generate a single line, or it can be used with the GROUP= option to generate a separate line for each unique group value in the data. You can generate a single line by specifying a number for each required argument that you use. You can generate grouped lines by specifying a numeric column for each required argument that you use. |
| Interaction: |
If both the XINTERCEPT= and the YINTERCEPT= arguments are specified, then the YINTERCEPT= argument is ignored. |
| Tip: |
You can generate a vertical line by specifying an XINTERCEPT= argument without the SLOPE= option. |
| Required Arguments |
- SLOPE
-
specifies the slope of the line.
Tip: Values are displayed in the units of the data. - XINTERCEPT
-
specifies the X intercept of the line.
Restriction: If a numeric column is specified and the column has missing values, then a line is not displayed for the rows with missing values. Tip: If the value specified for the XINTERCEPT= option is outside of the data range, then the data range is extended to include the specified intercept. Tip: Values are in the units of the data. - YINTERCEPT
-
specifies the Y intercept for the line.
Restriction: If a numeric column is specified and the column has missing values, then a line is not displayed for the rows with missing values. Tip: If the value specified for the XINTERCEPT= option is outside of the data range, then the data range is extended to include the specified intercept. Tip: Values are in the units of the data.
| Options |
| Option | Description |
|---|---|
| CURVELABEL= 'string' | Specifies the label of the line. |
| CURVELABELFORMAT= format | Specifies the format of the label. |
| CURVELABELHALIGN= LEFT | CENTER | RIGHT | Specifies the horizontal alignment of the label. |
| CURVELABELPOSITION= number | Specifies the position of the label on the line, expressed as a decimal proportion of the data range that is represented by the line. |
| CURVELABELVALIGN= TOP | CENTER | BOTTOM | Specifies the vertical alignment of the label. |
| DATATRANSPARENCY= number | Specifies the degree of the transparency of the lines. |
| EXTREME= boolean | Specifies whether the line is to be drawn to the area bounded by the axes, ignoring any specified offsets. |
| GROUP= column | Creates a separate parameterized line plot for each unique group value of the specified column. |
| INDEX= integer-column | Specifies indices for remapping the assignment of the line color and the line pattern to group values. |
| LABELTRANSPARENCY= number | Specifies the percentage of the transparency of the line labels. |
| LEGENDLABEL=== 'string' | Specifies the label of the legends. |
| LINECOLOR=color | style-reference | Specifies the color of the line. |
| LINEPATTERN= line | style-reference | Specifies the pattern of the line. |
| LINETHICKNESS= dimension | style-reference | Specifies the thickness of the line. |
| NAME= 'string' | Assigns a name to a plot statement for reference in other template statements. |
| TRANSPARENCY==number | Specifies the degree of the transparency of the line, label of the line (if present), and axis elements, if displayed in a graph. |
| XAXIS= X | X2 | Specifies whether data is mapped to the primary X axis or the secondary X (X2) axis. |
| XMAX= number | Specifies the maximum X data value to use in the line. |
| XMIN =number | Specifies the minimum X data value to use in the line. |
| YAXIS= Y | Y2 | Specifies whether data is mapped to the primary Y axis or the secondary Y (Y2) axis. |
| YMAX =number | Specifies the maximum Y data value to use in the line. |
| YMIN= number | Specifies the minimum Y data value to use in the line. |
- CURVELABEL= 'string'
-
specifies the label of the line.
Default: No label is displayed. Tip: The font and color attributes for the label are specified by the GraphDataText style element. - CURVELABELFORMAT= format
-
specifies the format of the label.
Default: The label is unformatted. - CURVELABELHALIGN= LEFT | CENTER | RIGHT
-
specifies the horizontal alignment of the label.
Default: LEFT Interaction: The horizontal alignment of the label is at the position specified by the CURVELABELPOSITION= option. - CURVELABELPOSITION= number
-
specifies the position of the label on the line, expressed as a decimal proportion of the data range that is represented by the line.
Default: 1 Range: 0 (lowest value of the data range for the line) to 1 (highest value of the data range for the line) - CURVELABELVALIGN= TOP | CENTER | BOTTOM
-
specifies the vertical alignment of the label.
Default: TOP Interaction: The vertical alignment of the label is at the position specified by the CURVELABELPOSITION= option. - DATATRANSPARENCY= number
-
specifies the degree of the transparency of the lines.
Default: 0 Range: 0 (opaque) to 1 (entirely transparent) Interaction: The DATATRANSPARENCY= option overrides the TRANSPARENCY= option for the bars. See also: TRANSPARENCY= option - EXTREME= boolean
-
creates a separate line plot for each unique group value of the specified column.
Default: FALSE Interaction: The EXTREME= option is not affected by the XMAX=, XMIN=, YMAX=, or YMIN= options. Tip: If the EXTREME= option is not specified, then there can be a small gap between the line and the axis. If the offset is set to 0, then there is no gap. - GROUP= column
-
creates a separate parameterized line plot for each unique group value of the specified column.
Default: Each distinct group value is represented in the graph by a different combination of line color and line pattern. Restriction: When the GROUP= option is used, the XINTERCEPT, YINTERCEPT, and SLOPE arguments, when used, must specify numeric columns. Tip: The LINECOLOR= option , the LINEPATTERN= option, or both can be used to override the representations that are used to identify the groups. For example, the LINEPATTERN= option can be used to assign the same pattern to all of the lines. - INDEX= integer-column
-
specifies indices for remapping the assignment of the line color and the line pattern to group values.
Restriction: The INDEX= option must be used with the GROUP= option. If the GROUP= option is not specified, then the INDEX= option is ignored. Interaction: If the INDEX= option is not used, then group values are mapped in the order of the data. - LABELTRANSPARENCY= number
-
specifies the percentage of the transparency of the line labels.
Default: 0 Range: 0 (opaque) to 1 (entirely transparent) Interaction: The DATATRANSPARENCY= option overrides the TRANSPARENCY= option for the bars. See also: TRANSPARENCY= option - LEGENDLABEL= 'string'
-
specifies the label of the legends.
Default: No label. Interaction: If the GROUP= option is specified, then the group values override the LEGENDLABEL= option values. - LINECOLOR= color | style-reference
-
specifies the color of the line.
Default: If the GROUP= option is specified, then the color is specified by the contrast color in the GraphData1 - GraphData12 style elements. If the GROUP= option is not used, the the default is specified by the GraphDataDefault:ContrastColor style reference. Interaction: The LINECOLOR= option overrides the default color mapping for group values. - LINEPATTERN= line | style-reference
-
specifies the pattern of the line.
Default: If the GROUP= option is not specified, then the line pattern is specified by the GraphDataDefault:LineStyle style reference. If the GROUP= option is specified, then the line patterns are specified by the LineStyle attribute in the GraphData1 - GraphData12 style elements.
If the GraphData1 - GraphData12 style elements do not define the LineStyle attribute, then a default sequence of line patterns is used.
Interaction: The LINEPATTERN= option overrides the default line mapping for group values. - LINETHICKNESS= dimension | style-reference
-
specifies the thickness of the line.
Default: 1 px - 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. - TRANSPARENCY= number
-
specifies the degree of the transparency of the line, label of the line (if present), and axis elements, if displayed in a graph.
Default: 0 Range: 0 (opaque) to 1 (entirely transparent) Interaction: The transparency for the line and the line label can be specified individually with the DATATRANSPARENCY= and the LABELTRANSPARENCY= options. - 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.
- XMAX= number
-
specifies the maximum X data value to use in the line.
Default: The maximum X value in the data. Interaction: The XMAX= option does not affect the EXTREME= option. The EXTREME= option extends the line. Restriction: If the data contain values greater than the number specified for the XMAX= option, then the data values are excluded from the line. - XMIN= number
-
specifies the minimum X data value to use in the line.
Default: The minimum X value in the data. Interaction: The XMIN= option does not affect the EXTREME= option. The EXTREME= option extends the line. Restriction: If the data contain values less than the number specified for the XMIN= option, then the data values are excluded from the line. - 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.
- YMAX= number
-
specifies the maximum Y data value to use in the line.
Default: The maximum Y value in the data. Interaction: The YMAX= option does not affect the EXTREME= option. Restriction: If the data contain values greater than the number specified for the YMAX= option, then the data values are excluded from the line. - YMIN= number
-
specifies the minimum Y data value to use in the line.
Default: The minimum Y value in the data. Interaction: The YMIN= option does not affect the EXTREME= option. Restriction: If the data contain values less than the number specified for the YMIN= option, then the data values are excluded from the line.
