@adaptabletools/adaptable-cjs 23.0.0-canary.7 → 23.0.0-canary.8

package/src/Utilities/Helpers/barChartCellText.js

@@ -0,0 +1,333 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mountBarChartCellText = exports.formatBarChartCellTextLayoutSummary = exports.getBarChartCellTextSlotPresence = exports.resolveBarChartCellTextSlots = exports.joinBarChartCellTextLabels = exports.hasBarChartCellTextLabels = exports.buildBarChartCellTextLabels = exports.toggleBarChartCellTextToken = exports.patchBarChartCellTextPlacement = exports.setBarChartCellTextPlacement = exports.mergeBarChartCellTextProperties = exports.getActiveBarChartCellTextTokens = exports.hasBarChartCellTextConfigured = exports.resolveBarChartCellTextLayout = void 0;
+/** Default placement applied to a value whose Horizontal/Vertical were omitted. */
+const DEFAULT_PLACEMENT = {
+    Horizontal: 'Left',
+    Vertical: 'Below',
+};
+const HORIZONTAL_VALUES = ['Left', 'Center', 'Right'];
+const VERTICAL_VALUES = ['Above', 'Below', 'Merged'];
+const isHorizontal = (value) => typeof value === 'string' &&
+    HORIZONTAL_VALUES.includes(value);
+const isVertical = (value) => typeof value === 'string' && VERTICAL_VALUES.includes(value);
+/** Normalise a placement, applying defaults for missing axes. */
+const sanitizePlacement = (placement) => ({
+    Horizontal: isHorizontal(placement?.Horizontal) ? placement.Horizontal : DEFAULT_PLACEMENT.Horizontal,
+    Vertical: isVertical(placement?.Vertical) ? placement.Vertical : DEFAULT_PLACEMENT.Vertical,
+});
+/** Returns a layout with only the values that are actually present, defaults filled in. */
+const sanitizeCellTextLayout = (layout) => {
+    const result = {};
+    if (layout?.CellValue) {
+        result.CellValue = sanitizePlacement(layout.CellValue);
+    }
+    if (layout?.PercentValue) {
+        result.PercentValue = sanitizePlacement(layout.PercentValue);
+    }
+    return result;
+};
+const resolveBarChartCellTextLayout = (props) => sanitizeCellTextLayout(props?.CellTextLayout);
+exports.resolveBarChartCellTextLayout = resolveBarChartCellTextLayout;
+/** True when any value is configured for display. */
+const hasBarChartCellTextConfigured = (props) => {
+    const layout = (0, exports.resolveBarChartCellTextLayout)(props);
+    return Boolean(layout.CellValue || layout.PercentValue);
+};
+exports.hasBarChartCellTextConfigured = hasBarChartCellTextConfigured;
+/** Set of value tokens that currently have a placement. */
+const getActiveBarChartCellTextTokens = (props) => {
+    const layout = (0, exports.resolveBarChartCellTextLayout)(props);
+    const tokens = [];
+    if (layout.CellValue) {
+        tokens.push('CellValue');
+    }
+    if (layout.PercentValue) {
+        tokens.push('PercentageValue');
+    }
+    return tokens;
+};
+exports.getActiveBarChartCellTextTokens = getActiveBarChartCellTextTokens;
+const mergeBarChartCellTextProperties = (current, patch) => {
+    const merged = { ...current, ...patch };
+    if (merged.CellTextLayout) {
+        merged.CellTextLayout = sanitizeCellTextLayout(merged.CellTextLayout);
+        if (!merged.CellTextLayout.CellValue && !merged.CellTextLayout.PercentValue) {
+            delete merged.CellTextLayout;
+        }
+    }
+    if (!merged.CellTextLayout) {
+        return undefined;
+    }
+    return merged;
+};
+exports.mergeBarChartCellTextProperties = mergeBarChartCellTextProperties;
+/**
+ * Set or clear a value's placement. Passing `placement: undefined` removes the value.
+ */
+const setBarChartCellTextPlacement = (current, token, placement) => {
+    const layout = (0, exports.resolveBarChartCellTextLayout)(current);
+    const next = { ...layout };
+    const key = token === 'CellValue' ? 'CellValue' : 'PercentValue';
+    if (placement) {
+        next[key] = sanitizePlacement(placement);
+    }
+    else {
+        delete next[key];
+    }
+    return (0, exports.mergeBarChartCellTextProperties)(current, { CellTextLayout: next });
+};
+exports.setBarChartCellTextPlacement = setBarChartCellTextPlacement;
+/**
+ * Patch a single axis of a value's placement (creating the value with defaults if
+ * needed). Used by the wizard's placement pickers.
+ */
+const patchBarChartCellTextPlacement = (current, token, patch) => {
+    const layout = (0, exports.resolveBarChartCellTextLayout)(current);
+    const key = token === 'CellValue' ? 'CellValue' : 'PercentValue';
+    const existing = layout[key];
+    const nextPlacement = {
+        ...(existing ?? DEFAULT_PLACEMENT),
+        ...patch,
+    };
+    return (0, exports.setBarChartCellTextPlacement)(current, token, nextPlacement);
+};
+exports.patchBarChartCellTextPlacement = patchBarChartCellTextPlacement;
+/**
+ * Toggle whether a value is displayed. When turning on a previously-hidden
+ * value we use the default placement (Left / Below).
+ */
+const toggleBarChartCellTextToken = (current, token, show) => {
+    const layout = (0, exports.resolveBarChartCellTextLayout)(current);
+    const key = token === 'CellValue' ? 'CellValue' : 'PercentValue';
+    if (show && !layout[key]) {
+        return {
+            CellTextProperties: (0, exports.setBarChartCellTextPlacement)(current, token, DEFAULT_PLACEMENT),
+        };
+    }
+    if (!show && layout[key]) {
+        return {
+            CellTextProperties: (0, exports.setBarChartCellTextPlacement)(current, token, undefined),
+        };
+    }
+    return { CellTextProperties: current };
+};
+exports.toggleBarChartCellTextToken = toggleBarChartCellTextToken;
+const buildBarChartCellTextLabels = (props, cellValueLabel, percentageLabel) => {
+    const layout = (0, exports.resolveBarChartCellTextLayout)(props);
+    const labels = {};
+    if (layout.CellValue && cellValueLabel != undefined) {
+        labels.cellValue = cellValueLabel;
+    }
+    if (layout.PercentValue && percentageLabel != undefined) {
+        labels.percentage = percentageLabel;
+    }
+    return labels;
+};
+exports.buildBarChartCellTextLabels = buildBarChartCellTextLabels;
+const hasBarChartCellTextLabels = (labels) => Boolean(labels.cellValue || labels.percentage);
+exports.hasBarChartCellTextLabels = hasBarChartCellTextLabels;
+/** Join active labels with a space, Cell Value first then Percent Value. */
+const joinBarChartCellTextLabels = (labels) => {
+    const parts = [];
+    if (labels.cellValue)
+        parts.push(labels.cellValue);
+    if (labels.percentage)
+        parts.push(labels.percentage);
+    return parts.join(' ');
+};
+exports.joinBarChartCellTextLabels = joinBarChartCellTextLabels;
+/**
+ * Resolve which placements are populated and what text goes in each cell of
+ * the 3 × 3 grid. Empty slots are omitted. Two values landing on the same
+ * (vertical, horizontal) slot are concatenated with a single space, Cell
+ * Value before Percent Value.
+ */
+const resolveBarChartCellTextSlots = (props, labels) => {
+    const layout = (0, exports.resolveBarChartCellTextLayout)(props);
+    // Iteration order matters when both values share a slot: Cell Value first,
+    // then Percent Value (matches the legacy "joined" behaviour).
+    const candidates = [];
+    if (layout.CellValue && labels.cellValue) {
+        candidates.push({
+            placement: sanitizePlacement(layout.CellValue),
+            text: labels.cellValue,
+        });
+    }
+    if (layout.PercentValue && labels.percentage) {
+        candidates.push({
+            placement: sanitizePlacement(layout.PercentValue),
+            text: labels.percentage,
+        });
+    }
+    const slotMap = new Map();
+    for (const { placement, text } of candidates) {
+        const key = `${placement.Vertical}|${placement.Horizontal}`;
+        const existing = slotMap.get(key);
+        if (existing) {
+            existing.parts.push(text);
+            existing.text = existing.parts.join(' ');
+        }
+        else {
+            slotMap.set(key, {
+                vertical: placement.Vertical,
+                horizontal: placement.Horizontal,
+                parts: [text],
+                text,
+            });
+        }
+    }
+    return Array.from(slotMap.values());
+};
+exports.resolveBarChartCellTextSlots = resolveBarChartCellTextSlots;
+const getBarChartCellTextSlotPresence = (props) => {
+    const layout = (0, exports.resolveBarChartCellTextLayout)(props);
+    const verticals = new Set();
+    if (layout.CellValue)
+        verticals.add(sanitizePlacement(layout.CellValue).Vertical);
+    if (layout.PercentValue)
+        verticals.add(sanitizePlacement(layout.PercentValue).Vertical);
+    return {
+        hasAbove: verticals.has('Above'),
+        hasBelow: verticals.has('Below'),
+        hasMerged: verticals.has('Merged'),
+    };
+};
+exports.getBarChartCellTextSlotPresence = getBarChartCellTextSlotPresence;
+// ---------------------------------------------------------------------------
+// Summary formatting
+// ---------------------------------------------------------------------------
+const HORIZONTAL_LABEL = {
+    Left: 'Left',
+    Center: 'Center',
+    Right: 'Right',
+};
+const VERTICAL_LABEL = {
+    Above: 'Above',
+    Below: 'Below',
+    Merged: 'Merged',
+};
+const formatTokenLabel = (token) => token === 'CellValue' ? 'Cell Value' : 'Percent Value';
+const formatPlacementSummary = (placement) => {
+    const { Horizontal, Vertical } = sanitizePlacement(placement);
+    return `${VERTICAL_LABEL[Vertical]}-${HORIZONTAL_LABEL[Horizontal]}`;
+};
+const formatBarChartCellTextLayoutSummary = (layout) => {
+    const parts = [];
+    if (layout.CellValue) {
+        parts.push(`${formatTokenLabel('CellValue')}: ${formatPlacementSummary(layout.CellValue)}`);
+    }
+    if (layout.PercentValue) {
+        parts.push(`${formatTokenLabel('PercentageValue')}: ${formatPlacementSummary(layout.PercentValue)}`);
+    }
+    return parts.length ? parts.join('; ') : undefined;
+};
+exports.formatBarChartCellTextLayoutSummary = formatBarChartCellTextLayoutSummary;
+// ---------------------------------------------------------------------------
+// DOM mount
+// ---------------------------------------------------------------------------
+const HORIZONTAL_FLEX_JUSTIFY = {
+    Left: 'flex-start',
+    Center: 'center',
+    Right: 'flex-end',
+};
+const HORIZONTAL_TEXT_ALIGN = {
+    Left: 'left',
+    Center: 'center',
+    Right: 'right',
+};
+const createCellTextRow = (slots, textClassName, compact) => {
+    const row = document.createElement('div');
+    row.className = textClassName;
+    row.style.display = 'flex';
+    row.style.flexDirection = 'row';
+    row.style.alignItems = 'center';
+    row.style.width = '100%';
+    // When `Above` AND `Below` are both populated, two default-size text rows
+    // would squeeze the bar to 0 on a standard ~28-40px cell, so the caller
+    // asks for a compact band (smaller font + tighter line-height).
+    // Otherwise we render at the inherited cell font for legibility.
+    if (compact) {
+        row.style.fontSize = '0.75em';
+        row.style.lineHeight = '1';
+    }
+    else {
+        row.style.lineHeight = '1.2';
+    }
+    row.style.flex = '0 0 auto';
+    row.style.gap = '4px';
+    // Render fixed Left / Center / Right cells so spacing is stable even when
+    // only one or two slots are present.
+    for (const horizontal of HORIZONTAL_VALUES) {
+        const slot = slots.find((s) => s.horizontal === horizontal);
+        const cell = document.createElement('span');
+        cell.style.flex = '1';
+        cell.style.minWidth = '0';
+        cell.style.textAlign = HORIZONTAL_TEXT_ALIGN[horizontal];
+        cell.style.display = 'flex';
+        cell.style.justifyContent = HORIZONTAL_FLEX_JUSTIFY[horizontal];
+        cell.style.alignItems = 'center';
+        if (slot) {
+            cell.textContent = slot.text;
+        }
+        row.append(cell);
+    }
+    // Suppress the dummy row in the rare case where every slot for this band is
+    // empty (e.g. the only label is empty string). `String(...)` because text
+    // may arrive as a number when `params.formatValue` is undefined for a
+    // numeric column — `(11).length` is `undefined`, which would otherwise
+    // wrongly trip the empty-row branch.
+    if (!slots.some((s) => String(s.text ?? '').length)) {
+        row.style.display = 'none';
+    }
+    return row;
+};
+const mountBarChartCellText = (args) => {
+    const { cellTextProperties, labels, wrapperEl, textClassName } = args;
+    if (!(0, exports.hasBarChartCellTextConfigured)(cellTextProperties) || !(0, exports.hasBarChartCellTextLabels)(labels)) {
+        return;
+    }
+    const slots = (0, exports.resolveBarChartCellTextSlots)(cellTextProperties, labels);
+    if (!slots.length) {
+        return;
+    }
+    const mergedOverlayEl = args.mergedOverlayEl ?? wrapperEl;
+    const mergedPointerEventsNone = args.mergedPointerEventsNone ?? mergedOverlayEl === wrapperEl;
+    const slotsByVertical = {
+        Above: slots.filter((s) => s.vertical === 'Above'),
+        Below: slots.filter((s) => s.vertical === 'Below'),
+        Merged: slots.filter((s) => s.vertical === 'Merged'),
+    };
+    // Compact when Cell Value and Percent Value have *different* verticals
+    // (i.e. the two tokens claim two separate bands of vertical space). When
+    // they share a vertical band — or when only one token is configured —
+    // we have room for the full-size font.
+    const layout = (0, exports.resolveBarChartCellTextLayout)(cellTextProperties);
+    const compact = Boolean(layout.CellValue &&
+        layout.PercentValue &&
+        sanitizePlacement(layout.CellValue).Vertical !==
+            sanitizePlacement(layout.PercentValue).Vertical);
+    if (slotsByVertical.Above.length) {
+        const row = createCellTextRow(slotsByVertical.Above, textClassName, compact);
+        wrapperEl.prepend(row);
+    }
+    if (slotsByVertical.Below.length) {
+        const row = createCellTextRow(slotsByVertical.Below, textClassName, compact);
+        wrapperEl.append(row);
+    }
+    if (slotsByVertical.Merged.length) {
+        const row = createCellTextRow(slotsByVertical.Merged, textClassName, compact);
+        row.style.position = 'absolute';
+        row.style.top = '50%';
+        row.style.transform = 'translateY(-50%)';
+        row.style.left = '0';
+        row.style.right = '0';
+        row.style.paddingLeft = '5px';
+        row.style.paddingRight = '5px';
+        if (mergedPointerEventsNone) {
+            row.style.pointerEvents = 'none';
+        }
+        mergedOverlayEl.append(row);
+    }
+};
+exports.mountBarChartCellText = mountBarChartCellText;

package/src/Utilities/Helpers/percentBarPreviewHelper.d.ts

@@ -1,4 +1,5 @@
-import { PercentBarStyle, StyledColumn } from '../../AdaptableState/StyledColumnState';
+import { StyledColumn } from '../../AdaptableState/StyledColumnState';
+import { PercentBarStyle } from '../../AdaptableState/StyledColumns/PercentBarStyle';
 export declare const hasPercentBarRangesConfigured: (pb: PercentBarStyle | undefined) => boolean;
 /** Illustrative scale for preview — shows negatives when origin is Auto or Zero. */
 export declare const getPercentBarPreviewScale: (pb: PercentBarStyle) => {

package/src/Utilities/Helpers/percentBarPreviewHelper.js

@@ -5,6 +5,7 @@ const tslib_1 = require("tslib");
 const StyleHelper_1 = require("./StyleHelper");
 const clamp_1 = tslib_1.__importDefault(require("../utils/clamp"));
 const StyledColumnGradientHelper_1 = require("./StyledColumnGradientHelper");
+const barChartCellText_1 = require("./barChartCellText");
 const evenlySpacedValues = (min, max, count) => {
     if (count <= 1) {
         return [min];
@@ -132,14 +133,8 @@ const getPercentBarPreviewGeometry = (numericValue, pb, min, max) => {
 };
 exports.getPercentBarPreviewGeometry = getPercentBarPreviewGeometry;
 const formatPercentBarPreviewCellText = (numericValue, percentageValue, pb) => {
-    const parts = [];
-    if (pb.CellText?.includes('CellValue')) {
-        parts.push(Number.isInteger(numericValue) ? String(numericValue) : numericValue.toFixed(1));
-    }
-    if (pb.CellText?.includes('PercentageValue')) {
-        parts.push(`${percentageValue.toFixed(0)}%`);
-    }
-    return parts.join(' ');
+    const labels = (0, barChartCellText_1.buildBarChartCellTextLabels)(pb.CellTextProperties, Number.isInteger(numericValue) ? String(numericValue) : numericValue.toFixed(1), `${percentageValue.toFixed(0)}%`);
+    return (0, barChartCellText_1.joinBarChartCellTextLabels)(labels);
 };
 exports.formatPercentBarPreviewCellText = formatPercentBarPreviewCellText;
 const getPercentBarPreviewTrackColor = (pb) => {