Full API?

[mqklin]

I've asked this question at stackoverflow, but got -2 and question was closed

I've read all the docs and can't find a full basic API: for example, which options does data option have? I know there are labels and datasets, but what else? Or this is a complete list?

I can't even understand how can I can configure Chart. There are type, data, options, and what else? Where is the full list of options I can pass to Chart?

[etimberg]

@mqklin unfortunately there is no single list of all the options, rather it is spread across the pages of the documentation.

[mqklin]

@etimberg is there something that is not spread? I mean, spread is ok, I can read all the docs, but if some option isn't even in some example, I have no chances to find it!

[Hedva]

Yea something like DiscordJS has is really useful.

I'm willing to help if someone can start a stub.

[etimberg]

@Hedva @mqklin I think the closest to find something not spread is to read the code and look for the default options which is usually a pretty good start.

Way back in chartjs v1 the options were documented as a single <code> block with a JSON file of the default options an what they did. It was really nice and simple but it didn't scale well. I'm definitely open to ideas on how to improve this. I like the DiscordJS link, perhaps something like that could be auto generated from the codebase?

[Hedva]

@etimberg what about JSDoc, and use some template like

• DocDash
• DocStrap
• minami
• any other

I'm not familiar with the exact DiscordJS documentation generator tho. Haven't looked into it but it could be their own CSS styling based on the default JSDoc output, or something else.

http://usejsdoc.org/

[simonbrunel]

Maybe a clean and simple markdown table would be enough (and more user friendly), linking to related sections with detailed description, something very similar to https://chartjs-plugin-datalabels.netlify.com/options. And it will be integrated in the existing docs.

If we are going to comment options directly in our code, I would go with jsdoc comments and https://doclets.io/. I already did this in the datalabels plugin and I think it's a good template. We also have a very few comment in this repo but still a huge work to document everything.

Anyway, I think I prefer option 1.

[Hedva]

Markdown is probably easier and faster on short term. But I think with JSDoc + Doclets.io, the documentation will be more complete over time. Also, we can write contributing guidelines where we can ask to include JSDoc when needed.

I also really like the Doclets interface. It's better than DocDash of DocStrap.

[simonbrunel]

The big plus with Doclets is that we don't need to setup CI to deploy the documentation online.

[etimberg]

Markdown seems like the way to go for now. Not sure how hard of an effort it is to make the table in the first place

[travbeamo]

Has there been any progress on this?

[etimberg]

@simonbrunel, @kurkle, and I have been discussing this quite recently. We've been trying to figure out a way to simplify the default options such that every option is the same between the global defaults, chart type defaults, and instance level. We haven't yet agreed to a solution, but we are thinking about it and if we do make a change, we'd like to do it soon to get it into v3.0.0.

Recent v3 beta versions have been shipping with their own typescript types. Those should be fairly complete.

[etimberg]

With the release of v3.0.0 we now have generated Typedoc documentation from the typescript definitions. These should be complete.

For example, to view the chart configuration https://www.chartjs.org/docs/latest/api/interfaces/chartconfiguration.html