Macro Arguments for the DS2CONST and DS2TREE Macros |
Macro arguments specify the configuration of the HTML output file, the location of the data that is used to generate the diagram, and the configuration of the applet's interactive features.
The macros use the following syntax:
%macroname(argument1=value1, argument2=value2, ...); |
Arguments for the APPLET Tag. The CODEBASE argument is required.
DS2TREE and DS2CONST Arguments for Data Definition. For DS2TREE, the arguments NDATA and NID are required. For DS2CONST the arguments NDATA, NID, LDATA, and LTO are required.
Arguments for the APPLET Tag |
The following arguments configure the APPLET tag in the HTML output file. The CODEBASE argument is required.
specifies the units of the HEIGHT= argument. The default value is PIXELS. See also the AWUNITS= argument.
Used by: | DS2TREE, DS2CONST |
specifies the alignment of the applet window in the browser window or frame. Values can be LEFT, RIGHT, TOP, BOTTOM, TEXTTOP, MIDDLE, ABSMIDDLE, BASELINE, or ABSBOTTOM.
Used by: | DS2TREE, DS2CONST |
specifies the text that will be displayed on mouseover by browsers that understand the tag but cannot run Java applets. The default value is SAS Institute Inc. applet_name.
Used by: | DS2TREE, DS2CONST |
specifies the name of the Java archive file(s).
Note: The path to the Java archive is specified in the CODEBASE argument.
The following table shows what archive files to use with each of the macros. For DS2TREE and DS2CONST, you do not have to specify a value for ARCHIVE= because the values shown are generated by default.
DS2TREE |
archive=%str(sas.graph.treeview.jar, sas.graph.nld.jar, sas.graph.j2d.jar) |
DS2CONST |
archive=%str(sas.graph.constapp.jar, sas.graph.nld.jar, sas.graph.j2d.jar) |
Note: Before SAS 9.1, treeview.jar and constapp.jar also contained the classes that are now included in the auxiliary JAR files (sas.graph.nld.jar and sas.graph.j2d.jar). Although you can continue to use the older JAR files by specifying ARCHIVE=treeview.jar or ARCHIVE=constapp.jar, future versions may not support these older JAR files.
Used by: | DS2TREE, DS2CONST |
specifies the units of the WIDTH= argument. The default value is PIXELS. See also the HEIGHT= and AHUNITS= arguments.
Used by: | DS2TREE, DS2CONST |
specifies the path of the SAS Java archives specified in the ARCHIVE= argument.
The CODEBASE argument is required. You can specify CODEBASE="." if the HTML file and Java archive files are in the same directory.
Note: You can specify the location pointed to by the SAS system option APPLETLOC=, or you can specify a different location. To display the current value of APPLETLOC, run the following code:
proc options option=appletloc; run;The value of the APPLETLOC system option is not used as the default value.
Used by: | DS2TREE, DS2CONST |
specifies the height of the applet window. The unit of measure is pixels unless changed by the AHUNITS= argument. The default value is 600 for all macros.
Used by: | DS2TREE, DS2CONST |
specifies the amount of horizontal space, in pixels, to the left and right of the graph or diagram.
Used by: | DS2TREE, DS2CONST |
specifies the name for this instance of the applet. You need to use this argument only if you have more than one instance of the APPLET tag in your HTML file, and if you have included your own scripts or DHTML that communicates with or acts on a particular instance of the applet.
Used by: | DS2TREE, DS2CONST |
specifies the amount of vertical space, in pixels, to the top and bottom of the graph or diagram.
Used by: | DS2TREE, DS2CONST |
specifies the width of the applet window. The unit of measure defaults to pixels unless specified by the AWUNITS= argument.
Used by: | DS2TREE, DS2CONST |
DS2TREE and DS2CONST Arguments for Data Definition |
The following arguments for the DS2TREE and DS2CONST macros define how the applet will use the data set to generate the node/link diagram.
For DS2TREE the arguments NDATA and NID are required.
For DS2CONST the arguments NDATA, NID, LDATA, and LTO are required.
specifies the type of the XML data. Valid values are defined as follows:
indicates that the data set is in the form of an arc list. This is the default value.
indicates that the data set is associative. The links can be displayed based on their weighted values, and node size and link width can represent the relative size of the node and link values.
Used by: | DS2CONST |
indicates whether or not node labels are displayed in the diagram. The default value is Y.
Used by: | DS2CONST, DS2TREE |
when the value is AUTO (default), specifies that the Constellation Applet lays out the diagram using stress and strain equations. Specifying the value USER indicates that the node positions are specified in the NX and NY arguments.
Used by: | DS2CONST |
specifies the name of the variable that determines the color of the link lines. The values of this variable must be HTML 3.2 color names, or you must use the LCOLFMT= argument to convert those values to valid color names. The default color is provided by the CLINK= argument (see DS2TREE and DS2CONST Arguments for Diagram Appearance).
In the DS2CONST macro, the LCOLOR= argument is overridden by the LCOLVAL= argument.
Used by: | DS2CONST, DS2TREE |
specifies the name of a user-defined SAS format that converts the values in the variable named in the LCOLOR= argument to valid HTML color names. Note that the SAS format does not change any values in the data set. The formatted values are applied to the diagram only.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable that determines the color mapping of link lines. This argument is valid only when the value of the DATATYPE= argument is ASSOC, and only when the value of the COLORMAP= argument is Y. If the LCOLVAL= argument is not specified, the link colors are determined by the following arguments in the following order: LCOLOR= (see above) and CLINK= (see DS2TREE and DS2CONST Arguments for Diagram Appearance).
Used by: | DS2CONST |
specifies the name of the SAS data set that contains the link data that is used to generate the diagram.
Used by: | DS2CONST |
specifies the name of the variable whose values define the nodes at the start of link lines. The LFROM variable values must be coordinated with the values of the variables that are named in the NID= and LTO= arguments.
Used by: | DS2CONST |
when the value is ARROW (default), indicates that link lines are to be drawn with arrowheads that indicate the direction of flow.
Used by: | DS2CONST |
specifies the password that is needed for accessing a password-protected link data set (specified with the LDATA= argument). The LPT= argument is required if the data set has a READ or PW password. You do not need to specify this argument if the data set has a WRITE or ALTER password.
Used by: | DS2CONST |
specifies the name of the variable in the data set that determines the stipple mask. The stipple mask generates dashed or dotted link lines. The value of the variable must be an integer, which is then converted into a binary value. In the binary value, a "1" bit means that a pixel is to be drawn and a "0" bit means that no pixel is to be drawn. For example, if the variable has a value of 61680, the binary conversion of that value will be 1111000011110000. This stipple mask generates a dashed link line with dashes and spaces that are four pixels wide. See also the LSTIPFAC= argument.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable in the data set whose value specifies a multiplier for the binary stipple mask (see the LSTIP= argument). The multiplier lengthens the dashes in the base mask. For example, if the multiplier is 2, a stipple mask that specifies 4-pixel dashes and 4-pixel spaces will generate link lines with 8-pixel dashes and spaces.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable in the data set that provides the text that is displayed in the pop-up data tips windows for links.
Used by: | DS2CONST, DS2TREE |
specifies the name of a user-defined SAS format that is applied to the values in the variable specified in the LTIP= argument to configure those values for display in the pop-up data tips window. Note that the SAS format does not change any values in the data set. The formatted values are applied to the diagram only.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable whose values identify the nodes at the ends of link lines. The LTO variable values must be coordinated with the values of the variables that are named in the LFROM and NID arguments.
Used by: | DS2CONST |
specifies the name of the variable whose values determine the weights of the link lines, which determines the color and relative thickness of link lines. The variable values must be real numbers. The link weights are used with the MINLNKWT= argument (see below) and the SCLNKWT= argument (see DS2TREE and DS2CONST Arguments for Diagram Appearance) to control the display of link lines. The LVALUE= argument is valid only when the value of the DATATYPE= argument is ASSOC.
Used by: | DS2CONST |
specifies a WHERE clause that subsets the link data for display in the diagram. If the expression contains any special characters (for example, % or &), include %NRBQUOTE in the expression to process those characters correctly. The following example shows how to correctly specify INT%:
LWHERE=%NRBQUOTE(value="Int%")See also the NWHERE argument.
Used by: | DS2CONST |
specifies the name of the variable in the data set that determines the width of the link lines.
For DS2CONST: When this argument is not specified, the width is determined by the LVALUE argument. This argument is valid for DS2CONST only when the value of the DATATYPE argument is ASSOC.
Used by: | DS2CONST, DS2TREE |
specifies the initial minimum link weight, which determines which links are initially displayed. The initial diagram show only those links that have weights that are greater than or equal to the minimum weight. In the Constellation Applet, a scroll bar allows the Web user to change the minimum link weight to change the number of links that are displayed. Selecting the brower's Refresh option restores the intial minimum link weight that is specified in the MINLNKWT argument. Link weights are determined by the LVALUE argument. This argument is valid only when the value of the DATATYPE argument is ASSOC.
Used by: | DS2CONST |
specifies the name of the variable in the nodes data set that provides the menu text that is displayed when the Web user selects a node with the right mouse button. Selecting this menu option text displays the URL that is associated with that node in the NURL= argument. This argument overrides the ACTION= argument (see DS2TREE and DS2CONST Arguments for Diagram Appearance). The default menu option text is Open URL.
Used by: | DS2CONST, DS2TREE |
specifies the name of a user-defined SAS format that converts the values in the variable named in the NCOLOR= argument to valid HTML color names. Note that the data in the data set is not altered; the formatted value is used in the hierarchical tree rather than the data value.
Used by: | DS2CONST, DS2TREE |
specifies the variable in the nodes data set that determines the background color of the nodes, using HTML 3.2 color names or 6-digit hexadecimal RGB values . If the variable does not contain valid HTML color names, then you can use the NCOLFMT=argument to convert those values to the HTML color names. See also the NCOLVAL= and NVALUE=arguments.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable in the nodes data set that determines the color mapping for the nodes. This argument is valid only when the DATASET= argument is set to ASSOC, and only when the value of the COLORMAP= argument is Y. If this argument is not specified, then the node color is determined by the LVALUE= argument.
Used by: | DS2CONST |
specifies the SAS data set that contains the node data.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable that determines the text font for the node labels. The variable value can be SERIF, SANSSERIF, DIALOG, DIALOGINPUT, or MONOSPACED. The default node font is specified by the FNTNAME= argument (see DS2TREE and DS2CONST Arguments for Diagram Appearance).
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable in the nodes data set that determines the size of the text font used for node labels. This font size is expressed in points. This argument overrides the FNTSIZE= argument.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable that determines the font style for the node label. The valid values that can be assigned to the variable are BOLD, ITALIC, and PLAIN.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable in the nodes data set whose values are to illustrated as the nodes in the diagram. The node ID variable type can be either numeric or character. For the DS2CONST macro, the values of the NID variable must be coordinated with the values of the LFROM and LTO variables.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable that represents the node labels. This variable type can be either numeric or character.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable that represents the parent nodes. This variable type can be either numeric or character.
Used by: | DS2TREE |
specifies the password that is needed for accessing a password-protected data set. This argument is required if the data set has a READ or PW password. You do not need to specify this argument if the data set has only WRITE or ALTER passwords.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable in the node styles data set that determines the background color of the nodes. The variable values must be HTML 3.2 color names. The default value is determined by the CNODE= argument (see DS2TREE and DS2CONST Arguments for Diagram Appearance).
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable in the node styles data set that provides the colors for the node label text. Valid variable values must be HTML 3.2 color names. The default color is provided by the CATEXT= argument.
Used by: | DS2CONST, DS2TREE |
specifies the name of the node styles data set.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable in the node styles data set that determines the text font that is to be used for node labels. Valid variable values can be SERIF, SANSSERIF, DIALOG, DIALOGINPUT, or MONOSPACED. This argument overrides the FNTNAME= argument.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable in the node styles data set that determines the size of the node label text, in points. This argument overrides the FNTSIZE= argument.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable in the node styles data set that determines the style of the node label text. Valid variable values can be BOLD, ITALIC, or the default value, PLAIN. This argument overrides the FNTSTYL= argument.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable that determines the shape of the nodes. Valid variable values can be CIRCLE, DIAMOND, NONE, SQUARE, or TRIANGLE. The default value is SQUARE. This argument overrides the NODESHAP= argument.
Used by: | DS2CONST |
specifies the name of the variable in the node styles data set that represents the nodes.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable that determines the size of the nodes. The values of this variable can be real numbers. Node sizes are determined based on the value of the LAYOUT= argument. When LAYOUT=USER, the values of the NSIZE variable are interpreted as literal pixel measurements. When LAYOUT=AUTO, the values of the NSIZE variable determine the size of the nodes based on the relative size of individual values. The values of the NSIZE variable can be scaled with the SCNSIZE= argument (see DS2TREE and DS2CONST Arguments for Diagram Appearance). This argument is valid only when the value of the DATATYPE= argument is ASSOC.
Used by: | DS2CONST |
specifies the password that is needed to access a password-protected node styles data set. This argument is required if the data set has a READ or PW password. You do not need to specify this argument if the data set has only WRITE or ALTER passwords.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable that determines the style of the nodes. This variable type can be either numeric or character, and the values must correspond to the node identifiers specified in the NSID= argument.
Used by: | DS2CONST, DS2TREE |
specifies a WHERE clause that subsets the node styles data set for display in the diagram. If the expression contains any special characters (for example, % or &), then include %NRBQUOTE in the expression to process those characters correctly. The following example shows how to correctly specify INT%:
NSWHERE=%NRBQUOTE(value="Int%")
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable that determines the color of the text for the node labels. Valid variable values must be HTML 3.2 color names.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable that provides the data or text that is displayed in the pop-up data tips window.
Used by: | DS2CONST, DS2TREE |
specifies the name of a user-defined SAS format that is applied to the data tips variable that is named in the NTIP= argument. Note that the data set is not altered; the formatted value is used only in the diagram.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable that provides the drill-down URLs for the nodes. These URLs are displayed when the Web user double-clicks on a node or selects the node with the right mouse button and chooses an option from the pop-up menu. Menu text is determined by the NACTION= argument above and by the ACTION= argument in DS2TREE and DS2CONST Arguments for Diagram Appearance. The default menu option text is Open URL.
Used by: | DS2CONST, DS2TREE |
specifies the name of the variable that determines the relative node size. This argument is valid only when DATATYPE=ASSOC.
If you do not specify a particular node color using either the NCOLOR or NCOLVAL argument (and if COLORMAP=Y), then this argument also determines a default node color. By default, the largest value of NVALUE is mapped to red, the median value to green, and the lowest value to blue. Values in between result in interpolated colors.
Used by: | DS2CONST |
specifies a WHERE clause that subsets the nodes data set for display in the diagram. If the expression contains any special characters (for example, % or &), then include %NRBQUOTE in the expression to process those characters correctly. The following example shows how to correctly specify INT%:
NWHERE=%NRBQUOTE(value="Int%")See also the LWHERE= argument.
Used by: | DS2CONST, DS2TREE |
specify the variables that determine the locations of the centers of the nodes. These arguments are valid only when the LAYOUT= argument is set to USER. The values are expressed in pixels. Positive values are measured from the top-left corner of the screen. Negative values are measured from the bottom-right corner of the screen.
Used by: | DS2CONST |
Arguments for Generating HTML and XML Files |
The following arguments determine the name, storage location, and file makeup of Web presentations that run in the Constellation Applet or the Treeview Applet.
specifies the name and storage location of the HTML output file. If the external file does not exist, then it is created for you. Either this argument, or HTMLFREF=, is required if you specify MAKEHTML=Y. Note: Do not use the HTMLFILE= argument if you use the HTMLFREF= argument.
Used by: | DS2TREE, DS2CONST |
specifies the SAS fileref that identifies the name and storage location of the HTML output file. If the external file does not exist, then it is created for you. Either this argument, or HTMLFILE=filename, is required if you specify MAKEHTML=Y. Note: Do not use the HTMLFREF= argument if you use the HTMLFILE= argument, and do not use a reserved name (see Reserved Names).
Used by: | DS2TREE, DS2CONST |
specifies whether or not an HTML file is to be generated. The default value is Y, which generates the HTML output file. If you specify MAKEHTML=N and MAKEXML=Y, then only an XML file is generated.
Used by: | DS2TREE, DS2CONST |
specifies whether or not an XML file is to be generated. The default value is Y, which generates the XML output file. If you specify MAKEXML=N and MAKEHTML=Y, then only an HTML file will be generated. Note that under these circumstances, you must specify a value for the XMLURL= argument.
Used by: | DS2TREE, DS2CONST |
indicates whether the new HTML or XML output or both overwrites the information that is currently in the specified file(s), or if the new output is appended to the end of the existing file(s). The default value is REPLACE. Specify APPEND to add your new HTML-enhanced output to the end of an existing file. Note: OPENMODE=APPEND is not valid if you are writing your resulting HTML to a partitioned data set (PDS) on z/OS.
Used by: | DS2TREE, DS2CONST |
specifies whether you are running the DS2TREE macro in batch or server mode. Batch mode (RUNMODE=B, the default) means that you are submitting the DS2TREE macro in the SAS Program Editor or you have included it in a SAS program. Server mode (RUNMODE=S) generates the HTTP header that is required by Application Dispatcher in the SAS/INTRNET software.
Used by: | DS2TREE, DS2CONST |
specifies the name and storage location of the XML output file. If the external file does not exist, then it is created for you. This argument, or XMLFREF=, is required if you specify MAKEXML=Y and XMLTYPE=EXTERNAL. Note: Do not use the XMLFILE= argument if you use the XMLFREF= argument.
Used by: | DS2TREE, DS2CONST |
specifies the SAS fileref that identifies the name and storage location of the XML output file. If the external file does not exist, then it is created for you. This argument, or XMLFILE=, is required if you specify MAKEXML=Y and XMLTYPE=EXTERNAL. Note: Do not use the XMLFREF= argument if you use the XMLFILE= argument, and do not use a reserved name (see Reserved Names).
Used by: | DS2TREE, DS2CONST |
specifies whether the XML output file is to be written to an external file or included inline with the HTML. The default value is INLINE. If you specify EXTERNAL you must also specify a value for either the XMLFILE= or XMLFREF= arguments. This argument is required if you specify MAKEXML=Y.
Used by: | DS2TREE, DS2CONST |
specifies the URL of the existing file that contains the XML tags that define the node/link diagram. This argument is required if specified XMLTYPE=EXTERNAL.
Used by: | DS2TREE, DS2CONST |
DS2TREE and DS2CONST Arguments for Diagram Appearance |
The following arguments for the DS2TREE and DS2CONST macros specify non-default behavior and appearance of the node/link diagram in the respective applet.
None of the following arguments are required.
specifies the default text that is displayed in a pop-up menu when the Web user selects a node with the right mouse button. Selecting this menu option displays the URL that is associated with that node in the NURL= argument. This argument is overridden by the NACTION= argument (see DS2TREE and DS2CONST Arguments for Data Definition). The ACTION= argument is useful when you want to use a single menu text string for most of the nodes in your diagram. The default menu option text is Open URL.
Used by: | DS2CONST, DS2TREE |
works with the TREESPAN= argument to determine the direction of growth for the diagram. The ANGLE= argument is valid only when you do not specify the TREEDIR= argument. The TREESPAN= argument defines the angular width of the tree (narrow or wide layout). The TREESPAN angle can be visualized as a V shape, with the starting node positioned at the base of the V. The rest of the nodes are laid out between the spreading arms of the V. The ANGLE= argument specifies the angle of the V shape. By default, the value of the ANGLE= argument is zero (0) and the V shape opens to the right, as if the letter V was rotated 90 degrees clockwise, to the three-o'clock position. Values of the ANGLE= argument that are greater than zero rotate the V shape counterclockwise away from the three-o'clock position. Valid values for the ANGLE= argument range from zero (0) to 360 degrees.
Used by: | DS2TREE |
specifies whether or not a border is drawn around the background area. The default value is N.
Used by: | DS2CONST, DS2TREE |
specifies a default color for the text in the diagram, using an HTML 3.2 color name or a 6-digit hexadecimal RGB value. For DS2CONST, this argument is overridden by the FNTNAME= argument (see below) and the NTEXTCOL argument (see DS2TREE and DS2CONST Arguments for Data Definition).
Used by: | DS2CONST, DS2TREE |
specifies a background color for the Treeview Applet. The value must be a valid HTML 3.2 color name.
Used by: | DS2TREE |
specifies the color of the Collapse/Expand handle on the nodes. The handle is represented by a small plus sign (+) that is prefixed to the label of the node when its subtree is collapsed. The value must be a valid HTML color name.
Used by: | DS2TREE |
specifies a default color for the links in the diagram, using an HTML 3.2 color name or a 6-digit RGB value. For DS2CONST, this argument is overridden by the LCOLOR= and LCOLVAL= arguments (see DS2TREE and DS2CONST Arguments for Data Definition).
Used by: | DS2CONST, DS2TREE |
specifies the node background color. The value must be a valid HTML color name. The value specified here can be overridden by specifying a value for the NCOLOR= argument.
Used by: | DS2TREE |
specifies a default background color for the nodes, using an HTML 3.2 color name or a 6-digit RGB value. This argument is overridden by the NCOLOR=, NCOLVAL=, NVALUE=, or NSCBACK= arguments (see DS2TREE and DS2CONST Arguments for Data Definition).
Used by: | DS2CONST |
when the value is N (default), specifies that the Constellation Applet is to use the NCOLOR= and LCOLOR= arguments (see DS2TREE and DS2CONST Arguments for Data Definition) to determine node and link colors rather than using the color map.
Used by: | DS2CONST |
specifies a color for nodes that are selected by the mouse or as the result of a node search. The value must be a valid HTML 3.2 color name.
Used by: | DS2CONST, DS2TREE |
specifies the percentage of the nodes that will be displayed with node labels. After the percentage has been reached, nodes are drawn as rectangles. The size of those rectangles decreases as the distance from the starting node increases. Valid values range from 0.0 to 1.0 (The decimal value is mapped to a percentage from 0% to 100%). The default value is 0.5. See also the DEPTH argument.
Used by: | DS2CONST, DS2TREE |
specifies a whole number greater than zero that determines the maximum number of links that are to be displayed in the node/link diagram. Paths whose lengths exceed the limit are truncated. This argument affects only the initial display of the diagram. Nodes that are initially hidden can become visible as a user selects nodes and navigates around the diagram.
Note that this value is ignored if CUTOFF= 1.0. There is no default value for this argument.
Used by: | DS2TREE |
specifies the HTML target or the name of the browser window or frame where drill-down URLs are displayed. The default behavior is to open a new browser window and reuse it for subsequent drill-down requests. Specifically, the default value is _BLANK, which is one of several reserved names for targets in HTML. The value can also be the name of a window or frame in the Web presentation.
Used by: | DS2CONST, DS2TREE |
specifies whether or not the applet will check for duplicate node IDs. The default value is FALSE. When set to TRUE, this argument will cause the applet to update an ID if a duplicate ID is found, instead of creating a new node with the same ID. This enables you to collect node information from different locations in the data set.
Used by: | DS2TREE |
specifies the distortion factor for the fish-eye lens. The distortion factor determines the amount that the central region of the display is to be expanded (or zoomed). The value specified must be greater than or equal to 1.0. The default value is 1.0, which represents the lowest amount of distortion. This argument is valid only when the value of the FISHEYE= argument is Y. The maximum effective value (beyond which no further distortion is visible) is variable depending upon the number of nodes in the diagram.
Used by: | DS2TREE |
indicates whether or not the diagram is to be displayed with the fish-eye distortion, which displays the central region of the diagram at a specified size and displays the rest of the diagram as if it were mapped onto a ball, with the nodes and links disappearing over a curved horizon. The Web user can move the diagram past the central region by scrolling or searching for nodes. The amount of distortion used in the fish-eye lens is determined by the FACTOR= argument. The default value is Y.
Used by: | DS2TREE |
specifies the default text font for node labels. Valid values can be SERIF, SANSSERIF, DIALOG, DIALOGINPUT, or MONOSPACED. This argument is overridden by the NFNTNAME or NSFNTNAM= arguments (see DS2TREE and DS2CONST Arguments for Data Definition).
Used by: | DS2CONST, DS2TREE |
specifies the size of the node label text font, in points. This argument is overridden by the NFNTSIZE= argument.
Used by: | DS2CONST, DS2TREE |
specifies the text font style for node labels. Valid values are BOLD, ITALIC, and PLAIN. PLAIN is the default value. This argument is overridden by the NFNTSTYL= argument.
Used by: | DS2CONST, DS2TREE |
specifies a URL for the image that you want to use in the background of the diagram. See also the IBACKPOS= argument.
Used by: | DS2CONST, DS2TREE |
specifies how to display the background image in the IBACKLOC= argument. Specify one of the following options:
centers the image in the browser window without resizing the image.
fills the browser window by replicating the image at its original size.
positions the image without resizing at the values specified by the IBACKX= and IBACKY= arguments.
Used by: | DS2CONST, DS2TREE |
specifies the URL that is displayed when you click on the background image. This argument is valid only when the value of the IBACKPOS= argument is POSITION. If you are including the Powered by SAS logo, then you must use this argument to link the image to the SAS Web site.
Used by: | DS2CONST, DS2TREE |
specifies the x (horizontal) and y (vertical) pixel coordinates of the upper left-hand corner of the background image. Positive values are measured from the upper-left corner of the background area. Negative values are measured from the lower-right corner of the background area. These values are valid only if the value of the IBACKPOS= argument is POSITION. Always specify both the IBACKX= and IBACKY= arguments.
Used by: | DS2CONST, DS2TREE |
specifies the appearance of the node border line, using one of the following values:
Used by: | DS2TREE |
specifies the shape of the nodes. Valid values can be CIRCLE, DIAMOND, NONE, SQUARE, or TRIANGLE. The default value is SQUARE. This argument is overridden by the NSHAPE= argument (see DS2TREE and DS2CONST Arguments for Data Definition).
Used by: | DS2CONST |
the default value N indicates that size information from the resource bundle is not to be used for sizing the two dialog boxes that can be invoked from the pop-up menu that appears when a user right-mouse-clicks on a diagram. The two dialog boxes are the About dialog box and the Mouse Help dialog box.
Specify Y for this argument for languages other than English.If you specify Y, then the height and the width of the dialog box frames are read in from the resource bundle. This allows translators to set appropriate heights and widths for the frames in the resource bundle, based on the length of the message strings in each language.
Used by: | DS2CONST, DS2TREE |
when the value is Y (default), specifies that the link weight values are to be scaled into the range of 0-1, which corresponds to 0-100%. When SCLNKWT=Y, the scroll bar in Constellation Applet displays a percentage of the range of the link weights. When SCLNKWT=N, the link weights are not scaled and the scroll bar reflects the actual link weight data values. These values are real numbers that are specified in the LVALUE= argument (see DS2TREE and DS2CONST Arguments for Data Definition). The SCLNKWT= argument is valid only when the value of the DATATYPE= argument is ASSOC. Note that the range of link weights (maximum minus minimum) must be greater than 2 when SCLNKWT=N. Otherwise, the scroll bar will not correctly map the link weights.
Used by: | DS2CONST |
when the value is Y (default), indicates that the link width values are to be scaled into the range of 0-1. Specifying N indicates that the link widths are already scaled into that range. This argument is valid only when the value of the DATATYPE= argument is ASSOC.
Used by: | DS2CONST |
when the value is Y (default), indicates that the node size values are to be scaled into the range of 0-1. Specifying N indicates that the node sizes are already scaled into that range. This argument is valid only when the value of the DATATYPE= argument is ASSOC. Node sizes are specified with the NSIZE= argument (see DS2TREE and DS2CONST Arguments for Data Definition).
Used by: | DS2CONST |
specifies whether initially to display all arc lines between nodes. Specifying N suppresses all arc lines. The default value is Y.
Note: This argument affects only the initial display. A viewer can subsequently control which arc lines are displayed by right-mouse clicking and selecting a Show links option from the pop-up menu.
Used by: | DS2CONST |
specifies the angular spreading factor for the layout of the diagram. The value specified must be greater than or equal to 1.0. The default value is 1.25.
Used by: | DS2TREE |
indicates whether or not pop-up data tips are displayed when the cursor is positioned over nodes or links or both. The default value is Y.
Used by: | DS2CONST, DS2TREE |
when the value is TRACKING (default), indicates that the pop-up data tips windows are to move with the cursor while the cursor moves within the area of a single node or link.
Used by: | DS2CONST |
determines the growth direction of the node/link diagram using the following values.
grows the tree in a circular pattern. This is the default value.
The TREEDIR= argument overrides the ANGLE= argument.
Used by: | DS2TREE |
specifies the angular width of the diagram in degrees. Valid values must be greater than zero and less than 360. The default value is 60. For details, see the TREEDIR= and ANGLE= arguments.
Used by: | DS2TREE |
specifies the zoom value that is used for the initial display of the diagram. After the initial display, the Web user can change the zoom percentage dragging the mouse up and down while pressing the Ctrl + left mouse button. Selecting the Refresh button on the browser runs the applet and restores the initial zoom setting. The default value is 100 percent. The initial diagram can be scaled up with a value greater than 100 or scaled down with a value less than 100.
Used by: | DS2CONST |
Arguments for Page Formatting |
The following arguments format the HTML output file. The rendering of some of these arguments may vary in certain browsers. Several of the following arguments apply only to certain macros, as noted in the descriptions of the arguments.
The BGTYPE=, BRTITLE=, CENTER=, CTEXT=, and DOCTYPE= arguments apply to the entire page for the current invocation of the macro. If you append data to an existing HTML page, then the HTML formatting will not change. You may want to use these arguments only when you replace, rather than append, HTML files.
specifies the name of the stylesheet that is to be applied to the body of the HTML output file.
Used by: | DS2TREE, DS2CONST |
specifies the background color or image, based on the value of the BGTYPE= argument. The color can be specified as an HTML 3.2 color name or as a 6-digit hexadecimal RGB value. When BGTYPE=IMAGE, this argument specifies a background image, using a path or a URL, relative or absolute.
Used by: | DS2TREE, DS2CONST |
specifies the background type, using one of the following values:
causes the applet to display its default background color. This is the default value.
specifies that the value of the BG= argument must be an HTML 3.2 color name or hexadecimal RGB value.
specifies that the value of the BG= argument must be the path or URL pointing to an image file that will be displayed in the background of the applet window.
Used by: | DS2TREE, DS2CONST |
specifies the text that appears in the title bar of the browser window. By default, no title is displayed.
Used by: | DS2TREE, DS2CONST |
specifies whether or not the graph or diagram is centered in the browser window. The default value is N.
Used by: | DS2TREE, DS2CONST |
specifies a default text color that replaces the default text color in the browser. Other color arguments can be used to override this new default. The color can be specified as an HTML 3.2 color name or as a six-digit hexadecimal RGB value.
Used by: | DS2TREE, DS2CONST |
generates the following DOCTYPE tag by default, which specifies HTML version 3.2:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">To use a different DOCTYPE tag, specify the entire contents of the tag as the value of the DOCTYPE= argument, including the angle brackets.
If you specify DOCTYPE="", then no DOCTYPE tag is generated in the HTML output file.
Used by: | DS2TREE, DS2CONST |
when the value is Y (default), replaces the angle bracket characters (< and >) in SAS TITLE and FOOTNOTE lines with the HTML character entities (> and <) respectively. Specifying ENCODE=N causes the browser to interpret the angle brackets as parts of HTML tags. For example, you would use ENCODE=N if you wanted to use the following TITLE statement:
title "<FONT COLOR="red">Out of Range Data</FONT>";
Used by: | DS2TREE, DS2CONST |
specifies which part or parts of the HTML page are to be written into the HTML output file. This argument is helpful when are appending HTML output to the end of an existing HTML file, or when you are using separate files for the head, body, and foot of your Web page.
writes the entire HTML file, including the XML tags for the DS2CONST and DS2TREE. This is the default value. Do not use this value if you are appending an existing HTML file.
writes the HTML header information and or XML (for DS2CONST and DS2TREE) into the HTML file. The header information consists of the HEAD and BODY tags. HTML footer information is not included.
writes only the XML tags (for DS2CONST and DS2TREE) into the HTML output file. No head or foot information is generated in the HTML output file.
writes metagraphics codes or XML tags and the </BODY> and </HTML> tags to conclude the HTML file.
Used by: | DS2TREE, DS2CONST |
specifies the path or URL, relative or absolute, to the image file of the SAS Powered logo. In the HTML file, the image appears at the bottom of the page. Selecting the image displays the SAS home page. By default, the logo is omitted. To obtain the logo image file, see http://www2.sas.com/dispatcher/index.html. See also the SPCLASS= argument.
Used by: | DS2TREE, DS2CONST |
specifies the path or URL, relative or absolute, to the style sheet that is used for the page separator. If the value of the SEPTYPE= argument is RULE, then the value of the SEPCLASS= argument is used on the CLASS attribute of the HTML tag <HR>. If the value of the SEPTYPE= argument is IMAGE, then the value of SEPCLASS= argument is used on the CLASS attribute of the HTML tag <IMG>.
Used by: | DS2TREE, DS2CONST |
specifies the path or URL, relative or absolute, to the image that you want to use as the separator between the graphs in your presentation. This argument is valid only if the value of the SEPTYPE= argument is IMAGE.
Used by: | DS2TREE, DS2CONST |
specifies the type of separator that is used between multiple applets in your presentation. The valid values are defined as follows:
Used by: | DS2TREE, DS2CONST |
specifies the name of the style sheet class that is to be used for the Powered by SAS logo.
Used by: | DS2TREE, DS2CONST |
Arguments for Stylesheets |
DS2CONT and DS2TREE enable the following arguments for style sheet specifications in the HTML output file. See also the BDCLASS=, SEPCLASS=, and SPCLASS= arguments in Arguments for Page Formatting.
Style sheet arguments reference style information in one of two ways. Most of the arguments specify parameters in the HTML LINK tag:
<LINK HREF="1qtr98.css" TYPE="text/css" REL="stylesheet">
Use these arguments when you do not want to enter your style information directly into your HTML file when you create that file.
Other arguments embed the style information into the header of the HTML file. Use these arguments when you want to collect style information from multiple style sheets. The end result must create a complete STYLE tag in your HTML file.
You can combine LINK tag arguments with arguments that embed style information, but you cannot use the same ordinal number in two arguments. For example, you can specify the arguments SSHREF1= and SSFILE2=, but you cannot specify SSHREF1= and SSFILE1=.
The following arguments link to two different style sheets and include text comments for each stylesheet.
ssfile1=comments1.txt, /* embeds text */ sshref2=/style/style1.css, /* links to stylesheet */ sstype2=text/css, /* parameters for style sheets */ ssrel2=stylesheet, ssfile3=comments2.txt, /* embeds text */ sshref4=/style/style2.css, /* link to stylesheets */ sstype4=text/css, ssrel4=stylesheet,
embeds in the HTML file the entire contents of the specified file.
Used by: | DS2TREE, DS2CONST |
embeds in the HTML file the entire contents of the file that is referenced by the SAS fileref.
Used by: | DS2TREE, DS2CONST |
specifies the URL of the stylesheet in the HREF= attribute of the LINK tag. If you specify a relative URL, it must be relative to the location of the HTML output file.
Used by: | DS2TREE, DS2CONST |
specifies the media for which the style sheet was designed. The value is applied to the MEDIA= attribute of the LINK tag. The default value is SCREEN. Examples of other valid MEDIA values include BRAILLE for tactile feedback devices, and HANDHELD for small-screen devices.
Used by: | DS2TREE, DS2CONST |
specifies the REL= attribute of the LINK tag, which describes the relationship from the linked file to the HTML file. The value of this tag is generally STYLESHEET. The arguments SSREL1-5= can also be used with the arguments SSREV1-5 to link HTML pages in a series. For example, the SSREL1= argument can specify the next document in the series, and the SSREV2= argument can specify the reverse relationship, which would be the previous document in the series. Both arguments, SSRELn= and SSREVn=, can appear in the same LINK tag.
Used by: | DS2TREE, DS2CONST |
specifies the REV= attribute of the LINK tag, which describes the relationship from the HTML file to the linked file. See the SSREL1-5= argument for details.
Used by: | DS2TREE, DS2CONST |
specifies the TITLE= attribute of the LINK tag. The TITLE= attribute provides a title for the referenced page. Use this argument when you are using the SSRELn= and SSREVn= arguments to specify next and previous links in a series of Web pages.
Used by: | DS2TREE, DS2CONST |
specifies the TYPE= attribute of the LINK tag. For cascading style sheets, this value usually is TEXT/CSS. For JavaScript style sheets, this value is generally TEXT/JAVASCRIPT.
Used by: | DS2TREE, DS2CONST |
Arguments for the SAS TITLE and FOOTNOTE Tags |
The following arguments determine the content and appearance of the SAS TITLE and FOOTNOTE tags in the HTML output file.
specify the name of the style sheet class that is to be used for the SAS TITLE or FOOTNOTE.
Used by: | DS2TREE, DS2CONST. |
specify the color of the text in the SAS TITLE or FOOTNOTE, using an HTML 3.2 color name or a six-digit hexadecimal RGB value.
Used by: | DS2TREE, DS2CONST. |
specify a text font for the SAS TITLE or FOOTNOTE. Valid values are browser-specific.
Used by: | DS2TREE, DS2CONST. |
specify the size of the text font that is to be used for the SAS TITLE or FOOTNOTE, where n is an integer. Valid values are browser-specific depending on how the browser handles the SIZE attribute on the FONT tag.
Used by: | DS2TREE, DS2CONST. |
specify a text string that the macro translates into one or more tags that will enclose the SAS TITLE or FOOTNOTE.
The default value is as follows:
PREFORMATTED + HEADER 3
Used by: | DS2TREE, DS2CONST. |
For each possible value of the TTAG= and FTAG= arguments, the following table shows the HTML tags that are generated by the macro for the SAS TITLE and FOOTNOTE lines (the corresponding end tags are generated automatically):
Arguments for Character Transcoding |
The following arguments allow you to specify a character set or convert character data to the corresponding Unicode Numeric Character Reference (NCR).
specifies the character set name that will be written into the META tag of the HTML output file. For information on available character set names, see http://www.iana.org/assignments/character-sets.
Used by: | DS2TREE, DS2CONST, META2HTM |
specifies the name and location of an existing transcoding list, either user-defined or from SAS. The transcoding list name must be a four-level name, and the fourth level must be SLIST, as in the following example:
TRANLIST=SASHELP.HTMLGEN.IDENTITY.SLISTThis argument is required if you are implementing character transcoding.
SAS provides a number of transcoding lists in the SASHELP.HTMLNLS catalog. For a description of these transcoding lists, and for information on generating your own transcoding lists, see the SAS Web site at http://support.sas.com/rnd/web/intrnet/format/lang2.html.
Used by: | DS2TREE, DS2CONST, META2HTM |
Reserved Names |
Do not use the following names as the value of a macro variable:
Copyright © 2010 by SAS Institute Inc., Cary, NC, USA. All rights reserved.