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

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


AHELP for CIAO 4.6 ChIPS v1

display_frame

Context: frames

Synopsis

Display the specified frame.

Syntax

display_frame()
display_frame(id)

display_frame_border()
display_frame_border(id)

Description

The function arguments.

Argument Description
id A ChipsId structure identifying the item, or a string containing the name of the object.

If no argument is given then the current frame is shown, otherwise the argument determines what to show.

Hiding and Displaying the Frame Border

By default, the frame border is hidden. It can be displayed with the display_frame_border command, but will not be apparent unless the color is different than the frame background; see the set_frame command for information on setting the border color. The frame border can be hidden with the hide_frame_border command. The border cannot be displayed if the frame is hidden; it is automatically hidden as well.

Example 1

chips> add_frame(.1, .1, .5, .5, "id=data06")
chips> set_frame(["bgcolor",red"])
chips> hide_frame("data06")
chips> display_frame()

Create a frame and hide it, then display the current frame.

Example 2

chips> add_frame(.1, .1, .5, .5, "id=data06")
chips> set_frame(["bgcolor",red"])
chips> hide_frame("data06")
chips> add_frame(.5, .5, .9, .9, "id=data05")
chips> set_frame(["bgcolor",blue"])
chips> id = ChipsId()
chips> id.frame = "data06"
chips> display_frame(id)

Two frames are created; the second frame is current after it is created. The id.frame command sets the frame value of the ChipsId structure to the first frame. That frame is then displayed.

Example 3

chips> add_frame(.1, .5, .5, .9, "id=data04")
chips> set_frame(["bgcolor","green"])
chips> add_frame(.5, .1, .9, .5, "id=data07")
chips> set_frame(["bgcolor","purple"])
chips> hide_frame("all")
chips> display_frame("all")

Two frames are created and hidden, then the display_frame command displays them both.

Example 4

chips> add_frame("bgcolor=red border.color=purple")
chips> display_frame_border()

A frame is added with a red background and purple border, then the border is displayed.

Bugs

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

See Also

concepts
chipsid, currency, depthcontrol
depth
collapse_depths, display_depth, get_default_depth, hide_depth, reindex_depth, set_default_depth
frames
add_frame, arrange_frames, blink_frames, current_frame, delete_frame, get_frame, hide_frame, move_frame, next_frame, reposition_frame, set_frame, tile, view_placed_frame, view_single_frame
utilities
erase, get_object_count

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:   cxcweb@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2014. All rights reserved.