Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #353

Open
RobinClowers opened this issue Jul 6, 2023 · 1 comment
Open

Improve documentation #353

RobinClowers opened this issue Jul 6, 2023 · 1 comment

Comments

@RobinClowers
Copy link

I just started using Dagre, and while I really like it so far, I don't have a great understanding of many parts of the api. For example, the setGraph and setDefaultEdgeLabel functions seem to be for setting options on the graph and edges, but it would be great to have some api docs around these core functions.

@RobinClowers
Copy link
Author

Specifically related to the two functions I mentioned above, the wiki page has some comments about their use:

// Set an object for the graph label
g.setGraph({});

// Default to assigning a new object as a label for each new edge.
g.setDefaultEdgeLabel(function() { return {}; });

But looking at the code, these functions seem to be about more than just UI labels? Or does label have a specific meaning in graph domain?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant