benfred / venn.js

Area proportional Venn and Euler diagrams in JavaScript
MIT License
1.04k stars 217 forks source link

Use d3 namespace and naming conventions #88

Open ale0xb opened 7 years ago

ale0xb commented 7 years ago

Hello,

I found this repo listed in the D3 plugins wiki. It strikes me that it is the only plugin not using the "official" (d3-*) naming convention.

Also the plugin seems to be using a different namespace (venn). Wouldn't it be a good idea if it used d3.venn? So rollup would end up being:

rollup -g d3-selection:d3,d3-transition:d3 -f umd -n d3 -o build/venn.js -- index.js

I'd like to use these kind of layouts: d3-venn, which in turn use a lot of code in this repo. My point is I think the functionality in the other repo should be eventually integrated into this one (if the owner is happy with that), but at the moment the "d3 venn landscape" is a bit rough for newcomers like me to be honest.

I'm happy to contribute if help is needed but would require these issues to be sorted out first I think.

benfred commented 7 years ago

What functionality from d3-venn would you like to see integrated here?

This project predates the 'd3-*' naming convention. There are lots of project on the D3 plugins wiki that don't follow that naming style (listed under the 'V3' section) - it just seems that this is the only one that has had d3 v4 support added to it.

At this stage, I'm not changing the name of the project - its in too many different places, not all of which are in this repo (for example this R project has ported the main layout algorithm over and cites this project by name: https://github.com/jolars/eulerr ).

ale0xb commented 7 years ago

d3-venn follows the layout approach, which allows you to employ individual nodes to create the venn diagrams. (in opposition to using groups and sizes as it is now). That way you can do things like this or this. Venn diagrams could also be enhanced/customised much more easily. (eg: adding forces, etc).

Not changing the name of the project is fair enough, but what about using the d3 namespace? I think this is expected by a majority of users.