介绍
@jupyterlab/attachments 是一个 JupyterLab 插件,它允许用户在 JupyterLab 中查看和编辑附件。它接受以下类型的附件:JPEG,PNG,SVG,PDF,文本文件等。该 npm 包为开发者提供了一种简单的方式为他们的 JupyterLab 插件添加附件功能。
安装
您可以使用 npm 在您的项目中安装 @jupyterlab/attachments:
npm install @jupyterlab/attachments
使用
导入
导入 AttachmentsViewer 和 AttachmentsModel:
import { AttachmentsViewer, AttachmentsModel } from '@jupyterlab/attachments';
初始化
在添加附件之前,您需要实例化 AttachmentsViewer 和 AttachmentsModel。AttachmentsViewer 是在 JupyterLab 的主面板上显示附件的视图。AttachmentsModel 是附件的逻辑表示。
var viewer = new AttachmentsViewer(); var model = new AttachmentsModel();
添加附件
附件可以通过显式添加到 AttachmentsModel 中来添加,并且必须提供文件的名称和内容:
var name = 'my_image.png'; var content = 'data:image/png;base64,iVBORw0KG...'; model.add(name, content);
链接 AttachmentsModel 和 AttachmentsViewer
连接模型和视图,并将 AttachmentsViewer 添加到 JupyterLab 的主面板上:
viewer.model = model; app.shell.add(viewer, 'left', { rank: 200 });
示例
-- -------------------- ---- ------- ------ - ------------------ ---------------- - ---- -------------------------- -- --- ------ - ------ --- ------ - --- -------------------- --- ----- - --- ------------------- -- ----- --- ---- - --------------- --- ------- - ------------------------------------- --------------- --------- -- -------- ------------ - ------ -- - ----------------- --- ---------- ------ --------------------- ------- - ----- --- ---
这样就可以在 JupyterLab 中看到附件了!
结论
@jupyterlab/attachments 是一个非常有用且易于使用的 npm 包,使开发者可以轻松地将附件添加到他们的 JupyterLab 插件中。虽然此包的功能比较简单,但是它确实具有一定的深度和学习意义,对于 JupyterLab 开发者来说是一个很好的起点。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5f1fa8a0403f2923b035c61a