search

jacomyal / sigma.js

A JavaScript library aimed at visualizing graphs of thousands of nodes and edges
https://www.sigmajs.org/
MIT License
11.29k stars 1.59k forks source link

Document the type attribute of edges #1436

Closed Picorims closed 4 months ago

Picorims commented 4 months ago

Is your feature request related to a problem? Please describe. The type attribute of the edge element is not documented in https://www.sigmajs.org/docs/advanced/data, making it hard to find how to, for example, use an arrow style without browsing Stack Overflow or other forums.

Describe the solution you'd like Add a bullet point in the edge attributes to describe the different available edge types.

Describe alternatives you've considered I tried figuring them out through the module @types/sigmajs or the EdgeDisplayData type from sigma/types, and while the type attribute is exposed, the possible values are not. The TypeScript section doesn't seem to indicate it either, or I couldn't find the information there.

Additional context None.

jacomyal commented 4 months ago

Thanks for the report, I just updated the doc page you pointed with some explanation on what's the edge type attribute is about.