Last modified: December 2013

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


AHELP for CIAO 4.11 ChIPS v1

reposition_frame

Context: frames

Synopsis

Repositions the frame within the window.

Syntax

reposition_frame(x1, y1, x2, y2)
reposition_frame(id, x1, y1, x2, y2)

Description

The function arguments.

Argument Description
x1, y1, x2, y2 The lower left (x1,y1) and upper right (x2,y2) corners of the frame in window normalized coordinates.
id A ChipsId structure identifying the item.

The reposition_frame command is used to modify the location of the plot within the frame. The location is specifed as lower left (x1,y2) and upper right (x2,y2) values. The values are in Window Normalized Coordinates with (0,0,1,1) representing the entire window.

Repositioning the frame may cause the aspect ratio to change. The objects in the frame are adjusted accordingly.

Depending on the viewing mode of the window, the repositioned values may not be readily apparent. If the window is in placed mode, the changes should be visible, unless the frame is obstructed by another frame. If in view_single_mode, the changes will only be noticeable if the aspect ratio of the frame changes, since the frame is enlarged to fill the window based on the aspect ratio.

If the frames have been tiled, changes will not appear unless the tile command is issued again. As with view_single_mode, only a change to the aspect ratio will be noticeable.

This is different than the move_frame command, which cannot change the aspect ratio of the frame. Refer to the move_frame command for more information.


Examples

Example 1

chips> add_frame('border.visible=1')
chips> reposition_frame(0.2, 0.3, 0.7, .08)

Add a frame encompassing the whole window from (0,0) to (1,1). Reposition the frame to the area between (0.2,0.3) and (0.7,0.8).

Example 2

chips> id = ChipsId()
chips> id.frame = 'frm2'
chips> reposition_frame(id, 0.25, 0.25, 0.75, 0.75)

A ChipsId structure is created and the id.frame field is set to "frm2". reposition_frame is called with the ChipsId so that the frame covers the area of the window from (0.25,0.25) to (0.75,0.75).


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, set_frame, tile, view_placed_frame, view_single_frame
utilities
erase, get_object_count