Chandra X-Ray Observatory
	(CXC)
Skip to the navigation links
Last modified: December 2013

URL: http://cxc.harvard.edu/chips/ahelp/display_label.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.9 ChIPS v1

display_label

Context: labels

Synopsis

Display the specified label.

Syntax

display_label()
display_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 shown, otherwise the argument determines what to show.

Example 1

chips> add_label(.35,.9,"The top of the frame.", "id=top")
chips> hide_label("top")
chips> display_label()

Create a label and hide it, then display the current label.

Example 2

chips> add_label(.35,.9,"The top of the frame.", "id=top")
chips> hide_label("top")
chips> add_label(.35,.1,"The bottom of the frame.","id=bot")
chips> id = ChipsId()
chips> id.label = "top"
chips> display_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 displayed.

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")
chips> display_label("all")

Two labels are created and hidden, then the display_label command displays 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, depthcontrol
depth
collapse_depths, display_depth, get_default_depth, hide_depth, reindex_depth, set_default_depth
labels
add_label, current_label, delete_label, get_label, hide_label, move_label, set_label, shuffle_label
utilities
load_font

Last modified: December 2013
Smithsonian Institute Smithsonian Institute

The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory. 60 Garden Street, Cambridge, MA 02138 USA.   Email:   cxchelp@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2017. All rights reserved.