.. _l-classes:

Classes
=======

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


Summary
+++++++

+----------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                  | class parent | truncated documentation                                                                                                                                                                            |
+========================================================================================+==============+====================================================================================================================================================================================================+
| :class:`JavascriptScriptError <jyquickhelper.jspy.render_nb_js.JavascriptScriptError>` |              | Raised when the class does not find what it expects.                                                                                                                                               |
+----------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`JavascriptVisError <jyquickhelper.jspy.render_nb_js_vis.JavascriptVisError>`   |              | Raised when the code does not contain what the class expects to find.                                                                                                                              |
+----------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RenderJS <jyquickhelper.jspy.render_nb_js.RenderJS>`                           |              | Renders :epkg:`javascript`, only outputs :epkg:`HTML`.                                                                                                                                             |
+----------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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`.                                                                                                                               |
+----------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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:`RenderJsDot <jyquickhelper.jspy.render_nb_js_dot.RenderJsDot>`                 |              | Renders a graph in a :epkg:`notebook` defined in :epkg:`DOT` language with :epkg:`viz.js`. On `binder <https://mybinder.org/v2/gh/sdpython/jyquickhelper/ master?filepath=_doc%2Fnotebooks>`_, ... |
+----------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RenderJsVis <jyquickhelper.jspy.render_nb_js_vis.RenderJsVis>`                 |              | Renders a network in a :epkg:`notebook` with :epkg:`vis.js`.                                                                                                                                       |
+----------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`UrlNotFoundError <jyquickhelper.jspy.render_nb_js.UrlNotFoundError>`           |              | Raised when a url does not exist.                                                                                                                                                                  |
+----------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+