Last modified: December 2013

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


AHELP for CIAO 4.11 ChIPS v1

display_region

Context: regions

Synopsis

Display the specified region.

Syntax

display_region()
display_region(id)

Description

The function arguments.

Argument Description
id A ChipsId structure identifying the item, or a string containing the name of the object.

If no argument is given then the current region is shown, otherwise the argument determines what to show.


Examples

Example 1

chips> add_region(3, .7, .7, .2, "id=tri")
chips> hide_region("tri")
chips> display_region()

Create a region and hide it, then display the current region.

Example 2

chips> add_region(4, .5, .5, .4, "id=square")
chips> set_region("square", ["edge.color", "white", "fill.color",
"blue", "fill.style", "1"])
chips> hide_region("square")
chips> add_region(6, .5, .5, .1, "id=hex")
chips> set_region("hex", ["edge.color", "white", "edge.thickness", 2])
chips> id = ChipsId()
chips> id.region = "square"
chips> display_region(id)

Two regions are created; the second region is current after it is created. The id.region command sets the region value of the ChipsId structure to the first region. That region is then displayed.

Example 3

chips> add_region(4, .5, .5, .4, "id=square")
chips> add_region(6, .5, .5, .1, "id=hex")
chips> hide_region("all")
chips> display_region("all")

Two regions are created and hidden, then the display_region command displays them both.


Bugs

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

See Also

concepts
chipsid, currency, depthcontrol
contrib
chips_regions
depth
collapse_depths, display_depth, get_default_depth, hide_depth, reindex_depth, set_default_depth
regions
add_region, current_region, delete_region, get_region, hide_region, move_region, set_region, shuffle_region
utilities
load_fill