| AHELP for CIAO 4.5 ChIPS v1 | hide_histogram |
Context: histograms |
Synopsis
Hide the specified histogram.
Syntax
hide_histogram() hide_histogram( [ChipsId] ) hide_histogram( "histogram_id" ) hide_histogram( "all" )
Description
Depending on the argument, this command hides the current histogram, the histogram indicated in a ChipsId structure or by the histogram_id, or all histograms.
- (no argument) - the current histogram is hidden.
- 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 hide a specific histogram.
- all - hides all histograms.
The histogram is not deleted, just hidden. The display_histogram command makes it visible again.
Example 1
chips> add_histogram([1,2,3], [10, 15, 20],["dropline", "off"]) chips> hide_histogram()
Create a histogram, then hide the current histogram.
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", "Histogram2", "symbol.style", "diamond", "err.style", "capped"]) 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

![[ChIPS Logo]](../imgs/chips_logo_navbar.gif)