dagrejs / dagre-d3

A D3-based renderer for Dagre
MIT License
2.84k stars 587 forks source link

About the API doc #333

Open CatOnCoCle opened 6 years ago

CatOnCoCle commented 6 years ago

Does this project have API documents? It doesn't seem to be in its wiki. If it exists, where can I see it? I‘m confused about what usage or method darge-d3 can provide, except for a part of demo. Now i have to console.log(g) to see its proto method and try it, but it's not very....emmmm, effective.

CatOnCoCle commented 6 years ago

image

SolAZDev commented 4 years ago

I'd like to reopen this issue. Sure it's necroposting, or reviving something old, but we seriously don't have a documentation. At least I can't seem to find one, not for dagre-d3 nor dagre itself.

knightswatch3 commented 4 years ago

Well,this is quite frustrating. I am trying to find the documentation since ages. Couldn't find one.

smetroid commented 4 years ago

Not sure if this is what you guys are looking for https://github.com/dagrejs/graphlib/wiki/API-Reference ... it seems to be used by dagre and therefore dagre-d3

curtain-MO commented 3 years ago

I'd like to reopen this issue.

fwx5618177 commented 2 years ago

I think need to add this url in root ReadMe doc. api url: https://github.com/dagrejs/graphlib/wiki/API-Reference