Jupyter前端扩展JavaScript API的文档在哪里？

Question

我已经阅读了docs，有关编写Jupyter前端扩展，并学习了examples，现在可以自己构建简单的扩展了。

但是-Jupyter扩展JavaScript API的完整文档在哪里？如何找到用于笔记本属性和方法的JavaScript API？

Answer 1

这可能不是您希望的答案。但是，这可能对一些不熟悉JavaScript开发的读者有所帮助。

我也在寻找有关Jupyter客户端API的文档，但找不到官方文档。

可以在github存储库上找到JavaScript源代码，例如：

• https://github.com/jupyter/notebook/blob/859ae0ac60456c0e38b44f06852b8a24f8a1cfb0/notebook/static/notebook/js/notebook.js

• https://github.com/jupyter/notebook/blob/4.2.2/notebook/static/services/kernels/kernel.js

对我也有帮助的是

A。使用Google Chrome开发工具，在扩展程序中设置断点，然后输入

Jupyter 

在控制台中

。然后，您将获得可浏览的树结构，可用于检查Jupyter对象。该树结构似乎不包含方法。

B。记录对象的所有属性，包括方法。如果您想了解笔记本的使用方法，例如

for(var property in Jupyter.notebook){ console.log(property)}

C。在控制台中键入时，代码完成。例如，您可能要输入

Jupyter.notebook.

并查看有关如何完成命令的建议：

另请参见

• How to inspect Javascript Objects
• How to display all methods of an object?
• https://www.codeproject.com/Articles/24549/How-to-Inspect-a-JavaScript-Object
• Chrome Developer Tools console - inspect JavaScript object

开发工具控制台中的可浏览树结构：

如何列出包括方法的属性：

...

Answer 2

显然，没有前端 API 文档，因为有一个 open GitHub issue 甚至引用了您的 SO 问题。也许在这个问题上的几个 +1 可能会改变这一点，尽管我怀疑答案（如果有的话）会指向 JupyterLab，它有一个定义的 front-end API，但与 Jupyter Notebook 前端扩展没有共同的技术基础。