pyvista.Plotter.add_point_labels

pyvista.Plotter.add_point_labels#

Plotter.add_point_labels(
points: MatrixLike[float] | VectorLike[float] | DataSet | _vtk.vtkAlgorithm,
labels: list[str | int] | str,
italic: bool = False,
bold: bool = True,
font_size: int | None = None,
text_color: ColorLike | None = None,
font_family: FontFamilyOptions | None = None,
font_file: str | None = None,
shadow: bool = False,
show_points: bool = True,
point_color: ColorLike | None = None,
point_size: float | None = None,
name: str | None = None,
shape_color: ColorLike = 'grey',
shape: Literal['rect', 'rounded_rect'] | None = 'rounded_rect',
fill_shape: bool = True,
margin: int = 3,
shape_opacity: float = 1.0,
pickable: bool = False,
render_points_as_spheres: bool = False,
tolerance: float = 0.001,
reset_camera: bool | None = None,
always_visible: bool = False,
render: bool = True,
justification_horizontal: HorizontalOptions | None = None,
justification_vertical: VerticalOptions | None = None,
background_color: ColorLike | None = None,
background_opacity: float | None = None,
) → _vtk.vtkActor2D[ソース]#

各ポイントに割り当てられたリストラベルから1つのラベルを持つポイントアクターを作成します．

パラメータ:
pointssequence | DataSet | vtkAlgorithm

n x 3 の点列，または点またはメッシュ生成アルゴリズムを含む pyvista.DataSet です．

labelslist | str

ラベルのリスト．点と同じ長さでなければなりません．文字列名がpyvistaで指定されている場合．点の pyvista.DataSet 入力を取得すると，これらが取得されます．

italicbool, default: False

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

boldbool, default: True

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

font_sizefloat, optional

タイトルフォントのサイズを設定します．

text_colorColorLike, optional

テキストの色．文字列，RGB配列，または16進数の色文字列のいずれかです．

  • text_color='white'

  • text_color='w'

  • text_color=[1.0, 1.0, 1.0]

  • text_color='#FFFFFF'

font_familystr, optional

Font family. Must be either 'courier', 'times', or 'arial. This is ignored if the font_file is set.

font_filestr, default: None

フリータイプ可読フォントを含むローカルファイルへの絶対フ ァ イ ルパス．

shadowbool, default: False

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

show_pointsbool, default: True

ポイントを表示するかどうかをコントロールします．

point_colorColorLike, optional

文字列，rgbリスト，または16進数の色文字列のいずれかです． 以下のいずれかです．

  • point_color='white'

  • point_color='w'

  • point_color=[1.0, 1.0, 1.0]

  • point_color='#FFFFFF'

point_sizefloat, optional

表示されている場合，点のサイズ．

namestr, optional

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

shape_colorColorLike, default: "grey"

シェイプの色（表示されている場合）． 文字列，RGB配列，または16進数の色文字列のいずれかです．

shapestr, default: "rounded_rect"

使用する図形の文字列名を指定します．オプションは 'rect' または 'rounded_rect' です．シェイプを作成しない場合は None を渡します．

fill_shapebool, default: True

shape_color で図形を埋めます． False の場合は輪郭を描きます．

marginint, default: 3

ラベルの背景図形の余白のサイズを指定します．

shape_opacityfloat, default: 1.0

図形の不透明度を [0, 1] の範囲で指定します．

pickablebool, default: False

このアクターを選択可能にするかどうかを設定します．

render_points_as_spheresbool, default: False

点をドットではなく球としてレンダリングします．

tolerancefloat, default: 0.001

ポイントラベルを表示するかどうかを決定するために使用する許容差．レンダリング中にワールドスペースから表示スペースに変換すると，数値の丸めが発生するため，通常は許容差が必要です．

reset_camerabool, optional

シーンにポイントを追加した後，カメラをリセットします．

always_visiblebool, default: False

表示フィルタの追加をスキップします．

renderbool, default: True

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

justification_horizontalstr, optional

テキストの水平方向の両端揃え． "left", "center", "right" のいずれかでなければなりません．

警告

位置揃えがデフォルト以外の場合，ラベルと形がずれてしまいます．デフォルト以外を使用する場合は，背景色を使用してください．参照: pyvista/pyvista#5407

justification_verticalstr, optional

テキストの垂直方向の両端揃え． "bottom", "center", "top" のいずれかでなければなりません．

警告

位置揃えがデフォルト以外の場合，ラベルと形がずれてしまいます．デフォルト以外を使用する場合は，背景色を使用してください．参照: pyvista/pyvista#5407

background_colorColor, optional

テキストのプロパティの背景色．

background_opacityfloat, optional

テキストのプロパティの背景不透明度．

戻り値:
vtkActor2D

VTKラベルアクター．ラベルのプロパティを変更するために使用できます．

参考

ラベルポイント

例

>>> import numpy as np
>>> import pyvista as pv
>>> pl = pv.Plotter()
>>> points = np.array([[0.0, 0.0, 0.0], [1.0, 1.0, 0.0], [2.0, 0.0, 0.0]])
>>> labels = ['Point A', 'Point B', 'Point C']
>>> actor = pl.add_point_labels(
...     points,
...     labels,
...     italic=True,
...     font_size=20,
...     point_color='red',
...     point_size=20,
...     render_points_as_spheres=True,
...     always_visible=True,
...     shadow=True,
... )
>>> pl.camera_position = 'xy'
>>> pl.show()
../../../_images/pyvista-Plotter-add_point_labels-1_00_00.png
目次