pyvista.Plotter.add_legend_scale

Plotter.add_legend_scale(corner_offset_factor=2.0, bottom_border_offset=30, top_border_offset=30, left_border_offset=30, right_border_offset=30, bottom_axis_visibility=True, top_axis_visibility=True, left_axis_visibility=True, right_axis_visibility=True, legend_visibility=True, xy_label_mode=False, render=True, color=None, font_size_factor=0.6, label_size_factor=1.0, label_format=None, number_minor_ticks=0, tick_length=5, minor_tick_length=3, show_ticks=True, tick_label_offset=2)

レンダーウィンドウにスケールや距離の情報をアノテートします．

その基本的な目的は，シーンのスケールを表示することです．レンダリングウィンドウを囲む4つの軸は，カメラが見ているもののスケールを(様々な方法で)示します．また，スケール凡例を表示するオプションもあります．

パラメータ:

corner_offset_factorfloat, default: 2.0

コーナーオフセット値．

bottom_border_offsetint, default: 30

下辺のボーダーオフセット．推奨値は 50 です．

top_border_offsetint, default: 30

上辺のボーダーオフセット．推奨値は 50 です．

left_border_offsetint, default: 30

左辺のボーダーオフセット．推奨値は 100 です．

right_border_offsetint, default: 30

右辺のボーダーオフセット．推奨値は 100 です．

bottom_axis_visibilitybool, default: True

下軸を表示するかどうか．

top_axis_visibilitybool, default: True

上軸を表示するかどうか．

left_axis_visibilitybool, default: True

左軸を表示するかどうか．

right_axis_visibilitybool, default: True

右軸を表示するかどうか．

legend_visibilitybool, default: True

凡例スケールを表示するかどうか．

xy_label_modebool, default: False

軸は，距離の目盛りを表示するか，x-y座標値を表示するか，どちらかにプログラムすることができます．デフォルトでは，スケールは距離を表示します．しかし，ビューがz軸の下にあることが分かっている場合，スケールはx-y座標値を表示するようプログラムすることができます．

renderbool, default: True

アクターが追加されたときにレンダリングするかどうか．

colorColorLike, optional

文字列，RGBリスト，または16進カラー文字列のいずれかを，目盛りのテキストと目盛りの線の色に使用します．

警告

軸のラベルは白か黒のどちらかになる傾向があります．

font_size_factorfloat, default: 0.6

フォントサイズを全体的に拡大縮小するファクター．

label_size_factorfloat, default: 1.0

タイトルサイズに対するラベルサイズの倍率を設定します．

label_formatstr, optional

ラベルのprintf形式`．例えば '%E' のフォーマット． printf-style String Formatting を参照してください．

number_minor_ticksint, default: 0

メジャーティック間のマイナーティックの数．

tick_lengthint, default: 5

目盛りのピクセル長さ．

minor_tick_lengthint, default: 3

軸小目盛りのピクセル長さ．

show_ticksbool, default: True

軸目盛りを表示するかどうか．

tick_label_offsetint, default: 2

ピクセル目盛りとラベルのオフセット．

戻り値:

vtk.vtkActor

追加された vtkLegendScaleActor に対応するアクターです．

警告

軸やスケール値は，パースペクティブの影響を受けますので，ご注意ください．距離はカメラの焦点面において計算されます．視野角が大きい場合（つまり，透視投影），計算された距離はユーザーに間違ったスケール感を与える可能性があります．平行投影が有効な場合は，これらの効果はありません．

例

>>> import pyvista as pv
>>> cone = pv.Cone(height=2.0, radius=0.5)
>>> pl = pv.Plotter()
>>> _ = pl.add_mesh(cone)
>>> _ = pl.add_legend_scale()
>>> pl.show()