add_scalar_bar

Plotter.add_scalar_bar(title='', mapper=None, n_labels=5, italic=False, bold=False, title_font_size=None, label_font_size=None, color=None, font_family=None, shadow=False, width=None, height=None, position_x=None, position_y=None, vertical=None, interactive=None, fmt=None, use_opacity=True, outline=False, nan_annotation=False, below_label=None, above_label=None, background_color=None, n_colors=None, fill=False, render=False, theme=None)

Create scalar bar using the ranges as set by the last input mesh.

Parameters
titlestr, optional

Title of the scalar bar. Default '' which is rendered as an empty title.

mappervtkMapper, optional

Mapper used for the scalar bar. Defaults to the last mapper created by the plotter.

n_labelsint, optional

Number of labels to use for the scalar bar.

italicbool, optional

Italicises title and bar labels. Default False.

boldbool, optional

Bolds title and bar labels. Default True.

title_font_sizefloat, optional

Sets the size of the title font. Defaults to None and is sized according to pyvista.themes.DefaultTheme.font.

label_font_sizefloat, optional

Sets the size of the title font. Defaults to None and is sized according to pyvista.themes.DefaultTheme.font.

colorstr or 3 item list, optional

Either a string, rgb list, or hex color string. Default set by pyvista.themes.DefaultTheme.font. Can be in one of the following formats:

  • color='white'

  • color='w'

  • color=[1, 1, 1]

  • color='#FFFFFF'

font_family{‘courier’, ‘times’, ‘arial’}

Font family. Default is set by pyvista.themes.DefaultTheme.font.

shadowbool, optional

Adds a black shadow to the text. Defaults to False.

widthfloat, optional

The percentage (0 to 1) width of the window for the colorbar. Default set by pyvista.themes.DefaultTheme.colorbar_vertical or pyvista.themes.DefaultTheme.colorbar_horizontal depending on the value of vertical.

heightfloat, optional

The percentage (0 to 1) height of the window for the colorbar. Default set by pyvista.themes.DefaultTheme.colorbar_vertical or pyvista.themes.DefaultTheme.colorbar_horizontal depending on the value of vertical.

position_xfloat, optional

The percentage (0 to 1) along the windows’s horizontal direction to place the bottom left corner of the colorbar. Default set by pyvista.themes.DefaultTheme.colorbar_vertical or pyvista.themes.DefaultTheme.colorbar_horizontal depending on the value of vertical.

position_yfloat, optional

The percentage (0 to 1) along the windows’s vertical direction to place the bottom left corner of the colorbar. Default set by pyvista.themes.DefaultTheme.colorbar_vertical or pyvista.themes.DefaultTheme.colorbar_horizontal depending on the value of vertical.

verticalbool, optional

Use vertical or horizontal scalar bar. Default set by pyvista.themes.DefaultTheme.colorbar_orientation.

interactivebool, optional

Use a widget to control the size and location of the scalar bar. Default set by pyvista.themes.DefaultTheme.interactive.

fmtstr, optional

printf format for labels. Default set by pyvista.themes.DefaultTheme.font.

use_opacitybool, optional

Optionally display the opacity mapping on the scalar bar.

outlinebool, optional

Optionally outline the scalar bar to make opacity mappings more obvious.

nan_annotationbool, optional

Annotate the NaN color.

below_labelstr, optional

String annotation for values below the scalars range.

above_labelstr, optional

String annotation for values above the scalars range.

background_colorarray, optional

The color used for the background in RGB format.

n_colorsint, optional

The maximum number of color displayed in the scalar bar.

fillbool, optional

Draw a filled box behind the scalar bar with the background_color.

renderbool, optional

Force a render when True. Default True.

themepyvista.themes.DefaultTheme, optional

Plot-specific theme. By default, calling from the Plotter, will use the plotter theme. Setting to None will use the global theme.

Returns
vtk.vtkScalarBarActor

Scalar bar actor.

Notes

Setting title_font_size, or label_font_size disables automatic font sizing for both the title and label.

Examples

Add a custom interactive scalar bar that is horizontal, has an outline, and has a custom formatting.

>>> import pyvista as pv
>>> sphere = pv.Sphere()
>>> sphere['Data'] = sphere.points[:, 2]
>>> plotter = pv.Plotter()
>>> _ = plotter.add_mesh(sphere, show_scalar_bar=False)
>>> _ = plotter.add_scalar_bar('Data', interactive=True, vertical=False,
...                            title_font_size=35,
...                            label_font_size=30,
...                            outline=True, fmt='%10.5f')
>>> plotter.show()
../../../_images/pyvista-Plotter-add_scalar_bar-1_00_00.png