delete_histogram

Synopsis

Delete the specified histogram.

delete_histogram()
delete_histogram( [ChipsId] )
delete_histogram( "histogram_id" )
delete_histogram( "all" )

Description

Depending on the argument, the delete_histogram command deletes the current histogram, the histogram indicated in a ChipsId structure or by the histogram_id, or all histograms.

• (no argument) - the current histogram is deleted.
• ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
• histogram_id - identification tag given to each object that is created; use this to delete a specific histogram.
• all - deletes all histograms.

Example 1

chips> add_histogram([1,2,3], [10, 15, 20],["dropline", "off"])
chips> delete_histogram()

Create a histogram, then delete it.

Example 2

chips> id = ChipsId()
chips> add_histogram([5,8,13], [10, 15, 20], [12, 17, 22], "id=basic")
chips> add_histogram([8,10,14], [12, 17, 22], [14, 19, 24], [1,1,2],
["id", "witherrs", "symbol.style", "diamond", "err.style", "capped"])
chips> id.histogram = "basic"
chips> delete_histogram(id)

Two histograms are created; the second histogram is current after it is created. The id.histogram command sets the histogram value of the ChipsId structure to the first histogram. That histogram is then deleted.

Example 3

chips> add_histogram([5,8,13], [10, 15, 20], [12, 17, 22], "id=basic")
chips> add_histogram([8,10,14], [12, 17, 22], [14, 19, 24], [1,1,2],
["id", "witherrs", "symbol.style", "diamond", "err.style", "capped"])
chips> delete_histogram("all")

Two histograms are created, then the delete_histogram command deletes 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

histograms

add_histogram, current_histogram, display_histogram, get_histogram, hide_histogram, set_histogram, shuffle_histogram

utilities

load_fill