shuffle

Context: shuffle

Synopsis

Shuffles the rendering order of the object within the depth.

Syntax

shuffle(object, direction)
shuffle(id, object, direction)

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".
direction	What direction should the object be shuffled? The options are: chips_forward, chips_backward, chips_front, and chips_back. The default value is chips_forward.
id	A ChipsId structure identifying the item, or a string containing the name of the object.

There is also a "shuffle" command for specific ChIPS objects: shuffle_axis, shuffle_colorbar, shuffle_contour, shuffle_curve, shuffle_histogram, shuffle_image, shuffle_label, shuffle_line, shuffle_point, and shuffle_region. Additionally, there are direction-specific commands: shuffle_back, shuffle_backward, shuffle_forward, and shuffle_front.

Examples

Example 1

chips> set_preference("line.thickness", "9")
chips> add_line(0.1, 0.1, 0.9, 0.9)
chips> add_line(0.1, 0.9, 0.9, 0.1, 'color=red')
chips> add_line(0.6, 0.1, 0.6, 0.9, 'color=lime')
chips> shuffle(chips_line, chips_back)

Create three overlapping lines (they all have the same depth, the default one). Move the current line to the back of the stack.

Example 2

chips> shuffle('line2', chips_line, chips_backward)

Move the line "line2" one step back in the rendering order.

Shuffling objects

By default, objects within a depth are ordered chonologically based on when they were added to that depth. The objects are stacked with the oldest item at the back of the list and the newest item at the front of the list. This order dictates how the objects overlap when drawn.

The shuffle command changes the object's position within the stack. Any given object may be shuffled forward or backward one place in the stack or sent directly to the front or back of the stack.

The direction options:

Value	Description
chips_back	Send to the back of the stack.
chips_front	Send to the front of the stack.
chips_forward	Move one step closer to the front of the stack.
chips_backward	Move one step further back along the stack.

The shuffle routines can only operate on a single object. An error is returned if currency is set to "all".

Bugs

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