delete_label

Context: labels

Synopsis

Delete the specified label.

Syntax

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

Description

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

(no argument) - the current label is deleted.
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 delete a specific label.
all - deletes all labels.

Example 1

chips> add_label(.4,.5,"area={\\pi}r^2")
chips> delete_label()

Create a label, then delete it.

Example 2

chips> id = ChipsId()
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.label = "top"
chips> delete_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 deleted.

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

Two labels are created, then the delete_label command deletes them both.

Bugs

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