@rowsncolumns/charts 28.1.18 → 28.1.19

package/dist/cjs/utils/overrides.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildSeriesLabelOption = exports.resolveSeriesDataLabels = exports.dataLabelFormatter = exports.applyAxisOverrides = exports.applyLegendOverrides = exports.textFormatToEchartsTextStyle = exports.themedTextStyle = void 0;
+exports.buildSeriesLabelOption = exports.resolveSeriesDataLabels = exports.dataLabelFormatter = exports.applyAxisOverrides = exports.DISPLAY_UNITS = exports.applyLegendOverrides = exports.textFormatToEchartsTextStyle = exports.themedTextStyle = exports.CHART_TITLE_PX = exports.CHART_TEXT_PX = exports.fontSizePx = exports.pointsToPixels = void 0;
 var tslib_1 = require("tslib");
 var axis_number_format_1 = require("./axis-number-format");
 // Map ChartSpec.legend / dataLabels / axisOptions to ECharts option
@@ -17,14 +17,32 @@ var axis_number_format_1 = require("./axis-number-format");
  * Underline / strikethrough have no canvas text decoration in echarts and
  * are not drawn.
  */
+/**
+ * `ChartTextFormat.fontSize` is in points (OOXML `sz` / 100, the editor's
+ * Size field); echarts draws pixels. 9 pt → 12 px, 14 pt → 18.67 px.
+ */
+var pointsToPixels = function (points) {
+    return Math.round(((points * 4) / 3) * 100) / 100;
+};
+exports.pointsToPixels = pointsToPixels;
+/** An authored point size as pixels, or `fallbackPx` when none is set. */
+var fontSizePx = function (points, fallbackPx) {
+    return typeof points === "number" && points > 0 ? (0, exports.pointsToPixels)(points) : fallbackPx;
+};
+exports.fontSizePx = fontSizePx;
+/**
+ * Excel's chart text defaults (Office 2013+ chart styles): the theme's body
+ * (minor) font, 9 pt in Text 1 at 65% (#595959 on the light theme), and a
+ * 14 pt regular title (RD-24).
+ */
+exports.CHART_TEXT_PX = (0, exports.pointsToPixels)(9);
+exports.CHART_TITLE_PX = (0, exports.pointsToPixels)(14);
 var themedTextStyle = function (fmt, defaults) {
     var _a, _b, _c, _d;
     return ({
         color: (_a = fmt === null || fmt === void 0 ? void 0 : fmt.color) !== null && _a !== void 0 ? _a : defaults.color,
         fontFamily: (_c = (_b = fmt === null || fmt === void 0 ? void 0 : fmt.fontFamily) !== null && _b !== void 0 ? _b : defaults.fontFamily) !== null && _c !== void 0 ? _c : "sans-serif",
-        fontSize: typeof (fmt === null || fmt === void 0 ? void 0 : fmt.fontSize) === "number" && fmt.fontSize > 0
-            ? fmt.fontSize
-            : defaults.fontSize,
+        fontSize: (0, exports.fontSizePx)(fmt === null || fmt === void 0 ? void 0 : fmt.fontSize, defaults.fontSize),
         fontWeight: (fmt ? (fmt.bold ? "bold" : "normal") : (_d = defaults.fontWeight) !== null && _d !== void 0 ? _d : "normal"),
         fontStyle: ((fmt === null || fmt === void 0 ? void 0 : fmt.italic) ? "italic" : "normal"),
     });
@@ -39,8 +57,9 @@ var textFormatToEchartsTextStyle = function (fmt) {
         result.color = fmt.color;
     if (fmt.fontFamily)
         result.fontFamily = fmt.fontFamily;
-    if (typeof fmt.fontSize === "number")
-        result.fontSize = fmt.fontSize;
+    if (typeof fmt.fontSize === "number" && fmt.fontSize > 0) {
+        result.fontSize = (0, exports.pointsToPixels)(fmt.fontSize);
+    }
     if (fmt.bold)
         result.fontWeight = "bold";
     if (fmt.italic)
@@ -97,14 +116,40 @@ var applyLegendOverrides = function (legend, opts) {
     return next;
 };
 exports.applyLegendOverrides = applyLegendOverrides;
+/** Excel's Format Axis → Display units: the divisor and the label it shows. */
+exports.DISPLAY_UNITS = {
+    hundreds: { divisor: 1e2, label: "Hundreds" },
+    thousands: { divisor: 1e3, label: "Thousands" },
+    tenThousands: { divisor: 1e4, label: "10000" },
+    hundredThousands: { divisor: 1e5, label: "100000" },
+    millions: { divisor: 1e6, label: "Millions" },
+    tenMillions: { divisor: 1e7, label: "10000000" },
+    hundredMillions: { divisor: 1e8, label: "100000000" },
+    billions: { divisor: 1e9, label: "Billions" },
+    trillions: { divisor: 1e12, label: "Trillions" },
+};
+var positive = function (v) {
+    return typeof v === "number" && Number.isFinite(v) && v > 0;
+};
 /**
  * `numberFormatPattern` is the axis' RESOLVED format (explicit pattern or
  * the linked source-cell format — see `resolveValueAxisNumberFormat`); it
- * becomes the tick-label formatter.
+ * becomes the tick-label formatter. `placement` says which side of the plot
+ * the axis runs along (`x` horizontal, `y` vertical) for Excel's axis
+ * crossing; it defaults to `x` for a category axis and `y` for a value axis.
  */
-var applyAxisOverrides = function (axis, opts, numberFormatPattern, locale) {
-    var _a, _b, _c, _d, _e;
-    var formatter = (0, axis_number_format_1.valueAxisLabelFormatter)(numberFormatPattern, locale);
+var applyAxisOverrides = function (axis, opts, numberFormatPattern, locale, placement) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+    var units = (opts === null || opts === void 0 ? void 0 : opts.displayUnits) ? exports.DISPLAY_UNITS[opts.displayUnits] : undefined;
+    var baseFormatter = (0, axis_number_format_1.valueAxisLabelFormatter)(numberFormatPattern, locale);
+    // Display units divide the tick labels: 25,000 on a "Thousands" axis reads 25.
+    var formatter = units
+        ? function (value) {
+            return typeof value === "number"
+                ? (baseFormatter !== null && baseFormatter !== void 0 ? baseFormatter : (function (v) { return (0, axis_number_format_1.formatAxisValue)(undefined, v, locale); }))(value / units.divisor)
+                : String(value !== null && value !== void 0 ? value : "");
+        }
+        : baseFormatter;
     if (!opts && !formatter)
         return axis;
     var next = tslib_1.__assign({}, axis);
@@ -113,8 +158,11 @@ var applyAxisOverrides = function (axis, opts, numberFormatPattern, locale) {
     }
     if (!opts)
         return next;
-    if (opts.logarithmic)
+    var isValueAxis = next.type !== "category";
+    if (opts.logarithmic) {
         next.type = "log";
+        next.logBase = positive(opts.logBase) && opts.logBase >= 2 ? opts.logBase : 10;
+    }
     if (opts.reverse)
         next.inverse = true;
     if (typeof opts.min === "number")
@@ -129,12 +177,62 @@ var applyAxisOverrides = function (axis, opts, numberFormatPattern, locale) {
     if (opts.showMajorGridlines === true) {
         next.splitLine = tslib_1.__assign(tslib_1.__assign({}, ((_c = next.splitLine) !== null && _c !== void 0 ? _c : {})), { show: true });
     }
+    // Format Axis → Units (FT-08). A value axis' major unit is the tick
+    // interval; minor ticks / gridlines split it by major ÷ minor (Excel's
+    // automatic minor unit is a fifth of the major).
+    if (isValueAxis && positive(opts.majorUnit) && !opts.logarithmic) {
+        next.interval = opts.majorUnit;
+    }
+    var minorSplit = positive(opts.majorUnit) && positive(opts.minorUnit)
+        ? Math.max(1, Math.round(opts.majorUnit / opts.minorUnit))
+        : 5;
+    var minorTicks = typeof opts.minorTickMark === "string" && opts.minorTickMark !== "none";
+    if (isValueAxis && (minorTicks || opts.showMinorGridlines)) {
+        next.minorTick = { show: minorTicks, splitNumber: minorSplit };
+    }
+    if (isValueAxis && opts.showMinorGridlines) {
+        next.minorSplitLine = { show: true, lineStyle: { color: "#F2F2F2" } };
+    }
+    // Format Axis → Tick Marks: none / inside / outside / cross.
+    if (opts.majorTickMark === "none") {
+        next.axisTick = tslib_1.__assign(tslib_1.__assign({}, ((_d = next.axisTick) !== null && _d !== void 0 ? _d : {})), { show: false });
+    }
+    else if (opts.majorTickMark === "in") {
+        next.axisTick = tslib_1.__assign(tslib_1.__assign({}, ((_e = next.axisTick) !== null && _e !== void 0 ? _e : {})), { show: true, inside: true });
+    }
+    else if (opts.majorTickMark === "cross") {
+        next.axisTick = tslib_1.__assign(tslib_1.__assign({}, ((_f = next.axisTick) !== null && _f !== void 0 ? _f : {})), { show: true, inside: false, length: 8 });
+    }
+    // Category axis "Interval between labels / tick marks": every Nth category.
+    if (!isValueAxis && positive(opts.tickLabelSkip)) {
+        next.axisLabel = tslib_1.__assign(tslib_1.__assign({}, ((_g = next.axisLabel) !== null && _g !== void 0 ? _g : {})), { interval: Math.round(opts.tickLabelSkip) - 1 });
+    }
+    if (!isValueAxis && positive(opts.tickMarkSkip)) {
+        next.axisTick = tslib_1.__assign(tslib_1.__assign({}, ((_h = next.axisTick) !== null && _h !== void 0 ? _h : {})), { interval: Math.round(opts.tickMarkSkip) - 1 });
+    }
+    // Where this axis crosses the perpendicular one (OOXML's `<c:crosses>` /
+    // `<c:crossesAt>` on this axis). echarts places an axis at the other's zero
+    // or at either plot edge, so a `crossesAt` other than 0 draws at the edge.
+    var side = placement !== null && placement !== void 0 ? placement : (isValueAxis ? "y" : "x");
+    if (opts.crosses === "max") {
+        next.position = side === "x" ? "top" : "right";
+        next.axisLine = tslib_1.__assign(tslib_1.__assign({}, ((_j = next.axisLine) !== null && _j !== void 0 ? _j : {})), { onZero: false });
+    }
+    else if (opts.crosses === "min" ||
+        (typeof opts.crossesAt === "number" && opts.crossesAt !== 0)) {
+        next.position = side === "x" ? "bottom" : "left";
+        next.axisLine = tslib_1.__assign(tslib_1.__assign({}, ((_k = next.axisLine) !== null && _k !== void 0 ? _k : {})), { onZero: false });
+    }
+    // The display-units label ("Thousands") rides with the axis title.
+    if (units && opts.showDisplayUnitsLabel !== false) {
+        next.name = next.name ? "".concat(next.name, " (").concat(units.label, ")") : units.label;
+    }
     // Axis label text style (tick labels) + axis title font come from
     // <c:txPr>. Without this echarts uses its default (~black on light).
     var axisTextStyle = (0, exports.textFormatToEchartsTextStyle)(opts.textFormat);
     if (axisTextStyle) {
-        next.axisLabel = tslib_1.__assign(tslib_1.__assign({}, ((_d = next.axisLabel) !== null && _d !== void 0 ? _d : {})), axisTextStyle);
-        next.nameTextStyle = tslib_1.__assign(tslib_1.__assign({}, ((_e = next.nameTextStyle) !== null && _e !== void 0 ? _e : {})), axisTextStyle);
+        next.axisLabel = tslib_1.__assign(tslib_1.__assign({}, ((_l = next.axisLabel) !== null && _l !== void 0 ? _l : {})), axisTextStyle);
+        next.nameTextStyle = tslib_1.__assign(tslib_1.__assign({}, ((_m = next.nameTextStyle) !== null && _m !== void 0 ? _m : {})), axisTextStyle);
     }
     return next;
 };
@@ -153,6 +251,12 @@ joiner) {
     if (joiner === void 0) { joiner = ": "; }
     return function (params) {
         var parts = [];
+        // Value From Cells (FT-08): the point's cell leads; resolved by the caller.
+        if (Array.isArray(opts.cellLabels)) {
+            var cell = opts.cellLabels[params.dataIndex];
+            if (cell !== undefined && cell !== null && cell !== "")
+                parts.push(String(cell));
+        }
         if (opts.showSeriesName && params.seriesName)
             parts.push(params.seriesName);
         if (opts.showCategoryName && params.name)
@@ -168,7 +272,8 @@ joiner) {
             !opts.showCategoryName &&
             !opts.showPercent &&
             !opts.showSeriesName &&
-            !opts.showBubbleSize
+            !opts.showBubbleSize &&
+            !Array.isArray(opts.cellLabels)
             ? true
             : !!opts.showValue;
         // A scatter / bubble point's value is its [x, y, size] tuple: the label's

package/dist/esm/basic-chart/basic-chart.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"basic-chart.d.ts","sourceRoot":"","sources":["../../../basic-chart/basic-chart.tsx"],"names":[],"mappings":"AAkEA,OAAO,KAAiD,MAAM,OAAO,CAAC;AAEtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAyTrD,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC;AAiGnD,eAAO,MAAM,UAAU,GAAI,0PAmBxB,eAAe,sBA2wHjB,CAAC"}
+{"version":3,"file":"basic-chart.d.ts","sourceRoot":"","sources":["../../../basic-chart/basic-chart.tsx"],"names":[],"mappings":"AAkEA,OAAO,KAAiD,MAAM,OAAO,CAAC;AAEtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AA2UrD,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC;AAoHnD,eAAO,MAAM,UAAU,GAAI,0PAmBxB,eAAe,sBAm8HjB,CAAC"}