@adaptabletools/adaptable 23.0.4-canary.0 → 23.0.5-canary.0

package/src/Utilities/Helpers/StyleHelper.js

@@ -1,9 +1,5 @@
 import tinycolor from 'tinycolor2';
 import { EnumExtensions } from '../Extensions/EnumExtensions';
-/**
- * Keys belonging to the "Font" slice (text rendering + alignment).
- * See {@link CellFontStyle}.
- */
 export const CELL_FONT_STYLE_KEYS = [
     'ForeColor',
     'FontWeight',
@@ -12,10 +8,6 @@ export const CELL_FONT_STYLE_KEYS = [
     'FontSize',
     'Alignment',
 ];
-/**
- * Keys belonging to the "Cell" slice (cell chrome — background and border).
- * See {@link CellBoxStyle}.
- */
 export const CELL_BOX_STYLE_KEYS = [
     'BackColor',
     'BorderColor',
@@ -27,17 +19,8 @@ const hasAtLeastOneKey = (obj, keys) => {
     }
     return keys.some((k) => obj[k] !== undefined && obj[k] !== null);
 };
-/**
- * Returns true when the given style has any property in the Font slice set.
- */
 export const hasCellFontStyle = (style) => hasAtLeastOneKey(style, CELL_FONT_STYLE_KEYS);
-/**
- * Returns true when the given style has any property in the Cell (box) slice set.
- */
 export const hasCellBoxStyle = (style) => hasAtLeastOneKey(style, CELL_BOX_STYLE_KEYS);
-/**
- * Returns a copy of `style` containing only Font-slice keys.
- */
 export const pickCellFontStyle = (style) => {
     const out = {};
     if (!style) {
@@ -51,9 +34,6 @@ export const pickCellFontStyle = (style) => {
     });
     return out;
 };
-/**
- * Returns a copy of `style` containing only Cell-slice (box) keys.
- */
 export const pickCellBoxStyle = (style) => {
     const out = {};
     if (!style) {
@@ -67,23 +47,16 @@ export const pickCellBoxStyle = (style) => {
     });
     return out;
 };
-/**
- * Returns a copy of `style` with all Font-slice keys removed.
- */
 export const omitCellFontStyle = (style) => {
     const out = { ...(style ?? {}) };
     CELL_FONT_STYLE_KEYS.forEach((k) => delete out[k]);
     return out;
 };
-/**
- * Returns a copy of `style` with all Cell-slice (box) keys removed.
- */
 export const omitCellBoxStyle = (style) => {
     const out = { ...(style ?? {}) };
     CELL_BOX_STYLE_KEYS.forEach((k) => delete out[k]);
     return out;
 };
-// required for hacky fix for https://github.com/AdaptableTools/adaptable/issues/2119
 export const AgGridCellStyleProperties = [
     'backgroundColor',
     'color',
@@ -91,9 +64,6 @@ export const AgGridCellStyleProperties = [
     'fontStyle',
     'fontSize',
     'borderColor',
-    // needed for quick search
-    // as otherwise, the currentTextMatchStyle is not removed correctly
-    // from the cell when looping through the values, and the cell is no longer the current match
     '--ab-dynamic-background-color',
     '--ab-dynamic-color',
     '--ab-dynamic-font-weight',
@@ -103,9 +73,6 @@ export const AgGridCellStyleProperties = [
     '--ab-dynamic-border-radius',
     '--ab-dynamic-border-color',
 ];
-// see https://github.com/AdaptableTools/adaptable/issues/2119
-// since v29 AG Grid ignores style properties with null or undefined values
-// Fix: pass empty string instead of null/undefined
 export const normalizeStyleForAgGrid = (style) => {
     const normalizedStyle = { ...style };
     AgGridCellStyleProperties.forEach((cellStylePropKey) => {
@@ -115,7 +82,6 @@ export const normalizeStyleForAgGrid = (style) => {
     });
     return normalizedStyle;
 };
-// the inverse of normalizeStyleForAgGrid, see comments above
 export const sanitizeStyle = (style) => {
     const sanitizedStyle = {};
     Object.keys(style).forEach((key) => {
@@ -178,10 +144,8 @@ export const convertAdaptableStyleToCSS = (style) => {
                 break;
         }
     }
-    // assertion added to comply with the ag-Grid types
     return result;
 };
-// based on http://jerekdain.com/fontconversion.html
 export const convertCSSAbsoluteFontSizeToPt = (fontSize) => {
     switch (fontSize) {
         case 'x-large':
@@ -216,28 +180,8 @@ export const getVariableColor = (variable) => {
     }
     return getComputedStyle(document.documentElement).getPropertyValue(match[1]).trim();
 };
-/**
- * Default surface colour assumed to sit *behind* a semi-transparent cell tint
- * when computing auto-contrast text. Gradient cells paint a base colour at a
- * value-driven alpha, so the colour the user actually perceives is that tint
- * composited over the grid cell background (white in the default light theme).
- */
 export const DEFAULT_CELL_SURFACE_COLOR = '#ffffff';
-/**
- * Luminance above which a (composited, opaque) background is considered "light"
- * enough to need dark text.
- */
 const AUTO_CONTRAST_LUMINANCE_THRESHOLD = 0.45;
-/**
- * Picks a readable text colour (near-black or white) for a cell whose
- * background is `baseColor` painted at `alpha` over `surfaceColor`.
- *
- * The tint must be composited over the surface *before* measuring luminance:
- * `tinycolor.getLuminance()` ignores the alpha channel, so measuring the raw
- * base colour would yield the same result for a faint cell and a fully-opaque
- * one — making auto-contrast text identical on every row instead of adapting
- * per cell.
- */
 export const getAutoContrastTextColor = (baseColor, alpha, surfaceColor = DEFAULT_CELL_SURFACE_COLOR) => {
     const composited = tinycolor.mix(surfaceColor, baseColor, alpha * 100);
     return composited.getLuminance() > AUTO_CONTRAST_LUMINANCE_THRESHOLD ? '#111111' : '#ffffff';

package/src/Utilities/Helpers/StyledColumns/BarStylesHelper.js

@@ -1,4 +1,3 @@
-/** Default placement applied to a value whose Horizontal/Vertical were omitted. */
 const DEFAULT_PLACEMENT = {
     Horizontal: 'Left',
     Vertical: 'Below',
@@ -7,14 +6,12 @@ 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) {
@@ -26,12 +23,10 @@ const sanitizeCellTextLayout = (layout) => {
     return result;
 };
 export const resolveBarStyleCellTextLayout = (props) => sanitizeCellTextLayout(props?.CellTextLayout);
-/** True when any value is configured for display. */
 export const hasBarStyleCellTextConfigured = (props) => {
     const layout = resolveBarStyleCellTextLayout(props);
     return Boolean(layout.CellValue || layout.PercentValue);
 };
-/** Set of value tokens that currently have a placement. */
 export const getActiveBarStyleCellTextTokens = (props) => {
     const layout = resolveBarStyleCellTextLayout(props);
     const tokens = [];
@@ -56,9 +51,6 @@ export const mergeBarStyleCellTextProperties = (current, patch) => {
     }
     return merged;
 };
-/**
- * Set or clear a value's placement. Passing `placement: undefined` removes the value.
- */
 export const setBarStyleCellTextPlacement = (current, token, placement) => {
     const layout = resolveBarStyleCellTextLayout(current);
     const next = { ...layout };
@@ -71,10 +63,6 @@ export const setBarStyleCellTextPlacement = (current, token, placement) => {
     }
     return mergeBarStyleCellTextProperties(current, { CellTextLayout: next });
 };
-/**
- * Patch a single axis of a value's placement (creating the value with defaults if
- * needed). Used by the wizard's placement pickers.
- */
 export const patchBarStyleCellTextPlacement = (current, token, patch) => {
     const layout = resolveBarStyleCellTextLayout(current);
     const key = token === 'CellValue' ? 'CellValue' : 'PercentValue';
@@ -85,10 +73,6 @@ export const patchBarStyleCellTextPlacement = (current, token, patch) => {
     };
     return setBarStyleCellTextPlacement(current, token, nextPlacement);
 };
-/**
- * Toggle whether a value is displayed. When turning on a previously-hidden
- * value we use the default placement (Left / Below).
- */
 export const toggleBarStyleCellTextToken = (current, token, show) => {
     const layout = resolveBarStyleCellTextLayout(current);
     const key = token === 'CellValue' ? 'CellValue' : 'PercentValue';
@@ -116,7 +100,6 @@ export const buildBarStyleCellTextLabels = (props, cellValueLabel, percentageLab
     return labels;
 };
 export const hasBarStyleCellTextLabels = (labels) => Boolean(labels.cellValue || labels.percentage);
-/** Join active labels with a space, Cell Value first then Percent Value. */
 export const joinBarStyleCellTextLabels = (labels) => {
     const parts = [];
     if (labels.cellValue)
@@ -125,16 +108,8 @@ export const joinBarStyleCellTextLabels = (labels) => {
         parts.push(labels.percentage);
     return parts.join(' ');
 };
-/**
- * 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.
- */
 export const resolveBarStyleCellTextSlots = (props, labels) => {
     const layout = resolveBarStyleCellTextLayout(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({
@@ -180,9 +155,6 @@ export const getBarStyleCellTextSlotPresence = (props) => {
         hasMerged: verticals.has('Merged'),
     };
 };
-// ---------------------------------------------------------------------------
-// Summary formatting
-// ---------------------------------------------------------------------------
 const HORIZONTAL_LABEL = {
     Left: 'Left',
     Center: 'Center',
@@ -208,9 +180,6 @@ export const formatBarStyleCellTextLayoutSummary = (layout) => {
     }
     return parts.length ? parts.join('; ') : undefined;
 };
-// ---------------------------------------------------------------------------
-// DOM mount
-// ---------------------------------------------------------------------------
 const HORIZONTAL_FLEX_JUSTIFY = {
     Left: 'flex-start',
     Center: 'center',
@@ -228,10 +197,6 @@ const createCellTextRow = (slots, textClassName, compact) => {
     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';
@@ -241,8 +206,6 @@ const createCellTextRow = (slots, textClassName, compact) => {
     }
     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');
@@ -257,11 +220,6 @@ const createCellTextRow = (slots, textClassName, compact) => {
         }
         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';
     }
@@ -283,10 +241,6 @@ export const mountBarStyleCellText = (args) => {
         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 = resolveBarStyleCellTextLayout(cellTextProperties);
     const compact = Boolean(layout.CellValue &&
         layout.PercentValue &&

package/src/Utilities/Helpers/StyledColumns/GradientStyleHelper.js

@@ -2,15 +2,7 @@ import tinycolor from 'tinycolor2';
 import { convertAdaptableStyleToCSS } from '../StyleHelper';
 import { getAutoContrastTextColor, getVariableColor } from '../StyleHelper';
 import { clamp } from '../../Extensions/NumberExtensions';
-/**
- * Default alpha at the **low** end of a Gradient range when `MinAlpha` is unset.
- * Slightly above zero so the bottom-edge value of every range still shows its
- * colour (rather than rendering fully transparent).
- */
 export const DEFAULT_GRADIENT_MIN_ALPHA = 0.15;
-/**
- * Default alpha at the **high** end of a Gradient range when `MaxAlpha` is unset.
- */
 export const DEFAULT_GRADIENT_MAX_ALPHA = 1;
 export const hasGradientRangesConfigured = (gs) => !!(gs?.ZeroCentred || gs?.CellRanges?.length || gs?.ColumnComparison);
 const evenlySpacedValues = (min, max, count) => {
@@ -20,12 +12,9 @@ const evenlySpacedValues = (min, max, count) => {
     const step = (max - min) / (count - 1);
     return Array.from({ length: count }, (_, i) => min + step * i);
 };
-/** Number of sample cells shown in Gradient / Percent Bar style previews. */
 export const STYLED_COLUMN_PREVIEW_SAMPLE_COUNT = 6;
-/** Illustrative zero-centred scale endpoints for preview geometry. */
 export const ZERO_CENTRED_PREVIEW_SCALE_MIN = -20;
 export const ZERO_CENTRED_PREVIEW_SCALE_MAX = 20;
-/** @deprecated Use {@link getZeroCentredGradientPreviewValues} — kept for callers using endpoints. */
 export const ZERO_CENTRED_GRADIENT_PREVIEW_VALUES = evenlySpacedValues(ZERO_CENTRED_PREVIEW_SCALE_MIN, ZERO_CENTRED_PREVIEW_SCALE_MAX, STYLED_COLUMN_PREVIEW_SAMPLE_COUNT);
 export const getZeroCentredGradientPreviewValues = () => evenlySpacedValues(ZERO_CENTRED_PREVIEW_SCALE_MIN, ZERO_CENTRED_PREVIEW_SCALE_MAX, STYLED_COLUMN_PREVIEW_SAMPLE_COUNT);
 export function isDivergingZeroCellRanges(ranges) {
@@ -38,9 +27,6 @@ export function isDivergingZeroCellRanges(ranges) {
 export function isZeroCentredGradientStyle(gs) {
     return !!(gs.ZeroCentred || isDivergingZeroCellRanges(gs.CellRanges));
 }
-/**
- * Sample cell values for gradient preview strips — spread across the effective scale.
- */
 export const getGradientPreviewSampleValues = (styledColumn, api) => {
     const gs = styledColumn.GradientStyle;
     if (!gs || !hasGradientRangesConfigured(gs)) {
@@ -86,11 +72,6 @@ const getZeroCentredPreviewColors = (gradientStyle) => {
     }
     return null;
 };
-/**
- * Zero-centred preview uses a fixed -20…20 illustrative scale so negative
- * colours always appear — independent of whether the column currently has
- * negative values (Col-Min may be above zero today).
- */
 const getZeroCentredGradientPreviewCellStyle = (cellValue, gradientStyle) => {
     const colors = getZeroCentredPreviewColors(gradientStyle);
     if (!colors) {
@@ -147,9 +128,6 @@ const getZeroCentredGradientPreviewCellStyle = (cellValue, gradientStyle) => {
     }
     return style;
 };
-/**
- * Cell CSS for gradient preview — mirrors `AgGridColumnAdapter.getStyledColumnStyle` gradient path.
- */
 export const getGradientPreviewCellStyle = (cellValue, styledColumn, api, rowNode) => {
     const gradientStyle = styledColumn.GradientStyle;
     if (!gradientStyle || !hasGradientRangesConfigured(gradientStyle)) {
@@ -214,10 +192,6 @@ export const getGradientPreviewCellStyle = (cellValue, styledColumn, api, rowNod
     }
     return style;
 };
-/**
- * Effective cell ranges for gradient rendering / range lookup.
- * When `ZeroCentred` is set, expands to the canonical Col-Min…0 and 0…Col-Max bands.
- */
 export function expandGradientCellRanges(gs) {
     if (gs.ZeroCentred) {
         return [
@@ -227,21 +201,9 @@ export function expandGradientCellRanges(gs) {
     }
     return gs.CellRanges;
 }
-/**
- * Value type passed to `findRangeForColumn` / `getCellColorRangeMinValue` /
- * `getCellColorRangeMaxValue` when resolving which gradient band a cell falls in.
- *
- * Zero-centred bands use numeric `0` as an **absolute** zero crossing between
- * `Col-Min…0` and `0…Col-Max`. Under `RangeValueType: 'Percentage'`, numeric
- * endpoints are interpreted as % positions along the column min–max span, so
- * literal `0` wrongly becomes `Col-Min` and the negative band collapses to a
- * single point — boundary cells (e.g. the column minimum) pick up the negative
- * colour incorrectly. Zero-centred lookup must always use Number semantics.
- */
 export function gradientStyleRangeLookupValueType(gs) {
     return gs.ZeroCentred ? 'Number' : gs.RangeValueType ?? 'Number';
 }
-/** The negative half of a zero-centred gradient (darker toward Col-Min). */
 export function isNegativeZeroCentredBand(range) {
     return range.Min === 'Col-Min' && range.Max === 0;
 }

package/src/Utilities/Helpers/StyledColumns/IconStyleHelper.js

@@ -1,7 +1,3 @@
-/**
- * Icon Column Style resolves one key → glyph per scalar cell value; AdapTable
- * array column types are not supported (use Badge Style for per-element visuals).
- */
 export function isUnsupportedColumnDataTypeForIconStyle(dataType) {
     switch (dataType) {
         case 'textArray':
@@ -13,28 +9,10 @@ export function isUnsupportedColumnDataTypeForIconStyle(dataType) {
             return false;
     }
 }
-/**
- * Built-in {@link IconStyle} mapping presets.
- *
- * The wizard's "Apply preset" action seeds `IconStyle.Mappings` from one
- * of these. Once seeded the data is just normal mappings — users can add
- * / edit / remove rows freely.
- *
- * Implementation notes:
- *  - All icons here are emoji strings, so the presets cost nothing at
- *    bundle / asset level. On Windows some flag emojis fall back to
- *    regional-indicator letter pairs (e.g. "🇺🇸" → "US"), which is still
- *    a sensible visual; users who want a consistent SVG flag pack across
- *    platforms can swap individual mappings to URL icons.
- *  - Presets are deliberately *small* — the most common values for each
- *    domain. Users add the long tail by editing the mappings list.
- */
 const flagEmoji = (countryCodeAlpha2) => {
     const cc = countryCodeAlpha2.toUpperCase();
     if (cc.length !== 2)
         return cc;
-    // Convert ISO-3166 alpha-2 → regional indicator pair (each letter +
-    // 0x1F1A5). Browsers render this pair as the country flag.
     const a = 0x1f1a5;
     return String.fromCodePoint(a + cc.charCodeAt(0), a + cc.charCodeAt(1));
 };
@@ -54,8 +32,6 @@ const FLAG_PRESET = [
     { Key: 'NL', Icon: flagEmoji('NL'), Description: 'Netherlands' },
     { Key: 'PT', Icon: flagEmoji('PT'), Description: 'Portugal' },
     { Key: 'US', Icon: flagEmoji('US'), Description: 'United States' },
-    // Friendly synonyms so the preset works against full country names too
-    // (`MatchMode: 'CaseInsensitive'` is a sensible default for this preset).
     { Key: 'Australia', Icon: flagEmoji('AU'), Description: 'Australia' },
     { Key: 'Belgium', Icon: flagEmoji('BE'), Description: 'Belgium' },
     { Key: 'Canada', Icon: flagEmoji('CA'), Description: 'Canada' },
@@ -68,23 +44,11 @@ const FLAG_PRESET = [
     { Key: 'United Kingdom', Icon: flagEmoji('GB'), Description: 'United Kingdom' },
     { Key: 'United States', Icon: flagEmoji('US'), Description: 'United States' },
 ];
-// Currency → issuing country flag. Currency *symbols* (`$`, `¥`) are NOT
-// unique across currencies (USD/AUD/CAD/NZD all share `$`; CNY/JPY both use
-// `¥`), so an icon column built from symbols ends up visually ambiguous —
-// defeating the whole point of an icon column. Flags map 1-to-1 with the
-// issuing economy, give every currency a distinct glyph, and read instantly
-// in financial UIs (which is where this preset is most commonly used).
-//
-// Pair with `Description` ("US Dollar", "Euro") so tooltips / companion
-// text still surface the human-readable name. Anyone who prefers symbols
-// can still build that mapping by hand in the wizard.
 const CURRENCY_PRESET = [
     { Key: 'AUD', Icon: flagEmoji('AU'), Description: 'Australian Dollar' },
     { Key: 'CAD', Icon: flagEmoji('CA'), Description: 'Canadian Dollar' },
     { Key: 'CHF', Icon: flagEmoji('CH'), Description: 'Swiss Franc' },
     { Key: 'CNY', Icon: flagEmoji('CN'), Description: 'Chinese Yuan' },
-    // 'EU' as a regional indicator pair renders as the EU flag in modern
-    // emoji fonts; falls back to the letters "EU" otherwise — still readable.
     { Key: 'EUR', Icon: flagEmoji('EU'), Description: 'Euro' },
     { Key: 'GBP', Icon: flagEmoji('GB'), Description: 'British Pound' },
     { Key: 'HKD', Icon: flagEmoji('HK'), Description: 'Hong Kong Dollar' },
@@ -105,7 +69,6 @@ const TREND_PRESET = [
     { Key: 'Up', Icon: '⬆', Description: 'Up' },
     { Key: 'Down', Icon: '⬇', Description: 'Down' },
     { Key: 'Flat', Icon: '➡', Description: 'Flat' },
-    // Trading-side synonyms so the same preset works against Buy/Sell columns.
     { Key: 'Buy', Icon: '⬆', Description: 'Buy' },
     { Key: 'Sell', Icon: '⬇', Description: 'Sell' },
     { Key: 'Hold', Icon: '➡', Description: 'Hold' },
@@ -116,7 +79,6 @@ const STATUS_PRESET = [
     { Key: 'Pass', Icon: '🟢', Description: 'Pass' },
     { Key: 'Warn', Icon: '🟡', Description: 'Warn' },
     { Key: 'Fail', Icon: '🔴', Description: 'Fail' },
-    // Status-column synonyms (cover the `status` column in the trade demo).
     { Key: 'Completed', Icon: '🟢', Description: 'Completed' },
     { Key: 'In Progress', Icon: '🟡', Description: 'In Progress' },
     { Key: 'Pending', Icon: '🟡', Description: 'Pending' },
@@ -129,7 +91,6 @@ export const ICON_STYLE_PRESETS = {
     Trend: TREND_PRESET,
     Status: STATUS_PRESET,
 };
-/** Returns a fresh copy of the mappings for a given preset. */
 export const getIconStylePresetMappings = (preset) => {
     return ICON_STYLE_PRESETS[preset].map((m) => ({ ...m }));
 };

package/src/Utilities/Helpers/StyledColumns/PercentBarStyleHelper.js

@@ -64,7 +64,6 @@ const getPreviewBarColor = (value, pb, scaleMin, scaleMax) => {
     return pb.CellRanges?.[0]?.Color;
 };
 export const hasPercentBarRangesConfigured = (pb) => !!(pb?.CellRanges?.length || pb?.ColumnComparison);
-/** Illustrative scale for preview — shows negatives when origin is Auto or Zero. */
 export const getPercentBarPreviewScale = (pb) => {
     const origin = pb.Origin ?? 'Auto';
     if (origin === 'Zero' || origin === 'Auto') {

package/src/Utilities/Helpers/StyledColumns/SparklineStyleHelper.js

@@ -19,11 +19,6 @@ const resolveHighlightStyle = (style) => {
     }
     return resolved;
 };
-/**
- * AG Charts sparklines do not resolve Adaptable `var(--ab-color-*)` tokens.
- * Resolve palette / theme CSS variables to concrete colours at render time so
- * wizard previews and grid cells match the chosen Fill / Stroke values.
- */
 export function resolveSparklineOptionsForRender(options) {
     const resolved = { ...options };
     if ('fill' in options && options.fill != null) {

package/src/Utilities/Helpers/StyledColumns/StyledColumnHelper.js

@@ -20,11 +20,6 @@ export const getStyledColumnRowKindDisabledReason = (styledColumn, kind) => {
     }
     return undefined;
 };
-/**
- * Classifies the AG Grid row node into a single {@link StyledColumnRowKind}.
- * Order matches {@link shouldRenderStyledColumnOnRow}: total before summary,
- * summary before group.
- */
 export const getStyledColumnRowKindForNode = (node, api) => {
     if (api.gridApi.isGrandTotalRowNode(node)) {
         return 'Total';
@@ -37,11 +32,6 @@ export const getStyledColumnRowKindForNode = (node, api) => {
     }
     return 'Data';
 };
-/**
- * Forces `Exclude*` to `true` for row kinds that do not apply to the current
- * Styled Column type, so persisted state cannot contradict the capability
- * matrix. Returns `undefined` when no change is needed.
- */
 export const sanitizeStyledColumnRowScope = (styledColumn) => {
     const scope = styledColumn.RowScope;
     if (!scope) {
@@ -61,32 +51,6 @@ export const sanitizeStyledColumnRowScope = (styledColumn) => {
     }
     return changed ? next : undefined;
 };
-/**
- * Returns `true` when the Styled Column should render on the given row.
- *
- * Single source of truth consulted by every styled-column cell renderer
- * (Badge / Icon / Rating / Percent Bar / Bullet Chart / Range Bar) and
- * by `getStyledColumnStyle` (Gradient / Percent Bar cellStyle).
- *
- * Semantics:
- *  - **Type capabilities** first: some types never target certain row kinds
- *    (see {@link isStyledColumnRowKindSupported}). Unsupported kinds always
- *    return `false` regardless of `RowScope`.
- *  - When `StyledColumn.RowScope` is **set**, the explicit `Exclude*`
- *    flags win. Unset flags default to "include" — i.e. `RowScope: {}`
- *    means "render on every *supported* row kind".
- *  - When `StyledColumn.RowScope` is **unset**, the historical per-type
- *    default applies:
- *      - Badge: render on every row kind (that the type supports).
- *      - All other types: render on every row kind *except* group rows
- *        (matches the hardcoded "isGroupRowNode → plain text" check that
- *        every other styled-column renderer used to carry), again
- *        intersected with type capabilities (e.g. Sparkline → data only).
- *
- * The per-type default lets us promote `RowScope` cleanly without
- * altering existing user-visible behaviour: state that doesn't mention
- * `RowScope` keeps rendering exactly as before.
- */
 export const shouldRenderStyledColumnOnRow = (styledColumn, node, api) => {
     const rowKind = getStyledColumnRowKindForNode(node, api);
     if (!isStyledColumnRowKindSupported(styledColumn, rowKind)) {
@@ -108,7 +72,6 @@ export const shouldRenderStyledColumnOnRow = (styledColumn, node, api) => {
             return false;
         return true;
     }
-    // No explicit RowScope → fall back to historical per-type behaviour.
     if (styledColumn.BadgeStyle) {
         return true;
     }

package/src/Utilities/Helpers/TimingHelper.js

@@ -1,13 +1,3 @@
-/**
- * Timing helpers for delaying / rate-limiting function calls.
- *
- * `debounce` and `throttle` are drop-in replacements for the equivalent
- * lodash exports (`debounce` supports `{ leading, trailing, maxWait }`,
- * `throttle` supports `{ leading, trailing }`).
- *
- * Both return an instance of `DebouncedFunction<T>` which exposes
- * `cancel()` and `flush()` for managing pending invocations.
- */
 export function debounce(func, wait = 0, options) {
     let lastArgs;
     let lastThis;
@@ -118,9 +108,6 @@ export function debounce(func, wait = 0, options) {
     };
     return debounced;
 }
-/**
- * Implemented in terms of `debounce` with `maxWait` (same approach as lodash).
- */
 export function throttle(func, wait = 0, options) {
     return debounce(func, wait, {
         leading: options?.leading ?? true,

package/src/Utilities/ObjectFactory.js

@@ -28,7 +28,6 @@ export function CreateEmptyCalculatedColumn(defaultSpecialColumnSettings) {
         Query: {
             ScalarExpression: EMPTY_STRING,
         },
-        // need to create some defaults - which we will change later
         CalculatedColumnSettings: {
             ...defaultSpecialColumnSettings,
             DataType: undefined,
@@ -269,8 +268,8 @@ export function CreateDefaultStyledColumnBadge() {
     return {
         Shape: 'Rounded',
         PillStyle: {
-            BackColor: getSwatchColorVar(3), // light gray by default (for styled column badge)
-            ForeColor: getSwatchColorVar(1), // black by default (for styled column badge)
+            BackColor: getSwatchColorVar(3),
+            ForeColor: getSwatchColorVar(1),
         },
     };
 }
@@ -344,7 +343,6 @@ export function CreateToastOptions(notificationsOptions, { onClose, containerId
         transition: transition,
         draggablePercent: 75,
         onClose,
-        // progress: undefined,
     };
     return toastProps;
 }

package/src/Utilities/Services/AggregatedScalarLiveValue.js

@@ -29,7 +29,6 @@ export class AggregatedScalarLiveValue {
                 .getQueryLanguageService()
                 .evaluateAggregatedScalarExpression(source.aggregatedScalarExpression, requestingModule, getRowNodes).value
             : source.aggregatedScalarExpressionEvaluation;
-        // currently we support only one reducer
         this.aggregationReducerName = Object.keys(this.expressionEvaluation.aggregationParams.reducers)[0];
         this.aggregationResult = this.computeAggregatedValue(this.expressionEvaluation);
     }
@@ -39,7 +38,6 @@ export class AggregatedScalarLiveValue {
                 .getQueryLanguageService()
                 .evaluateAggregatedScalarExpression(this.aggregatedScalarExpression, this.requestingModule, this.getRowNodes).value;
         }
-        // currently we support only one reducer
         this.aggregationReducerName = Object.keys(this.expressionEvaluation.aggregationParams.reducers)[0];
         this.aggregationResult = this.computeAggregatedValue(this.expressionEvaluation);
     }
@@ -76,7 +74,6 @@ export class AggregatedScalarLiveValue {
     }
     getRowNodeValueForColumnId(rowNode, columnId) {
         const rawValue = this.adaptableApi.gridApi.getRawValueFromRowNode(rowNode, columnId);
-        // we need to convert the Date object to a number, otherwise the grouping will not work (each Date instance is unique)
         return rawValue instanceof Date ? rawValue.getTime() : rawValue;
     }
     computeAggregatedValue(expressionEvaluation) {
@@ -85,14 +82,11 @@ export class AggregatedScalarLiveValue {
             : this.adaptableApi.gridApi.getAllRowNodes({
                 filterFn: expressionEvaluation.rowFilterFn,
             });
-        // we iterate over the RowNode list (we need this to handle complex column values (nested values, valueGetters etc)
-        // so we will map the fieldNames to RowNode.data
         const mapReducerValueGetter = (columnId) => {
             return (rowNode) => this.getRowNodeValueForColumnId(rowNode, columnId);
         };
         Object.values(expressionEvaluation.aggregationParams.reducers).forEach((aggregationReducer) => {
             aggregationReducer.getter = mapReducerValueGetter(aggregationReducer.field);
-            // nullify the field to force the fallback on the getter fn
             aggregationReducer.field = null;
         });
         const mapGroupByToKey = (columnId) => {
@@ -104,7 +98,6 @@ export class AggregatedScalarLiveValue {
         let aggregatedRowNodes = gridRowNodes;
         if (expressionEvaluation.sortByColumn) {
             const sortByColumn = expressionEvaluation.sortByColumn;
-            // currently, we support only ascending sorting
             aggregatedRowNodes.sort((first, second) => {
                 const firstValue = this.getRowNodeValueForColumnId(first, sortByColumn);
                 const secondValue = this.getRowNodeValueForColumnId(second, sortByColumn);

package/src/Utilities/Services/AlertService.js

@@ -21,7 +21,6 @@ export class AlertService {
         return this.emitter.on('ReactiveAlertTriggered', callback);
     };
     createReactiveAlert(alertDefinition) {
-        // if there is already a reactive alert for this definition, delete it (possible in case of editing definitions),
         this.deleteReactiveAlert(alertDefinition);
         if (!('Rule' in alertDefinition)) {
             return;