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

Question

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

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

标签： jupyter-notebook

Answer 1

这个答案已经过时了。另请参阅下面的答案。

这可能不是您希望的答案。但是，它可能会帮助一些刚接触 JavaScript 开发的读者。

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

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

• 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. 使用谷歌浏览器开发工具，在扩展中设置断点并输入

Jupyter 

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

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

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

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

Jupyter.notebook.

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

另见

• 如何检查 Javascript 对象
• 如何显示一个对象的所有方法？
• https://www.codeproject.com/Articles/24549/How-to-Inspect-a-JavaScript-Object
• Chrome 开发者工具控制台 - 检查 JavaScript 对象

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

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

...