hide_colorbar

Context: images

Syntax

hide_colorbar()
hide_colorbar( [ChipsId] )
hide_colorbar( "colorbar_id" )
hide_colorbar( "all" )
hide_colorbar_border()

Description

Depending on the argument, this command hides the current colorbar, the colorbar indicated in a ChipsId structure or by the colorbar_id, or all colorbars.

(no argument) - the current colorbar is hidden.
ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
colorbar_id - identification tag given to each object that is created; use this to hide a specific colorbar.
all - hides all colorbars.

The colorbar is not deleted, just hidden. The display_colorbar command makes it 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.

Example 1

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

Create a colorbar, then hide the current colorbar.

Example 2

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