| TEMPLATE Procedure: Plot Statements (Experimental) |
| VECTORPLOT Y= numeric-column | expression X= numeric-column | expression < / option(s)> ; |
| Usage Information |
Vector Plot
![[Vector Plot]](./images/vectorplot.gif)
| Interaction: |
By default, the vector starts at 0, 0 in the data space. To specify alternative coordinates for the starting point, use the XORIGIN= and YORIGIN= options. |
| Required Arguments |
specifies the column for the X values.
specifies the column for the Y values.
| Options |
| Option | Description |
|---|---|
| ARROWDIRECTION= IN | OUT | BOTH | NONE | Specifies the placement of the arrowheads at the ends of the vector. |
| ARROWSHAPE= arrow | Specifies the shape of the arrowheads. |
| BACKGROUND= color | style-reference | Specifies the background color of the graph. |
| BACKTRANSPARENCY= number | Specifies the degree of the transparency of the background color. |
| DATALABEL= column | Specifies the label at the end of the vector. |
| DATALABELCOLOR= color | style-reference | Specifies the color of the data labels. |
| DATALABELFONTFAMILY= 'string' | style-reference | Specifies the family of the font of the data labels. |
| DATALABELFONTSIZE= dimension | style-reference | Specifies the size of the font of the data labels. |
| DATALABELFONTSTYLE= NORMAL | ITALIC | style-reference | Specifies the style of the font of the data labels. |
| DATALABELFONTWEIGHT= NORMAL | BOLD | style-reference | Specifies the weight of the font of the data labels. |
| DATALABELFORMAT= format | Specifies the format of the data labels. |
| DATATRANSPARENCY= number | Specifies the degree of the transparency of the vector line. |
| EQUATED= boolean | Equates the axes so that one unit on the Y axis is equal in length to one unit on the X axis. |
| GRIDTRANSPARENCY= number | Specifies the degree of the transparency of the grid lines. |
| GROUP= column | Creates a separate vector plot for each unique group value of the specified column. |
| INDEX= integer-column | Specifies indices for remapping the assignment of the color, marker symbols, and line pattern to group values. |
| LABELTRANSPARENCY= number | Specifies the degree of the transparency of the labels. |
| LEGENDLABEL= 'string' | Specifies the label of the legends. |
| LINECOLOR= color | style-reference | Specifies the color of the vector 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. |
| SCALE= number | Specifies the scale factor of the vector length. |
| TIP= ( column-list ) | Specifies the information to display when the cursor is positioned over a graph element. |
| TRANSPARENCY= number | Specifies the degree of the transparency of the vector line, background, grid, labels, wall, and axis elements, if displayed in a graph. |
| WALLTRANSPARENCY= number | Specifies the degree of the transparency of the plot wall. |
| XAXIS= X | X2 | Specifies whether data is mapped to the primary X axis or 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. |
| XMAX= number | Specifies the maximum X data value to use in the display of data. |
| XMIN= number | Specifies the minimum X data value to use in the display of data. |
| XOFFSETMAX= number | Specifies an offset to add to the end that represents high data values on the primary X axis. |
| XOFFSETMIN= number | Specifies an offset to add to the end that represents low data values on the of the primary X axis. |
| XORIGIN= number | expression | Specifies the X data coordinate of the vector origin. |
| YAXIS= Y | Y2 | Specifies whether data is mapped to the primary Y axis or the secondary Y (Y2) axis. |
| YAXISOPTS= ( axis-options ) | Specifies one or more Y axis options. |
|
YGRID =boolean |
Specifies whether the grid lines drawn at the tick marks. |
| YMAX= number | Specifies the maximum Y data value to use in the display of data. |
| YMIN= number | Specifies the minimum Y data value to use in the display of data. |
| YOFFSETMAX=number | Specifies an offset to add to the end that represents high data values on the primary Y axis. |
| YOFFSETMIN= number | Specifies an offset to add to the end that represents low data values on the primary Y axis. |
| YORIGIN= number | expression | Specifies the Y data coordinate of the vector origin. |
specifies the placement of the arrowheads at the ends of the vector.
| IN |
specifies that the arrow direction is toward the origin. |
| OUT |
specifies that the arrow direction is away from the origin. |
| BOTH |
specifies that the arrow direction is both toward and away from the origin. |
| NONE |
specifies that there are no arrowheads. |
| Default: | OUT |
specifies the shape of the arrowheads.
| Default: | OPENARROW |
specifies the background color of the graph.
| Default: | Specified by the GraphBackground:Background style reference. |
| Interaction: | Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block. |
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. |
| Interaction: | Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block. |
| See also: | TRANSPARENCY= option |
specifies the label at the end of the vector.
| Default: | No labels are displayed. |
| Tip: | The position of the labels are adjusted to prevent the labels from overlapping. |
specifies the color of the data labels.
| Default: | Specified by the GraphDataDefault:ContrastColor style reference. |
| Interaction: | The DATALABELCOLOR= option overrides the GROUP= option. |
| Tip: | When the GROUP= option is used, each distinct group value is represented by a different color. The data label that is associated with the group is assigned the group color. The DATALABELCOLOR= option can be used to specify a single color for all of the data labels in a graph, without affecting items that have the group color, such as the vector line. |
specifies the family of the font of the data labels.
| Default: | Specified by the GraphDataText:Font_Face style reference. |
| Restriction: | You must specify one font family name. You cannot specify a list of font family names. |
specifies the size of the font of the data labels.
| Default: | Specified by the GraphDataText:Font_Size style reference. |
specifies the style of the font of the data labels.
| Default: | Specified by the GraphDataText:Font_Style style reference. |
specifies the weight of the font of the data labels.
| Default: | Specified by the GraphDataText:Font_Weight style reference. |
specifies the format of the data labels.
| Default: | The format of the data label uses the format of the column. If the column is unformatted, then the data label uses the BEST12 format. |
| Restriction: | The w.d format must be specified using the Fw.d format. |
specifies the degree of the transparency of the vector line.
| Default: | 0 |
| Range: | 0 (opaque) to 1 (entirely transparent) |
| Interaction: | The DATATRANSPARENCY= option overrides the TRANSPARENCY= option for the vector line. |
| See also: | TRANSPARENCY= option |
equates the axes so that one unit on the Y axis is equal in length to one unit on the X axis.
| Default: | FALSE |
| Interaction: | Although the axes are equated, they may differ in length. |
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. |
| Interaction: | Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block. |
| See also: | TRANSPARENCY= option |
creates a separate vector 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 color and line pattern (as appropriated for the graph). |
| Tip: | The representations that are used to identify the groups can be overridden individually. For example, the LINEPATTERN= option could be used to assign the same line pattern to all the vector lines of the plot. |
specifies indices for remapping the assignment of color, marker symbols, and line pattern to group values.
| Interaction: |
If the INDEX= option is not used,
then the group values are mapped in the order of the data.
The INDEX= option must be used with the GROUP= option. If the GROUP= option is not specified, then the INDEX= option is ignored. |
specifies the degree of the transparency of the labels in the display of data .
| Default: | 0 |
| Range: | 0 (opaque) to 1 (entirely transparent) |
| Interaction: | The LABELTRANSPARENCY= option overrides the TRANSPARENCY= option for the data labels. |
specifies the label of the legends.
| Default: | No label |
| Interaction: | The GROUP= option overrides the LEGENDLABEL= option. |
specifies the color of the vector line.
| 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. |
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 set the LineStyle attribute, then a default sequence of line patterns is used. |
specifies the thickness of the line.
| Default: | 1 px |
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. |
specifies the scale factor of the vector length.
| Default: | 1.0 |
| Restriction: | The number specified must be greater than 0. |
specifies the information to display when the cursor is positioned over a graph element.
| Default: | All of the variables specified for the graph. |
| Requirement: | You can activate tool tips in a SAS program by specifying an ODS GRAPHICS statement that has IMAGEFMT=STATICMAP specified. |
| Requirement: | Tool tips are only available for graphs that are written to the ODS HTML destination. Tool tips are only displayed if they are activated by the SAS program that generates the ODS graphics output. |
specifies the degree of the transparency of the vector line, background, grid, labels, wall 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=, DATATRANSPARENCY=, GRIDTRANSPARENCY=, LABELTRANSPARENCY=, and WALLTRANSPARENCY= options. The value specified by the TRANSPARENCY= option is only applied to the transparencies that you do not specify individually. |
| Interaction: | In a LAYOUT OVERLAY block, the TRANSPARENCY= option only affects the data area and the data labels. The LAYOUT OVERLAY statement specifies the transparency of the background, grid, and wall of the graph. |
specifies the degree of the transparency of the plot wall.
| Default: | 0 |
| Range: | 0 (opaque) to 1 (entirely transparent) |
| Interaction: | The WALLTRANSPARENCY= option overrides the TRANSPARENCY= option for the graph wall. |
| Interaction: | Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block. |
| See also: | TRANSPARENCY= option |
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. |
specifies one or more X axis options.
| Requirement: | The list of axis options must be enclosed in parentheses and separated by spaces. |
| Interaction: | Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block. |
specifies whether the grid lines are drawn at the tick marks.
| Default: | FALSE | ||||||
| Interaction: | Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block. | ||||||
| Interaction: |
If you specify or use the default
XGRID= option for the OVERLAY LAYOUT statement, then the XGRID= option specified
for a graph is ignored. Default characteristics for the grid lines are specified
from the following attributes on the GraphGridLines style element:
|
specifies the maximum X data value to use in the display of data.
| Default: | The maximum X value in the data. |
| Restriction: | If the data contains values greater than the number that is specified for the XMAX= option, then the data values are excluded from the vector line. |
specifies the minimum X data value to use in the display of data.
| Default: | The minimum X value in the data. |
| Restriction: | If the data contains values that are less than the number specified for the XMIN= option, then the data values are excluded from the vector line. |
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. |
| Interaction: | Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block. |
| Main discussion: | THRESHOLDMAX= sub-option. |
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 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. |
| Interaction: | Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block. |
| Main discussion: | THRESHOLDMAX= sub-option. |
specifies the X data coordinate of the vector origin.
| Default: | 0 |
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. |
specifies one or more Y axis options.
| Requirement: | The list of axis options must be enclosed in parentheses and separated by spaces. |
| Interaction: | Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block. |
specifies whether grid lines are drawn at the tick marks.
| Default: | FALSE | ||||||
| Interaction: | Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block. | ||||||
| Interaction: |
If you specify or use the default
YGRID= option for the OVERLAY LAYOUT statement, then the YGRID= option specified
for a graph is ignored. Default characteristics for the grid lines are specified
from the following attributes on the GraphGridLines style element:
|
specifies the maximum Y data value to use in the display of data.
| Default: | The maximum Y value in the data. |
| Restriction: | If the data contains values that are greater than the number specified for the YMAX= option, then the data values are excluded from the vector line. |
specifies the minimum Y data value to use in the display of data.
| Default: | The minimum Y value in the data. |
| Restriction: | If the data contains values that are less than the number specified for the YMIN= option, then the data values are excluded from the vector line. |
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. |
| Interaction: | Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block. |
| Main discussion: | THRESHOLDMAX= sub-option. |
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. |
| Interaction: | Ignored in a LAYOUT OVERLAY block. For information, see Ignored Plot Options in a LAYOUT OVERLAY Block. |
| Main discussion: | THRESHOLDMAX= sub-option. |
specifies the Y data coordinate of the vector origin.
| Default: | 0 |