IPyDrawio

演示	文档	安装	建造

JupyterLab的Drawio图。与来自 QuantStack/jupyterlab-drawio 的 ❤️ 分叉。

安装·历史·路线图· 贡献·开源

这是测试版软件。使用这些工具创建的本机 drawio 文件应该可以与任何其他drawio客户端一起使用，但任何 UI/API 都可能随时更改。

安装

mamba install -c conda-forge ipydrawio  # recommended, or...
conda install -c conda-forge ipydrawio  # or...
pip install ipydrawio[all]

特征

• ipydrawio
  • 全面支持 JupyterLab
  • 全力支持 JupyterLiteⓁ 和 RetroLabⓡ
  • 编辑多页文档
    • 具有与diagrams.net几乎相同的 UI 和功能
    • 多种文件格式
      • Drawio/mxgraph XML、SVG、PNG
      • 或 Jupyter 笔记本ⓡ
    • 包含所有 Drawio 模板ⓡ
      • 加上一些 Jupyter
  • Jupyter丰富的显示输出
  • Jupyter小部件
  • 基本协同编辑
    • 需要--collaborative标志，在 JupyterLab 3.1+ 中添加
    • 令牌共享、la jupyterlab-link-share或自定义连接器（尚不清楚）
    • 没有其他编辑器的存在指示器
• ipydrawio-export
  • 从图表导出打印质量的 PDF Ⓛⓡ
    • 可选择包含可编辑的 Drawio XML 作为 PDF 附件

    • 注意：推荐一些重的，可能是脆弱的依赖项mamba

      mamba install -c conda-forge ipydrawio-export  # recommended, or...
      conda install -c conda-forge ipydrawio-export  # or...
      pip install ipydrawio ipydrawio-export
      

ⓡ：在 RetroLab 中不可用Ⓛ：在 JupyterLite 中不可用

例子

笔记	截图/示例
带有导出选项的 drawio“最小”UI 的屏幕截图
交互式计算海报的开始
该项目的混合计算/创意路线图	需要截图

用法

请参阅文档以获取完整信息

• 试一下
  • 或按照安装说明启动 JupyterLab
• 通过执行以下操作之一打开图表：
  • 从启动器创建 图表_
  • 使用文件管理器上传在diagrams.net上创建的图表并双击它
  • IPython通过交互式计算构建图表ipydrawio.Diagram
  • 使用application/x-drawioMIME 渲染器
• 使用命令面板将图表导出为各种格式

  • 注意：drawio 的一些内置 UI 功能在 JupyterLab 的 IFrame 中无法正常工作，并且难以彻底禁用：请参阅命令面板和各种主菜单菜单中可用的图表 选项。

配置

用户界面主题

您可以在 JupyterLab 主菜单中更改默认主题：

• 打开设置
• 打开图表主题
• 选择你的主题
• 所有打开的文档都将更改为此主题（如果未保存则提示）
• 以后的所有文档都将使用这个主题

不同的主题有一些优点和缺点：

请注意，这rough将改变多少形状的外观

Drawio 配置和 URL 参数

使用高级设置修改drawio嵌入参数

请参阅架构以获取（已知）支持选项的完整详细信息以及所有参数的 上游文档，尽管 IPyDrawio 可能不支持它们......但。

PDF：实验室和服务器扩展

ipydrawio-export可以生成打印质量的 PDF。这种方法依赖于由@jgraph/draw-image-export2、puppeteer和提供支持的无头浏览器nodejs。

• 安抚所需的本机依赖项puppeteer
  • 如果运行docker，这可能有点试错
  • 有关更多信息，请参阅活页夹和 CI。
• nodejs>10,<14来自conda或您的系统包管理器
  • 注意：这依赖于在第一次使用时能够安装puppeteer（以及其他任意依赖项）jlpm
    • 我们很快就会找到更好的方法
• pip install ipydrawio-export或者conda install -c conda-forge ipydrawio-export

例如安装所有依赖项：

conda install -yc conda-forge ipydrawio-export

安装后，您可以使用浏览器内工具将图表导出为 PDF以及命令行：

jupyter ipydrawio-export <name of document>

开源

执照

除非另有说明，否则此处的所有文件都是在Apache 2.0下获得许可的免费软件。

版权

此扩展的版权所有者是此存储库的贡献者。

JupyterLab 组件的一部分源自QuantStack/jupyterlab-drawio。

drawio 和 drawio-export 的版权所有者是jgraph。

此包中提供的原始源代码来自：

• @jgraph/drawio
• @jgraph/draw-image-export2

Copyright 2022 ipydrawio contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.