-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
[charts][docs] Improve Charts export docs #17538
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,8 @@ | ||
<ScatterChartPro | ||
apiRef={apiRef} | ||
height={300} | ||
series={[ | ||
{ | ||
label: 'Series A', | ||
data: data.map((v) => ({ x: v.x1, y: v.y1, id: v.id })), | ||
}, | ||
{ | ||
label: 'Series B', | ||
data: data.map((v) => ({ x: v.x1, y: v.y2, id: v.id })), | ||
}, | ||
]} | ||
/> | ||
<Button onClick={() => apiRef.current?.exportAsPrint()}>Print</Button> | ||
<Button | ||
onClick={() => apiRef.current!.exportAsPrint()} | ||
variant="contained" | ||
sx={{ mb: 1 }} | ||
> | ||
</Button> | ||
<ScatterChartPro apiRef={apiRef} height={300} series={series} /> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,7 +12,7 @@ Export is available on the **Pro**[<span class="plan-pro"></span>](/x/introducti | |
|
||
## Print/Export as PDF | ||
|
||
The `apiRef` prop exposes a `exportAsPrint` method that can be used to open the browser's print dialog. | ||
The `apiRef` prop exposes a `exportAsPrint()` method that can be used to open the browser's print dialog. | ||
|
||
The print dialog allows you to print the chart or save it as a PDF, as well as configuring other settings. | ||
|
||
|
@@ -24,7 +24,7 @@ The `apiRef` prop also exposes a `exportAsImage()` method to export the chart as | |
|
||
### 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. | ||
|
||
<codeblock storageKey="package-manager"> | ||
|
||
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. function should be |
||
|
||
{{"demo": "ExportCompositionNoSnap.js"}} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a bit clearer for people that wonder what a dependency is.