• Print  |
  • Feedback  |

TEMPLATE Procedure: Plot Statements (Experimental)

ELLIPSEPARM Statement

Displays an ellipse specified by slope and axes parameters, and typically is used to add a confidence ellipse to a scatter plot.
ELLIPSEPARM SEMIMAJOR= number | numeric-column | expression
SEMIMINOR= number | numeric-column | expression
SLOPE= number | numeric-column | expression
< / option(s)> ;

Usage Information

Ellipse Around a Scatterplot

[Ellipse Around a Scatterplot]

Requirement:

An ELLIPSEPARM plot must be contained within a LAYOUT OVERLAY block and the ELLIPSEPARM 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:

By default, the ellipse center is at 0, 0 in the data space. You can specify alternative coordinates for the center by using the XORIGIN= and YORIGIN= options.

Interaction:

If the GROUP= option is specified, then the group value must be a string or numeric column 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 SEMIMAJOR=, SEMIMINOR=, and SLOPE=, and if used, XORIGIN= and YORIGIN=. Under these circumstances, an ellipse is drawn for each group value.

Interaction:

The ELLIPSEPARM statement plots an ellipse with specified major and minor axes and a specified slope for the major axis. The ELLIPSEPARM statement can generate a single ellipse, or it can be used with the GROUP= option to generate a separate ellipse for each unique group value in the data. You can generate a single ellipse by specifying a number for each required argument, and if used, for the XORIGIN= and YORIGIN= options. You can generate grouped ellipses by specifying a numeric column for each required argument, and if used, for the XORIGIN= and YORIGIN= options.

Required Arguments

SEMIMAJOR

specifies half the length of the major axis for the ellipse.

Interaction: If a numeric column is specified and the column has missing values, then an ellipse is not displayed for the rows with missing values.
Tip: Values are in the units of the data.
SEMIMINOR

specifies half the length of the minor axis for the ellipse.

Interaction: If a numeric column is specified and the column has missing values, then an ellipse is not displayed for the rows with missing values.
Tip: Values are in the units of the data.
SLOPE

specifies the slope of the major axis for the ellipse.

Tip: Values are in the units of the data.
Options

ELLIPSEPARM Options
Option Description
DATATRANSPARENCY= number Specifies the degree of the transparency of the ellipse.
FILL= boolean Specifies whether an interior fill is used for the ellipse.
FILLCOLOR= color | style-reference Specifies the color of the interior fill of the ellipse.
GROUP= column Creates a separate ellipse for each unique group value of the specified column.
INDEX= integer-column Specifies indices for remapping the assignment of the color and line pattern to group values.
LEGENDLABEL= 'string' Specifies the label of the legends.
LINECOLOR= color | style-reference Specifies the color of the border line around the ellipse.
LINEPATTERN= line | style-reference Specifies the pattern of the border line around the ellipse.
LINES= boolean Specifies whether the border of the ellipse is drawn.
LINETHICKNESS= dimension | style-reference Specifies the thickness of the border line around the ellipse.
NAME= 'string' Assigns a name to a plot statement so that it can be referenced in other template statements.
XAXIS= X | X2 Specifies whether data is mapped to the primary X axis or the secondary X (X2) axis.
XORIGIN= number | numeric-column | expression Specifies the X coordinate of the center of the ellipse.
YAXIS= Y | Y2 Specifies whether data is mapped to the primary Y axis or the secondary Y (Y2) axis.
YORIGIN= number | numeric-column | expression Specifies the Y coordinate of the center of the ellipse.

DATATRANSPARENCY= number

specifies the degree of the transparency of the ellipse.

Default: 0
Range: 0 (opaque) to 1 (entirely transparent)
Interaction: The DATATRANSPARENCY= option overrides the TRANSPARENCY= option for the ellipse.
See also: TRANSPARENCY= option
FILL= boolean

specifies whether an interior fill is used for the ellipse.

Default: FALSE
Tip: You can display a filled ellipse that has no border line by specifying LINES=FALSE and FILL=TRUE.
FILLCOLOR= color | style-reference

specifies the color of the interior fill of the ellipse.

Default: If the GROUP= option is not specified, then the default fill color is specified by the GraphDataDefault:ForeGround style reference.

If the GROUP= option is specified, then the fill color is specified by the ContrastColor attributes on the GraphData1 - GraphData12 style elements.

GROUP= column

creates a separate ellipse for each unique group value of the specified column.

Default: Each distinct group value is represented in the graph by an ellipse, and each ellipse has a different color and pattern for the border of the ellipse.
Restriction: The GROUP= option can only be used when a numeric column is specified for the SLOPE=, SEMIMAJOR=, and SEMIMINOR= arguments, and when used, the XORGIN= and YORIGIN= options.
Tip: The representations that are used to identify the groups can be overridden individually. For example, each distinct group value is represented by a different line pattern for the border line of the ellipse, but the LINEPATTERN= option could be used to assign the same line pattern to all ellipse border lines.
INDEX= integer-column

specifies indices for remapping the assignment of the color and 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 the group values are mapped in the order that the data appears in the column.
LEGENDLABEL= 'string'

specifies the label of the legends.

Default: No label
Interaction: The GROUP= option overrides the LEGENDLABEL= option.
LINECOLOR= color | style-reference

specifies the color of the border line around the ellipse.

Default: If the GROUP= option is specified, then color is specified by the contrast color in the GraphData1 - GraphData12 style elements.

If the GROUP= option is not specified, then color 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 border line around the ellipse.

Default: If the GROUP= option is not specified, then a solid line pattern is applied to the line.

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.

LINES= boolean

specifies whether the border of the ellipse is drawn.

Default: TRUE
Interaction: If LINES=FALSE and the FILL= option is either FALSE or unspecified, then the ellipse border line is drawn to prevent an empty display.
Tip: You can display a filled ellipse that has no border line by specifying LINES=FALSE and FILL=TRUE.
LINETHICKNESS= dimension | style-reference

specifies the thickness of the border line around the ellipse.

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.
XAXIS= X | X2

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

Default: X
Interaction: 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.
XORIGIN= number | numeric-column | expression

specifies the X coordinate of the center of the ellipse.

Default: 0
Interaction: If the GROUP= option is specified, then the group value must be a string or numeric column 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 XORIGIN= option.
YAXIS= Y | Y2

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

Default: Y
Interaction: 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.
YORIGIN= number | numeric-column | expression

specifies the Y coordinate of the center of the ellipse.

Default: 0
Interaction: If the GROUP= option is specified, then the group value must be a string or numeric column 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 XORIGIN= option.

Previous Page | Next Page | Top of Page