@funnest/charts 0.6.17 → 0.6.18

package/dist/index.js

@@ -2412,6 +2412,25 @@ function drawMain(layer, m) {
     }
   }
   if (f.settings.gridVertical) for (const tick of f.timeTicks) p.vLine(tick.x, 0, f.panesHeight, pal.grid);
+  const o = m.objects;
+  const rc = { painter: p, coords: o.coords, palette: pal };
+  const runOverlay = (overlay) => {
+    ctx.save();
+    try {
+      overlay.render(rc);
+    } catch (error) {
+      console.error("[fnc] overlay", error);
+    }
+    ctx.restore();
+  };
+  if (o.overlays.some((x) => x.layer === "below")) {
+    ctx.save();
+    ctx.beginPath();
+    ctx.rect(0, main.top, f.plotWidth, main.height);
+    ctx.clip();
+    for (const overlay of o.overlays) if (overlay.layer === "below") runOverlay(overlay);
+    ctx.restore();
+  }
   const hasBars = f.range.to >= f.range.from;
   if (hasBars) {
     ctx.save();
@@ -2451,17 +2470,7 @@ function drawMain(layer, m) {
   ctx.beginPath();
   ctx.rect(0, main.top, f.plotWidth, main.height);
   ctx.clip();
-  const o = m.objects;
-  const rc = { painter: p, coords: o.coords, palette: pal };
-  for (const overlay of o.overlays) {
-    ctx.save();
-    try {
-      overlay.render(rc);
-    } catch (error) {
-      console.error("[fnc] overlay", error);
-    }
-    ctx.restore();
-  }
+  for (const overlay of o.overlays) if (overlay.layer !== "below") runOverlay(overlay);
   o.trading.render(rc, m.bars, o.barIndexAt, (i) => m.timeScale.indexToX(i), o.tradingLabels, badges);
   o.drawings.render(rc, badges, m.bars, o.barIndexAt);
   ctx.restore();

package/dist/objects/types.d.ts

@@ -29,6 +29,11 @@ export interface ObjectRenderContext {
  */
 export interface ChartOverlay {
     render(rc: ObjectRenderContext): void;
+    /**
+     * 'below': painted right after the grid, under the candles and indicators (an order-book
+     * heatmap, session shading). Default 'above'.
+     */
+    layer?: 'above' | 'below';
 }
 export type ObjectHit = {
     kind: 'drawing';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@funnest/charts",
-  "version": "0.6.17",
+  "version": "0.6.18",
   "description": "Canvas charting engine for financial charts",
   "keywords": [
     "chart",