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

.. oe:namespace:: OEDepict


.. _OEDepict_OEAtomSVGAtomIdxMarkup:

.. oe:class:: OEAtomSVGAtomIdxMarkup

   .. oe:api::

      class OEAtomSVGAtomIdxMarkup : public OEAtomSVGMarkupBase

   This class represents the :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>` atom
   SVG markup functor.  If this functor is passed to the
   :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor`
   method, the atoms will be not marked in the :file:`svg` image when
   calling the :ref:`OERenderMolecule <OEDepict_OERenderMolecule>` function.

   .. seealso::

      * :ref:`chapter_svg` chapter
      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor` method
      * :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>` class
      * :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>` class

   The following methods are publicly inherited from
   :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>`:

   ==================================================================== ==================================================================== ====================================================================
   :oe:meth:`CreateCopy<OEDepict::OEAtomSVGMarkupBase::CreateCopy>`     :oe:meth:`GetClassName<OEDepict::OEAtomSVGMarkupBase::GetClassName>` :oe:meth:`GetGroupId<OEDepict::OEAtomSVGMarkupBase::GetGroupId>`
   ==================================================================== ==================================================================== ====================================================================

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

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomSVGAtomIdxMarkup(const std::string prefix = "",
                                   const std::string classname = "atom")

      .. oe:language:: python

         .. oe:api:: python

            OEAtomSVGAtomIdxMarkup(prefix: str = "", classname: str = "atom") -> OEAtomSVGAtomIdxMarkup

      Creates an :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>` object.

      prefix
         The string that will be added at the beginning of each atom
         :oe:cls:`group id <OEDepict::OESVGGroup>`.
         For information about valid ids see
         :oe:func:`OEDepict::OEIsValidSVGGroupId` function.
         By default, no prefix will be added.

      classname
         The :oe:cls:`class name <OEDepict::OESVGClass>` that is going to
         be used to mark atoms.
         For information about valid names see
         :oe:func:`OEDepict::OEIsValidSVGClassName` function.

      By default, the svg image for the first atom of a molecule will be
      marked as follows:

      ::

          <g id='idx=0' class='atom'>
          ..
          list of drawing elements
          ..
          <circle ... >
          </g>

      The transparent circle will be drawn with the atom position
      :oe:meth:`OEDepict::OE2DAtomDisplay::GetCoords` center.
      This can be used to manipulate the generated :file:`.svg` image
      and associate event with the SVG groups.

   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEAtomSVGMarkupBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEAtomSVGMarkupBase

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>`
      object is dynamically allocated and owned by the caller.

   .. oe:method:: GetClassName

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetClassName(const OEChem::OEAtomBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg2: OEAtomBase) -> str

      Returns the string that specifies the
      :oe:cls:`group id <OEDepict::OESVGGroup>`
      of an atom in an :file:`svg` image.

   .. oe:method:: GetGroupId

      .. oe:language:: c++ java csharp

         .. oe:api::

            std::string GetGroupId(const OEChem::OEAtomBase &) const

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(atom: OEAtomBase) -> str

      Returns the string that specifies the
      :oe:cls:`class name <OEDepict::OESVGClass>`
      of an atom in an :file:`svg` image.
