|AHELP for CIAO 4.5 ChIPS v1||
Creates a vertical line.
add_vline([ChipsId,] x [,attributes]) Vertical lines can also be created directly from the GUI using the "Annotate" menu item.
- 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".
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.
Please see the section "Line Preferences and Attributes" below the examples for a list of the line attributes.
Add a vertical line at x=0.1 in the current coordinate system.
chips> vl = ChipsLine() chips> vl.color = 'blue' chips> vl.thickness = 8.0 chips> vl.stem = 'MyLine' chips> add_axis(XY_AXIS, 0, 0, 200) chips> add_vline(100, vl)
Populate the "vl" structure with the attribute values, then add a vertical line that passes through the point 100 on the x-axis.
The attributes associated with lines are given in the following table, where the "Set?" column refers to whether the attribute can be change using the set_line() command. To change the line preference settings prepend "line." to the attribute name.
|color||line color||name or hex; see the Color section of "ahelp chipsopt"||default||Yes|
|coordsys||coordinate system for the line||PIXEL, WINDOW_NORM, FRAME_NORM, PLOT_NORM, DATA||see "ahelp coordsys"||No|
|depth||Integer value indicating line depth||see the Depth section of "ahelp chipsopt"||default||Yes|
|extend||Should the line extend to infinity (segment vs ray)||One of "none", "both", "start", "end", chips_extend_none, chips_extend_both, chips_extend_start, or chips_extend_end.||chips_extend_none||Yes|
|stem||stem used for line id||An alpha-numeric character sequence that does not contain a space||line||No|
|style||stipple pattern used to draw the line segment||see the Line Style section of "ahelp chipsopt"||chips_solid||Yes|
|thickness||line thickness||0.5 to 10.0; see the Thickness section of "ahelp chipsopt"||1||Yes|
Vertical lines can now be added directly from the GUI, using either the "Annotate" menu item or the "Annotate" option brought up by using the Right-Mouse Button in the ChIPS window.
See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.