Document chart registry

[gordonwoodhull]

The interface needed to add external charts to dc is quite minimal; looks like it's just render, redraw, filterAll.

Verify this and document the chart registry so that people know how to add external charts.

[gordonwoodhull]

SO question that prompted this:

http://stackoverflow.com/questions/25336528/dc-js-listening-for-chart-group-render

[r4j4h]

There is also refocusAll

[r4j4h]

And if you want to participate in deregistering your chart you will need to provide a .anchorName() function that returns some kind of guid. I just generate a random integer with Math.random() * 1000000 << 0; in the constructor and save it as a member and I return that from my anchorName. Kind of a home-made _dcFlags identifier. Anything will work its just used as a key to remove it from the registry.

[brylie]

Subscribing to progress updates, as this would help with issue #966.

[nsubordin81]

The stack overflow question and this page on issues have been really helpful. Would documenting the chart registry consist of a pull request to edit the docs files? Seems like what is included here encompasses the majority of the interface for chartRegistry, so it would be worthwhile to get it recorded somewhere central, I just wasn't sure if that was the process.

What I did with this info is 'dc-ify' a chart from one of my favorite other chart libraries, Chart.js. It didn't need zoom controls and I didn't add an unregister feature yet (I should), but it is implementing the render, redraw, and filterAll methods. https://github.com/nsubordin81/Chart.dc.js

[gordonwoodhull]

Thanks @nsubordin81, yes that's all it would take.

I think I've gotten slightly distracted from this goal by #988 spinning off the chart registry, but we'll retain backward compatibility if we do that. And documentation will help the spin-off, as well as helping folks adapt other charts.

Thanks for the link to Chart.dc.js - once you're ready for people to use that, let's put a link to it somewhere. I'll check it out soon.

[nsubordin81]

Thanks @gordonwoodhull. I appreciate the backward compatibility, I'll hopefully be able to make this chart work with the generalized version as well later.

Thanks for the support, I only have the one chart right now which probably needs a lot of peer review and work, but I am willing to put it out there as a learning experience and to encourage other more experienced devs to help adapt the other chart.js charts and add features.

[gordonwoodhull]

That would be great. I think it will help people for sure.

As for the previous question, I realize I misread. What this ticket requires is editing the comments in the source files. The documentation is generated from there.

Specifically, it means adding comments to this source file:
https://github.com/dc-js/dc.js/blob/develop/src/core.js

In case you're still interested in helping with that. 😁

[gordonwoodhull]

Fixed by #1082