set_cascading_property

Context: utilities

Synopsis

Sets all occurrences of the attribute within a specified hierarchy.

Syntax

set_cascading_property( [id,] start_obj, attribute, value)

Description

id - an optional ChipsId structure containing values to modify the currency state for the command or a string id to specify the object
object_type - where in the hierarchy to being changing the values, chips_window or chips_curve; see the Object Type section of "ahelp chipsopt"
attribute - the name of the attribute to modify.
value - the value for the specified attribute

The set_cascading_property command sets all occurrances of the specified attribute to the given value. It descends down the hierarchy of current objects (or based on an optional ChipsId), beginning at the specified object type.

The start_obj parameter specifies at which object to begin the attribute changes. For instance, if the object_type is set to chips_window, the changes will be applied to all objects in the hierarchy that exist under the current window(s). The currency only applies to the start_obj itself; the currency state of the child objects is not considered.

The attributes supported in set_cascading_property are:

Argument	Description	Options	Default
angle	angle properties in labels and points	0:360	0.0
bgcolor	background colors in windows and frames	name or hex; see the Color section of "ahelp chipsopt"	default: black in the ChIPS window, white on printout
color	colors in frames, plots, curves, axes, lines, labels, regions, points, contours, histograms	name or hex; see the Color section of "ahelp chipsopt"	default: black in the ChIPS window, white on printout
fill	fill for points, curve symbols, histogram symbols, and regions	boolean values; see the Booleans section of "ahelp chipsopt"	varies
font	font for labels, axis labels, axis ticklabels, and plot titles	helvetica\|courier\|times\|greek; see the Font section of "ahelp chipsopt"	helvetica
fontstyle	fontstyle for labels, axis labels, axis ticklabels, and plot titles	normal\|bold\|italic\|bolditalic; see the Font Style section of "ahelp chipsopt"	normal
length	length of the major and minor axis tickmarks	integer values 0:100	varies
thickness	thickness of lines and traces	0.5 to 10.0; see the Thickness section of "ahelp chipsopt"	1

Example 1

chips> add_contour([1,2,2,.2,.4,5,1,9,0], 3, 3, "color=plum")
chips> add_frame(.2, .2, .45, .45, "border.visible=1")
chips> add_line([.1,.2,.6,.9], [.3,.8,.9,.1], "color=red")
chips> add_label(.5, .5, r"\sigma", "color=forest")
chips> set_cascading_property(chips_window, "color", "coral")

Create a contour and inlay a frame with a red line and green label. Change all (foreground) color attributes to the "coral", starting at the current window.

Example 2

chips> set_cascading_property("frm1", chips_frame, "thickness", "3")

Continuing from the previous example, set the thickness of all objects in frame "frm1" to 3.

Changes in CIAO 4.4

Bug fix: set_cascading_property would not work on the properties of annotation objects - including labels, lines, points, regions, and colorbars - when the object was used directly.

Bugs

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