@@ -98,6 +98,29 @@ def _view_from_pickle(builder, args):
98
98
99
99
@dataclass
100
100
class ViewSpecification :
101
+ """
102
+ A view specification, or a mutable dataclass containing configuration
103
+ options for a view's "viewing" of a different axes.
104
+
105
+ Parameters:
106
+ -----------
107
+ image_interpolation: string
108
+ Supported options are 'antialiased', 'nearest', 'bilinear',
109
+ 'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite',
110
+ 'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell',
111
+ 'sinc', 'lanczos', or 'none'. The default value is 'nearest'. This
112
+ determines the interpolation used when attempting to render a
113
+ zoomed version of an image.
114
+
115
+ filter_set: Iterable[Union[Type[Artist], Artist]] or None
116
+ An optional filter set, which can be used to select what artists
117
+ are drawn by the view. Any artists or artist types in the set are not
118
+ drawn.
119
+
120
+ scale_lines: bool, defaults to True
121
+ Specifies if lines should be drawn thicker based on scaling in the
122
+ view.
123
+ """
101
124
image_interpolation : str = "nearest"
102
125
filter_set : Optional [Set [Union [Type [Artist ], Artist ]]] = None
103
126
scale_lines : bool = True
0 commit comments