Skip to content

[charts][docs] Document click listener for scatter composition #22809

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.

Sign up for GitHub

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
sai6855 merged 7 commits into from
Jun 16, 2026
Merged

[charts][docs] Document click listener for scatter composition #22809

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7a05630
[charts][docs] Document click listener for scatter composition
sai6855 Jun 15, 2026
602a99a
Merge branch 'master' into scatter-click
sai6855 Jun 15, 2026
0dc8fe4
trigger CI
sai6855 Jun 15, 2026
eabc284
Merge branch 'scatter-click' of https://github.com/sai6855/mui-x into…
sai6855 Jun 15, 2026
c1a5aff
update comment in API page
sai6855 Jun 15, 2026
6dd84bf
fix alex review
sai6855 Jun 16, 2026
c63009f
update docs
alexfauquette Jun 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/translations/api-docs/charts/scatter-plot/scatter-plot.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"componentDescription": "",
"propDescriptions": {
"onItemClick": {
"description": "Callback fired when clicking on a scatter item.",
"description": "Callback fired when a marker is clicked directly and <code>disableHitArea</code> is <code>true</code>. When <code>disableHitArea</code> is <code>false</code>, use <code>onItemClick</code> on the chart container to handle closest-point clicks.",
"typeDescriptions": {
"event": {
"name": "event",
Expand Down
12 changes: 10 additions & 2 deletions packages/x-charts/src/ScatterChart/ScatterPlot.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,15 @@ export interface ScatterPlotSlotProps extends ScatterSlotProps {

export type RendererType = 'svg-single' | 'svg-batch';

export interface ScatterPlotProps extends Pick<ScatterProps, 'onItemClick' | 'classes'> {
export interface ScatterPlotProps extends Pick<ScatterProps, 'classes'> {
className?: string;
/**
* Callback fired when a marker is clicked directly and `disableHitArea` is `true`.
* When `disableHitArea` is `false`, use `onItemClick` on the chart container to handle closest-point clicks.
* @param {MouseEvent} event Mouse event recorded on the `<svg/>` element.
* @param {ScatterItemIdentifier} scatterItemIdentifier The scatter item identifier.
Comment on lines +38 to +42

@alexfauquette alexfauquette Jun 16, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

That's true but at the ScatterChart level.

For the props of the ScatterPlot, the onItemClick will be trigger independently from the disableHitArea value.

This logic is just in the useScatterChartProps that

  • if disableHitArea=true => the onItemClick is propagated to the ScatterPlot
  • if disableHitArea=false => the onItemClick is propagated to the DataProvider

https://github.com/mui/mui-x/blob/master/packages/x-charts/src/ScatterChart/useScatterChartProps.ts#L75-L77

@sai6855 sai6855 Jun 16, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

wdyt now?

image

*/
onItemClick?: ScatterProps['onItemClick'];
/**
* Overridable component slots.
* @default {}
Expand Down Expand Up @@ -155,7 +162,8 @@ ScatterPlot.propTypes = {
// | To update them edit the TypeScript types and run "pnpm proptypes" |
// ----------------------------------------------------------------------
/**
* Callback fired when clicking on a scatter item.
* Callback fired when a marker is clicked directly and `disableHitArea` is `true`.
* When `disableHitArea` is `false`, use `onItemClick` on the chart container to handle closest-point clicks.
* @param {MouseEvent} event Mouse event recorded on the `<svg/>` element.
* @param {ScatterItemIdentifier} scatterItemIdentifier The scatter item identifier.
*/
Expand Down
Loading