@adaptabletools/adaptable 23.0.0-canary.8 → 23.0.0

package/src/Utilities/Helpers/Helper.js

@@ -140,38 +140,6 @@ export function isInputNullOrEmpty(itemToCheck) {
 export function isInputNotNullOrEmpty(itemToCheck) {
     return !isInputNullOrEmpty(itemToCheck);
 }
-export function roundNumber(numberToRound, decimalPlaces) {
-    switch (decimalPlaces) {
-        case 1:
-            return Math.round(numberToRound * 10) / 10;
-        case 2:
-            return Math.round(numberToRound * 100) / 100;
-        case 3:
-            return Math.round(numberToRound * 1000) / 1000;
-        case 4:
-            return Math.round(numberToRound * 10000) / 10000;
-        case 5:
-            return Math.round(numberToRound * 100000) / 100000;
-        case 6:
-            return Math.round(numberToRound * 1000000) / 1000000;
-    }
-}
-export function roundNumberTo4dp(numberToRound) {
-    return roundNumber(numberToRound, 4);
-}
-// putting this here to remove lodash clamp which seems to cause an issue
-export function clamp(value, boundOne, boundTwo) {
-    if (!boundTwo) {
-        return Math.max(value, boundOne) === boundOne ? value : boundOne;
-    }
-    else if (Math.min(value, boundOne) === value) {
-        return boundOne;
-    }
-    else if (Math.max(value, boundTwo) === value) {
-        return boundTwo;
-    }
-    return value;
-}
 export function extractColsFromText(text) {
     // rowData.columnName => columnName
     const regex = /\[rowData\.(.*?)\]/g;
@@ -212,9 +180,6 @@ export const Helper = {
     returnItemCount,
     isInputNullOrEmpty,
     isInputNotNullOrEmpty,
-    roundNumber,
-    roundNumberTo4dp,
-    clamp,
     extractColsFromText,
     replaceAll,
     extractContextKeysFromText,

package/src/Utilities/Helpers/{QuickSearchStyleHelper.js → QuickSearchHelper.js}

@@ -1,6 +1,6 @@
 import { QUICK_SEARCH_DEFAULT_CURRENT_TEXT_MATCH_STYLE, QUICK_SEARCH_DEFAULT_TEXT_MATCH_STYLE, } from '../../Redux/ActionsReducers/QuickSearchRedux';
 import { convertAdaptableStyleToCSS } from './StyleHelper';
-import kebabCase from '../utils/kebabCase';
+import { kebabCase } from '../Extensions/StringExtensions';
 const QUICK_SEARCH_FIND_CSS_KEYS = [
     'backgroundColor',
     'color',

package/src/Utilities/Helpers/{ScheduleHelper.d.ts → Scheduling/ScheduleHelper.d.ts}

@@ -1,4 +1,4 @@
-import { Schedule, Weekday } from '../../AdaptableState/Common/Schedule';
+import { Schedule, Weekday } from '../../../AdaptableState/Common/Schedule';
 export type ScheduleRecurrencePreset = 'daily' | 'weekdays' | 'selectedDays' | 'monthly' | 'custom';
 export declare function buildCronExpression(preset: ScheduleRecurrencePreset, hour: number, minute: number, options?: {
     days?: Weekday[];

package/src/Utilities/Helpers/{ScheduleHelper.js → Scheduling/ScheduleHelper.js}

@@ -1,5 +1,5 @@
 import { parseExpression } from 'cron-parser';
-import StringExtensions from '../Extensions/StringExtensions';
+import StringExtensions from '../../Extensions/StringExtensions';
 const WEEKDAY_TO_CRON = {
     Sunday: 0,
     Monday: 1,

package/src/Utilities/Helpers/{ScheduleJobManager.d.ts → Scheduling/ScheduleJobManager.d.ts}

@@ -1,4 +1,4 @@
-import { Schedule } from '../../AdaptableState/Common/Schedule';
+import { Schedule } from '../../../AdaptableState/Common/Schedule';
 export interface ScheduleJobManagerConfig<T> {
     getActiveItems: () => T[];
     getSchedule: (item: T) => Schedule | undefined;

package/src/Utilities/Helpers/{ScheduleJobRunner.d.ts → Scheduling/ScheduleJobRunner.d.ts}

@@ -1,4 +1,4 @@
-import { Schedule } from '../../AdaptableState/Common/Schedule';
+import { Schedule } from '../../../AdaptableState/Common/Schedule';
 export interface ScheduleJob {
     cancel: () => void;
 }

package/src/Utilities/Helpers/{ScheduledAlertHelper.d.ts → Scheduling/ScheduledAlertHelper.d.ts}

@@ -1,4 +1,4 @@
-import { AlertButtonForm, AlertDefinition, RuleAlertProperties, RuleBasedAlertDefinition, ScheduledAlertDefinition } from '../../AdaptableState/AlertState';
+import { AlertButtonForm, AlertDefinition, RuleAlertProperties, RuleBasedAlertDefinition, ScheduledAlertDefinition } from '../../../AdaptableState/AlertState';
 export declare function isScheduledAlertDefinition(alert: AlertDefinition | undefined | null): alert is ScheduledAlertDefinition;
 export declare function isRuleBasedAlertDefinition(alert: AlertDefinition | undefined | null): alert is RuleBasedAlertDefinition;
 export declare function getRuleAlertProperties(alert: AlertDefinition | undefined | null): RuleAlertProperties | undefined;

package/src/Utilities/Helpers/{ScheduledAlertHelper.js → Scheduling/ScheduledAlertHelper.js}

@@ -1,7 +1,7 @@
-import ObjectFactory from '../ObjectFactory';
-import { EMPTY_STRING } from '../Constants/GeneralConstants';
-import { ALERT_DEFAULT_MESSAGE_TYPE } from '../Constants/ObjectDefaultConstants';
-import { createUuid } from '../../AdaptableState/Uuid';
+import ObjectFactory from '../../ObjectFactory';
+import { EMPTY_STRING } from '../../Constants/GeneralConstants';
+import { ALERT_DEFAULT_MESSAGE_TYPE } from '../../Constants/ObjectDefaultConstants';
+import { createUuid } from '../../../AdaptableState/Uuid';
 export function isScheduledAlertDefinition(alert) {
     return alert != null && 'Schedule' in alert;
 }

package/src/Utilities/Helpers/{ScheduledJobsMiddlewareHelper.d.ts → Scheduling/ScheduledJobsMiddlewareHelper.d.ts}

@@ -1,3 +1,3 @@
-import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { IAdaptable } from '../../../AdaptableInterfaces/IAdaptable';
 export declare function refreshScheduledAlertJobs(adaptable: IAdaptable): void;
 export declare function refreshScheduledReportJobs(adaptable: IAdaptable): void;

package/src/Utilities/Helpers/{ScheduledJobsMiddlewareHelper.js → Scheduling/ScheduledJobsMiddlewareHelper.js}

@@ -1,4 +1,4 @@
-import * as ModuleConstants from '../Constants/ModuleConstants';
+import * as ModuleConstants from '../../Constants/ModuleConstants';
 export function refreshScheduledAlertJobs(adaptable) {
     const alertModule = adaptable.adaptableModules.get(ModuleConstants.AlertModuleId);
     alertModule?.setUpScheduledAlertJobs?.();

package/src/Utilities/Helpers/{ScheduledReportHelper.d.ts → Scheduling/ScheduledReportHelper.d.ts}

@@ -1,4 +1,4 @@
-import { ExportState, ReportNameType, ReportSchedule } from '../../AdaptableState/ExportState';
+import { ExportState, ReportNameType, ReportSchedule } from '../../../AdaptableState/ExportState';
 export declare function reportScheduleToSchedule(reportSchedule: {
     ReportName?: string;
     ScheduleType?: string;

package/src/Utilities/Helpers/{ScheduledReportHelper.js → Scheduling/ScheduledReportHelper.js}

@@ -1,4 +1,4 @@
-import { createUuid } from '../../AdaptableState/Uuid';
+import { createUuid } from '../../../AdaptableState/Uuid';
 export function reportScheduleToSchedule(reportSchedule) {
     const { ReportName: reportName, ScheduleType: _scheduleType, ...schedule } = reportSchedule;
     return {

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

@@ -0,0 +1,5 @@
+import { AdaptableApi } from '../../Api/AdaptableApi';
+import { SettingsPanelNavigation, SettingsPanelNavigationGroup, SettingsPanelOptions } from '../../AdaptableOptions/SettingsPanelOptions';
+export declare const DEFAULT_SETTINGS_PANEL_NAVIGATION_GROUPS: SettingsPanelNavigationGroup[];
+export declare const buildDefaultSettingsPanelNavigation: (customPanelNames?: string[]) => SettingsPanelNavigation;
+export declare const resolveSettingsPanelNavigation: (api: AdaptableApi, settingsPanelOptions: SettingsPanelOptions) => SettingsPanelNavigation;

package/src/Utilities/{Defaults/DefaultSettingsPanel.js → Helpers/SettingsPanelHelper.js}

@@ -45,3 +45,17 @@ export const buildDefaultSettingsPanelNavigation = (customPanelNames = []) => {
     }
     return { groups };
 };
+const cloneSettingsPanelNavigation = (navigation) => ({
+    groups: navigation.groups.map((group) => ({
+        label: group.label,
+        items: [...group.items],
+    })),
+});
+export const resolveSettingsPanelNavigation = (api, settingsPanelOptions) => {
+    const defaultNavigation = buildDefaultSettingsPanelNavigation(settingsPanelOptions.customSettingsPanels?.map((panel) => panel.name) ?? []);
+    if (!settingsPanelOptions.navigation) {
+        return defaultNavigation;
+    }
+    const context = api.internalApi.buildBaseContext();
+    return settingsPanelOptions.navigation(context, cloneSettingsPanelNavigation(defaultNavigation));
+};

package/src/Utilities/Helpers/StyledColumns/BarStylesHelper.d.ts

@@ -0,0 +1,63 @@
+import { BarStyleCellTextHorizontalAlignment, BarStyleCellTextLayout, BarStyleCellTextPlacement, BarStyleCellTextProperties, BarStyleCellTextVerticalAlignment } from '../../../AdaptableState/StyledColumns/Common/BarStyleProperties';
+import { CellTextOption, CellTextOptions } from '../../../AdaptableState/StyledColumns/Common/CellTextOptions';
+export type BarStyleCellTextLabels = {
+    cellValue?: string;
+    percentage?: string;
+};
+export declare const resolveBarStyleCellTextLayout: (props: BarStyleCellTextProperties | undefined) => BarStyleCellTextLayout;
+/** True when any value is configured for display. */
+export declare const hasBarStyleCellTextConfigured: (props: BarStyleCellTextProperties | undefined) => boolean;
+/** Set of value tokens that currently have a placement. */
+export declare const getActiveBarStyleCellTextTokens: (props: BarStyleCellTextProperties | undefined) => CellTextOptions;
+export declare const mergeBarStyleCellTextProperties: (current: BarStyleCellTextProperties | undefined, patch: Partial<BarStyleCellTextProperties>) => BarStyleCellTextProperties | undefined;
+/**
+ * Set or clear a value's placement. Passing `placement: undefined` removes the value.
+ */
+export declare const setBarStyleCellTextPlacement: (current: BarStyleCellTextProperties | undefined, token: CellTextOption, placement: BarStyleCellTextPlacement | undefined) => BarStyleCellTextProperties | undefined;
+/**
+ * Patch a single axis of a value's placement (creating the value with defaults if
+ * needed). Used by the wizard's placement pickers.
+ */
+export declare const patchBarStyleCellTextPlacement: (current: BarStyleCellTextProperties | undefined, token: CellTextOption, patch: Partial<BarStyleCellTextPlacement>) => BarStyleCellTextProperties | undefined;
+/**
+ * Toggle whether a value is displayed. When turning on a previously-hidden
+ * value we use the default placement (Left / Below).
+ */
+export declare const toggleBarStyleCellTextToken: (current: BarStyleCellTextProperties | undefined, token: CellTextOption, show: boolean) => {
+    CellTextProperties: BarStyleCellTextProperties | undefined;
+};
+export declare const buildBarStyleCellTextLabels: (props: BarStyleCellTextProperties | undefined, cellValueLabel: string | undefined, percentageLabel: string | undefined) => BarStyleCellTextLabels;
+export declare const hasBarStyleCellTextLabels: (labels: BarStyleCellTextLabels) => boolean;
+/** Join active labels with a space, Cell Value first then Percent Value. */
+export declare const joinBarStyleCellTextLabels: (labels: BarStyleCellTextLabels) => string;
+export type BarStyleCellTextSlotEntry = {
+    vertical: BarStyleCellTextVerticalAlignment;
+    horizontal: BarStyleCellTextHorizontalAlignment;
+    /** Labels in render order (Cell Value first, then Percent Value). */
+    parts: string[];
+    /** The joined text, ready to render. */
+    text: string;
+};
+/**
+ * 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 declare const resolveBarStyleCellTextSlots: (props: BarStyleCellTextProperties | undefined, labels: BarStyleCellTextLabels) => BarStyleCellTextSlotEntry[];
+export type BarStyleCellTextSlotPresence = {
+    hasAbove: boolean;
+    hasBelow: boolean;
+    hasMerged: boolean;
+};
+export declare const getBarStyleCellTextSlotPresence: (props: BarStyleCellTextProperties | undefined) => BarStyleCellTextSlotPresence;
+export declare const formatBarStyleCellTextLayoutSummary: (layout: BarStyleCellTextLayout) => string | undefined;
+export type MountBarStyleCellTextArgs = {
+    wrapperEl: HTMLElement;
+    mergedOverlayEl?: HTMLElement;
+    textClassName: string;
+    cellTextProperties?: BarStyleCellTextProperties;
+    labels: BarStyleCellTextLabels;
+    mergedPointerEventsNone?: boolean;
+};
+export declare const mountBarStyleCellText: (args: MountBarStyleCellTextArgs) => void;

package/src/Utilities/Helpers/{barChartCellText.js → StyledColumns/BarStylesHelper.js}

@@ -5,12 +5,13 @@ const DEFAULT_PLACEMENT = {
 };
 const HORIZONTAL_VALUES = ['Left', 'Center', 'Right'];
 const VERTICAL_VALUES = ['Above', 'Below', 'Merged'];
-const isHorizontal = (value) => typeof value === 'string' &&
-    HORIZONTAL_VALUES.includes(value);
+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,
+    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. */
@@ -24,15 +25,15 @@ const sanitizeCellTextLayout = (layout) => {
     }
     return result;
 };
-export const resolveBarChartCellTextLayout = (props) => sanitizeCellTextLayout(props?.CellTextLayout);
+export const resolveBarStyleCellTextLayout = (props) => sanitizeCellTextLayout(props?.CellTextLayout);
 /** True when any value is configured for display. */
-export const hasBarChartCellTextConfigured = (props) => {
-    const layout = resolveBarChartCellTextLayout(props);
+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 getActiveBarChartCellTextTokens = (props) => {
-    const layout = resolveBarChartCellTextLayout(props);
+export const getActiveBarStyleCellTextTokens = (props) => {
+    const layout = resolveBarStyleCellTextLayout(props);
     const tokens = [];
     if (layout.CellValue) {
         tokens.push('CellValue');
@@ -42,7 +43,7 @@ export const getActiveBarChartCellTextTokens = (props) => {
     }
     return tokens;
 };
-export const mergeBarChartCellTextProperties = (current, patch) => {
+export const mergeBarStyleCellTextProperties = (current, patch) => {
     const merged = { ...current, ...patch };
     if (merged.CellTextLayout) {
         merged.CellTextLayout = sanitizeCellTextLayout(merged.CellTextLayout);
@@ -58,8 +59,8 @@ export const mergeBarChartCellTextProperties = (current, patch) => {
 /**
  * Set or clear a value's placement. Passing `placement: undefined` removes the value.
  */
-export const setBarChartCellTextPlacement = (current, token, placement) => {
-    const layout = resolveBarChartCellTextLayout(current);
+export const setBarStyleCellTextPlacement = (current, token, placement) => {
+    const layout = resolveBarStyleCellTextLayout(current);
     const next = { ...layout };
     const key = token === 'CellValue' ? 'CellValue' : 'PercentValue';
     if (placement) {
@@ -68,43 +69,43 @@ export const setBarChartCellTextPlacement = (current, token, placement) => {
     else {
         delete next[key];
     }
-    return mergeBarChartCellTextProperties(current, { CellTextLayout: next });
+    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 patchBarChartCellTextPlacement = (current, token, patch) => {
-    const layout = resolveBarChartCellTextLayout(current);
+export const patchBarStyleCellTextPlacement = (current, token, patch) => {
+    const layout = resolveBarStyleCellTextLayout(current);
     const key = token === 'CellValue' ? 'CellValue' : 'PercentValue';
     const existing = layout[key];
     const nextPlacement = {
         ...(existing ?? DEFAULT_PLACEMENT),
         ...patch,
     };
-    return setBarChartCellTextPlacement(current, token, nextPlacement);
+    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 toggleBarChartCellTextToken = (current, token, show) => {
-    const layout = resolveBarChartCellTextLayout(current);
+export const toggleBarStyleCellTextToken = (current, token, show) => {
+    const layout = resolveBarStyleCellTextLayout(current);
     const key = token === 'CellValue' ? 'CellValue' : 'PercentValue';
     if (show && !layout[key]) {
         return {
-            CellTextProperties: setBarChartCellTextPlacement(current, token, DEFAULT_PLACEMENT),
+            CellTextProperties: setBarStyleCellTextPlacement(current, token, DEFAULT_PLACEMENT),
         };
     }
     if (!show && layout[key]) {
         return {
-            CellTextProperties: setBarChartCellTextPlacement(current, token, undefined),
+            CellTextProperties: setBarStyleCellTextPlacement(current, token, undefined),
         };
     }
     return { CellTextProperties: current };
 };
-export const buildBarChartCellTextLabels = (props, cellValueLabel, percentageLabel) => {
-    const layout = resolveBarChartCellTextLayout(props);
+export const buildBarStyleCellTextLabels = (props, cellValueLabel, percentageLabel) => {
+    const layout = resolveBarStyleCellTextLayout(props);
     const labels = {};
     if (layout.CellValue && cellValueLabel != undefined) {
         labels.cellValue = cellValueLabel;
@@ -114,9 +115,9 @@ export const buildBarChartCellTextLabels = (props, cellValueLabel, percentageLab
     }
     return labels;
 };
-export const hasBarChartCellTextLabels = (labels) => Boolean(labels.cellValue || labels.percentage);
+export const hasBarStyleCellTextLabels = (labels) => Boolean(labels.cellValue || labels.percentage);
 /** Join active labels with a space, Cell Value first then Percent Value. */
-export const joinBarChartCellTextLabels = (labels) => {
+export const joinBarStyleCellTextLabels = (labels) => {
     const parts = [];
     if (labels.cellValue)
         parts.push(labels.cellValue);
@@ -130,8 +131,8 @@ export const joinBarChartCellTextLabels = (labels) => {
  * (vertical, horizontal) slot are concatenated with a single space, Cell
  * Value before Percent Value.
  */
-export const resolveBarChartCellTextSlots = (props, labels) => {
-    const layout = resolveBarChartCellTextLayout(props);
+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 = [];
@@ -166,8 +167,8 @@ export const resolveBarChartCellTextSlots = (props, labels) => {
     }
     return Array.from(slotMap.values());
 };
-export const getBarChartCellTextSlotPresence = (props) => {
-    const layout = resolveBarChartCellTextLayout(props);
+export const getBarStyleCellTextSlotPresence = (props) => {
+    const layout = resolveBarStyleCellTextLayout(props);
     const verticals = new Set();
     if (layout.CellValue)
         verticals.add(sanitizePlacement(layout.CellValue).Vertical);
@@ -197,7 +198,7 @@ const formatPlacementSummary = (placement) => {
     const { Horizontal, Vertical } = sanitizePlacement(placement);
     return `${VERTICAL_LABEL[Vertical]}-${HORIZONTAL_LABEL[Horizontal]}`;
 };
-export const formatBarChartCellTextLayoutSummary = (layout) => {
+export const formatBarStyleCellTextLayoutSummary = (layout) => {
     const parts = [];
     if (layout.CellValue) {
         parts.push(`${formatTokenLabel('CellValue')}: ${formatPlacementSummary(layout.CellValue)}`);
@@ -266,12 +267,12 @@ const createCellTextRow = (slots, textClassName, compact) => {
     }
     return row;
 };
-export const mountBarChartCellText = (args) => {
+export const mountBarStyleCellText = (args) => {
     const { cellTextProperties, labels, wrapperEl, textClassName } = args;
-    if (!hasBarChartCellTextConfigured(cellTextProperties) || !hasBarChartCellTextLabels(labels)) {
+    if (!hasBarStyleCellTextConfigured(cellTextProperties) || !hasBarStyleCellTextLabels(labels)) {
         return;
     }
-    const slots = resolveBarChartCellTextSlots(cellTextProperties, labels);
+    const slots = resolveBarStyleCellTextSlots(cellTextProperties, labels);
     if (!slots.length) {
         return;
     }
@@ -286,7 +287,7 @@ export const mountBarChartCellText = (args) => {
     // (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 = resolveBarChartCellTextLayout(cellTextProperties);
+    const layout = resolveBarStyleCellTextLayout(cellTextProperties);
     const compact = Boolean(layout.CellValue &&
         layout.PercentValue &&
         sanitizePlacement(layout.CellValue).Vertical !==

package/src/Utilities/Helpers/{StyledColumnGradientHelper.d.ts → StyledColumns/GradientStyleHelper.d.ts}

@@ -1,9 +1,9 @@
 import type { CSSProperties } from 'react';
 import type { IRowNode } from 'ag-grid-community';
-import { StyledColumn } from '../../AdaptableState/StyledColumnState';
-import { CellColorRange, NumericStyledColumn } from '../../AdaptableState/StyledColumns/Common/NumericStyledColumn';
-import { GradientStyle } from '../../AdaptableState/StyledColumns/GradientStyle';
-import { AdaptableApi } from '../../Api/AdaptableApi';
+import { StyledColumn } from '../../../AdaptableState/StyledColumnState';
+import { CellColorRange, NumericStyledColumn } from '../../../AdaptableState/StyledColumns/Common/NumericStyledColumn';
+import { GradientStyle } from '../../../AdaptableState/StyledColumns/GradientStyle';
+import { AdaptableApi } from '../../../Api/AdaptableApi';
 /**
  * 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

package/src/Utilities/Helpers/{StyledColumnGradientHelper.js → StyledColumns/GradientStyleHelper.js}

@@ -1,7 +1,7 @@
 import tinycolor from 'tinycolor2';
-import { convertAdaptableStyleToCSS } from './StyleHelper';
-import { getAutoContrastTextColor, getVariableColor } from './StyleHelper';
-import clamp from '../utils/clamp';
+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

package/src/Utilities/Helpers/{IconStylePresets.d.ts → StyledColumns/IconStyleHelper.d.ts}

@@ -1,4 +1,9 @@
-import { IconStyleBuiltInPreset, IconStyleMapping } from '../../AdaptableState/StyledColumns/IconStyle';
+import { IconStyleBuiltInPreset, IconStyleMapping } from '../../../AdaptableState/StyledColumns/IconStyle';
+/**
+ * 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 declare function isUnsupportedColumnDataTypeForIconStyle(dataType?: string): boolean;
 export declare const ICON_STYLE_PRESETS: Record<IconStyleBuiltInPreset, IconStyleMapping[]>;
 /** Returns a fresh copy of the mappings for a given preset. */
 export declare const getIconStylePresetMappings: (preset: IconStyleBuiltInPreset) => IconStyleMapping[];

package/src/Utilities/Helpers/{IconStylePresets.js → StyledColumns/IconStyleHelper.js}

@@ -1,3 +1,18 @@
+/**
+ * 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':
+        case 'numberArray':
+        case 'tupleArray':
+        case 'objectArray':
+            return true;
+        default:
+            return false;
+    }
+}
 /**
  * Built-in {@link IconStyle} mapping presets.
  *

package/src/Utilities/Helpers/{percentBarPreviewHelper.d.ts → StyledColumns/PercentBarStyleHelper.d.ts}

@@ -1,5 +1,5 @@
-import { StyledColumn } from '../../AdaptableState/StyledColumnState';
-import { PercentBarStyle } from '../../AdaptableState/StyledColumns/PercentBarStyle';
+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 → StyledColumns/PercentBarStyleHelper.js}

@@ -1,7 +1,7 @@
-import { getVariableColor } from './StyleHelper';
-import clamp from '../utils/clamp';
-import { STYLED_COLUMN_PREVIEW_SAMPLE_COUNT, ZERO_CENTRED_PREVIEW_SCALE_MAX, ZERO_CENTRED_PREVIEW_SCALE_MIN, } from './StyledColumnGradientHelper';
-import { buildBarChartCellTextLabels, joinBarChartCellTextLabels, } from './barChartCellText';
+import { getVariableColor } from '../StyleHelper';
+import { clamp } from '../../Extensions/NumberExtensions';
+import { STYLED_COLUMN_PREVIEW_SAMPLE_COUNT, ZERO_CENTRED_PREVIEW_SCALE_MAX, ZERO_CENTRED_PREVIEW_SCALE_MIN, } from './GradientStyleHelper';
+import { buildBarStyleCellTextLabels, joinBarStyleCellTextLabels } from './BarStylesHelper';
 const evenlySpacedValues = (min, max, count) => {
     if (count <= 1) {
         return [min];
@@ -125,8 +125,8 @@ export const getPercentBarPreviewGeometry = (numericValue, pb, min, max) => {
     };
 };
 export const formatPercentBarPreviewCellText = (numericValue, percentageValue, pb) => {
-    const labels = buildBarChartCellTextLabels(pb.CellTextProperties, Number.isInteger(numericValue) ? String(numericValue) : numericValue.toFixed(1), `${percentageValue.toFixed(0)}%`);
-    return joinBarChartCellTextLabels(labels);
+    const labels = buildBarStyleCellTextLabels(pb.CellTextProperties, Number.isInteger(numericValue) ? String(numericValue) : numericValue.toFixed(1), `${percentageValue.toFixed(0)}%`);
+    return joinBarStyleCellTextLabels(labels);
 };
 export const getPercentBarPreviewTrackColor = (pb) => {
     if (pb.ColumnComparison) {
@@ -134,5 +134,5 @@ export const getPercentBarPreviewTrackColor = (pb) => {
     }
     return pb.BackColor ?? undefined;
 };
-export const getPercentBarPreviewResolvedBarColor = (color) => color ? getVariableColor(color) : undefined;
+export const getPercentBarPreviewResolvedBarColor = (color) => (color ? getVariableColor(color) : undefined);
 export const hasPercentBarStylePreview = (styledColumn) => hasPercentBarRangesConfigured(styledColumn.PercentBarStyle);

package/src/Utilities/Helpers/{SparklineOptionsHelper.js → StyledColumns/SparklineStyleHelper.js}

@@ -1,4 +1,4 @@
-import { getVariableColor } from './StyleHelper';
+import { getVariableColor } from '../StyleHelper';
 const resolveCssColor = (color) => {
     if (color == null || color === '') {
         return color;

package/src/Utilities/Helpers/StyledColumns/StyledColumnHelper.d.ts

@@ -0,0 +1,52 @@
+import type { IRowNode } from 'ag-grid-enterprise';
+import type { AdaptableApi } from '../../../Api/AdaptableApi';
+import type { StyledColumn } from '../../../AdaptableState/StyledColumnState';
+import type { RowScope } from '../../../AdaptableState/Common/RowScope';
+/**
+ * Row kinds used by {@link RowScope} and the Styled Column Scope wizard.
+ * All are available to all Styled Columns with exception of Sparkline (which is data rows only)
+ */
+export type StyledColumnRowKind = 'Data' | 'Group' | 'Summary' | 'Total';
+export declare const STYLED_COLUMN_ROW_KINDS: StyledColumnRowKind[];
+export declare const STYLED_COLUMN_ROW_KIND_EXCLUDE_KEY: Record<StyledColumnRowKind, keyof RowScope>;
+export declare const isStyledColumnRowKindSupported: (styledColumn: StyledColumn, kind: StyledColumnRowKind) => boolean;
+export declare const getStyledColumnRowKindDisabledReason: (styledColumn: StyledColumn, kind: StyledColumnRowKind) => string | undefined;
+/**
+ * Classifies the AG Grid row node into a single {@link StyledColumnRowKind}.
+ * Order matches {@link shouldRenderStyledColumnOnRow}: total before summary,
+ * summary before group.
+ */
+export declare const getStyledColumnRowKindForNode: (node: IRowNode, api: AdaptableApi) => StyledColumnRowKind;
+/**
+ * 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 declare const sanitizeStyledColumnRowScope: (styledColumn: StyledColumn) => RowScope | 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 declare const shouldRenderStyledColumnOnRow: (styledColumn: StyledColumn, node: IRowNode, api: AdaptableApi) => boolean;