🤖 Merge PR DefinitelyTyped#73832 [plotly.js] Add missing hoversubplots property by @MysteryBlokHed

Author: MysteryBlokHed

types/plotly.js/index.d.ts

@@ -639,6 +639,15 @@ export interface Layout {
     hovermode: "closest" | "x" | "y" | "x unified" | "y unified" | false;
     hoverdistance: number;
     hoverlabel: Partial<HoverLabel>;
+    /**
+     * Determines expansion of hover effects to other subplots.
+     * If "single" just the axis pair of the primary point is included without overlaying subplots.
+     * If "overlaying" all subplots using the main axis and occupying the same space are included.
+     * If "axis", also include stacked subplots using the same axis
+     * when `hovermode` is set to "x", "x unified", "y" or "y unified".
+     * @default "overlaying"
+     */
+    hoversubplots: "single" | "overlaying" | "axis";
     calendar: Calendar;
 
     // these are just the most common nested property updates that you might

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

@@ -53,7 +53,8 @@ const layout = {
     datarevision: 0,
     editrevision: 0,
     selectionrevision: 0,
-};
+    hoversubplots: "overlaying",
+} satisfies Partial<Layout>;
 
 //////////////////////////////////////////////////////////////////////
 // Plotly.newPlot

types/plotly.js/v2/index.d.ts

@@ -642,6 +642,15 @@ export interface Layout {
     hovermode: "closest" | "x" | "y" | "x unified" | "y unified" | false;
     hoverdistance: number;
     hoverlabel: Partial<HoverLabel>;
+    /**
+     * Determines expansion of hover effects to other subplots.
+     * If "single" just the axis pair of the primary point is included without overlaying subplots.
+     * If "overlaying" all subplots using the main axis and occupying the same space are included.
+     * If "axis", also include stacked subplots using the same axis
+     * when `hovermode` is set to "x", "x unified", "y" or "y unified".
+     * @default "overlaying"
+     */
+    hoversubplots: "single" | "overlaying" | "axis";
     calendar: Calendar;
     "xaxis.range": [Datum, Datum];
     "xaxis.range[0]": Datum;

types/plotly.js/v2/test/core-tests.ts

@@ -49,7 +49,8 @@ const layout = {
     datarevision: 0,
     editrevision: 0,
     selectionrevision: 0,
-};
+    hoversubplots: "overlaying",
+} satisfies Partial<Layout>;
 
 //////////////////////////////////////////////////////////////////////
 // Plotly.newPlot