.. _f-rendernbjs:

module ``jspy.render_nb_js``
============================





.. inheritance-diagram:: jyquickhelper.jspy.render_nb_js


Short summary
+++++++++++++

module ``jyquickhelper.jspy.render_nb_js``

Helpers around JSON


:githublink:`%|py|6`




Classes
+++++++

+----------------------------------------------------------------------------------------+--------------------------------------------------------+
| class                                                                                  | truncated documentation                                |
+========================================================================================+========================================================+
| :class:`JavascriptScriptError <jyquickhelper.jspy.render_nb_js.JavascriptScriptError>` | Raised when the class does not find what it expects.   |
+----------------------------------------------------------------------------------------+--------------------------------------------------------+
| :class:`RenderJS <jyquickhelper.jspy.render_nb_js.RenderJS>`                           | Renders :epkg:`javascript`, only outputs :epkg:`HTML`. |
+----------------------------------------------------------------------------------------+--------------------------------------------------------+
| :class:`RenderJSObj <jyquickhelper.jspy.render_nb_js.RenderJSObj>`                     | Renders JS using :epkg:`javascript`.                   |
+----------------------------------------------------------------------------------------+--------------------------------------------------------+
| :class:`RenderJSRaw <jyquickhelper.jspy.render_nb_js.RenderJSRaw>`                     | Adds :epkg:`javascript` into a noteboook.              |
+----------------------------------------------------------------------------------------+--------------------------------------------------------+
| :class:`UrlNotFoundError <jyquickhelper.jspy.render_nb_js.UrlNotFoundError>`           | Raised when a url does not exist.                      |
+----------------------------------------------------------------------------------------+--------------------------------------------------------+




Functions
+++++++++

+---------------------------------------------------------------+-------------------------+
| function                                                      | truncated documentation |
+===============================================================+=========================+
| :func:`check_url <jyquickhelper.jspy.render_nb_js.check_url>` | Checks urls.            |
+---------------------------------------------------------------+-------------------------+








Methods
+++++++

+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| method                                                                                       | truncated documentation                                                                                                               |
+==============================================================================================+=======================================================================================================================================+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_js.RenderJS.__init__>`                      |                                                                                                                                       |
+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_js.RenderJSObj.__init__>`                   |                                                                                                                                       |
+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_js.RenderJSRaw.__init__>`                   |                                                                                                                                       |
+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_js.UrlNotFoundError.__init__>`              |                                                                                                                                       |
+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_copy_local <jyquickhelper.jspy.render_nb_js.RenderJS._copy_local>`                | If *self.local*, copies javascript dependencies in the local folder.                                                                  |
+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_copy_local <jyquickhelper.jspy.render_nb_js.RenderJSObj._copy_local>`             | If *self.local*, copies javascript dependencies in the local folder.                                                                  |
+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_copy_local <jyquickhelper.jspy.render_nb_js.RenderJSRaw._copy_local>`             | If *self.local*, copies javascript dependencies in the local folder.                                                                  |
+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_ipython_display_ <jyquickhelper.jspy.render_nb_js.RenderJSObj._ipython_display_>` | overloads method `_ipython_display_ <http://ipython.readthedocs.io/en/stable/config/integrating.html?highlight=Integrating%20>`_. ... |
+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <jyquickhelper.jspy.render_nb_js.RenderJS._repr_html_>`                | Overloads method *_repr_html_*.                                                                                                       |
+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`generate_html <jyquickhelper.jspy.render_nb_js.RenderJS.generate_html>`               | 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>`            | 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>`            | Overloads method `_ipython_display_ <http://ipython.readthedocs.io/en/stable/config/integrating.html?highlight=Integrating%20>`_. ... |
+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: jyquickhelper.jspy.render_nb_js
    :members:
    :special-members: __init__
    :show-inheritance: