Last modified: December 2013

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


AHELP for CIAO 4.11 ChIPS v1

display_colorbar

Context: images

Synopsis

Display the specified colorbar.

Syntax

display_colorbar()
display_colorbar(id)

display_colorbar_border()
display_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 shown, otherwise the argument determines what to show.

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()
chips> display_colorbar()

Create a colorbar and hide it, then display the current colorbar.

Example 2

chips> add_colorbar(0, .5, "id=vert orientation=vertical")
chips> hide_colorbar("vert")
chips> add_colorbar(.5, -.05)
chips> id = ChipsId()
chips> id.colorbar = "vert"
chips> display_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 displayed.


Bugs

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

See Also

concepts
chipsid, currency, depthcontrol
depth
collapse_depths, display_depth, get_default_depth, hide_depth, reindex_depth, set_default_depth
images
add_colorbar, current_colorbar, delete_colorbar, get_colorbar, hide_colorbar, move_colorbar, set_colorbar, shuffle_colorbar