.. py:currentmodule:: mhi.enerplot

=======
Changes
=======

What's new in 3.1
=================

3.1.0
-----

- Uses ``mhi.help`` framework for HTML Help documentation.
- The command ``py -m mhi.help`` will open all help documentation.


What's new in 3.0
=================

3.0.1
-----
- Update to mhi.common 3.1.4
- Added HTML documentation ``py -m mhi.enerplot help``

3.0.0
-----
- Drop support for Python 3.5 and Python 3.6
- :meth:`~mhi.enerplot.launch` now accepts

  - a port ``range``
  - an network ``address`` for Enerplot to bind the automation server to


What's new in 2.6
=================

2.6.1
-----
- Update to mhi.common 2.4.5
- ``allow_alpha`` and ``allow_beta`` are no longer supported in :meth:`launch`

2.6.0
-----
- Added :meth:`Sheet.select_all` command
- Update to mhi.common 2.4.2
- Support `mode` & `style` properties in graph curves


What's new in 2.5
=================

2.5.3
-----
- Added :meth:`Book.relink` & :meth:`Sheet.relink`.
- :attr:`Sheet.name` and :attr:`Sheet.description` are now read/write.
- Recording now includes book/sheet relinking, sheet parameter changes.
- :meth:`Enerplot.new_workspace` with `default_book=False` now works in both 1.0 and 1.1.
- Fixed :meth:`Sheet.graph_frame` name error.
- Update to mhi.common 2.3.10

2.5.2
-----
- Update to mhi.common 2.3.9

2.5.1
-----
- Restore Enerplot 1.0.x compatibility in :meth:`Enerplot.load_datafiles`.

2.5.0
-----
- Added :meth:`Book.focus`.
- Added :meth:`Book.print`.
- Added :meth:`Sheet.group_box`.


What's new in 2.4
=================

2.4.1
-----
- Added :meth:`~DataFile.record` alias for :meth:`~DataFile.channel`.
- Removed deprecated `distutils` dependency

2.4.0
-----
- Added :meth:`Enerplot.reload`.


What's new in 2.3
=================

2.3.0
-----
- Added :meth:`Enerplot.substitute`, :meth:`~Enerplot.is_dirty`, :attr:`~Enerplot.workspace_dir`,
  :attr:`~Enerplot.workspace_name`, :attr:`~Enerplot.workspace_path`.
- Added :meth:`Book.reload`, :meth:`~Book.is_dirty`, :attr:`~Book.dirty`.
- Added alias to `mhi.enerplot.common` for Enerplot 1.0.x compatibility.


What's new in 2.2
=================

2.2.2
-----
- :meth:`~Enerplot.datafiles` and :meth:`~Enerplot.load_datafiles` would
  omit datafiles with duplicate final path component names.
  These methods now return a `Datafiles` object, which supports duplicate
  filenames where the paths to those files are different.

2.2.1
-----

- Fixed missing import when :func:`mhi.enerplot.versions` is not called
- Added `minimum`, `maximum`, `allow_alpha`, `allow_beta`, `x64` parameters
  to :func:`mhi.enerplot.launch`
- Added :meth:`~GraphFrame.zoom` for x-axis only zoom support.

2.2.0
-----

- Added :func:`mhi.enerplot.versions`.
- `mhi.enerplot.common` has been moved to an external dependency: `mhi.common`.
- `mhi.enerplot.automation.*` has been flatten to `mhi.enerplot.*`.


What's new in 2.1
=================

2.1.0
-----

- Added :attr:`~Sheet.grid`, :attr:`~Sheet.orientation` and :attr:`~Sheet.pagesize` properties to Sheet
- Added :attr:`~Book.header`, :attr:`~Book.title`, and footer print formatting properties to Book
