Books

class mhi.enerplot.Book

An Enerplot Book holds one or more sheets, which in turn will hold graph frames for viewing curve data.

name

The name of the book (read-only)

file

The book’s filename (read-only)

description

The book’s description (read-only)

unload()

Unload this book

The book is unloaded from the Enerplot workspace.

Warning

Any changes made to the book, which have not explicitly been saved, will be lost. Call save() or save_as() before unloading to preserve changes.

save()

Save all changes in book

save_as(path, folder=None)

Save book to a new path location

Parameters:

• path (str) – location to store the book. The extension .epbx is appended if not present.
• folder (str) – If provided, the path to the book is resolved relative to this folder.

sheets()

List all of the sheets in this book.

Returns:An indexable dictionary of sheets. Return type:IndexableDict[str,Sheet]

sheet(name)

Retrieve a sheet reference, by name

Parameters:name (str) – the name of the sheet Returns:the named sheet (if present) Return type:Sheet

new_sheet(name='', description='')

Create a new sheet

Parameters:

• name (str) – The desired sheet name; if not provided, “Sheet#” will be used.
• description (str) – a description to be given to the sheet.

Returns:

the created sheet.

Return type:

Sheet

delink_all()

Delink all channel data from book

relink_all(datafile)

Relink the channel data to the given datafile

Parameters:datafile (DataFile) – the datafile to link channel data to.