holoviews.ipython.archive module#

Implements NotebookArchive used to automatically capture notebook data and export it to disk via the display hooks.

class holoviews.ipython.archive.NotebookArchive(*, skip_notebook_export, snapshot_name, archive_format, dimension_formatter, export_name, filename_formatter, flush_archive, max_filename, object_formatter, pack, root, timestamp_format, unique_name, exporters, name)[source]#

Bases: FileArchive

FileArchive that can automatically capture notebook data via the display hooks and automatically adds a notebook HTML snapshot to the archive upon export.

Parameter Definitions

---

Parameters inherited from:

holoviews.core.io.FileArchive: dimension_formatter, object_formatter, timestamp_format, root, archive_format, pack, unique_name, max_filename, flush_archive

exporters = List(bounds=(0, None), default=[<class 'holoviews.core.io.Pickler'>], label='Exporters')

The exporter functions used to convert HoloViews objects into the appropriate format(s).

filename_formatter = String(default='{dimensions},{obj}', label='Filename formatter')

Similar to FileArchive.filename_formatter except with support for the notebook name field as {notebook}.

export_name = String(default='{notebook}', label='Export name')

Similar to FileArchive.filename_formatter except with support for the notebook name field as {notebook}.

skip_notebook_export = Boolean(default=False, label='Skip notebook export')

Whether to skip JavaScript capture of notebook data which may be unreliable. Also disabled automatic capture of notebook name.

snapshot_name = String(default='index', label='Snapshot name')

The basename of the exported notebook snapshot (html). It may optionally use the {timestamp} formatter.

add(obj=None, filename=None, data=None, info=None, html=None)[source]#

Similar to FileArchive.add but accepts html strings for substitution

auto(enabled=Boolean, name=String, exporters=List, dimension_formatter=String, object_formatter=Callable, filename_formatter=String, timestamp_format=String, root=String, archive_format=Selector, pack=Boolean, export_name=String, unique_name=Boolean, max_filename=Integer, flush_archive=Boolean, skip_notebook_export=Boolean, snapshot_name=String)[source]#

export(timestamp=None)[source]#

Get the current notebook data and export.

get_namespace()[source]#

Find the name the user is using to access holoviews.

last_export_status()[source]#

Helper to show the status of the last call to the export method.