Skip to content

Commit 302c16c

Browse files
fix(plotly.js): nested property attributes fix
This changes the shape of the PlotlyRelayoutEvent to use string based property access as per-discussion here: plotly/plotly.js#1877 See: https://plotly.com/javascript/plotlyjs-events/ https://plotly.com/javascript/zoom-events/#binding-to-zoom-events /cc @mmakrzem Thanks! Fixes: DefinitelyTyped#43735
1 parent 07e5a59 commit 302c16c

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

types/plotly.js/index.d.ts

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,21 +85,19 @@ export type PlotRestyleEvent = [
8585
number[] // array of traces updated
8686
];
8787

88-
export interface PlotAxis {
89-
range: [number, number];
90-
autorange: boolean;
91-
}
92-
9388
export interface PlotScene {
9489
center: Point;
9590
eye: Point;
9691
up: Point;
9792
}
9893

9994
export interface PlotRelayoutEvent {
100-
xaxis: PlotAxis;
101-
yaxis: PlotAxis;
102-
scene: PlotScene;
95+
"xaxis.range[0]": number;
96+
"xaxis.range[1]": number;
97+
"yaxis.range[0]": number;
98+
"yaxis.range[1]": number;
99+
"xaxis.autorange": boolean;
100+
"yaxis.autorange": boolean;
103101
}
104102

105103
export interface ClickAnnotationEvent {

types/plotly.js/test/index-tests.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -493,6 +493,15 @@ function rand() {
493493
}, [0]);
494494
});
495495

496+
myPlot.on('plotly_relayout', eventdata => {
497+
eventdata["xaxis.autorange"]; // $ExpectType boolean
498+
eventdata["xaxis.autorange"]; // $ExpectType boolean
499+
eventdata["xaxis.range[0]"]; // $ExpectType number
500+
eventdata["xaxis.range[1]"]; // $ExpectType number
501+
eventdata["yaxis.range[0]"]; // $ExpectType number
502+
eventdata["yaxis.range[1]"]; // $ExpectType number
503+
});
504+
496505
myPlot.on('plotly_restyle', (data) => {
497506
console.log('restyling');
498507
});

0 commit comments

Comments
 (0)