shuffle_histogram

Synopsis

Shuffles the rendering order of the histogram within the depth.

Syntax

shuffle_histogram([id,] [direction])

Description

id - an optional ChipsId structure containing values to modify the currency state for the command, or a string to specify the id of the histogram to operate on.
direction - how to shuffle the object; options are chips_forward, chips_backward, chips_front, and chips_back. If not given then chips_forward is assumed.

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_histogram command modifies the order in which objects at a specific depth are rendered. It may be used to position a histogram in front of or behind other objects which are at the same depth.

The available "direction" options are:

chips_back - send to the back of the stack
chips_front - send to the front of the stack
chips_forward - moves one step closer to the front
chips_backward - moves one step further back

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

Example 1

chips> set_preference("histogram.fill.style", "1")
chips> set_preference("histogram.fill.opacity","0.8")
chips> add_histogram([1,3,5,8,2,1,0,0,1],"fill.color=sienna")
chips> add_histogram([2,0,3,4,5,7,1],"fill.color=coral")
chips> add_histogram([5,3,4,2,0,0,1], "fill.color=plum")
chips> shuffle_histogram("hist2",chips_forward)

Create three overlapping histograms, then move "hist2" - the second histogram - forward one step.

Example 2

chips> shuffle_histogram(chips_back)

Move the current histogram to the back of the display.

Bugs

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