Changelog¶

Release history for vtkplotlib.

v2.0.0¶

Add support for opaque background colors (settable via vpl.gcf().background_opactity = x). Note that this is for screenshots only (e.g. using screenshot_fig or save_fig). VTK does not support tranparent windows so this has no effect on interactive render windows.
BREAKING: vtkplotlib.screenshot_fig now returns a (height, width, 4) array instead of a (height, width, 3) array. This fourth entry symbolises opacity.
Fix a segfault when screenshot_fig then show is called on the same figure.

Speed up initialisation by replacing loading of matplotlib’s colors with a literal dict.
Fix the text property to text returning None.
Fix the colors attribute of surface mishandling 2D array of scalars.
Fix TypeError tripped by as_vtk_cmap("string", False).
Create the interactive submodule with the alias i.
Fix legend‘s key: entry mapping being reset.
Fix legend.set_entry(array) calling bool on an array
Fix VTK version dependent image_io.read for TIFF, BMP and PNG.
Move the tests module outside of the distributed vtkplotlib package.
Fix unicode support for VTK>=9.0.0.
Add cursor tracker to fancy QtFigure2.
Fix handling of a PolyData containing NaNs in a legend.

Import new VTK==9.0.0 dependencies explicitly to make them more PyInstaller friendly.

Catch VTK file reading errors and raise them as Python exceptions, replacing the pop-up error dialogs VTK uses by default.
QtFigure now supports being re-shown.
Fix spurious VTK error dialogs from messy garbage collection of figures.
Allow a pathlib.Path to be used in functions where a filename is expected.
Support TIFF and bitmap image formats using VTK’s image reading/writing machinery.
Add patchy support for io.BytesIO image files. This is heavily dependent on VTK allows it.
Add a zoom_to_contents method.
Add support for off screen rendering (screenshotting without drawing a window).
Fix the label parameter to quiver and arrow having no effect.

Take advantage of the new modular structure of VTK >= 8.2.0 so that vtkplotlib only imports the parts of VTK that it needs. This makes import vtkplotlib faster and PyInstaller applications smaller. Older versions of VTK are still supported and behave unchanged.

Add a vtkplotlib.legend whose contents are determined by a new label parameter to each vtkplotlib plot command.
Add colormaps support to mesh_plot
Add an option to save_fig and screenshot_fig to automatically crop away blank regions of the image.
Add a quick_show() method to all plots.

Made a clumsy mistake in screenshot_fig. Forgot that the window needs to be open for it to work. Updated now and added to its test so it doesn’t slip by again
Catch and raise an exception raise if unable to open a given image type.
Add a figure history (vtkplotlib.figure_history) to store the most recent figure(s).
Allow cursors (given by vtkplotlib.scatter with use_cursors=True) to be resized.
Alias zip_axes and unzip_axes to the top level package.
Fix non-Qt figures not being re show able.
Add a PolyData wrapper class for VTK’s vtkPolyData allowing easy construction of custom mesh-like objects.
Encourage a sys.stdout flush before starting the interactive renderer. This reduces (but does not fix) a race condition between VTK’s event loop and IPython’s console if a figure is shown soon after a print statement.
Add support for non ASCII characters in paths which VTK doesn’t handle by default.