pyvista.Plotter.add_scalar_bar

pyvista.Plotter.add_scalar_bar#

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

最後の入力メッシュによって設定された範囲を使用してスカラーバーを作成します．

パラメータ:
titlestr, default: ""

スカラーバーのタイトル．デフォルトのはタイトルとしてレンダリングされます．

mappervtkMapper, optional

スカラーバーに使用されるマッパー．既定は，プロッタで最後に作成されたマッパーです．

n_labelsint, default: 5

スカラーバーに使用するラベルの数．

italicbool, default: False

タイトルとバーのラベルを斜体にします．

boldbool, default: False

タイトルとバーのラベルを太字にします．

title_font_sizefloat, optional

タイトルフォントのサイズを設定します． デフォルトは None で， pyvista.plotting.themes.Theme.font に従ってサイズが設定されます．

label_font_sizefloat, optional

タイトルフォントのサイズを設定します． デフォルトは None で， pyvista.plotting.themes.Theme.font に従ってサイズが設定されます．

colorColorLike, optional

文字列，RGBリスト，または16進数の色文字列のいずれかです． デフォルトは pyvista.plotting.themes.Theme.font で設定されています． 次のいずれかの形式で指定します．

  • color='white'

  • color='w'

  • color=[1.0, 1.0, 1.0]

  • color='#FFFFFF'

font_family{'courier', 'times', 'arial'}

フォントファミリーです． デフォルトは pyvista.plotting.themes.Theme.font で設定されます．

shadowbool, default: False

テキストに黒い影を追加します．

widthfloat, optional

カラーバーが表示されるウィンドウの幅のパーセンテージ(0-1)です．デフォルトは pyvista.plotting.themes.Theme.colorbar_vertical または pyvista.plotting.themes.Theme.colorbar_horizontal で設定され， vertical の値に依存します．

heightfloat, optional

カラーバーが表示されるウィンドウの高さのパーセンテージ(0-1)です．デフォルトは pyvista.plotting.themes.Theme.colorbar_vertical または pyvista.plotting.themes.Theme.colorbar_horizontal で設定され， vertical の値に依存します．

position_xfloat, optional

カラーバーの左下隅を配置するウィンドウの水平方向の割合(0から1)です．デフォルトは pyvista.plotting.themes.Theme.colorbar_vertical または pyvista.plotting.themes.Theme.colorbar_horizontal で設定され， vertical の値に依存します．

position_yfloat, optional

カラーバーの左下隅を配置するウィンドウの垂直方向の割合(0から1)です．デフォルトは pyvista.plotting.themes.Theme.colorbar_vertical または pyvista.plotting.themes.Theme.colorbar_horizontal で設定され， vertical の値に依存します．

verticalbool, optional

垂直または水平のスカラーバーを使用します． デフォルトは pyvista.plotting.themes.Theme.colorbar_orientation によって設定されます．

interactivebool, optional

スカラーバーのサイズと位置を制御するには，ウィジェットを使用します．デフォルトは pyvista.plotting.themes.Theme.interactive によって設定されます．

fmtstr, optional

ラベルのフォーマットは printf です．デフォルトは pyvista.plotting.themes.Theme.font によって設定されます．

use_opacitybool, default: True

必要に応じて，スカラーバーに不透明度マッピングを表示します．

outlinebool, default: False

必要に応じて，スカラーバーのアウトラインを設定し，不透明度マッピングを見やすくします．

nan_annotationbool, default: False

NaN色に注釈を付ける．

below_labelstr, optional

スカラー範囲より下の値の文字列注釈．

above_labelstr, optional

スカラー範囲より上の値の文字列注釈．

background_colorColorLike, optional

RGB形式で背景に使用される色です．

n_colorsint, optional

スカラーバーに表示されるカラーの最大数．

fillbool, default: False

background_color でスカラーバーの後ろに塗りつぶされたボックスを描画します．

renderbool, default: False

True のときに強制的にレンダーします．

themepyvista.plotting.themes.Theme, optional

プロット固有のテーマです． デフォルトでは， Plotter から呼び出した場合には，プロッターのテーマを使用します． None に設定すると，グローバルテーマを使用します．

unconstrained_font_sizebool, default: False

タイトルとラベルのフォントサイズが制約されないかどうか．制約がある場合，スカラーバーのサイズがフォントサイズを制約する．制約がない場合，フォントサイズは常に尊重される．

Added in version 0.44.0.

戻り値:
vtkScalarBarActor

スカラーバーアクター．

参考

スカラーバーをカスタマイズ

備考

title_font_size または label_font_size を設定すると，タイトルとラベルの両方のフォントサイズの自動設定が無効になります．

例

水平でアウトラインがあり，独自の書式が設定された，独自の対話型のスカラーバーを追加します．

>>> 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
目次