# vispy.scene.widgets.colorbar module

class vispy.scene.widgets.colorbar.ColorBarWidget(cmap, orientation, label='', label_color='black', clim=('', ''), border_width=0.0, border_color='black', padding=(0.2, 0.2), axis_ratio=0.05, **kwargs)

  Bases: `Widget`

  Widget containing a ColorBar

  Parameters:
    cmap str | vispy.color.ColorMap

      Either the name of the ColorMap to be used from the standard set of names (refer to vispy.color.get_colormap), or a custom ColorMap object. The ColorMap is used to apply a gradient on the colorbar.

    orientation{‘left’, ‘right’, ‘top’, ‘bottom’}

      The orientation of the colorbar, used for rendering. The orientation can be thought of as the position of the label relative to the color bar.

      When the orientation is ‘left’ or ‘right’, the colorbar is vertically placed. When it is ‘top’ or ‘bottom’, the colorbar is horizontally placed. The colorbar automatically resizes when its container’s dimension changes.

      > - ‘top’: the colorbar is horizontal. Color is applied from left to right. Minimum corresponds to left and maximum to right. Label is to the top of the colorbar

      > - ‘bottom’: Same as top, except that label is to the bottom of the colorbar

      > - ‘left’: the colorbar is vertical. Color is applied from bottom to top. Minimum corresponds to bottom and maximum to top. Label is to the left of the colorbar

      > - ‘right’: Same as left, except that the label is placed to the right of the colorbar

    label str

      The label that is to be drawn with the colorbar that provides information about the colorbar.

    label_color str | vispy.color.Color

      The color of labels. This can either be a str as the color’s name or an actual instace of a vipy.color.Color

    clim tuple (min, max)

      the minimum and maximum values of the data that is given to the colorbar. This is used to draw the scale on the side of the colorbar.

    border_width float (in px)

      The width of the border the colormap should have. This measurement is given in pixels

    border_color str | vispy.color.Color

      The color of the border of the colormap. This can either be a str as the color’s name or an actual instace of a vipy.color.Color

    padding tuple (major_axis, minor_axis) [0, 1]

      padding with respect to the major and minor axis

    axis_ratio float

      ratio of minor axis to major axis

  property border_color

    The color of the border around the ColorBar in pixels

  property border_width

    The width of the border around the ColorBar in pixels

  property clim
  property cmap
  property label
  on_resize(event)

    Resize event handler

    Parameters:
      event instance of Event

        The event.

  property orientation
  property ticks

previous

vispy.scene.widgets.axis module

next

vispy.scene.widgets.console module