Last modified: December 2013

URL: https://cxc.cfa.harvard.edu/chips/ahelp/view_placed_frame.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.11 ChIPS v1

view_placed_frame

Context: frames

Synopsis

Sets the window display to placed frame mode.

Syntax

view_placed_frame()
view_placed_frame(id)

Description

The function arguments.

Argument Description
id A ChipsId structure identifying the item.

The view_placed_frame command sets the display of the specified window to placed frame mode, where all frames are displayed in their normalized positions. This is a viewing command, and does not affect the original size or location of the frames.

Frames can be of any size up to and including the size of the window that contains them. When one or more frames are created in a window, and one or more are smaller than the window, they are shown "placed" in the locations specified by the user. The user can cause each frame to be viewed in the entire window using the view_single_frame command. Each frame will then fill the entire window when viewed. The view_placed_frame returns the viewing style to show the frames in their original position and size.


Examples

Example 1

chips> (x1, y1) = ([1,2,4,6], [2,4.4,2.8,3])
chips> (x2, y2) = ([10,20,30,40,50,60,70,80], [23,25,27,25,22,19,18,21])
chips> (x3, y3) = ([0.5,2,4,6], [1,4,4,2.5])
chips> add_frame(0.1, 0.1, 0.5, 0.5)
chips> add_curve(x1, y1, "line.color=green symbol.color=yellow")
chips> add_frame(0.5, 0.5, 0.9, 0.9)
chips> add_curve(x2, y2, "line.color=coral")
chips> add_frame(0.1, 0.5, 0.5, 0.9)
chips> add_curve(x3, y3, "line.color=blue")
chips> view_single_frame()
chips> next_frame()
chips> next_frame()
chips> prev_frame()
chips> prev_frame()
chips> view_placed_frame()

Create a window containg three frames with a curve in each of them. The frame mode is set to single frame for the current window; the last frame created is displayed in the window. The next_frame and prev_frame commands are used to cycle through the frames. Finally, the frame mode is set to "placed", showing the frames in their original locations.

Example 2

chips> id = ChipsId()
chips> id.window = "win2"
chips> view_placed_frame(id)

A ChipsId object may be used to set the display mode of a window other than the current one. In this example, "win2" is set to placed frame mode.


Bugs

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

See Also

frames
add_frame, arrange_frames, blink_frames, current_frame, delete_frame, display_frame, get_frame, hide_frame, move_frame, next_frame, reposition_frame, set_frame, tile, view_single_frame
utilities
erase, get_object_count