@rowsncolumns/charts 28.1.14 → 28.1.15

package/dist/esm/utils/echarts-overlays.js

@@ -14,7 +14,7 @@
  *     trendline is a regression of Y on X (#1067).
  */
 import { computeErrorBars, resolveCustomErrorBarValues } from "./error-bars";
-import { computeTrendline } from "./trendline";
+import { computeTrendline, trendlineLabel } from "./trendline";
 const ERROR_BAR_CAP_HALF = 5;
 /**
  * Build the overlay series for one data series. Returns an empty array
@@ -39,9 +39,23 @@ export const buildEchartsOverlaySeries = ({ series, values, xValues, horizontal
             continue;
         const tlName = tl.name ??
             `${dataLabel ? dataLabel + " " : ""}${tl.type ?? "linear"} trend`;
+        // Excel's "Display Equation" / "Display R-squared" sit at the line's end.
+        const label = trendlineLabel(tl, result);
         overlays.push({
             type: "line",
             name: tlName,
+            ...(label
+                ? {
+                    endLabel: {
+                        show: true,
+                        formatter: label,
+                        color: tl.color ?? seriesColor,
+                        fontSize: 11,
+                        offset: [4, 0],
+                    },
+                    labelLayout: { moveOverlap: "shiftY" },
+                }
+                : {}),
             // On a category chart the index x overlays the category axis even
             // when forecasting extends beyond the data range; a horizontal bar
             // keeps its categories on y.

package/dist/esm/utils/series-name.d.ts

@@ -0,0 +1,12 @@
+import type { ChartData, SheetRange } from "@rowsncolumns/spreadsheet";
+/**
+ * A series' name as Excel shows it: the current text of its header cell
+ * when the name is linked to one (`dataLabelSource`), else `undefined` so
+ * the caller falls back to the literal / formula `dataLabel`.
+ *
+ * The cell is read with the hidden rows and columns included — Excel keeps
+ * a series' name when its header row is hidden — and a blank cell yields
+ * the cached `dataLabel`, which is what Excel's `<c:strCache>` is for.
+ */
+export declare const linkedSeriesName: (entry: Pick<ChartData, "dataLabel" | "dataLabelSource"> | undefined, getDomainValuesFromRange: (range: SheetRange, hiddenDimensionStrategy?: "SHOW_ALL" | "SKIP_HIDDEN_ROWS_AND_COLUMNS" | null) => (string | number | null | undefined)[] | undefined) => string | undefined;
+//# sourceMappingURL=series-name.d.ts.map

package/dist/esm/utils/series-name.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"series-name.d.ts","sourceRoot":"","sources":["../../../utils/series-name.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAEvE;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAC3B,OAAO,IAAI,CAAC,SAAS,EAAE,WAAW,GAAG,iBAAiB,CAAC,GAAG,SAAS,EACnE,0BAA0B,CACxB,KAAK,EAAE,UAAU,EACjB,uBAAuB,CAAC,EAAE,UAAU,GAAG,8BAA8B,GAAG,IAAI,KACzE,CAAC,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,GAAG,SAAS,KACtD,MAAM,GAAG,SAaX,CAAC"}

package/dist/esm/utils/series-name.js

@@ -0,0 +1,24 @@
+/**
+ * A series' name as Excel shows it: the current text of its header cell
+ * when the name is linked to one (`dataLabelSource`), else `undefined` so
+ * the caller falls back to the literal / formula `dataLabel`.
+ *
+ * The cell is read with the hidden rows and columns included — Excel keeps
+ * a series' name when its header row is hidden — and a blank cell yields
+ * the cached `dataLabel`, which is what Excel's `<c:strCache>` is for.
+ */
+export const linkedSeriesName = (entry, getDomainValuesFromRange) => {
+    const source = entry?.dataLabelSource;
+    if (!source)
+        return undefined;
+    const cell = {
+        ...source,
+        endRowIndex: source.startRowIndex,
+        endColumnIndex: source.startColumnIndex,
+    };
+    const value = getDomainValuesFromRange(cell, "SHOW_ALL")?.[0];
+    if (value === null || value === undefined || value === "") {
+        return entry?.dataLabel ?? "";
+    }
+    return String(value);
+};

package/dist/esm/utils/trendline.d.ts

@@ -57,4 +57,13 @@ export declare const computeTrendline: (values: (number | null | undefined)[], s
     forecastForward?: number | null;
     forecastBackward?: number | null;
 }, xValues?: (number | null | undefined)[] | null) => TrendlineResult | null;
+/**
+ * The label Excel prints next to a trendline when "Display Equation on
+ * chart" / "Display R-squared value on chart" are on — one line each, or
+ * `undefined` when neither is requested or the fit has no equation.
+ */
+export declare const trendlineLabel: (spec: {
+    showEquation?: boolean | null;
+    showRSquared?: boolean | null;
+}, result: Pick<TrendlineResult, "equation" | "rSquared">) => string | undefined;
 //# sourceMappingURL=trendline.d.ts.map

package/dist/esm/utils/trendline.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trendline.d.ts","sourceRoot":"","sources":["../../../utils/trendline.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,MAAM,MAAM,aAAa,GACrB,QAAQ,GACR,KAAK,GACL,KAAK,GACL,MAAM,GACN,OAAO,GACP,WAAW,CAAC;AAEhB,6FAA6F;AAC7F,MAAM,MAAM,cAAc,GAAG;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtD,MAAM,MAAM,eAAe,GAAG;IAC5B,sEAAsE;IACtE,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,uEAAuE;IACvE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB,CAAC;AAkKF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,EACrC,OAAM;IACJ,IAAI,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B,EACN,UAAU,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,GAAG,IAAI,KAC7C,eAAe,GAAG,IA+HpB,CAAC"}
+{"version":3,"file":"trendline.d.ts","sourceRoot":"","sources":["../../../utils/trendline.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,MAAM,MAAM,aAAa,GACrB,QAAQ,GACR,KAAK,GACL,KAAK,GACL,MAAM,GACN,OAAO,GACP,WAAW,CAAC;AAEhB,6FAA6F;AAC7F,MAAM,MAAM,cAAc,GAAG;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtD,MAAM,MAAM,eAAe,GAAG;IAC5B,sEAAsE;IACtE,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,uEAAuE;IACvE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB,CAAC;AAkKF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,EACrC,OAAM;IACJ,IAAI,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B,EACN,UAAU,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,GAAG,IAAI,KAC7C,eAAe,GAAG,IA+HpB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM;IAAE,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAAC,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CAAE,EACtE,QAAQ,IAAI,CAAC,eAAe,EAAE,UAAU,GAAG,UAAU,CAAC,KACrD,MAAM,GAAG,SAOX,CAAC"}

package/dist/esm/utils/trendline.js

@@ -328,3 +328,17 @@ export const computeTrendline = (values, spec = {}, xValues) => {
         equation,
     };
 };
+/**
+ * The label Excel prints next to a trendline when "Display Equation on
+ * chart" / "Display R-squared value on chart" are on — one line each, or
+ * `undefined` when neither is requested or the fit has no equation.
+ */
+export const trendlineLabel = (spec, result) => {
+    const lines = [];
+    if (spec.showEquation && result.equation)
+        lines.push(result.equation);
+    if (spec.showRSquared && result.rSquared !== null) {
+        lines.push(`R² = ${result.rSquared.toFixed(4)}`);
+    }
+    return lines.length ? lines.join("\n") : undefined;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rowsncolumns/charts",
-  "version": "28.1.14",
+  "version": "28.1.15",
   "author": "Vinay M",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "./dist/cjs/index.js",
@@ -70,9 +70,9 @@
     "@rowsncolumns/common-types": ">=5.3.2",
     "@rowsncolumns/grid": ">=13.2.35",
     "@rowsncolumns/icons": ">=7.2.33",
-    "@rowsncolumns/spreadsheet": ">=10.4.12",
+    "@rowsncolumns/spreadsheet": ">=10.4.13",
     "@rowsncolumns/spreadsheet-state": ">=29.1.8",
-    "@rowsncolumns/toolkit": ">=24.5.12",
+    "@rowsncolumns/toolkit": ">=24.5.13",
     "@rowsncolumns/ui": ">=16.0.4",
     "@rowsncolumns/utils": ">=9.5.5",
     "@types/react-plotly.js": "^2.6.3",