shuffle_front

Context: shuffle

Synopsis

Shuffles the object to the front of the depth.

Syntax

shuffle_front(object)
shuffle_front(id, object)

Description

The function arguments.

Argument	Description
object	What type of object to shuffle, such as chips_label or chips_plot. See the Object Type section of "ahelp chipsopt".
id	A ChipsId structure identifying the item, or a string containing the name of the object.

The shuffle_front command sends the specified object to the front of the stack. If no id is given, the current object of that type is shuffled. It is the same as calling shuffle or shuffle_<object> with the "chips_front" direction.

Examples

Example 1

chips> set_preference("line.thickness", "9")
chips> add_line(0.1, 0.1, 0.9, 0.9, "id=line1")
chips> add_line(0.1, 0.9, 0.9, 0.1, "color=red id=line2")
chips> add_line(0.6, 0.1, 0.6, 0.9, "color=lime id=line3")
chips> shuffle_front("line", chips_line)

Create three overlapping lines and move "line1" to the front of the stack.

Example 2

chips> add_region(4, 0.5, 0.5, 0.3, "fill.style=solid depth=50")
chips> add_line(0.1, 0.1, 0.9, 0.9, "depth=100")
chips> add_point(0.5, 0.5, "depth=50")
chips> shuffle_front(chips_region)

Move the current region to the front of the stack. It will then be on top of the point, but behind the line, because the line is at a higher depth.

Bugs

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