Last modified: December 2013

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


AHELP for CIAO 4.11 ChIPS v1

hide_histogram

Context: histograms

Synopsis

Hide the specified histogram.

Syntax

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


Examples

Example 1

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

Create a histogram, then hide it.

Example 2

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", "Histogram2", "symbol.style", "diamond", "err.style", "capped"])
chips> id = ChipsId()
chips> id.histogram = "basic"
chips> hide_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 hidden.

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", "Histogram2", "symbol.style", "diamond", "err.style", "capped"])
chips> hide_histogram("all")

Two histograms are created, then the hide_histogram 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
histograms
add_histogram, current_histogram, delete_histogram, display_histogram, get_histogram, set_histogram, shuffle_histogram
utilities
load_fill