[charts][docs] Improve Charts export docs #17538
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oliviertassinari
added
docs
| @@ -63,6 +63,6 @@ As detailed in the [Composition](/x/react-charts/composition/) section, charts c | |||
| When exporting a chart, the `ChartsWrapper` element is considered the root element of the chart, and every descendant is included in the export. | |||
| As such, you need to ensure that the `ChartsWrapper` element is the root element of the chart you want to export. | |||
|
|
|||
| If you want to use a custom wrapper element, you need to use the `useChartRootRef` hook to set the reference to the chart's root element so that exporting works properly, as exemplified below. | |||
| If you want to use a custom wrapper element, you need to use the `useChartRootRef()` hook to set the reference to the chart's root element so that exporting works properly, as exemplified below. | |||
There was a problem hiding this comment.
function should be (), see style guide.
|
|
||
| ## Export as image | ||
|
|
||
| The `apiRef` prop also exposes a `exportAsImage()` method to export the chart as an image. | ||
|
|
||
| ### Dependency | ||
|
|
||
| For `exportAsImage()` to work, you need to add `rasterizehtml` as a dependency in your project. | ||
| For `exportAsImage()` to work, you need to add the`rasterizehtml` npm dependency in your project. |
There was a problem hiding this comment.
a bit clearer for people that wonder what a dependency is.
|
Deploy preview: https://deploy-preview-17538--material-ui-x.netlify.app/ Updated pages: |
CodSpeed Performance ReportMerging #17538 will not alter performanceComparing Summary
|
oliviertassinari
force-pushed
the
fix-typos
branch
from
b8bad3f to
0a6722a
Compare
oliviertassinari
force-pushed
the
fix-typos
branch
from
0a6722a to
bd27654
Compare
This was referenced Apr 27, 2025
bernardobelchior
approved these changes
Apr 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I noticed this from #17353 - https://deploy-preview-17353--material-ui-x.netlify.app/x/react-charts/export/.
I almost didn't see that the demos on the page were interactive (I couldn't see the call to action buttons).
Preview: https://deploy-preview-17538--material-ui-x.netlify.app/x/react-charts/export/