1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
"""Type aliases for type hints."""
from __future__ import annotations
from collections.abc import Sequence
from typing import TYPE_CHECKING
from typing import Literal
from typing import TypedDict
from typing import Union
import matplotlib as mpl
from pyvista.core._typing_core import BoundsTuple as BoundsTuple
from pyvista.core._typing_core import MatrixLike
from pyvista.core._typing_core import Number as Number
from pyvista.core._typing_core import NumpyArray
from pyvista.core._typing_core import VectorLike
from . import _vtk
from .renderer import CameraPosition
if TYPE_CHECKING:
from pyvista.plotting.themes import Theme
from .charts import Chart2D as Chart2D
from .charts import ChartBox as ChartBox
from .charts import ChartMPL as ChartMPL
from .charts import ChartPie as ChartPie
from .colors import _CMCRAMERI_CMAPS_LITERAL
from .colors import _CMOCEAN_CMAPS_LITERAL
from .colors import _COLORCET_CMAPS_LITERAL
from .colors import _MATPLOTLIB_CMAPS_LITERAL
from .colors import Color as Color
NamedColormaps = Union[
'_MATPLOTLIB_CMAPS_LITERAL',
'_CMOCEAN_CMAPS_LITERAL',
'_COLORCET_CMAPS_LITERAL',
'_CMCRAMERI_CMAPS_LITERAL',
]
ColormapOptions = Union[NamedColormaps, list[str], mpl.colors.Colormap]
ColorLike = Union[
tuple[int, int, int],
tuple[int, int, int, int],
tuple[float, float, float],
tuple[float, float, float, float],
Sequence[int],
Sequence[float],
NumpyArray[float],
dict[str, Union[int, float, str]],
str,
'Color',
_vtk.vtkColor3ub,
]
# Overwrite default docstring, as sphinx is not able to capture the docstring
# when it is put beneath the definition somehow?
Chart = Union['Chart2D', 'ChartBox', 'ChartPie', 'ChartMPL']
FontFamilyOptions = Literal['courier', 'times', 'arial']
OpacityOptions = Literal[
'linear',
'linear_r',
'geom',
'geom_r',
'sigmoid',
'sigmoid_1',
'sigmoid_2',
'sigmoid_3',
'sigmoid_4',
'sigmoid_5',
'sigmoid_6',
'sigmoid_7',
'sigmoid_8',
'sigmoid_9',
'sigmoid_10',
'sigmoid_15',
'sigmoid_20',
'foreground',
]
CullingOptions = Literal['front', 'back', 'frontface', 'backface', 'f', 'b']
StyleOptions = Literal['surface', 'wireframe', 'points', 'points_gaussian']
LightingOptions = Literal['light kit', 'three lights', 'none']
CameraPositionOptions = Union[
Literal['xy', 'xz', 'yz', 'yx', 'zx', 'zy', 'iso'],
VectorLike[float],
MatrixLike[float],
CameraPosition,
]
class BackfaceArgs(TypedDict, total=False):
theme: Theme
interpolation: Literal['Physically based rendering', 'pbr', 'Phong', 'Gouraud', 'Flat']
color: ColorLike
style: StyleOptions
metallic: float
roughness: float
point_size: float
opacity: float
ambient: float
diffuse: float
specular: float
specular_power: float
show_edges: bool
edge_color: ColorLike
render_points_as_spheres: bool
render_lines_as_tubes: bool
lighting: bool
line_width: float
culling: CullingOptions | bool
edge_opacity: float
class ScalarBarArgs(TypedDict, total=False):
title: str
mapper: _vtk.vtkMapper
n_labels: int
italic: bool
bold: bool
title_font_size: float
label_font_size: float
color: ColorLike
font_family: FontFamilyOptions
shadow: bool
width: float
height: float
position_x: float
position_y: float
vertical: bool
interactive: bool
fmt: str
use_opacity: bool
outline: bool
nan_annotation: bool
below_label: str
above_label: str
background_color: ColorLike
n_colors: int
fill: bool
render: bool
theme: Theme
unconstrained_font_size: bool
class SilhouetteArgs(TypedDict, total=False):
color: ColorLike
line_width: float
opacity: float
feature_angle: float
decimate: float
|
