@adaptabletools/adaptable 22.1.0 → 22.1.1-canary.0

package/index.css

@@ -1,4 +1,4 @@
-/*! tailwindcss v4.2.3 | MIT License | https://tailwindcss.com */
+/*! tailwindcss v4.3.0 | MIT License | https://tailwindcss.com */
 @layer properties;
 @layer adaptable.reset, adaptable.theming, adaptable.components, adaptable.utilities, adaptable.theme;
 @layer adaptable.reset {
@@ -316,6 +316,9 @@
   .twa\:mr-4 {
     margin-right: calc(var(--ab-base-space) * 4);
   }
+  .twa\:mr-6 {
+    margin-right: calc(var(--ab-base-space) * 6);
+  }
   .twa\:mr-\[2px\] {
     margin-right: 2px;
   }
@@ -3675,7 +3678,6 @@
     --ab-color-inputborder: var(--ab-color-primarydark);
     --ab-color-inputcolor: var(--ab-color-text-on-primary);
     --ab-color-error: #dc3545;
-    --ab-color-errorlight: #ffd3d2;
     --ab-color-warn: #eb9316;
     --ab-color-info: #17a2b8;
     --ab-color-success: #419641;
@@ -3686,12 +3688,10 @@
     --ab-color-text-on-error: white;
     --ab-color-text-on-info: white;
     --ab-color-text-on-warn: white;
-    --ab-color-action-add: #2966a8;
     --ab-color-action-edit: #17a2b8;
     --ab-color-action-share: #eb9316;
     --ab-color-action-delete: #dc3545;
     --ab-color-action-clone: #419641;
-    --ab-color-text-on-add: white;
     --ab-color-text-on-edit: white;
     --ab-color-text-on-share: white;
     --ab-color-text-on-delete: white;
@@ -3704,9 +3704,9 @@
     --ab-color-text-on-primary: #656565;
     --ab-color-primary-foreground: var(--ab-color-text-on-primary);
     --ab-color-text-on-primarydark: var(--ab-color-text-on-primary);
-    --ab-color-blue: blue;
     --ab-color-focus: var(--ab-color-accent);
-    --ab-gridheader--filtered__background: var(--ab-color-primary);
+    --ab-color-filtered-columns: var(--ab-color-text-on-primary);
+    --ab-color-filtered-columns-background: var(--ab-color-primary);
     --ab-color-shadow: rgb(0 0 0 / 0.2);
     --ab-shadow-sm: 0 0px 3px 0 var(--ab-color-shadow), 0 1px 2px -1px var(--ab-color-shadow);
     --ab-shadow-md: 0 -2px 6px -1px var(--ab-color-shadow), 0 2px 4px -2px var(--ab-color-shadow);
@@ -3746,7 +3746,8 @@
   }
   .ab-Grid.ab-Grid--indicate-filtered-columns .ag-header-cell-filtered {
     font-weight: bolder !important;
-    background: var(--ab-gridheader--filtered__background) !important;
+    color: var(--ab-color-filtered-columns) !important;
+    background: var(--ab-color-filtered-columns-background) !important;
   }
   .ab-Grid .ag-pivot-mode-panel {
     display: none !important;
@@ -6766,5 +6767,3 @@
     }
   }
 }
-
-/*# sourceMappingURL=index.css.map */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "22.1.0",
+  "version": "22.1.1-canary.0",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -4,7 +4,7 @@ import { AdaptableColumn } from '../AdaptableState/Common/AdaptableColumn';
 import { ColumnSort } from '../AdaptableState/Common/ColumnSort';
 import { DataRowConfig, DataUpdateConfig } from '../AdaptableState/Common/DataUpdateConfig';
 import { Layout } from '../AdaptableState/LayoutState';
-import { GridCell, GridCellWithChildren } from '../AdaptableState/Selection/GridCell';
+import { GridCell, GridCellWithChildren, CellUpdateRequest } from '../AdaptableState/Selection/GridCell';
 import { SelectedCellInfo } from '../AdaptableState/Selection/SelectedCellInfo';
 import { AdaptableTheme } from '../AdaptableState/ThemeState';
 import { IAdaptableStore } from '../Redux/Store/Interface/IAdaptableStore';
@@ -206,7 +206,7 @@ export interface IAdaptable {
     forPlugins(callback: (plugin: AdaptablePlugin) => any): void;
     getPluginProperty(pluginId: string, propertyName: string, ...args: any): any;
     getPlugin(pluginId: string): AdaptablePlugin;
-    setDataValue(value: any, column: AdaptableColumn, primaryKeyValue: any, rowNode?: IRowNode): void;
+    updateCell(cellUpdateRequest: CellUpdateRequest): void;
     getFirstRowNode(): IRowNode | undefined;
     getFirstDisplayedRowNode(): IRowNode | undefined;
     forAllRowNodesDo(func: (rowNode: IRowNode) => void, config?: {

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -42,7 +42,6 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
      * Identifier for this instance of AdapTable
      *
      * @defaultValue 'adaptable_id_${random_number}'
-     * @gridInfoItem
      * @noCodeItem
      */
     adaptableId?: string;
@@ -50,14 +49,12 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
      * Identifier used as localStorage persistence key for AdaptableState
      *
      * @defaultValue `adaptableId` value
-     * @gridInfoItem
      */
     adaptableStateKey?: string;
     /**
      * Will autogenerate a Primary Key; only use as a last resort if no unique column is available, as limits some Adaptable functionalities
      *
      * @defaultValue false
-     * @gridInfoItem
      */
     autogeneratePrimaryKey?: boolean;
     /**
@@ -66,6 +63,8 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
     licenseKey?: string;
     /**
      * Application-specific context object - is included by AdapTable in all callbacks and Events
+     *
+     * @defaultValue {}
      */
     adaptableContext?: TContext;
     /**
@@ -78,14 +77,12 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
      * Name of Column in AdapTable guaranteed to contain unique values
      *
      * @defaultValue n/a (Mandatory)
-     * @gridInfoItem
      */
     primaryKey: string;
     /**
      * Name of current AdapTable user
      *
      * @defaultValue 'anonymous'
-     * @gridInfoItem
      */
     userName?: string;
     /**
@@ -95,7 +92,6 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
     /**
      * Options for managing Alerts in AdapTable
      *
-     * @gridInfoContainer
      * @noCodeContainer
      */
     alertOptions?: AlertOptions<TData>;
@@ -120,7 +116,6 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
     /**
      * Options for managing AdapTable Column Menu
      *
-     * @gridInfoContainer
      */
     columnMenuOptions?: ColumnMenuOptions<TData>;
     /**
@@ -134,7 +129,6 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
     /**
      * Options for managing AdapTable Context Menu
      *
-     * @gridInfoContainer
      */
     contextMenuOptions?: ContextMenuOptions<TData>;
     /**
@@ -144,14 +138,12 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
     /**
      * Options for managing the Dashboard in AdapTable
      *
-     * @gridInfoContainer
      * @noCodeContainer
      */
     dashboardOptions?: DashboardOptions;
     /**
      * Options to manage Data Change History Module which provides an overview of all data changes
      *
-     * @gridInfoContainer
      * @noCodeContainer
      */
     dataChangeHistoryOptions?: DataChangeHistoryOptions<TData>;
@@ -166,19 +158,16 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
     /**
      * Options related to Editing in AdapTable including Server Validation
      *
-     * @gridInfoContainer
      */
     editOptions?: EditOptions<TData>;
     /**
      * Options for managing Entitlements
      *
-     * @gridInfoContainer
      */
     entitlementOptions?: EntitlementOptions;
     /**
      * Options for managing Exporting and Reports in AdapTable
      *
-     * @gridInfoContainer
      */
     exportOptions?: ExportOptions<TData>;
     /**
@@ -193,7 +182,6 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
     /**
      * Options for managing Flashing Cells - primarily default values
      *
-     * @gridInfoContainer
      */
     flashingCellOptions?: FlashingCellOptions;
     /**
@@ -207,7 +195,6 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
     /**
      * Options related to Layouts
      *
-     * @gridInfoContainer
      * @noCodeContainer
      */
     layoutOptions?: LayoutOptions;
@@ -218,7 +205,6 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
     /**
      * Options for managing Notifications in AdapTable
      *
-     * @gridInfoContainer
      * @noCodeContainer
      */
     notificationsOptions?: NotificationsOptions;
@@ -229,7 +215,6 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
     /**
      * Options for managing Search related functions in AdapTable
      *
-     * @gridInfoContainer
      * @noCodeContainer
      */
     quickSearchOptions?: QuickSearchOptions<TData>;
@@ -240,7 +225,6 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
     /**
      * Setting panel options
      *
-     * @gridInfoContainer
      * @noCodeContainer
      */
     settingsPanelOptions?: SettingsPanelOptions;
@@ -251,20 +235,17 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
     /**
      * Options for managing 'Team Sharing' which allows users to create Adaptable Objects and share with colleagues
      *
-     * @gridInfoContainer
      */
     teamSharingOptions?: TeamSharingOptions;
     /**
      * Options related to managing the Tool Panel elements in AdapTable
      *
-     * @gridInfoContainer
      * @noCodeContainer
      */
     toolPanelOptions?: ToolPanelOptions;
     /**
      * Options for managing the User Interface elements of AdapTable, i.e. Action Columns, Color Palette etc.
      *
-     * @gridInfoContainer
      */
     userInterfaceOptions?: UserInterfaceOptions<TData>;
     /**

package/src/AdaptableOptions/AlertOptions.d.ts

@@ -11,7 +11,6 @@ export interface AlertOptions<TData = any> {
      * How many alerts held in State at any one time; when limit is breached, oldest alert will be removed
      *
      * @defaultValue  20
-     * @gridInfoItem
      * @noCodeItem
      */
     maxAlertsInStore?: number;
@@ -19,14 +18,12 @@ export interface AlertOptions<TData = any> {
      * How long (in ms) a Cell will be highlighted when an Alert fires
      *
      * @defaultValue 2000
-     * @gridInfoItem
      */
     cellHighlightDuration?: number;
     /**
      * How long (in ms) a Row will be highlighted when an Alert Fires
      *
      * @defaultValue 4000
-     * @gridInfoItem
      */
     rowHighlightDuration?: number;
     /**
@@ -47,7 +44,6 @@ export interface AlertOptions<TData = any> {
      * Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data
      *
      * @defaultValue 'rawValue'
-     * @gridInfoItem
      */
     dataChangeDetectionPolicy?: DataChangeDetectionPolicy;
     /**
@@ -62,7 +58,6 @@ export interface AlertOptions<TData = any> {
      * Shows Alert if Primary Key column in Adaptable Options is not present or incorrect
      *
      * @defaultValue false
-     * @gridInfoItem
      * @noCodeItem
      * @uiLabel Show Missing Primary Key Warning
      */

package/src/AdaptableOptions/CellSummaryOptions.d.ts

@@ -10,6 +10,8 @@ export interface CellSummaryOptions<TData = any> {
     customCellSummaryOperations?: CustomCellSummaryOperation<TData>[];
     /**
      * Numeric format to use for summary value; a Format Column DisplayFormat will take precedence
+     *
+     * @defaultValue { FractionDigits: 2 }
      */
     numericDisplayFormat?: NumberFormatterOptions | ((columnContext: AdaptableColumnContext) => NumberFormatterOptions);
 }

package/src/AdaptableOptions/ChartingOptions.d.ts

@@ -21,6 +21,8 @@ export interface ChartingOptions {
     agGridContainerName?: string;
     /**
      * Set of properties for managing behaviour of external (i.e non AG Grid) charts
+     *
+     * @defaultValue {}
      */
     externalChartingOptions?: ExternalChartingOptions;
 }

package/src/AdaptableOptions/ColumnOptions.d.ts

@@ -23,7 +23,6 @@ export interface ColumnOptions {
      * Log warning to console if AdapTable cannot find a column
      *
      * @defaultValue true
-     * @gridInfoItem
      * @noCodeItem
      */
     showMissingColumnsWarning?: boolean;
@@ -31,7 +30,6 @@ export interface ColumnOptions {
      * Appends the name of the Column Group to a Column's Friendly Name
      *
      * @defaultValue false
-     * @gridInfoItem
      * @noCodeItem
      */
     addColumnGroupToColumnFriendlyName?: boolean;

package/src/AdaptableOptions/CommentOptions.d.ts

@@ -27,6 +27,12 @@ export interface CommentOptions<TData = any> {
      * @defaultValue true
      */
     showPopupCloseButton?: boolean;
+    /**
+     * Whether to show Comments by hovering (default) or via context menu
+     *
+     * @defaultValue 'hover'
+     */
+    showCommentAction?: 'hover' | 'menu';
 }
 /**
  * Context used when determining if a cell can show Comments

package/src/AdaptableOptions/ContainerOptions.d.ts

@@ -44,37 +44,31 @@ export interface ContainerOptions {
     /**
      * Div containing AdapTable; element Id, CSS Selector, HTMLElement, or function returning one of these
      * @defaultValue "adaptable"
-     * @gridInfoItem
      */
     adaptableContainer?: AdaptableContainerValue | ((context: InitContainerContext) => AdaptableContainerValue);
     /**
      * Div containing AG Grid instance; element Id, CSS Selector, HTMLElement, or function returning one of these.
      * @defaultValue "grid"
-     * @gridInfoItem
      */
     agGridContainer?: AdaptableContainerValue | ((context: InitContainerContext) => AdaptableContainerValue);
     /**
      * Name of div where popups appear;element Id, CSS Selector, HTMLElement, or function returning one of these
      * @defaultValue undefined (centre of screen)
-     * @gridInfoItem
      */
     modalContainer?: AdaptableContainerValue | ((context: ContainerContext) => AdaptableContainerValue);
     /**
      * Div to show System Status Messages; elementId, CSS Selector, HTMLElement, or function returning one of these
      * @defaultValue undefined
-     * @gridInfoItem
      */
     systemStatusContainer?: AdaptableContainerValue | ((context: ContainerContext) => AdaptableContainerValue);
     /**
      * Div to display Alerts; elementId, CSS Selector, HTMLElement, or function returning one of these
      * @defaultValue undefined
-     * @gridInfoItem
      */
     alertContainer?: AdaptableContainerValue | ((context: ContainerContext) => AdaptableContainerValue);
     /**
      * Div to render a Transposed View; elementId, CSS Selector, HTMLElement, or function returning one of these
      * @defaultValue undefined (rendered in a draggable popup window)
-     * @gridInfoItem
      */
     transposedViewContainer?: AdaptableContainerValue | ((context: ContainerContext) => AdaptableContainerValue);
 }

package/src/AdaptableOptions/DashboardOptions.d.ts

@@ -10,7 +10,6 @@ export interface DashboardOptions {
      * Whether the Dashboard can be floated; if true (the default), double-clicking Dashboard puts it in float mode
      *
      * @defaultValue true
-     * @gridInfoItem
      * @noCodeItem
      */
     canFloat?: boolean;
@@ -18,7 +17,6 @@ export interface DashboardOptions {
      * Shows Quick Search input in Dashboard Header
      *
      * @defaultValue true
-     * @gridInfoItem
      * @noCodeItem
      */
     showQuickSearchInHeader?: boolean;

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -8,7 +8,6 @@ export interface DataChangeHistoryOptions<TData = any> {
      * Make Data Change History active by default
      *
      * @defaultValue false
-     * @gridInfoItem
      * @noCodeItem
      */
     activeByDefault?: boolean;
@@ -16,7 +15,6 @@ export interface DataChangeHistoryOptions<TData = any> {
      * Function specifying which data changes to include in Data Change History
      *
      * @defaultValue undefined (all data changes are logged)
-     * @gridInfoItem
      */
     showDataChange?: (cellDataChangedInfo: CellDataChangedInfo<TData>) => boolean;
     /**

package/src/AdaptableOptions/DataSetOptions.d.ts

@@ -6,6 +6,8 @@ import { FormContext } from '../AdaptableState/Common/FormContext';
 export interface DataSetOptions<TData = any> {
     /**
      * Collection of Data Sets to provide data to AdapTable
+     *
+     * @defaultValue []
      */
     dataSets?: DataSet[];
 }

package/src/AdaptableOptions/DefaultAdaptableOptions.js

@@ -1,6 +1,6 @@
 import * as GeneralConstants from '../Utilities/Constants/GeneralConstants';
 import UIHelper, { getHexForName, GRAY, GREEN, RED } from '../View/UIHelper';
-import { EMPTY_STRING, EMPTY_ARRAY, DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME, SYSTEM_REPORT_NAMES, SYSTEM_REPORT_FORMATS, SYSTEM_EXPORT_DESTINATIONS, } from '../Utilities/Constants/GeneralConstants';
+import { ACCESS_LEVEL_FULL, EMPTY_STRING, EMPTY_ARRAY, DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME, SYSTEM_REPORT_NAMES, SYSTEM_REPORT_FORMATS, SYSTEM_EXPORT_DESTINATIONS, } from '../Utilities/Constants/GeneralConstants';
 import { SystemAlertPredicateIds, SystemBadgeStylePredicateIds, SystemFilterPredicateIds, SystemFlashingCellPredicateIds, SystemFormatColumnPredicateIds, } from '../AdaptableState/Common/AdaptablePredicate';
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
 import { addUuidsToInitialState } from '../Utilities/Helpers/AdaptableHelper';
@@ -25,6 +25,7 @@ const DefaultAdaptableOptions = {
         commandHandlers: undefined,
         alertMessageText: undefined,
         showMissingPrimaryKeyAlert: false,
+        alertMessageHeader: undefined,
     },
     calendarOptions: { holidays: undefined },
     cellSummaryOptions: {
@@ -37,12 +38,14 @@ const DefaultAdaptableOptions = {
         saveChartBehaviour: 'none',
         agGridContainerName: GeneralConstants.AG_GRID_CHART_WINDOW,
         externalChartingOptions: {},
+        chartContainers: undefined,
     },
     columnOptions: {
         columnFriendlyName: undefined,
         columnTypes: EMPTY_ARRAY,
         showMissingColumnsWarning: true,
         addColumnGroupToColumnFriendlyName: false,
+        columnHeader: undefined,
     },
     columnMenuOptions: {
         customColumnMenu: undefined,
@@ -50,6 +53,10 @@ const DefaultAdaptableOptions = {
     commentOptions: {
         showPopupCloseButton: true,
         dateFormat: DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME,
+        isCellCommentable: undefined,
+        loadCommentThreads: undefined,
+        persistCommentThreads: undefined,
+        showCommentAction: 'hover',
     },
     containerOptions: {
         adaptableContainer: 'adaptable',
@@ -57,6 +64,7 @@ const DefaultAdaptableOptions = {
         modalContainer: undefined,
         systemStatusContainer: undefined,
         alertContainer: undefined,
+        transposedViewContainer: undefined,
     },
     contextMenuOptions: {
         customContextMenu: undefined,
@@ -77,6 +85,9 @@ const DefaultAdaptableOptions = {
     },
     dataImportOptions: {
         fileHandlers: undefined,
+        textHandler: undefined,
+        validate: undefined,
+        handleImportedData: undefined,
     },
     dataSetOptions: { dataSets: EMPTY_ARRAY },
     editOptions: {
@@ -85,9 +96,10 @@ const DefaultAdaptableOptions = {
         isCellEditable: undefined,
         smartEditCustomOperations: undefined,
         customEditColumnValues: undefined,
+        showSelectCellEditor: undefined,
     },
     entitlementOptions: {
-        defaultAccessLevel: 'Full',
+        defaultAccessLevel: ACCESS_LEVEL_FULL,
         moduleEntitlements: undefined,
     },
     exportOptions: {
@@ -103,6 +115,8 @@ const DefaultAdaptableOptions = {
         csvSeparator: ',',
         skipColumnHeaders: false,
         excelSheetName: 'Sheet 1',
+        isColumnExportable: undefined,
+        getDetailRows: undefined,
     },
     expressionOptions: {
         evaluateAdaptableQLExternally: undefined,
@@ -116,6 +130,12 @@ const DefaultAdaptableOptions = {
         performExpressionValidation: true,
         maxTimeframeSize: 28800000, // 8 hours
         caseSensitiveExpressions: false,
+        customAggregatedFunctions: undefined,
+        customBooleanFunctions: undefined,
+        customQueryVariables: undefined,
+        customScalarFunctions: undefined,
+        fields: undefined,
+        isColumnQueryable: undefined,
     },
     fdc3Options: {
         enableLogging: false,
@@ -147,6 +167,8 @@ const DefaultAdaptableOptions = {
         enableFilterOnSpecialColumns: true,
         useAdaptableFiltering: true,
         showDatePicker: true,
+        isRowFilterable: undefined,
+        customInFilterValues: undefined,
         columnFilterOptions: {
             indicateFilteredColumns: true,
             manuallyApplyColumnFilter: false,
@@ -155,7 +177,6 @@ const DefaultAdaptableOptions = {
             defaultDateColumnFilter: 'On',
             defaultArrayColumnFilter: 'In',
             hideQuickFilterDropdown: undefined,
-            hideQuickFilterInput: undefined,
             quickFilterDebounce: 250,
             quickFilterHeight: null,
             showQuickFilter: true,
@@ -182,6 +203,8 @@ const DefaultAdaptableOptions = {
         customDisplayFormatters: undefined,
     },
     layoutOptions: {
+        layoutCreationDefaultProperties: undefined,
+        pivotPreviewColumns: undefined,
         layoutViewOptions: {
             maxColumnsToDisplay: 10,
         },
@@ -194,6 +217,8 @@ const DefaultAdaptableOptions = {
     noteOptions: {
         showPopupCloseButton: true,
         dateFormat: DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME,
+        isCellNotable: undefined,
+        showNoteAction: 'hover',
     },
     notificationsOptions: {
         maxNotifications: 3,
@@ -224,6 +249,7 @@ const DefaultAdaptableOptions = {
         filterGridAfterQuickSearch: false,
         isQuickSearchCaseSensitive: false,
         getCellSearchText: undefined,
+        isCellSearchable: undefined,
     },
     rowFormOptions: {
         autoHandle: true,
@@ -244,6 +270,10 @@ const DefaultAdaptableOptions = {
         alwaysShowInDashboard: false,
         alwaysShowInToolPanel: false,
         showModuleIcons: true,
+        position: undefined,
+        size: undefined,
+        customSettingsPanels: undefined,
+        gridInfoTabs: ['Grid Options', 'Grid Summary', 'Grid State'],
     },
     stateOptions: {
         debounceStateDelay: 400,
@@ -274,6 +304,8 @@ const DefaultAdaptableOptions = {
         alternativeModuleNames: undefined,
         applicationIcon: undefined,
         useCustomMacLikeScrollbars: false,
+        customIcons: undefined,
+        objectTags: undefined,
         loadingScreenOptions: {
             showLoadingScreen: true,
             loadingScreenDelay: 200,

package/src/AdaptableOptions/EditOptions.d.ts

@@ -14,7 +14,6 @@ export interface EditOptions<TData = any> {
      * Whether to display message after Server Validation runs
      *
      * @defaultValue true
-     * @gridInfoItem
      */
     displayServerValidationMessages?: boolean;
     /**

package/src/AdaptableOptions/EntitlementOptions.d.ts

@@ -8,14 +8,12 @@ export interface EntitlementOptions {
     /**
      * Returns either collection of `Entitlements`, or a function to invoke when an Entitlement is required
      *
-     * @gridInfoItem
      */
     moduleEntitlements?: Entitlement[] | ((entitlementContext: EntitlementContext) => AccessLevel | undefined);
     /**
      * AccessLevel to use when an Entitlement is not explicitly set; can be hardcoded value or a function to invoke
      *
      * @defaultValue 'Full'
-     * @gridInfoItem
      */
     defaultAccessLevel?: AccessLevel | ((defaultAccessLevelContext: DefaultAccessLevelContext) => AccessLevel);
 }

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -18,7 +18,6 @@ export interface ExportOptions<TData = any> {
      * Optional custom format for Date columns when exporting
      *
      * @defaultValue undefined
-     * @gridInfoItem
      */
     exportDateFormat?: string | ((context: ExportDateFormatContext<TData>) => string);
     /**
@@ -29,28 +28,24 @@ export interface ExportOptions<TData = any> {
      * System Reports to use; leave unset for all, empty array for none
      *
      * @defaultValue  'All Data', 'Current Layout', 'Selected Data',
-     * @gridInfoItem
      */
     systemReportNames?: SystemReportName[] | ((context: SystemReportNamesContext) => SystemReportName[]);
     /**
      * System Report Formats to use; leave unset for all, empty array for none
      *
      * @defaultValue 'Excel', 'VisualExcel', 'CSV', 'JSON'
-     * @gridInfoItem
      */
     systemReportFormats?: SystemReportFormat[] | ((context: SystemReportFormatsContext) => SystemReportFormat[]);
     /**
      * Export destinations to use; leave unset for all, empty array for none
      *
      * @defaultValue 'Download', 'Clipboard'
-     * @gridInfoItem
      */
     systemExportDestinations?: SystemExportDestination[] | ((context: SystemExportDestinationsContext) => SystemExportDestination[]);
     /**
      * Whether to add a timestamp as a suffix to exported file name
      *
      * @defaultValue false
-     * @gridInfoItem
      */
     appendFileTimestamp?: boolean;
     /**
@@ -67,7 +62,6 @@ export interface ExportOptions<TData = any> {
      * Separator for CSV exports
      *
      * @defaultValue ','
-     * @gridInfoItem
      */
     csvSeparator?: string | ((csvSeparatorContext: BaseExportContext) => string);
     /**
@@ -91,7 +85,7 @@ export interface ExportOptions<TData = any> {
     /**
      * Provides a custom name for the Excel sheet when exporting to Excel
      *
-     * @defaultValue 'Sheet1'
+     * @defaultValue 'Sheet 1'
      */
     excelSheetName?: string | ((excelSheetNameContext: BaseExportContext) => string);
 }