在哪里可以找到 sigma.js 的文档？

Question

我正在尝试测试 sigma.js (v2) 的限制，以确定它是否适合我们的项目。从我在各种示例应用程序中看到的情况来看，它看起来非常有前途。不幸的是，我无法找到适当的文档。

我能找到的只是演示应用程序和一些（看起来相当过时的）Wiki 子页面（即“设置”）。

基本上，我需要了解 SigmaJS 的功能集，并且我不想通过挖掘整个源代码来做到这一点；）

我目前正在寻找什么：

• 当我这样做时，我可以通过哪些全局设置？

  const sigmaRenderer = new Sigma(graph, container, settings);

• Sigma 中实现了哪些节点和边属性？

  例如，我可以像这样设置坐标、大小、类型和图像：

  graph.addNode("Node-A", {
    x: 0,
    y: 0,
    size: 10,
    type: "image",
    image: "my-image.png"
  })
  

  还有什么可能？还有哪些其他可能的类型选项？

• 在哪里可以找到受支持的事件侦听器的列表？返回对象的模型是什么？

• ETC。

是否有我错过的官方最新文档或 wiki？

Answer 1

Sigmajs 是用 typescript 编写的，因此很多信息可以直接在类型中获得。

如果您有一个处理打字稿的 IDE，您会看到自动完成以及您可以提供给构造函数的内容。

对于设置，您可以查看此链接https://github.com/jacomyal/sigma.js/blob/339be9ed274fcfb881ddd3585974ea7be46ca7dd/src/settings.ts#L34-L82

对于属性节点，您可以定义：

x: number;
y: number;
image: string;
label: string | null;
size: number;
color: string;
hidden: boolean;
forceLabel: boolean;
zIndex: number;
type: string; 

对于活动：

"clickNode",
  "rightClickNode",
  "downNode",
  "enterNode",
  "leaveNode",
  "doubleClickNode",
  "wheelNode",
  "clickEdge",
  "rightClickEdge",
  "downEdge",
  "enterEdge",
  "leaveEdge",
  "doubleClickEdge",
  "wheelEdge",
  "clickStage",
  "rightClickStage",
  "downStage",
  "doubleClickStage",
  "wheelStage",
  "kill",