hide_frame

Context: frames

Syntax

hide_frame()
hide_frame( [ChipsId] )
hide_frame( "frame_id" )
hide_frame( "all" )

Description

Depending on the argument, this command hides the current frame, the frame indicated in a ChipsId structure or by the frame_id, or all frames.

(no argument) - the current frame is hidden.
ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
frame_id - identification tag given to each object that is created; use this to hide a specific frame.
all - hides all frames.

The frame is not deleted, just hidden. The display_frame command makes it visible again.

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 "ahelp set_frame" 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)
chips> set_frame(["bgcolor",red"])
chips> hide_frame()

Create a frame, then hide the current frame.

Example 2

chips> id = ChipsId()
chips> add_frame(.1, .1, .5, .5, "id=data06")
chips> set_frame(["bgcolor",red"])
chips> add_frame(.5, .5, .9, .9,"id=data05")
chips> set_frame(["bgcolor",blue"])
chips> id.frame = "data06"
chips> hide_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 hidden.

Example 3

chips> add_frame(.1, .1, .5, .5,"id=data06")
chips> set_frame(["bgcolor","cornflower"])
chips> add_frame(.5, .5, .9, .9,"id=data05")
chips> set_frame(["bgcolor","green"])
chips> hide_frame("all")

Two frames are created, then the hide_frame command hides them both.

Example 4

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

A frame is added with a red background and purple border. The border is displayed, then hidden again.

Bugs

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