set_point

Context: points

Synopsis

Modifies the attributes of an existing point.

Syntax

set_point([id,] values)

Description

id - an optional ChipsId structure containing values to modify the currency state for the command or a string id to modify a point within the current frame.
values - a list containing attribute value pairs or a ChipsPoint object.

The set_point command sets the specified attributes to the provided values. The modified point becomes current. Multiple points may be modified with a single command by setting the currency to "all".

There are several attributes that control the characteristics of points. The set_point command may be used to modify the attribute values of an existing point at any time during a ChIPS session. See "ahelp attributes" and "ahelp setget" for more general information.

If multiple attributes are being set simultaneously and one of them fails, the entire command will fail and the point will not be modified.

Please see the section "Point Preferences and Attributes" below the examples for a list of the point attributes.

Advanced Functions

The module of advanced ChIPS functions contains other commands for setting attribute values (refer to "ahelp chips" for information on loading the module):

set_point_angle
set_point_color
set_point_depth
set_point_fill
set_point_size
set_point_style

Example 1

chips> set_point(["color", "coral", "style", "downtriangle"])

Using attribute/value pairs, set the point color to coral and symbol style to downtriangles.

Example 2

chips> pnt = ChipsPoint()
chips> pnt.color = "blue"
chips> pnt.size = 16
chips> set_point("pnt1", pnt)

Populate the "pnt" structure with attribute values, then use it to set pnt1 to be blue with a size of 16.

Point Preferences and Attributes

The attributes associated with points are given in the following table, where the "Set?" column refers to whether the attribute can be changed using the set_point() command. To change the point preference settings prepend "point." to the attribute name.

Attribute	Description	Options	Default	Set?
angle	Angle, in degrees, at which the point is drawn	-360.0 to 360.0	0.0	Yes
color	color of the point	name or hex; see the Color section of "ahelp chipsopt"	default	Yes
coordsys	coordinate system for the point	PIXEL, WINDOW_NORM, FRAME_NORM, PLOT_NORM, DATA	see "ahelp coordsys"	Yes
depth	Integer value indicating point depth	see the Depth section of "ahelp chipsopt"	default	Yes
fill	fill the point?	see the Booleans section of "ahelp chipsopt"	true	Yes
size	size of the point	1 to 100	12	Yes
stem	stem used for point id	An alpha-numeric character sequence that does not contain a space	pnt	No
style	symbol style	see the Symbol Styles section of "ahelp chipsopt"	cross	Yes

Bugs

See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.