current_colorbar

Context: images

Syntax

current_colorbar( ChipsId )
current_colorbar( "colorbar_id" )
current_colorbar( "all" )

Description

The current_colorbar command sets the colorbar indicated by the argument as the current colorbar; see "ahelp currency" for general information on currency.

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 select a specific colorbar.
all - sets all colorbars to be current.

Use the info_current command to retrieve a list of all the current items in the ChIPS session, as shown in Example 1.

Example 1

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)
chips> current_colorbar(id)
chips> info_current()

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, then the current_colorbar command makes that colorbar current.

The output of info_current for this session is:

Window [win1]
  Frame [frm1]
    Plot [plot1]
      X Axis [ax1]
      Y Axis [ay1]
      Image [image1]
      ColorBar [vert]
    Coord Sys [Data]
    Coord Sys ID [plot1_ax1ay1]

Example 2

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

Two colorbars are created. After the second colorbar is created, it is current. The current_colorbar command then sets the first colorbar as the current colorbar.

Example 3

chips> add_colorbar(0, .5, "id=vert orientation=vertical")
chips> add_colorbar(.5, -.05)
chips> current_colorbar("all")

Two colorbars are created. After the second colorbar is created, it is current. The current_colorbar command then makes all colorbars current.

Bugs

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