hide_region

Context: regions

Synopsis

Hide the specified region.

Syntax

hide_region()
hide_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 hidden, otherwise the argument determines what to hide. Note that this does not delete anything; use the display_region command to make the items visible again.

Examples

Example 1

chips> add_region(3, .7, .7, .2)
chips> hide_region()

Create a region, then hide it.

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> 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> hide_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 hidden.

Example 3

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

Two regions are created, then the hide_region command hides them both.

Bugs

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