.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEAromaticStyle, aromaticity depiction

.. oe:constnamespace:: OEAromaticStyle

   This namespace contains constants representing various styles
   of aromatic ring depictions.

   .. _table_OEAromaticStyle_Examples:

   .. list-table:: **Examples of aromatic display styles**
      :widths: 50 100 100 100
      :header-rows: 0

      * -
        - :oe:const:`OEDepict::OEAromaticStyle::Kekule` (default)
        - :oe:const:`OEDepict::OEAromaticStyle::Circle`
        - :oe:const:`OEDepict::OEAromaticStyle::Dash`

      * -  example A
        - .. image:: ../images/OEAromaticStyle_example-A-kekule.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-A-circle.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-A-dash.*
             :align:  center

      * - example B
        - .. image:: ../images/OEAromaticStyle_example-B-kekule.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-B-circle.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-B-dash.*
             :align:  center

      * - example C
        - .. image:: ../images/OEAromaticStyle_example-C-kekule.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-C-circle.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-C-dash.*
             :align:  center

      * - example D
        - .. image:: ../images/OEAromaticStyle_example-D-kekule.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-D-circle.*
             :align:  center
        - .. image:: ../images/OEAromaticStyle_example-D-dash.*
             :align:  center

   .. seealso::

      * :ref:`chapter_aromaticity` chapter in **OEChem TK** manual
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAromaticStyle`
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAromaticStyle`

   The :oe:constns:`OEDepict::OEAromaticStyle` namespace contains the
   following constants:

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default aromatic style is
      :oe:const:`OEDepict::OEAromaticStyle::Kekule`.


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Circle

      Aromatic rings up to 6-membered are depicted by drawing a circle 
      inside.
      See example in :ref:`Figure: Example of using the 'Circle' aromaticity style<figure_OEAromaticStyle_Circle>`.

      .. _figure_OEAromaticStyle_Circle:

      .. figure:: ../images/OEAromaticStyle_Circle.*
         :align:  center

         **Examples of using the 'Circle' aromaticity style**

      .. note::

         **OEDepict TK** applies the "circle" style only for rings up to 6-membered.
         The remaining aromatic bonds are depicted using the "dash" style.
         See example B and C in :ref:`Table Examples of aromatic display styles <table_OEAromaticStyle_Examples>`.
         **OEDepict TK** does not apply the "circle" style either if not all bonds of the rings
         are perceived as aromatic.
         See example A and D in :ref:`Table Examples of aromatic display styles <table_OEAromaticStyle_Examples>`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Dash

      See example in :ref:`Figure: Example of using the 'Dash' aromaticity style<figure_OEAromaticStyle_Dash>`.

      .. _figure_OEAromaticStyle_Dash:

      .. figure:: ../images/OEAromaticStyle_Dash.*
         :align:  center

         **Example of using the 'Dash' aromaticity style**


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Kekule

      See example in :ref:`Figure: Example of using the 'Kekule' aromaticity style<figure_OEAromaticStyle_Kekule>`.

      .. _figure_OEAromaticStyle_Kekule:

      .. figure:: ../images/OEAromaticStyle_Kekule.*
         :align:  center

         **Example of using the 'Kekule' aromaticity style**
