search

apache / echarts

Apache ECharts is a powerful, interactive charting and data visualization library for browser
https://echarts.apache.org
Apache License 2.0
60.14k stars 19.6k forks source link

Documentation Assistance [Documentation] #20224

Open langejay opened 1 month ago

langejay commented 1 month ago

What problem does this feature solve?

I am trying to exctract information from the documentation that would look something like this:

{ "type": { "Format": "LabelList", "Description": "Type of chart.", "Example": "bar", "Labels": ["line", "bar", "pie", "scatter", "effectScatter", "radar", "tree", "treemap", "sunburst", "boxplot", "candlestick", "heatmap", "map", "parallel", "lines", "graph", "sankey", "funnel", "gauge", "pictorialBar", "themeRiver", "custom"], "Link": "https://echarts.apache.org/en/option.html#series-bar.type", ChartType: [line, scatter,...] },

or 

"label.position": {
"Format": "LabelList",
"Description": "Position of the label.",
"Example": "inside",
"Labels": ["top", "left", "right", "bottom", "inside", "insideLeft", "insideRight", "insideTop", "insideBottom", "insideTopLeft", "insideTopRight", "insideBottomLeft", "insideBottomRight"],
"Link": "https://echarts.apache.org/en/option.html#series-bar.label.position"
 ChartType: [line, scatter,...]

},

An extraction of this information would be invaluable to me if someone has already done something like this or if the developers might be able to assist.

What does the proposed API look like?

This information would allow me to develop a subset of options in a developers user interface based on what they are working on and limit the possibility or errors and looking through the website to find the address of the property they are trying to change.

I have tried ChatGPT, Claude, WebCrawlers and more to try and extract the data, but it is not accurate enough for me.

Please help :-)

langejay commented 1 month ago

Note that the Formats that I am personally after are Value Percent Boolean Color String LabelList (a string with a predefined set of applicable strings)

Anything like this would be very helpful.