OEDepict TK 2.3.6
================================================================================

New features
--------------------------------------------------------------------------------

* The following API has been added to increase the reporting capabilities of
  **OEDepict TK**:

  * :ref:`OEImageTable <OEDepict_OEImageTable>` class
  * :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` class
  * :oe:constns:`OEDepict::OEImageTableStyle` namespace

  .. figure:: ../../depicttk/images/ImageTable.*
     :align:  center

     **Example of depicting molecules and data using image table**

* The following API has been added to render labels associated
  with certain parts of the depicted molecule:

  * :ref:`OEHighlightLabel <OEDepict_OEHighlightLabel>` class
  * :oe:func:`OEDepict::OEAddLabel` function

  .. figure:: ../../depicttk/images/releasenotes-2.3.6/HighlightLabel.png
     :align: center
     :width: 250 pt

     **Example of adding labels on molecule depiction**

* A new function, :oe:func:`OEDepict::OEDrawText`, has been added.

* The constructor of the
  :oe:meth:`OEDepict::OEHighlightByLasso<OEDepict::OEHighlightByLasso::Constructors>`
  class now takes a parameter that determines the width of the "lasso" used for
  highlighting.  The corresponding
  :oe:cls:`OEDepict::OEHighlightByLasso::GetLineWidthScale` and
  :oe:cls:`OEDepict::OEHighlightByLasso::SetLineWidthScale` methods
  have been added.

* A new constructor has been added to the
  :oe:meth:`OEDepict::OEImageFrame<OEDepict::OEImageFrame::Constructors>`
  class that generates a new image with equal padding around it.

* A new function, :oe:func:`OEDepict::OEWriteReportPageByPage`, has been added.

* A new constructor has been added to the
  :oe:meth:`OEDepict::OE2DPath<OEDepict::OE2DPath::Constructors>` class that
  copies and rotates an already existing path.

Preliminary API - New Functionalities
--------------------------------------------------------------------------------

* A new overload of the function :oe:func:`OEDepict::OEAddSVGClickEvent`
  has been added that allows associating any :ref:`OESVGGroup <OEDepict_OESVGGroup>`
  object with an SVG click event.

* A new :term:`Preliminary API` has been added to generate and access
  built-in visibility SVG classes (:ref:`OESVGClass <OEDepict_OESVGClass>`):

  * :oe:func:`OEDepict::OEAddBuiltInHiddenSVGClass`
  * :oe:func:`OEDepict::OEGetBuiltInHiddenSVGClass`
  * :oe:func:`OEDepict::OEAddBuiltInVisibleSVGClass`
  * :oe:func:`OEDepict::OEGetBuiltInVisibleSVGClass`

* A new :term:`Preliminary API` has been added to mark up the atoms in SVG
  images generated by the :oe:func:`OEDepict::OERenderMolecule` function:

  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor`
  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomSVGMarkupFunctor`
  * :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>`
  * :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>`
  * :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>`
  * :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>`

* A new constant, :oe:const:`OEDepict::OELayerPosition::SVG`, has been added
  to the :oe:constns:`OEDepict::OELayerPosition` namespace.

* The following virtual methods have been added to the
  :ref:`OEImageFileBase <OEDepict_OEImageFileBase>` class:

  * :oe:meth:`OEDepict::OEImageFileBase::PushGroup`
  * :oe:meth:`OEDepict::OEImageFileBase::PopGroup`
  * :oe:meth:`OEDepict::OEImageFileBase::IsVisible`

* A new method, :oe:meth:`OEDepict::OESVGGroup::IsVisible`, has been added.

Preliminary API - API Changes
--------------------------------------------------------------------------------

* The atom and bond display parameters of the following functions are no
  longer ``const``:

  * :oe:func:`OEDepict::OEDrawSVGToggleText`
  * :oe:func:`OEDepict::OEDrawSVGHoverText`
  * :oe:func:`OEDepict::OEAddSVGClickEvent`

Major bug fixes
--------------------------------------------------------------------------------

* Objects that have been drawn in hidden SVG groups are no longer visible in
  other image file formats.  For example, when adding hover text to atoms
  (using the :oe:func:`OEDepict::OEDrawSVGHoverText` function),
  the text will only be visible in SVG images when the mouse is moved
  over a displayed atom. If the image is written into any other image
  file format, the hover text is no longer visible.

  .. list-table::
     :widths: 250 250
     :header-rows: 1

     * - 2017.Jun
       - 2017.Oct

     * - .. image:: ../../depicttk/images/releasenotes-2.3.6/HoverAtomText-2017-Jun.*
       - .. image:: ../../depicttk/images/releasenotes-2.3.6/HoverAtomText-2017-Oct.*

* When generating interactive SVG images, hover text
  (:oe:func:`OEDepict::OEDrawSVGToggleText`)
  and click events (:oe:func:`OEDepict::OEAddSVGClickEvent`) can both be
  added to atoms and bonds.

Minor bug fixes
--------------------------------------------------------------------------------

* The Ogham API, deprecated since 2014, is no longer available.

Documentation changes
--------------------------------------------------------------------------------

* A new section, :ref:`section_image_layout_table`, has been added.
