About Chandra Archive Proposer Instruments & Calibration Newsletters Data Analysis HelpDesk Calibration Database NASA Archives & Centers Chandra Science Links

Skip the navigation links
Last modified: December 2007

URL: http://cxc.harvard.edu/chips4.0/add_frame.sl.html
AHELP for ChIPS 4.0 add_frame Context: sl.chips

Synopsis

Creates a frame.

Syntax

add_frame( [ChipsId,][attributes]);
add_frame( [ChipsId,] x1, y1, x2, y2 [,attributes]);

Description

  • ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
  • x1, y1, x2, y2 - the lower left (x1,y1) and upper right (x2,y2) corners of the frame in window normalized coordinates.
  • attributes - optional parameters which allow the user to configure properties though a structure, list, or attribute string.

The add_frame command creates a frame whose attributes are specified by user preferences or in an attribute list. The new frame becomes current by default; providing a ChipsId overrides the currency state.

The frame takes up the full size of the window in which it is created, unless the corner values (x1, y1) and (x2, y2) are supplied.

Customizing the Frame

There are several attributes that control the frame characteristics. The attributes can be set to the ChIPS defaults, values provided in the add_frame command, or values from the user's preference file.

The attributes may also be modified with the set_frame command at any time; see "ahelp sl.chips set_frame" and "ahelp sl.chips setget" for more information.

The attributes associated with frames are:

Attribute Description Options default
aspect Maintain the aspect ration of the frame when changing modes? see the Booleans section of "ahelp sl.chips chipsopt" true
bgcolor Background color of the frame. see the Color section of "ahelp sl.chips chipsopt" default
border.color Color of the border denoting the location of a frame in the window. see the Color section of "ahelp sl.chips chipsopt" default
border.visible Boolean flag indicating if the frame border should be visible. see the Booleans section of "ahelp sl.chips chipsopt" false
scale If set to true, all labels inside a window are rescaled as the window size is altered by the user. see the Booleans section of "ahelp sl.chips chipsopt" true
stem Default stem for newly created frames Alphanumeric frm
transparency Boolean flag indicating whether any object behind the frame is visible. see the Booleans section of "ahelp sl.chips chipsopt" false

Example 1

chips> add_frame();

Add a frame that fills the window.

Example 2

chips> add_frame( .1, .1, .4, .7, "bgcolor=red");
chips> add_frame({"bgcolor", "red"});

Create a frame with the lower left corner at (.1,.1) and the upper right corner at (.4,.7); the frame background color is set to red. A second frame is created, specifying the attributes and values in a list.

Example 3

chips> id = ChipsId();
chips> add_window( "id=MM300500");
chips> add_window( "id=Window2");
chips> id.window = "MM300500";
chips> add_frame(id);

Use the ChipsId structure to indicate to which window the new frame should be added.

Example 4

chips> settings = ChipsCurve;
chips> settings.bgcolor = "red";
chips> add_frame(settings);

Populate the "settings" structure with the attribute values, then add a frame.

Bugs

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

Last modified: December 2007



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-2004. All rights reserved.