.. include:: ../../toolkit-substitutions

OEDepict TK 2.4.1
================================================================================

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

* The following APIs have been added to generate consistent legend layouts:

  * :oe:constns:`OEDepict::OELegendLayoutStyle` namespace
  * :oe:constns:`OEDepict::OELegendColorStyle` namespace
  * :oe:const:`OEDepict::OELegendInteractiveStyle` namespace
  * :ref:`OELegendLayoutOptions <OEDepict_OELegendLayoutOptions>` class
  * :ref:`OELegendLayout <OEDepict_OELegendLayout>` class
  * :oe:func:`OEDepict::OEDrawLegendLayout` function

  .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>click on the Legend label</b>
         </p>

         <p align="center">
         <object data="../../_images/legend-layout.svg" type="image/svg+xml"  width = "300" ></object>
         <p>

         <p align="center">
         <b>Example of using legend layout</b>
         <p>

      .. image:: ../../depicttk/images/releasenotes-2.4.1/legend-layout.svg
         :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|

* The following APIs have been added to depict common protective groups:

  * :oe:constns:`OEDepict::OEProtectiveGroupStyle` namespace
  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupLabelFont`
  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupLabelFont`
  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle`
  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupStyle`

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

     * - default depiction
       - using :oe:const:`OEDepict::OEProtectiveGroupStyle::Fmoc` style
     * - .. image:: ../../depicttk/images/releasenotes-2.4.1/prot-group_Fmoc_OFF.*
            :scale:  100
            :align:  center
       - .. image:: ../../depicttk/images/releasenotes-2.4.1/prot-group_Fmoc.*
            :scale:  100
            :align:  center


* The following APIs have been added to mark up the bonds in SVG images generated
  by the :oe:func:`OEDepict::OERenderMolecule` functions:

  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondSVGMarkupFunctor`
  * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomSVGMarkupFunctor`
  * :ref:`OEBondSVGMarkupBase <OEDepict_OEBondSVGMarkupBase>`
  * :ref:`OEBondSVGNoMarkup <OEDepict_OEBondSVGNoMarkup>`
  * :ref:`OEBondSVGBondIdxMarkup <OEDepict_OEBondSVGBondIdxMarkup>`

* A new :oe:func:`OEDepict::OEDrawHighlighting` function has been added to
  render molecule highlights into a separate image rather than into the molecule display.

* New :oe:func:`OEDepict::OEAddHighlighting` function overloads have been added
  that take an :ref:`OESubSearch <OEChem_OESubSearch>` object and highlight its matches
  on the molecule display.

* New :oe:func:`OEDepict::OEAddWatermark` functions have been added that render a light
  gray watermark onto an image or a molecule display.

* A new :oe:meth:`OEDepict::OEImageBase::GetSVGGroups` method has been added to return
  the SVG groups associated with the image.

* New :oe:func:`OEDepict::OERotateVector` and :oe:func:`OEDepict::OELengthenVector`
  functions have been added.

* A new :oe:func:`OEDepict::OEAddSVGHover` function has been added that takes two target
  SVG groups to create a "hover" effect.

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

* The minimum margin allowed for :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`
  has been reduced from ``5.0%`` to ``2.5%``.

* A duplicate SVG group warning is no longer thrown when transferring
  built-in SVG groups from one image to another.
