d3-org-tree 开源项目教程

2025-05-21 01:10:16作者：彭桢灵Jeremy

1. 项目介绍

d3-org-tree 是一个基于 d3.js v6 构建的高度可定制的组织树形图。它可以在现代浏览器如 Chrome、Edge、Firefox 和 Safari 中运行。除了 d3.js 外，该项目没有其他第三方依赖。d3-org-tree 提供了多种定制化功能，包括自定义节点样式、行为、高亮样式、布局方向、链接样式以及动画持续时间等。

2. 项目快速启动

首先，确保您的开发环境中已安装 Node.js 和 npm。

克隆项目到本地：

git clone https://github.com/benyasin/d3-org-tree.git

进入项目目录并安装依赖：
```
cd d3-org-tree
npm install
```

在项目中创建一个新的 HTML 文件，比如 index.html，并添加以下内容：

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title)d3-org-tree 示例</title>
</head>
<body>
    <div id="org-tree"></div>
    <script src="node_modules/d3-org-tree/dist/d3-org-tree.js"></script>
    <script>
        // 初始化组织树实例
        const orgTree = new OrgTree();
        orgTree.container('#org-tree')
            .data([
                // ... 数据示例
            ])
            .svgWidth(800)
            .svgHeight(600)
            .render();
    </script>
</body>
</html>

用浏览器打开 index.html 文件，您应该能看到一个基本的组织树形图。

3. 应用案例和最佳实践

数据结构

d3-org-tree 需要一个数组作为数据输入，每个对象代表一个节点：

const data = [
    {
        nodeId: 'O-1',
        parentNodeId: null,
        // ... 其他节点属性
    },
    {
        nodeId: 'O-2',
        parentNodeId: 'O-1',
        // ... 其他节点属性
    },
    // ... 更多节点
];

定制样式

您可以通过 .highlight() 方法定制当前节点的样式：

orgTree.highlight({
    borderWidth: 1,
    borderRadius: 15,
    borderColor: { red: 50, green: 255, blue: 30, alpha: 1 },
    backgroundColor: { red: 20, green: 100, blue: 40, alpha: 1 }
});

事件回调

您可以绑定事件回调来处理节点的点击、添加和删除：

orgTree.onNodeClick(nodeId => {
    console.log(nodeId + ' node clicked');
});

orgTree.onNodeAdd(nodeId => {
    console.log(nodeId + ' node added');
    // 添加节点的逻辑
});

orgTree.onNodeRemove(nodeId => {
    console.log(nodeId + ' node removed');
    // 删除节点的逻辑
});