display_label

Context: labels

Synopsis

Display the specified label.

Syntax

display_label()
display_label( [ChipsId] )
display_label( "label_id" )
display_label( "all" )

Description

Depending on the argument, this command displays the current label, the label indicated in a ChipsId structure or by the label_id, or all labels.

(no argument) - the current label is displayed.
ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
label_id - identification tag given to each object that is created; use this to display a specific label.
all - displays all labels.

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> id = ChipsId()
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.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.