hide_frame

Context: frames

Synopsis

Hide the specified frame.

Syntax

hide_frame()
hide_frame(id)

hide_frame_border()
hide_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 hidden, otherwise the argument determines what to hide. Note that this does not delete anything; use the display_frame command to make the items 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 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.

Examples

Example 1

chips> add_frame(0.1, 0.1, 0.5, 0.5)
chips> set_frame(["bgcolor", "red"])
chips> hide_frame()

Create a frame, then hide it.

Example 2

chips> add_frame(0.1, 0.1, 0.5, 0.5, "id=data06")
chips> set_frame(["bgcolor", "red"])
chips> add_frame(0.5, 0.5, 0.9, 0.9,"id=data05")
chips> set_frame(["bgcolor", "blue"])
chips> id = ChipsId()
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(0.1, 0.1, 0.5, 0.5, "id=data06")
chips> set_frame(["bgcolor", "cornflower"])
chips> add_frame(0.5, 0.5, 0.9, 0.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.