Last modified: December 2013

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


AHELP for CIAO 4.11 ChIPS v1

hide_label

Context: labels

Synopsis

Hide the specified label.

Syntax

hide_label()
hide_label(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 label is hidden, otherwise the argument determines what to hide. Note that this does not delete anything; use the display_label command to make the items visible again.


Examples

Example 1

chips> add_label(4.4, 8.5, r"area={\pi}r^2")
chips> hide_label()

Create a label, then hide it.

Example 2

chips> add_label(.35,.9,"The top of the frame.", "id=top")
chips> add_label(.35,.1,"The bottom of the frame.","id=bot")
chips> id = ChipsId()
chips> id.label = "top"
chips> hide_label(id)

Two labels are created; the second label is current after it is created. The id.label command sets the label value of the ChipsId structure to the first label. That label is then hidden.

Example 3

chips> add_label(.35,.9,"The top of the frame.", "id=top")
chips> add_label(.35,.1,"The bottom of the frame.","id=bot")
chips> hide_label("all")

Two labels are created, then the hide_label command hides them both.


Bugs

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

See Also

concepts
chipsid, currency
labels
add_label, current_label, delete_label, display_label, get_label, move_label, set_label, shuffle_label
utilities
load_font