add_vline

add_vline( [ChipsId,] x [,attributes])

Description

• ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
• x - the location along the horizontal axis through which the vertical line should pass; the current coordinate system is used if one is not specified.
• attributes - optional parameters which allow the user to configure properties though a structure, list, or attribute string.

The add_vline command creates a vertical line at the specified x location. The location of the line can be specified in data, pixel, frame, or plot normalized coordinates. The line extends infinitely along the vertical. It is clipped appropriately by its coordinate system (e.g. lines in data coordinates or plot normalized will be clipped at plot boundaries).

This command is the same as creating a vertical line segment with add_line ("ahelp add_line") and setting the "extend" property so that it extends both ends of the line; see the Line Extend section of "ahelp chipsopt" .

Customizing the Line

There are several attributes that control the line characteristics. The attributes can be set to the ChIPS defaults, values provided in the add_vline command, or values from the user's preference file.

The attributes may also be modified with the set_line command at any time; see "ahelp set_line" and "ahelp setget" for more information.

The attributes associated with lines are:

Attribute	Description	Options	Default
color	line color	name or hex; see the Color section of "ahelp chipsopt"	default: white in the ChIPS window, black on printout
coordsys	coordinate system for the line	PIXEL, WINDOW_NORM, FRAME_NORM, PLOT_NORM, DATA	see "ahelp coordsys"
depth	Integer value indicating line depth	see the Depth section of "ahelp chipsopt"	100
stem	stem used for line id	alphanumeric	line
style	stipple pattern used to draw the line segment	see the Line Style section of "ahelp chipsopt"	chips_solid
thickness	line thickness	0.5 to 10.0; see the Thickness section of "ahelp chipsopt"	1

chips> add_vline(.1)

chips> settings = ChipsLine()
chips> settings.color = 'blue'
chips> settings.thickness = 8.0
chips> settings.stem = 'MyLine'
chips> add_axis (XY_AXIS, 0, 0, 200)
chips> add_vline(100,settings)