Last modified: December 2013

URL: https://cxc.cfa.harvard.edu/chips/ahelp/display_depth.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.11 ChIPS v1

display_depth

Context: depth

Synopsis

Display the objects at the specified depth

Syntax

display_depth(depth)
display_depth(id, depth)

Description

The function arguments.

Argument Description
depth The depth value (an integer greater than 0) to display.
id A ChipsId structure identifying the item, or a string containing the name of the object.

The display_depth command displays all objects at a specific depth which were hidden using the hide_depth command. Objects which were hidden using another method, such as "hide_<object>", will remain hidden.

The info_depth command can be used to find out the depths of the ChIPS objects.


Examples

Example 1

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=100')
chips> add_hline(5, 'depth=50 color=red')
chips> hide_depth(50)
chips> display_depth(50)

Create two curvess and a horizontal line at different depths. Hide everything at depth 50 (i.e. the line and the blue curve), then display it again.

Example 2

chips> add_histogram([1,2,3], [3,5,2], 'fill.style=1 fill.color=red
depth=50')
chips> add_curve([1,2,3], [3,5,2], 'depth=100')
chips> add_label(3, 3, 'LABEL', 'depth=50')
chips> hide_label()
chips> set_plot_title ('My Plot')
chips> set_plot(['title.depth', 50])
chips> hide_depth(50)
chips> display_depth(50)

Create a histogram, a curve, and a label. The label is hidden with the hide_label command. Hide everything at depth 50, then display it again. The label at depth 50 will not be displayed because it was not hidden by the hide_depth command.


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
collapse_depths, get_default_depth, hide_depth, reindex_depth, set_default_depth