collapse_depths

Synopsis

Merges an array of depths into a single new depth.

collapse_depths( [id,] depth_list, new_depth)

Description

• id - an optional ChipsId structure containing values to modify the currency state for the command or a string id to specify the frame. For this command, only the currency of windows and frames matters.
• depth_list - a list of one or more depth values.
• new_depth - the new value to assign to all objects indicated by the depth_list.

The collapse_depths command merges an array of depths into a single new depth. The order in which the depths are specified dictates the order in which the objects are merged into the new depth.

Use the info_depth command ("ahelp info_depth") to see which depths are being used. For general information on depth, refer to "ahelp depthcontrol" .

Example

chips> add_curve(range (10), range (10), 'line.color=blue
symbol.color=blue depth=50')
chips> add_curve(range (10), range (9,-1,-1), 'depth=200')
chips> add_hline(5, 'depth=70 color=red')
chips> collapse_depths([50,70,100], 200)

Create two curves and a horizontal line at different depths. All objects at depths 50, 70, and 100 are collapsed to a depth of 200.

Bugs

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

See Also

concepts

chipsid, currency, depthcontrol

depth

display_depth, get_default_depth, hide_depth, reindex_depth, set_default_depth