.. _l-functions:

Functions
=========

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


Summary
+++++++

+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                               | class parent | 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>`_. ... |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_add_notebook_menu_js <jyquickhelper.helper_in_notebook._add_notebook_menu_js>`                 |              |                                                                                                                                                           |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_setup_hook <jyquickhelper._setup_hook>`                                                        |              | if this function is added to the module, the help automation and unit tests call it first before anything goes on ...                                     |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`add_notebook_menu <jyquickhelper.helper_in_notebook.add_notebook_menu>`                         |              | Adds :epkg:`javascript` and :epkg:`HTML` to the notebook which gathers all in the notebook and builds a menu.                                             |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`check <jyquickhelper.check>`                                                                    |              | Checks the library is working. It raises an exception. If you want to disable the logs:                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`check_url <jyquickhelper.jspy.render_nb_js.check_url>`                                          |              | Checks urls.                                                                                                                                              |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`install_extension <jyquickhelper.js.install_extension>`                                         |              | Installs an extension.                                                                                                                                    |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_extension <jyquickhelper.helper_in_notebook.load_extension>`                               |              | install an extension, checks first it exists, if not displays an exception with the list of them                                                          |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_extension <jyquickhelper.js.load_extension>`                                               |              | Loads an extension.                                                                                                                                       |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`set_notebook_name_theNotebook <jyquickhelper.helper_in_notebook.set_notebook_name_theNotebook>` |              | This function must be called from the notebook you want to know the name. It relies on a javascript piece of code. ...                                    |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.c3.version>`                                                          |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.custom.version>`                                                      |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.cytoscape.version>`                                                   |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.d3.version>`                                                          |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.eve.version>`                                                         |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.mermaid.version>`                                                     |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.pig.version>`                                                         |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.raphael.version>`                                                     |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.renderjson.version>`                                                  |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.svg.version>`                                                         |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.svgpanzoom.version>`                                                  |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.treant.version>`                                                      |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.visjs.version>`                                                       |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`version <jyquickhelper.js.vizjs.version>`                                                       |              | version                                                                                                                                                   |
+--------------------------------------------------------------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+