.. _l-methods:

Methods
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| method                                                                                           | class parent     | truncated documentation                                                                                                               |
+==================================================================================================+==================+=======================================================================================================================================+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_js.RenderJS.__init__>`                          | RenderJS         |                                                                                                                                       |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_js.RenderJSObj.__init__>`                       | RenderJSObj      |                                                                                                                                       |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_js.RenderJSRaw.__init__>`                       | RenderJSRaw      |                                                                                                                                       |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_js.UrlNotFoundError.__init__>`                  | UrlNotFoundError |                                                                                                                                       |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_js_dot.RenderJsDot.__init__>`                   | RenderJsDot      |                                                                                                                                       |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_js_vis.RenderJsVis.__init__>`                   | RenderJsVis      |                                                                                                                                       |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_json.RenderJSON.__init__>`                      | RenderJSON       | Initialize with a :epkg:`JSON` data.                                                                                                  |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_json.RenderJSONObj.__init__>`                   | RenderJSONObj    | Initialize with a :epkg:`JSON` data.                                                                                                  |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_json.RenderJSONRaw.__init__>`                   | RenderJSONRaw    | Initialize with a :epkg:`JSON` data.                                                                                                  |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_copy_local <jyquickhelper.jspy.render_nb_js.RenderJS._copy_local>`                    | RenderJS         | If *self.local*, copies javascript dependencies in the local folder.                                                                  |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_copy_local <jyquickhelper.jspy.render_nb_js.RenderJSObj._copy_local>`                 | RenderJSObj      | If *self.local*, copies javascript dependencies in the local folder.                                                                  |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_copy_local <jyquickhelper.jspy.render_nb_js.RenderJSRaw._copy_local>`                 | RenderJSRaw      | If *self.local*, copies javascript dependencies in the local folder.                                                                  |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_copy_local <jyquickhelper.jspy.render_nb_json.RenderJSON._copy_local>`                | RenderJSON       | If *self.local*, copies javascript dependencies in the local folder.                                                                  |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_copy_local <jyquickhelper.jspy.render_nb_json.RenderJSONObj._copy_local>`             | RenderJSONObj    | If *self.local*, copies javascript dependencies in the local folder.                                                                  |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_copy_local <jyquickhelper.jspy.render_nb_json.RenderJSONRaw._copy_local>`             | RenderJSONRaw    | If *self.local*, copies javascript dependencies in the local folder.                                                                  |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_ipython_display_ <jyquickhelper.jspy.render_nb_js.RenderJSObj._ipython_display_>`     | RenderJSObj      | overloads method `_ipython_display_ <http://ipython.readthedocs.io/en/stable/config/integrating.html?highlight=Integrating%20>`_. ... |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_ipython_display_ <jyquickhelper.jspy.render_nb_json.RenderJSONObj._ipython_display_>` | RenderJSONObj    |                                                                                                                                       |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <jyquickhelper.jspy.render_nb_js.RenderJS._repr_html_>`                    | RenderJS         | Overloads method *_repr_html_*.                                                                                                       |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <jyquickhelper.jspy.render_nb_json.RenderJSON._repr_html_>`                | RenderJSON       |                                                                                                                                       |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`generate_html <jyquickhelper.jspy.render_nb_js.RenderJS.generate_html>`                   | RenderJS         | Overloads method `_ipython_display_ <http://ipython.readthedocs.io/en/stable/config/integrating.html?highlight=Integrating%20>`_. ... |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`generate_html <jyquickhelper.jspy.render_nb_js.RenderJSObj.generate_html>`                | RenderJSObj      | Overloads method `_ipython_display_ <http://ipython.readthedocs.io/en/stable/config/integrating.html?highlight=Integrating%20>`_. ... |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`generate_html <jyquickhelper.jspy.render_nb_js.RenderJSRaw.generate_html>`                | RenderJSRaw      | Overloads method `_ipython_display_ <http://ipython.readthedocs.io/en/stable/config/integrating.html?highlight=Integrating%20>`_. ... |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`generate_html <jyquickhelper.jspy.render_nb_json.RenderJSON.generate_html>`               | RenderJSON       | Overloads method `_ipython_display_ <http://ipython.readthedocs.io/en/stable/config/integrating.html?highlight=Integrating%20>`_. ... |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`generate_html <jyquickhelper.jspy.render_nb_json.RenderJSONObj.generate_html>`            | RenderJSONObj    | Overloads method `_ipython_display_ <http://ipython.readthedocs.io/en/stable/config/integrating.html?highlight=Integrating%20>`_. ... |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`generate_html <jyquickhelper.jspy.render_nb_json.RenderJSONRaw.generate_html>`            | RenderJSONRaw    | Overloads method `_ipython_display_ <http://ipython.readthedocs.io/en/stable/config/integrating.html?highlight=Integrating%20>`_. ... |
+--------------------------------------------------------------------------------------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------+