feat: pass scales and options to overlay snippet

gka · gka · commit a4250fb52fcd · 2025-07-08T17:14:13.000+02:00
diff --git a/src/lib/core/Plot.svelte b/src/lib/core/Plot.svelte
@@ -519,7 +519,20 @@
                 {/if}
             </FacetGrid>
         </svg>
-        {#if overlay}<div class="plot-overlay">{@render overlay?.()}</div>{/if}
+        {#if overlay}<div class="plot-overlay">
+                {@render overlay?.({
+                    width,
+                    height,
+                    options: plotOptions,
+                    scales: plotState.scales,
+                    mapXY,
+                    hasProjection,
+                    hasExplicitAxisX,
+                    hasExplicitAxisY,
+                    hasExplicitGridX,
+                    hasExplicitGridY
+                })}
+            </div>{/if}
     </div>
     {#if footer}
         <figcaption class="plot-footer">
diff --git a/src/lib/types/plot.ts b/src/lib/types/plot.ts
@@ -466,7 +466,7 @@ export type PlotOptions = {
      * The overlay snippet is useful for adding a layer of custom HTML markup
      * in front of the SVG body of your plot, e.g. for HTML tooltips.
      */
-    overlay: Snippet;
+    overlay: Snippet<[{ width: number; height: number; options: PlotOptions; scales: PlotScales }]>;
     facetAxes: Snippet;
     /**
      * if you set testid, the plot container will get a data-testid attribute which
