delete_region

Context: regions

Synopsis

Delete the specified region.

Syntax

delete_region()
delete_region( [ChipsId] )
delete_region( "region_id" )
delete_region( "all" )

Description

Depending on the argument, the delete_region command deletes the current region, the region indicated in a ChipsId structure or by the region_id, or all regions.

(no argument) - the current region is deleted.
ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
region_id - identification tag given to each object that is created; use this to delete a specific region.
all - deletes all regions.

Example 1

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

Create a region, then delete it.

Example 2

chips> id = ChipsId()
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.region = "square"
chips> delete_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 deleted.

Example 3

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

Two regions are created, then the delete_region command deletes them both.

Bugs

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