shuffle_label

Context: labels

Synopsis

Shuffles the rendering order of the label within the depth.

Syntax

shuffle_label()
shuffle_label(direction)
shuffle_label(id)
shuffle_label(id, direction)

Description

The function arguments.

Argument	Description
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.

The shuffle_label command modifies the location of the specified label within the stack of items at the same depth. It may be used to position a label in front of or behind other objects which are at the same depth.

Examples

Example 1

chips> add_label(0.5, 0.5, "HELLO THERE", "halign=.5 color=coral")
chips> add_label(0.5, 0.5, "Partial Eclipse", "halign=.5 color=skyblue")
chips> add_label(0.4, 0.5, "Rising Sun", "valign=.2 color=red")
chips> shuffle_label(chips_backward)

Create three overlapping labels at the default depth. Move the current label one step backward in the stack.

Example 2

chips> shuffle_label("lbl1",chips_front)

Move the label "lbl1" to the front of the display.

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.