Chandra X-Ray Observatory
	(CXC)
Skip to the navigation links
Last modified: December 2013

URL: http://cxc.harvard.edu/chips/ahelp/shuffle_forward.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.9 ChIPS v1

shuffle_forward

Context: shuffle

Synopsis

Shuffles the object one step forward in the depth.

Syntax

shuffle_forward(object)
shuffle_forward(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_forward command moves the specified object one step closer 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_forward" direction.

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_forward("line1", chips_line)

Create three overlapping lines. Move "line1" one step forward in the stack.

Example 2

chips> add_region(4, 0.5, 0.5, 0.3, "fill.style=1 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_forward(chips_region)

Move the current region one step forward in 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.

See Also

axes
shuffle_axis
concepts
depthcontrol
contours
shuffle_contour
curves
shuffle_curve
depth
collapse_depths, display_depth, get_default_depth, hide_depth, reindex_depth, set_default_depth
histograms
shuffle_histogram
images
shuffle_colorbar, shuffle_image
labels
shuffle_label
lines
shuffle_line
points
shuffle_point
regions
shuffle_region
shuffle
shuffle, shuffle_back, shuffle_backward, shuffle_front

Last modified: December 2013
Smithsonian Institute Smithsonian Institute

The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory. 60 Garden Street, Cambridge, MA 02138 USA.   Email:   cxchelp@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2017. All rights reserved.