@adaptabletools/adaptable 22.1.0 → 22.1.1-canary.1

package/src/AdaptableOptions/ExpressionOptions.d.ts

@@ -16,49 +16,42 @@ export interface ExpressionOptions<TData = any> {
      * System Boolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
-     * @gridInfoItem
      */
     systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);
     /**
      * Custom Boolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (none)
-     * @gridInfoItem
      */
     customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);
     /**
      * System Scalar Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
-     * @gridInfoItem
      */
     systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);
     /**
      * Custom Scalar Expression Functions available in AdapTableQL
      *
      * @defaultValue null (none)
-     * @gridInfoItem
      */
     customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);
     /**
      * System Observable Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
-     * @gridInfoItem
      */
     systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);
     /**
      * System AggregatedBoolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
-     * @gridInfoItem
      */
     systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);
     /**
      * System AggregatedScalar Expression Functions available in AdapTableQL
      *
      * @defaultValue undefined (sets all)
-     * @gridInfoItem
      */
     systemAggregatedScalarFunctions?: AggregatedScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedScalarFunctionName>) => AggregatedScalarFunctionName[]);
     /**
@@ -69,7 +62,6 @@ export interface ExpressionOptions<TData = any> {
      * Module-specific Expression Functions available
      *
      * @defaultValue undefined (defaults to available System & Custom values)
-     * @gridInfoItem
      */
     moduleExpressionFunctions?: ModuleExpressionFunctionsMap | ((context: ModuleExpressionFunctionsContext) => ModuleExpressionFunctions | undefined);
     /**
@@ -80,14 +72,12 @@ export interface ExpressionOptions<TData = any> {
      * Validate Expressions before they can be run or saved
      *
      * @defaultValue true
-     * @gridInfoItem
      */
     performExpressionValidation?: boolean;
     /**
      * Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe
      *
      * @defaultValue 28800000 (~8 hours)
-     * @gridInfoItem
      */
     maxTimeframeSize?: number;
     /**
@@ -105,7 +95,6 @@ export interface ExpressionOptions<TData = any> {
      * Perform case-sensitive text comparisons when evaluating Expressions
      *
      * @defaultValue false
-     * @gridInfoItem
      * @noCodeItem
      */
     caseSensitiveExpressions?: boolean;
@@ -151,49 +140,42 @@ export interface ModuleExpressionFunctions {
      * System Boolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
-     * @gridInfoItem
      */
     systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);
     /**
      * Custom Boolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (none)
-     * @gridInfoItem
      */
     customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);
     /**
      * System Scalar Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
-     * @gridInfoItem
      */
     systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);
     /**
      * Custom Scalar Expression Functions available in AdapTableQL
      *
      * @defaultValue null (none)
-     * @gridInfoItem
      */
     customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);
     /**
      * System Observable Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
-     * @gridInfoItem
      */
     systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);
     /**
      * System AggregatedBoolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
-     * @gridInfoItem
      */
     systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);
     /**
      * System AggregatedScalar Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
-     * @gridInfoItem
      */
     systemAggregatedScalarFunctions?: AggregatedScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedScalarFunctionName>) => AggregatedScalarFunctionName[]);
 }

package/src/AdaptableOptions/Fdc3Options.d.ts

@@ -32,10 +32,14 @@ export interface Fdc3Options {
     contexts?: Fdc3ContextOptions;
     /**
      * Configures the default FDC3 Actions column
+     *
+     * @defaultValue { columnId: 'fdc3ActionColumn', headerName: 'FDC3 Actions', width: 200, resizable: true, movable: false, rowScope: { ExcludeDataRows: false, ExcludeGroupRows: true, ExcludeSummaryRows: true, ExcludeTotalRows: true } }
      */
     actionColumnDefaultConfiguration?: ActionColumnDefaultConfiguration;
     /**
      * Customises FDC3 UI Controls
+     *
+     * @defaultValue { contexts: {}, intents: {} }
      */
     uiControlsDefaultConfiguration?: {
         contexts?: {
@@ -119,7 +123,7 @@ export interface ActionColumnDefaultConfiguration {
     resizable?: boolean;
     /**
      * If Column is movable
-     * @defaultValue true
+     * @defaultValue false
      */
     movable?: boolean;
     /**

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -20,8 +20,7 @@ export interface FilterOptions<TData = any> {
     /**
      * Clear Grid and Column Filters when AdapTable loads
      *
-     * @defaultValue true
-     * @gridInfoItem
+     * @defaultValue false
      * @noCodeItem
      */
     clearFiltersOnStartUp?: boolean;
@@ -41,7 +40,6 @@ export interface FilterOptions<TData = any> {
      * Allow filtering on Calculated & FreeText columns
      *
      * @defaultValue true
-     * @gridInfoItem
      */
     enableFilterOnSpecialColumns?: boolean;
     /**
@@ -53,7 +51,6 @@ export interface FilterOptions<TData = any> {
     isRowFilterable?: (context: IsRowFilterableContext) => boolean;
     /**
      * Show Date Picker (or Date Input) in Filter controls
-     * @gridInfoItem
      * @noCodeItem
      * @defaultValue true
      */
@@ -74,7 +71,6 @@ export interface ColumnFilterOptions<TData = any> {
      * Make Column Header distinctive for filtered columns, helps users see currently filtered columns
      *
      * @defaultValue true
-     * @gridInfoItem
      * @noCodeItem
      */
     indicateFilteredColumns?: boolean;
@@ -82,7 +78,6 @@ export interface ColumnFilterOptions<TData = any> {
      * Manually apply Column Filters; an Apply Filter button is displayed and Quick Filter is disabled
      *
      * @defaultValue false
-     * @gridInfoItem
      * @noCodeItem
      */
     manuallyApplyColumnFilter?: boolean | ((context: AdaptableColumnContext) => boolean);
@@ -90,28 +85,24 @@ export interface ColumnFilterOptions<TData = any> {
      * Default filter type for numeric Columns
      *
      * @defaultValue Equals
-     * @gridInfoItem
      */
     defaultNumericColumnFilter?: StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'In'> | ((adaptableColumnContext: DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'In'>);
     /**
      * Default filter type for text Columns
      *
      * @defaultValue Contains
-     * @gridInfoItem
      */
     defaultTextColumnFilter?: StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'In'> | ((adaptableColumnContext: DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'In'>);
     /**
      * Default filter type for date Columns
      *
      * @defaultValue On
-     * @gridInfoItem
      */
     defaultDateColumnFilter?: StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'> | ((adaptableColumnContext: DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'>);
     /**
      * Default filter type for array Columns ('textArray', 'numberArray', etc.)
      *
      * @defaultValue In
-     * @gridInfoItem
      */
     defaultArrayColumnFilter?: StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'> | ((adaptableColumnContext: DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'>);
     /**
@@ -120,17 +111,10 @@ export interface ColumnFilterOptions<TData = any> {
      * @defaultValue undefined
      */
     hideQuickFilterDropdown?: (adaptableColumnContext: AdaptableColumnContext<TData>) => boolean;
-    /**
-     * Hides Input in Quick Filter Bar for a given Column
-     *
-     * @defaultValue undefined
-     */
-    hideQuickFilterInput?: (adaptableColumnContext: AdaptableColumnContext<TData>) => boolean;
     /**
      * Height of Quick Filter Bar (if not provided, AG Grid default is used)
      *
      * @defaultValue null
-     * @gridInfoItem
      */
     quickFilterHeight?: number;
     /**
@@ -141,12 +125,13 @@ export interface ColumnFilterOptions<TData = any> {
     showQuickFilter?: boolean;
     /**
      * Shortcut Keys to activate a Quick Filter Predicate
+     *
+     * @defaultValue {}
      */
     quickFilterWildcards?: Partial<Record<SystemAlertPredicateId, string[]>>;
     /**
      * Time to wait (in ms) before Filter Bar reacts to new value
      * @defaultValue 250
-     * @gridInfoItem
      */
     quickFilterDebounce?: number;
 }

package/src/AdaptableOptions/NoteOptions.d.ts

@@ -19,6 +19,12 @@ export interface NoteOptions<TData = any> {
      * @defaultValue true
      */
     showPopupCloseButton?: boolean;
+    /**
+     * Whether to show Notes by hovering (default) or via context menu
+     *
+     * @defaultValue 'hover'
+     */
+    showNoteAction?: 'hover' | 'menu';
 }
 /**
  * Context used when determining if a Note can be added to a Cell

package/src/AdaptableOptions/NotificationsOptions.d.ts

@@ -6,7 +6,6 @@ export interface NotificationsOptions {
      * How many Notifications can be displayed at one time
      *
      * @defaultValue  3
-     * @gridInfoItem
      * noCodeItem
      */
     maxNotifications?: number;
@@ -14,63 +13,54 @@ export interface NotificationsOptions {
      * Where Notification will appear (if anywhere)
      *
      * @defaultValue 'BottomRight'
-     * @gridInfoItem
      */
     position?: ToastPositions;
     /**
      * How long (in ms) Notifications display for
      *
      * @defaultValue 3000
-     * @gridInfoItem
      */
     duration?: number | 'always';
     /**
      * Shows a Progress Bar in the Notification
      *
      * @defaultValue false
-     * @gridInfoItem
      */
     showProgressBar?: boolean;
     /**
      * Closes Notification automatically when its clicked
      *
      * @defaultValue false
-     * @gridInfoItem
      */
     closeWhenClicked?: boolean;
     /**
      * Pauses the Notification when mouse hovers over it
      *
      * @defaultValue false
-     * @gridInfoItem
      */
     pauseWhenHovering?: boolean;
     /**
      * Can Notification be dragged
      *
      * @defaultValue false
-     * @gridInfoItem
      */
     isDraggable?: boolean;
     /**
      * How Notification will appear: Bounce, Slide, Zoom or Flip
      *
      * @defaultValue 'Slide'
-     * @gridInfoItem
      */
     transition?: 'Bounce' | 'Slide' | 'Zoom' | 'Flip';
     /**
      * Display System Status Messages as Notifications
      *
      * @defaultValue false
-     * @gridInfoItem
      */
     showSystemStatusMessageNotifications?: boolean;
     /**
      * How many System Status Messages to hold in State; when limit is reached, oldest Message is removed
      *
      * @defaultValue  100
-     * @gridInfoItem
      * @transition
      */
     maxSystemMessagesInStore?: number;

package/src/AdaptableOptions/PredicateOptions.d.ts

@@ -6,33 +6,44 @@ import { AdaptablePredicateDef, ColumnScope, BaseContext, PredicateModuleScope,
 export interface PredicateOptions {
     /**
      * Definitions for Custom provided Predicates
+     *
+     * @defaultValue []
      */
     customPredicateDefs?: (AdaptablePredicateDef | AdaptablePredicateDefPartialWithExtends)[];
     /**
      * Which System Predicates are available when Filtering
+     *
+     * @defaultValue all `SystemFilterPredicateIds`
      */
     systemFilterPredicates?: SystemFilterPredicateIds | ((context: SystemPredicatesContext<SystemFilterPredicateId>) => SystemFilterPredicateIds);
     /**
      * Which System Predicates are available for Badge Styles
+     *
+     * @defaultValue all `SystemBadgeStylePredicateIds`
      */
     systemBadgeStylePredicates?: SystemBadgeStylePredicateIds | ((context: SystemPredicatesContext<SystemBadgeStylePredicateId>) => SystemBadgeStylePredicateIds);
     /**
      * Which System Predicates are available in Alert Module
+     *
+     * @defaultValue all `SystemAlertPredicateIds`
      */
     systemAlertPredicates?: SystemAlertPredicateIds | ((context: SystemPredicatesContext<SystemAlertPredicateId>) => SystemAlertPredicateIds);
     /**
      * Which System Predicates are available in Format Column Module
+     *
+     * @defaultValue all `SystemFormatColumnPredicateIds`
      */
     systemFormatColumnPredicates?: SystemFormatColumnPredicateIds | ((context: SystemPredicatesContext<SystemFormatColumnPredicateId>) => SystemFormatColumnPredicateIds);
     /**
      * Which System Predicates are available in Flashing Cell Module
+     *
+     * @defaultValue all `SystemFlashingCellPredicateIds`
      */
     systemFlashingCellPredicates?: SystemFlashingCellPredicateIds | ((context: SystemPredicatesContext<SystemFlashingCellPredicateId>) => SystemFlashingCellPredicateIds);
     /**
      * Perform case-sensitive text comparisons when evaluating Predicates
      *
      * @defaultValue false
-     * @gridInfoItem
      * @noCodeItem
      */
     caseSensitivePredicates?: boolean | ((context: AdaptableColumnContext) => boolean);

package/src/AdaptableOptions/QuickSearchOptions.d.ts

@@ -17,21 +17,18 @@ export interface QuickSearchOptions<TData = any> {
      * Value to use as placeholder in QuickSearch controls (e.g. in Dashboard)
      *
      * @defaultValue 'Search'
-     * @gridInfoItem
      */
     quickSearchPlaceholder?: string;
     /**
      * Clears saved searches when AdapTable loads
      *
      * @defaultValue false
-     * @gridInfoItem
      */
     clearQuickSearchOnStartUp?: boolean;
     /**
      * Filters Grid after quick search so only matching rows are displayed
      *
      * @defaultValue false
-     * @gridInfoItem
      * @noCodeItem
      */
     filterGridAfterQuickSearch?: boolean;
@@ -39,7 +36,6 @@ export interface QuickSearchOptions<TData = any> {
      * Run Quick Search using Case Sensitivity
      *
      * @defaultValue false
-     * @gridInfoItem
      * @noCodeItem
      */
     isQuickSearchCaseSensitive?: boolean;

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -9,7 +9,6 @@ export interface SettingsPanelOptions {
      * Title for the Settings Panel
      *
      * @defaultValue 'Settings Panel'
-     * @gridInfoItem
      */
     title?: string;
     /**
@@ -20,20 +19,17 @@ export interface SettingsPanelOptions {
     /**
      * Whether to show Icons for each Module in the Setting Panel
      * @defaultValue true
-     * @gridInfoItem
      */
     showModuleIcons?: boolean;
     /**
      * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of Dashboard
      * @defaultValue false
-     * @gridInfoItem
      *  @noCodeItem
      */
     alwaysShowInDashboard?: boolean;
     /**
      * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of ToolPanel
      * @defaultValue false
-     * @gridInfoItem
      *  @noCodeItem
      */
     alwaysShowInToolPanel?: boolean;
@@ -66,13 +62,19 @@ export interface SettingsPanelOptions {
     /**
      * Whether Settings Panel is 'window' (i.e. movable, resizable, no backdrop) or 'modal' (centre of screen with backdrop)
      *
-     * @defaultValue 'window'
+     * @defaultValue 'modal'
      */
     popupType?: PopupType;
     /**
      * Custom Settings Panels provided by developers at design-time
      */
     customSettingsPanels?: CustomSettingsPanel[];
+    /**
+   * Which Tabs can be used to display Grid Info: 'Grid Options', 'Grid Summary' or 'Grid State'
+   *
+   * @defaultValue ['Grid Options', 'Grid Summary', 'Grid State']
+   */
+    gridInfoTabs?: GridInfoTabs;
 }
 /**
  * Definition of a Custom Panel to add to the Adaptable Settings Panel
@@ -99,3 +101,11 @@ export interface CustomSettingsPanel {
  * Type of Popup
  */
 export type PopupType = 'modal' | 'window';
+/**
+ * List of Editors that can be used when creating the Grid Filter
+ */
+export type GridInfoTabs = GridInfoTab[];
+/**
+ * Tab to use for Grid Info: 'Grid Options', 'Grid Summary' or 'Grid State'
+ */
+export type GridInfoTab = 'Grid Options' | 'Grid Summary' | 'Grid State';

package/src/AdaptableOptions/TeamSharingOptions.d.ts

@@ -8,7 +8,6 @@ export interface TeamSharingOptions {
      * Whether Team Sharing is enabled
      *
      * @defaultValue false
-     * @gridInfoItem
      */
     enableTeamSharing: boolean;
     /**
@@ -39,14 +38,12 @@ export interface TeamSharingOptions {
      * Frequency (in minutes) to check if Active Shared Entities have a newer revision
      *
      * @defaultValue 0 (never)
-     * @gridInfoItem
      */
     updateInterval?: number;
     /**
      * How user is informed when Active Shared Entities have newer revisions
      *
      * @defaultValue null (none)
-     * @gridInfoItem
      */
     updateNotification?: 'Alert' | 'AlertWithNotification' | 'SystemStatus';
     /**
@@ -58,7 +55,6 @@ export interface TeamSharingOptions {
      * Suppress warning when an Import overrides existing Adaptable State item
      *
      * @defaultValue false
-     * @gridInfoItem
      */
     suppressOverrideConfigWarning?: boolean;
 }

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -10,7 +10,6 @@ export interface ToolPanelOptions {
      * Display the Tool Panels dropdown
      *
      * @defaultValue true
-     * @gridInfoItem
      * @noCodeItem
      */
     showToolPanelsDropdown?: boolean;

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -11,7 +11,6 @@ export interface UserInterfaceOptions<TData = any> {
      * Show Mac-like scrollbars; size is configurable via CSS variable `--ab-custom-scrollbar-size` (default: `10px`)
      *
      * @defaultValue false
-     * @gridInfoItem
      */
     useCustomMacLikeScrollbars?: boolean;
     /**
@@ -26,10 +25,13 @@ export interface UserInterfaceOptions<TData = any> {
     customIcons?: CustomIcon[] | (() => CustomIcon[]);
     /**
      * Options for managing and customizing date inputs in AdapTable
+     *
      */
     dateInputOptions?: DateInputOptions;
     /**
      * Colours to display in Colour Picker (in place of AdapTable's default set); can be hardcoded list or function
+     *
+     * @defaultValue default colors provided by AdapTable
      */
     colorPalette?: string[] | ((currentTheme: string) => string[]);
     /**
@@ -47,7 +49,7 @@ export interface UserInterfaceOptions<TData = any> {
     /**
      * Optional list of CSS styles that can be used when creating Adaptable Styles in Adaptable (e.g. in Format Column and other Modules)
      *
-     * @gridInfoItem
+     * @defaultValue []
      */
     styleClassNames?: string[];
     /**
@@ -58,28 +60,24 @@ export interface UserInterfaceOptions<TData = any> {
      * Provide links to AdapTable documentation (in Module popups and Expression Editor)
      *
      * @defaultValue true
-     * @gridInfoItem
      */
     showDocumentationLinks?: boolean;
     /**
      * Displays the AdapTable version in Grid Info section of Settings Panel
      *
      * @defaultValue true
-     * @gridInfoItem
      */
     showAdapTableVersion?: boolean;
     /**
      * Displays the AG Grid version in Grid Info section of Settings Panel
      *
      * @defaultValue true
-     * @gridInfoItem
      */
     showAgGridVersion?: boolean;
     /**
      * English variant to use in AdapTable UI
      *
      * @defaultValue 'GB'
-     * @gridInfoItem
      */
     englishVariant?: 'GB' | 'US';
     /**
@@ -96,6 +94,7 @@ export interface UserInterfaceOptions<TData = any> {
     alternativeModuleNames?: AlternativeModuleName[];
     /**
      * Options for showing Loading Screen (during initialisation)
+     *
      */
     loadingScreenOptions?: LoadingScreenOptions;
 }
@@ -123,7 +122,7 @@ export interface LoadingScreenOptions<TData = any> {
     /**
      * Text to display in Loading Screen.
      *
-     * @defaultValue 'Retrieving your settings and setting up Grid...'
+     * @defaultValue 'Retrieving your settings and setting up the grid...'
      */
     loadingScreenText?: string;
 }

package/src/AdaptableState/Common/AdaptableFormat.d.ts

@@ -78,6 +78,15 @@ export interface NumberFormatterOptions extends BaseFormatterOptions {
      * Show nothing in cell (but underlying value remains)
      */
     Empty?: boolean;
+    /**
+     * Numeric notation to use when rendering the value.
+     *
+     * - `'standard'` (default) — renders the number normally.
+     * - `'scientific'` — renders the number in scientific notation
+     *   (e.g. `1.23e+5`). When set, `IntegerSeparator` is ignored
+     *   and `FractionDigits` controls the number of mantissa digits.
+     */
+    Notation?: 'standard' | 'scientific';
 }
 /**
  * Formatter Options for Date Columns - contains a single `Pattern` property

package/src/AdaptableState/Common/AdaptableFormatPresets.d.ts

@@ -0,0 +1,31 @@
+import { AdaptableFormat, NumberFormatterOptions } from './AdaptableFormat';
+/**
+ * Named preset for a numeric Display Format.
+ *
+ * When a Format Column's `DisplayFormat` is set to one of these values,
+ * AdapTable resolves it at render time to the corresponding concrete
+ * `AdaptableFormat` (a `NumberFormatter` with the appropriate options).
+ */
+export type AdaptableNumericFormatPreset = 'Percentage' | 'Thousand' | 'Million' | 'Billion' | 'BasisPoints' | 'Dollar' | 'Sterling' | 'Euro' | 'Yen' | 'Bitcoin' | 'Integer' | 'Decimal' | 'Accounting' | 'FXRate' | 'Scientific';
+/**
+ * The full set of values a Format Column's `DisplayFormat` may hold:
+ * either a concrete `AdaptableFormat` object or the name of a numeric
+ * preset (e.g. `'Dollar'`).
+ */
+export type DisplayFormat = AdaptableFormat | AdaptableNumericFormatPreset;
+/**
+ * Concrete options associated with each numeric preset. The wizard and
+ * runtime resolver both pull from this single source of truth.
+ */
+export declare const NUMERIC_FORMAT_PRESETS: Record<AdaptableNumericFormatPreset, NumberFormatterOptions>;
+/**
+ * Type guard: `true` if the value is a known numeric preset name.
+ */
+export declare const isAdaptableNumericFormatPreset: (value: unknown) => value is AdaptableNumericFormatPreset;
+/**
+ * Resolve a `DisplayFormat` (preset name or concrete object) into a
+ * concrete `AdaptableFormat`. Returns `undefined` if the input is
+ * `undefined`. A bare preset name is expanded into a `NumberFormatter`
+ * with the corresponding options.
+ */
+export declare const resolveDisplayFormat: (displayFormat: DisplayFormat | undefined) => AdaptableFormat | undefined;