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

[docs] Use Netflix financial results to document bar charts #13991

Merged
merged 3 commits into from
Aug 13, 2024

Conversation

alexfauquette
Copy link
Member

@alexfauquette alexfauquette commented Jul 26, 2024

I took Netflix financial results from Yahoo Finance and used it to illustrate bar chart staking. The underlying idea is that financial data are composed of sub-data. For example, assets are divided into short-term and long-term ones, which is well suited for staked bars.

But I'm uncertain this helps to make the docs more appealing and do not disturb the learning aspect

image

https://deploy-preview-13991--material-ui-x.netlify.app/x/react-charts/bars/#bar-size
https://deploy-preview-13991--material-ui-x.netlify.app/x/react-charts/bars/#stacking

@alexfauquette alexfauquette added docs Improvements or additions to the documentation component: charts This is the name of the generic UI component, not the React module! labels Jul 26, 2024
@mui-bot
Copy link

mui-bot commented Jul 26, 2024

Deploy preview: https://deploy-preview-13991--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against bf9f814

{ dataKey: 'treas', stack: 'equity' },
])}
xAxis={[{ scaleType: 'band', dataKey: 'year' }]}
slotProps={{ legend: { hidden: true } }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to remove it? Seems like it could be helpful for the user to understand how the charts work 🤔

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The legend started to take too much space compared to the feature to display

image

Copy link
Member

@JCQuintas JCQuintas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small comment, otherwise looks good

Signed-off-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
Copy link

codspeed-hq bot commented Aug 13, 2024

CodSpeed Performance Report

Merging #13991 will not alter performance

Comparing alexfauquette:bar-dataset (bf9f814) with master (d5f2c0f)

Summary

✅ 3 untouched benchmarks

@alexfauquette alexfauquette merged commit 5070f8a into mui:master Aug 13, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: charts This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants