跳到主要内容

Diagram Editor 初始化

本文介绍了在页面中显示 Diagram Editor 的流程。要初始化编辑器,您需要引入编辑器专用的源文件,并使用 DiagramEditor 实例。除此之外,初始化阶段与 Diagram 组件的初始化过程相同:

<!DOCTYPE html>
<html>
<head>
<script type="text/javascript" src="../codebase/diagramWithEditor.js"></script>
<link rel="stylesheet" href="../codebase/diagramWithEditor.css">
</head>

<body>
<div id="editor_container"></div>
<script>
// 准备数据
const data = [
{ id: 1, x: 100, y: 40, text: "Start", type: "start", height: 50 },
{ id: 2, x: 100, y: 170, text: "Operation 1", type: "output" },
{ id: 3, x: 100, y: 300, text: "Operation 2", type: "input" },
{ from: 1, to: 2 },
{ from: 2, to: 3 }
// 更多对象
];

// 创建 Diagram Editor
const editor = new dhx.DiagramEditor("editor_container", {
// 配置选项
});

// 将数据加载到编辑器中
editor.parse(data);
</script>
</body>
</html>

引入所需的代码文件

要创建 Diagram Editor,您需要在页面中引入 2 个源文件:

  • diagramWithEditor.js
  • diagramWithEditor.css

请确保为这些文件设置了正确的相对路径:

<script type="text/javascript" src="../codebase/diagramWithEditor.js"></script>
<link rel="stylesheet" href="../codebase/diagramWithEditor.css">

通过 npm 或 yarn 安装 Diagram Editor

您可以使用 yarnnpm 包管理器,将 JavaScript Diagram Editor 引入到您的项目中。

通过 npm 或 yarn 安装试用版 Diagram Editor

信息

如果您想使用 Diagram Editor 的试用版本,请下载试用版 Diagram 软件包,并按照 README 文件中说明的步骤操作。请注意,试用版 Diagram Editor 仅可使用 30 天。

通过 npm 或 yarn 安装 PRO 版 Diagram Editor

信息

您可以在客户专区中生成您的 npm 登录名和密码,从而直接访问 DHTMLX 的私有 npm。该页面还提供了详细的安装指南。请注意,只有在您的 Diagram 专有许可处于有效状态时,才能访问私有 npm

初始化 Diagram Editor

您可以在容器中、文档主体中,或在布局单元格中初始化 Diagram Editor。

在容器中初始化

要在容器中初始化 Diagram Editor,请使用 dhx.DiagramEditor 构造函数,并向构造函数传入以下两个参数:

  • 用于放置 Diagram Editor 的容器,我们将其 id 设为 "editor_container"
index.html
<div id="editor_container"></div>
  • 一个包含配置属性的对象。如果未向构造函数传入该参数,将应用默认设置
index.js
const editor = new dhx.DiagramEditor("editor_container", {
type: "default" // "default" | "org" | "mindmap"
});

在文档主体中初始化

您也可以跳过为 Diagram Editor 设置容器的步骤,直接将其添加到文档主体中:

const editor = new dhx.DiagramEditor(document.body, {
type: "default" // "default" | "org" | "mindmap"
});

在布局单元格中初始化

您还可以在 Layout 单元格中初始化编辑器。在这种情况下,请使用 null 代替容器:

const editor = new dhx.DiagramEditor(null, {
type: "default" // "default" | "org" | "mindmap"
});
const layout = new dhx.Layout("layout", {
cols: [
{
id: "diagram_editor"
}
]
});

layout.getCell("diagram_editor").attach(editor);

配置属性

要更改编辑器的配置,您可以在作为构造函数第二个参数传入的配置对象中指定所需的属性。

const editor = new dhx.DiagramEditor("editor_container", {
type: "default", // "default" | "org" | "mindmap"
shapeBarWidth: 320,
lineGap: 20
});

属性

查看 Editor 的完整配置属性列表

将数据加载到 Diagram Editor 中

您可以通过编辑器的 parse() 方法,将适用的数据集加载到编辑器中。