Sigma.js 是一个开源JavaScript库,旨在使用WebGL可视化数千个节点和边的图形,主要由 @jacomyal 和 @Yomguithereal 开发,并基于 graphology 构建。
如何在项目中使用
要将sigma集成到您的项目中,请按照以下简单步骤操作:
-
安装: 通过运行以下命令将
sigma
和graphology
添加到您的项目中:npm install sigma graphology
-
使用: 在您的JavaScript或TypeScript文件中导入sigma:
import Graph from "graphology"; import Sigma from "sigma";
然后,使用您的图形数据和目标容器创建一个新的
Sigma
实例:const graph = new Graph(); graph.addNode("1", { label: "节点1", x: 0, y: 0, size: 10, color: "blue" }); graph.addNode("2", { label: "节点2", x: 1, y: 1, size: 20, color: "red" }); graph.addEdge("1", "2", { size: 5, color: "purple" }); const sigmaInstance = new Sigma(graph, document.getElementById("container"));
如何在本地开发
要在本地运行 Storybook:
git clone git@github.com:jacomyal/sigma.js.git
cd sigma.js
npm install
npm run start
这将在您的网络浏览器中打开Storybook,当您修改故事或包源时,它会实时重新加载。
资源
- GitHub项目: Sigma.js的源代码和协作开发工作托管在 GitHub 上。
- 网站: 官方网站 sigmajs.org 由来自 Sciences-Po médialab 团队的 Robin de Mourat 精心设计,展示了该库的功能。
- 文档: 使用 Docusaurus 构建的详细文档可在 sigmajs.org/docs 获取。它为用户提供了广泛的指南和API参考。
- Storybook: 交互式示例可在 sigmajs.org/storybook 找到。
- 演示: 一个全面的演示可在 sigmajs.org/demo 获取,其中包含一个使用Sigma.js的功能齐全的基于React的Web应用程序。
如何贡献
您可以通过提交 问题票 和提出 拉取请求 来贡献。在提交任何拉取请求之前,请确保测试和代码检查通过。
您还可以浏览相关文档 这里。