add_line

add_line( [ChipsId,] x1, y1, x2, y2 [,attributes]);
add_line( [ChipsId,] xvals, yvals, [,attributes]);

Description

• ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
• x1, y1, x2, y2 - the endpoints of the line segment, (x1,y1) and (x2,y2); the current coordinate system is used if one is not specified.
• xvals, yvals - arrays of x and y coordinates to create a polyline from (xvals[0],yvals[0]) to (xpos[n], yvals[n])
• attributes - optional parameters which allow the user to configure properties though a structure, list, or attribute string.

The add_line command creates a line segment whose attributes are specified by user preferences or in an attribute list. The new line becomes current by default; providing a ChipsId overrides the currency state.

The endpoints of the line can be specified in data, pixel, frame, or plot normalized coordinates. Lines specified in data coordinates will be clipped at plot boundaries. The "extend" attribute enables lines which extend to infinity.

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_line 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
extend	Should the line extend to infinity (segment vs ray)	see the Line Extend section of "ahelp chipsopt"	none
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_line(.1,.1,.9,.9);

chips> settings = ChipsLine;
chips> settings.color = "blue";
chips> settings.thickness = 8.0;
chips> settings.stem = "MyLine";
chips> add_line(100,100,200,150,settings);

chips> add_line([.1,.5,.9],[.9,.2,.7],{"color", "blue", "style", "dot"
});