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

.. oe:namespace:: OEGrapheme

.. oe:function:: OEDrawIridiumData

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         bool OEDrawIridiumData(OEDepict::OEImageBase& image,
                                const OEBio::OEDesignUnit& du)
         bool OEDrawIridiumData(OEDepict::OEImageBase& image,
                                const OEBio::OEIridiumData& iridium)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawIridiumData(image: OEImageBase, du: OEDesignUnit) -> bool
         OEDrawIridiumData(image: OEImageBase, iridium: OEIridiumData) -> bool

   Renders the Iridium data into an easily interpretable graph.

   *image*
     The image on which the Iridium data graph is drawn.

   *du*
     The :ref:`OEDesignUnit <OEBio_OEDesignUnit>` object of which Iridium data is
     being rendered.

   *iridium*
     The :ref:`OEIridiumData <OEBio_OEIridiumData>` object that is being rendered.

   .. oe:language:: c++ python

      **Example:**

      The following code snippet shows how to use the :oe:func:`OEGrapheme::OEDrawIridiumData`
      function. The image created is shown in
      :ref:`Figure: Example of using the OEDrawIridiumData function<figure_draw_iridium>`.

      .. oe:source:: DrawIridiumData.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-DRAW-IRIDIUM-DATA

      .. oe:source:: DrawIridiumData.py
         :language: python
         :noindent:
         :frag:     SNIPPET-DRAW-IRIDIUM-DATA

   .. _figure_draw_iridium:

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover cursor over graph</b>
         </p>

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

         <p align="center">
         <b>Example of using the OEDrawIridiumData function</b>
         <p>

      .. image:: ../images/DrawIridiumData.svg
         :width: 1pt

   .. only:: oepdf

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

         **Example of using the OEDrawIridiumData function**

   .. note::

      When generating :file:`.svg` image, the output will be interactive.
      With any other image file format it will be static.
      See also :ref:`chapter_svg` chapter in **OEDepict TK** manual.

   .. seealso::

      * :ref:`chapter_sprucetk_iridium` chapter in **OESpruce TK** manual
      * :ref:`OEDesignUnit <OEBio_OEDesignUnit>` class
      * :ref:`OEIridiumData <OEBio_OEIridiumData>` class
