ExportViewer

class jdaviz.configs.default.plugins.export_plot.export_plot.ExportViewer(*args, **kwargs)

Bases: PluginTemplateMixin, ViewerSelectMixin

See the Export Plot Plugin Documentation for more details.

Only the following attributes and methods are available through the public plugin API:

• viewer (ViewerSelect): Viewer to select for exporting the figure image.

• show()

• open_in_tray()

• save_figure()

Public constructor

Attributes Summary

template_file
user_api

Methods Summary

save_figure([filename, filetype])	Save the figure to an image with a provided filename or through an interactive save dialog.
vue_save_figure(filetype)	Callback for save figure events in the front end viewer toolbars.

Attributes Documentation

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/v3.5.0/lib/python3.9/site-packages/jdaviz/configs/default/plugins/export_plot/export_plot.py', 'export_plot.vue')

user_api

Methods Documentation

save_figure(filename=None, filetype=None)

Save the figure to an image with a provided filename or through an interactive save dialog.

If filetype is ‘png’ (or defaults to ‘png’ based on filename), the interactive save dialog will be bypassed (this is not supported for ‘svg’).

Parameters:

filenamestr or None

Filename to autopopulate the save dialog.

filetype{‘png’, ‘svg’, None}

Filetype (PNG or SVG). If None, will default based on filename or to PNG.

vue_save_figure(filetype)

Callback for save figure events in the front end viewer toolbars. Uses the bqplot.Figure save methods.