.. _f-rendernbjson:

module ``jspy.render_nb_json``
==============================





.. inheritance-diagram:: jyquickhelper.jspy.render_nb_json


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

module ``jyquickhelper.jspy.render_nb_json``

Helpers around JSON


:githublink:`%|py|6`




Classes
+++++++

+--------------------------------------------------------------------------+---------------------------------------------------------------------------+
| class                                                                    | truncated documentation                                                   |
+==========================================================================+===========================================================================+
| :class:`RenderJSON <jyquickhelper.jspy.render_nb_json.RenderJSON>`       | Renders :epkg:`JSON` using :epkg:`javascript`, outputs only :epkg:`HTML`. |
+--------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :class:`RenderJSONObj <jyquickhelper.jspy.render_nb_json.RenderJSONObj>` | Renders :epkg:`JSON` using :epkg:`javascript`.                            |
+--------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :class:`RenderJSONRaw <jyquickhelper.jspy.render_nb_json.RenderJSONRaw>` | Renders :epkg:`JSON` in a :epkg:`notebook` using :epkg:`renderjson`.      |
+--------------------------------------------------------------------------+---------------------------------------------------------------------------+




Functions
+++++++++

+-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                  | truncated documentation                                                                                                                                   |
+===========================================================+===========================================================================================================================================================+
| :func:`JSONJS <jyquickhelper.jspy.render_nb_json.JSONJS>` | Inspired from `Pretty JSON Formatting in IPython Notebook <http://stackoverflow.com/questions/18873066/pretty-json-formatting-in-ipython-notebook>`_. ... |
+-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+








Methods
+++++++

+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| method                                                                                           | truncated documentation                                                                                                               |
+==================================================================================================+=======================================================================================================================================+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_json.RenderJSON.__init__>`                      | Initialize with a :epkg:`JSON` data.                                                                                                  |
+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_json.RenderJSONObj.__init__>`                   | Initialize with a :epkg:`JSON` data.                                                                                                  |
+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <jyquickhelper.jspy.render_nb_json.RenderJSONRaw.__init__>`                   | Initialize with a :epkg:`JSON` data.                                                                                                  |
+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_copy_local <jyquickhelper.jspy.render_nb_json.RenderJSON._copy_local>`                | If *self.local*, copies javascript dependencies in the local folder.                                                                  |
+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_copy_local <jyquickhelper.jspy.render_nb_json.RenderJSONObj._copy_local>`             | If *self.local*, copies javascript dependencies in the local folder.                                                                  |
+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_copy_local <jyquickhelper.jspy.render_nb_json.RenderJSONRaw._copy_local>`             | If *self.local*, copies javascript dependencies in the local folder.                                                                  |
+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_ipython_display_ <jyquickhelper.jspy.render_nb_json.RenderJSONObj._ipython_display_>` |                                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <jyquickhelper.jspy.render_nb_json.RenderJSON._repr_html_>`                |                                                                                                                                       |
+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`generate_html <jyquickhelper.jspy.render_nb_json.RenderJSON.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_json.RenderJSONObj.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_json.RenderJSONRaw.generate_html>`            | Overloads method `_ipython_display_ <http://ipython.readthedocs.io/en/stable/config/integrating.html?highlight=Integrating%20>`_. ... |
+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+


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

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