pyvista.Plotter.add_legend

Plotter.add_legend(labels=None, bcolor=(0.5, 0.5, 0.5), border=False, size=(0.2, 0.2), name=None, loc='upper right', face='triangle')

凡例をレンダリングウィンドウに追加します．

エントリは，項目ごとに1つの文字列とカラーエントリを含みますリストである必要があります．

パラメータ:

labelslist, optional

None に設定すると，次で指定した既存のラベルが使用されます．

• add_mesh

• add_lines

• add_points

凡例に追加する項目ごとに1つのエントリを含みますリスト．各エントリには，2つの文字列 [label, color] を含める必要があります．ここで，labelは追加する項目の名前，colorは追加するラベルの色です．

bcolorColorLike, default: (0.5, 0.5, 0.5)

背景色．3つの項目0から1のRGBカラーリスト，またはmatplotlibカラー文字列(例:白色の場合は 'w' または 'white' )のいずれかです．Noneの場合，凡例の背景は使用不可になります．

borderbool, default: False

凡例の周囲に境界線を表示するかどうかをコントロールします．デフォルトはFalseです．

sizesequence[float], default: (0.2, 0.2)

2つの浮動小数点シーケンスで，それぞれが0と1の間の浮動小数点です．たとえば， (0.1, 0.1) と指定すると，凡例は図形ウィンドウ全体のサイズの10%のサイズになります．

namestr, optional

簡単に更新できるように，追加したアクターの名前．この名前のアクターがレンダリングウィンドウに既に存在する場合は，新しいアクターに置き換えられます．

locstr, default: "upper right"

位置情報の文字列です． 以下のいずれかになります:

• 'upper right'

• 'upper left'

• 'lower left'

• 'lower right'

• 'center left'

• 'center right'

• 'lower center'

• 'upper center'

• 'center'

facestr | pyvista.PolyData | NoneType, default: "triangle"

凡例の面の形． 次のいずれかです．

• なし: None

• 線: "-" か "line"

• 3角形: "^" か 'triangle'

• 円: "o" か 'circle'

• 長方形: "r" か 'rectangle'

• カスタム: pyvista.PolyData

None を渡すと，凡例の面が削除されます． カスタム面は pyvista.PolyData を使って作成することができます． これは，XY平面からレンダリングされます．

戻り値:

vtk.vtkLegendBoxActor

凡例のアクター．

例

add_mesh を使用する際に，メッシュにラベルを付けて凡例を作成します．

>>> import pyvista as pv
>>> from pyvista import examples
>>> sphere = pv.Sphere(center=(0, 0, 1))
>>> cube = pv.Cube()
>>> plotter = pv.Plotter()
>>> _ = plotter.add_mesh(
...     sphere, 'grey', smooth_shading=True, label='Sphere'
... )
>>> _ = plotter.add_mesh(cube, 'r', label='Cube')
>>> _ = plotter.add_legend(bcolor='w', face=None)
>>> plotter.show()

また，プロッタにラベルを貼ることもできます．

>>> plotter = pv.Plotter()
>>> _ = plotter.add_mesh(sphere, 'grey', smooth_shading=True)
>>> _ = plotter.add_mesh(cube, 'r')
>>> legend_entries = []
>>> legend_entries.append(['My Mesh', 'w'])
>>> legend_entries.append(['My Other Mesh', 'k'])
>>> _ = plotter.add_legend(legend_entries)
>>> plotter.show()