Chapter Contents |
Previous |
Next |
Chart Control: _addReferenceLine |
Syntax | |
Details |
Syntax |
objectName._addReferenceLine( axis, refId, vtype,value,label ); |
objectName._addReferenceLine( axis, refId, vtype, value ); |
objectName._addReferenceLine( axis, refId, vtype, value3, label ); |
objectName._addReferenceLine( axis, refId, vtype, value5 ); |
Argument | Type | Use | Description |
---|---|---|---|
axis | Character | Input | refline axis. Should be either 'x' or 'y' |
refId | Numeric | Input | unique ID returned for the reference line. Used to identify reference line for other related methods |
vtype | Character | Input | indicates whether the value parameter specifies a data value or a location on the axis |
value | Numeric | Input | specifies the reference line's initial position on the axis |
label | Character | Input | reference line label |
value3 | Character | Input | specifies the reference line's initial position on the axis |
value5 | Character | Input | specifies the reference line's initial position on the axis |
Details |
If the vtype parameter is set to Value, use a data value to position the line; for example, specify 5 to position the line at axis value 5. If the vtype parameter is set to Location, use a percentage to position the line; for example, specify .5 to position the line in the middle of the axis. Location values are expected to range from 0 to 1.
You cannot add a reference line on an axis that displays categorical or character data. If there is an error while creating the reference line, the refID parameter is set to -1.
Chapter Contents |
Previous |
Next |
Top of Page |
Copyright 1999 by SAS Institute Inc., Cary, NC, USA. All rights reserved.