Last modified: December 2013

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


AHELP for CIAO 4.11 ChIPS v1

hide_colorbar

Context: images

Synopsis

Hide the specified colorbar.

Syntax

hide_colorbar()
hide_colorbar(id)

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

Hiding and Displaying the Colorbar Border

By default, the colorbar border is visible; it can be hidden with the hide_colorbar_border command. To display a hidden border, use the display_colorbar_border command. The border cannot be displayed if the colorbar is hidden; it is automatically hidden as well.


Examples

Example 1

chips> add_colorbar(0, .5, "orientation=vertical")
chips> hide_colorbar()

Create a colorbar, then hide it.

Example 2

chips> add_colorbar(0, .5, "id=vert orientation=vertical")
chips> add_colorbar(.5, -.05)
chips> id = ChipsId()
chips> id.colorbar = "vert"
chips> hide_colorbar(id)

Two colorbars are created; the second colorbar is current after it is created. The id.colorbar command sets the colorbar value of the ChipsId structure to the first colorbar. That colorbar is then hidden.


Bugs

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

See Also

concepts
chipsid, currency
images
add_colorbar, current_colorbar, delete_colorbar, display_colorbar, get_colorbar, move_colorbar, set_colorbar, shuffle_colorbar