@adaptabletools/adaptable 24.0.0-canary.0 → 24.0.0-canary.10

package/src/AdaptableOptions/AdaptablePlugin.d.ts

@@ -13,37 +13,149 @@ type AdaptableReducerObject = {
     [key: string]: (...args: any[]) => any;
 };
 /**
- * Base class for all AdapTable Plugins
+ * Base class for an AdapTable plugin (OpenFin, ipushpull, interop.io, Master-Detail).
+ *
+ * Construct the plugin with its options and pass the instance in `AdaptableOptions.plugins`. The lifecycle methods run in the order they are declared.
  */
 export declare abstract class AdaptablePlugin {
+    /**
+     * Options the plugin was constructed with.
+     */
     options?: any;
+    /**
+     * Named callbacks the plugin registers for AdapTable to call.
+     */
     private values;
+    /**
+     * Id of this plugin. AdapTable uses it to find the plugin and its state.
+     */
     pluginId: string;
     constructor(options?: any);
+    /**
+     * Registers a named callback for AdapTable to call later via {@link AdaptablePlugin.getProperty}.
+     *
+     * @param name Callback name
+     * @param fn Function AdapTable will invoke
+     */
     registerProperty(name: string, fn: (...args: any) => any): void;
+    /**
+     * Returns a function that calls the callback registered under `name`.
+     *
+     * The returned function does nothing when no callback is registered.
+     *
+     * @param name Callback name passed to {@link AdaptablePlugin.registerProperty}
+     * @returns A function that invokes the registered callback
+     */
     getProperty(name: string): any;
+    /**
+     * Adds the plugin's reducers to AdapTable's store.
+     */
     rootReducer?: (rootReducer: AdaptableReducerObject) => AdaptableReducerObject;
+    /**
+     * Redux middleware the plugin adds to the store.
+     */
     reduxMiddleware?: (adaptable: IAdaptable) => Redux.Middleware;
+    /**
+     * Whether a callback was registered under `name`.
+     *
+     * @param name Callback name passed to {@link AdaptablePlugin.registerProperty}
+     * @returns `true` when that callback exists
+     */
     hasProperty(name: string): boolean;
+    /**
+     * Runs before AdapTable initialises. Change `adaptableOptions` or the AG Grid options here.
+     *
+     * @param adaptableOptions Options about to be used
+     * @param agGridOptions AG Grid options about to be used
+     */
     beforeInit(adaptableOptions: AdaptableOptions, agGridOptions: AgGridConfig): void;
+    /**
+     * Runs after AdapTable Options have been normalised.
+     *
+     * @param adaptable The AdapTable instance
+     * @param adaptableOptions Normalised options
+     */
     afterInitOptions(adaptable: IAdaptable, adaptableOptions: AdaptableOptions): void;
+    /**
+     * Runs after `adaptableApi` exists.
+     *
+     * @param adaptable The AdapTable instance
+     * @param api AdapTable API
+     */
     afterInitApi(adaptable: IAdaptable, api: AdaptableApi): void;
+    /**
+     * Runs after AdapTable's internal services exist.
+     *
+     * @param adaptable The AdapTable instance
+     */
     afterInitServices(adaptable: IAdaptable): void;
+    /**
+     * Runs after Initial State has been loaded into the store.
+     *
+     * @param adaptable The AdapTable instance
+     */
     afterInitialStateLoaded(adaptable: IAdaptable): void;
+    /**
+     * Runs after AdapTable modules have been created.
+     *
+     * @param adaptable The AdapTable instance
+     * @param strategies Modules, keyed by module name
+     */
     afterInitModules(adaptable: IAdaptable, strategies: Map<AdaptableModule, IModule>): void;
+    /**
+     * Runs after the AdapTable store exists.
+     *
+     * @param adaptable The AdapTable instance
+     */
     afterInitStore(adaptable: IAdaptable): void;
+    /**
+     * Runs at the end of initialisation, before `AdaptableReady`.
+     *
+     * @param ab The AdapTable instance
+     */
     afterInit(ab: IAdaptable): void;
+    /**
+     * Runs after each Layout is applied.
+     *
+     * @param adaptable The AdapTable instance
+     * @param layout Layout that was applied
+     */
     afterSetLayout(adaptable: IAdaptable, layout: Layout): void;
+    /**
+     * Runs synchronously before a store action is reduced.
+     *
+     * @param eventName Redux action type
+     * @param data Action and the state before it is applied
+     * @param adaptableStore AdapTable store
+     */
     onBeforeStoreEvent(eventName: string, data: {
         action: Redux.Action;
         state: AdaptableState;
     }, adaptableStore: IAdaptableStore): void;
+    /**
+     * Runs after a store action has been reduced.
+     *
+     * @param eventName Redux action type
+     * @param data Action, the state before it, and the state after it
+     * @param adaptableStore AdapTable store
+     */
     onStoreEvent(eventName: string, data: {
         action: Redux.Action;
         state: AdaptableState;
         newState: AdaptableState;
     }, adaptableStore: IAdaptableStore): void;
+    /**
+     * Runs when AdapTable fires `AdaptableReady`.
+     *
+     * @param adaptable The AdapTable instance
+     * @param adaptableOptions Options the instance was created with
+     */
     onAdaptableReady(adaptable: IAdaptable, adaptableOptions: AdaptableOptions): void;
+    /**
+     * Changes one AG Grid column property while AdapTable is building the column.
+     *
+     * Return the value to use, or `undefined` to leave the current value.
+     */
     interceptSetupColumnProperty?: <T extends keyof ColDef>(columnSetupInfo: ColumnSetupInfo, propertyName: T, currentValue: ColDef[T] | undefined, api: AdaptableApi) => ColDef[T] | undefined;
 }
 export {};

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
-     * @noCodeItem
      */
     maxAlertsInStore?: number;
     /**
@@ -58,7 +57,6 @@ export interface AlertOptions<TData = any> {
      * Shows Alert if Primary Key column in Adaptable Options is not present or incorrect
      *
      * @defaultValue false
-     * @noCodeItem
      * @uiLabel Show Missing Primary Key Warning
      */
     showMissingPrimaryKeyAlert?: boolean;

package/src/AdaptableOptions/ChartingOptions.d.ts

@@ -1,13 +1,14 @@
 import { ExternalChartDefinition } from '../AdaptableState/ChartingState';
 import { BaseContext } from '../types';
 /**
- * Options for managing AG Grid's Charts
+ * How charts are saved and where they open.
+ *
+ * AG Grid chart definitions the user saves are stored in Charting state. These options decide whether that happens automatically, and which element a chart is drawn into.
  */
 export interface ChartingOptions {
     /**
      * Behaviour for saving Charts: auto, manual (via popup) or none
      * @defaultValue 'none'
-     * @noCodeItem
      */
     saveChartBehaviour?: SaveChartBehaviour;
     /**
@@ -18,16 +19,21 @@ export interface ChartingOptions {
      */
     restoreChartsOnReady?: boolean | 'all' | string[];
     /**
-     * Locations to display saved Charts
+     * Elements a saved chart can be drawn into, offered by name when the user opens a chart.
+     *
+     * Omit this to open charts only in AG Grid's own window.
      */
     chartContainers?: ChartContainer[];
     /**
-     * Name of AG Grid Chart Container
+     * Name shown for AG Grid's own chart window in the container list.
+     *
      * @defaultValue 'AG Grid Window'
      */
     agGridContainerName?: string;
     /**
-     * Set of properties for managing behaviour of external (i.e non AG Grid) charts
+     * Show, hide, delete and preview for charts that are not AG Grid charts.
+     *
+     * Required when the chart is drawn by the application. AdapTable calls these instead of opening an AG Grid chart.
      *
      * @defaultValue {}
      */

package/src/AdaptableOptions/ColumnMenuOptions.d.ts

@@ -30,10 +30,25 @@ export interface CustomColumnMenuContext<TData = any> extends ColumnMenuContext<
      * Default structure of AG Grid Menu Items
      */
     defaultAgGridMenuStructure: (AgGridMenuItem<AgGridColumnMenuItemType> | {
+        /**
+         * Always `Group`. The item is a submenu of AG Grid column-menu entries.
+         */
         menuType: 'Group';
+        /**
+         * Text of the submenu.
+         */
         label: string;
+        /**
+         * AG Grid column-menu entries shown when the submenu opens.
+         */
         subMenuItems: AgGridMenuItem<AgGridColumnMenuItemType>[];
+        /**
+         * When `true`, the submenu cannot be opened.
+         */
         disabled?: boolean;
+        /**
+         * Icon drawn next to the submenu label.
+         */
         icon?: AdaptableIcon;
     })[];
 }
@@ -45,10 +60,25 @@ export type CustomColumnMenuItem = AgGridMenuItem<AgGridColumnMenuItemType> | Ad
  * Defines a Grouped Menu Item in the Column Menu
  */
 export type CustomGroupColumnMenuItem = {
+    /**
+     * Always `Group`. The item is a submenu, not a clickable command.
+     */
     menuType: 'Group';
+    /**
+     * Text of the submenu.
+     */
     label: string;
+    /**
+     * Items shown when the submenu opens.
+     */
     subMenuItems: CustomColumnMenuItem[];
+    /**
+     * When `true`, the submenu cannot be opened.
+     */
     disabled?: boolean;
+    /**
+     * Icon drawn next to the submenu label.
+     */
     icon?: AdaptableIcon;
 };
 /**

package/src/AdaptableOptions/ColumnOptions.d.ts

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

package/src/AdaptableOptions/CommentOptions.d.ts

@@ -1,6 +1,8 @@
 import { CommentThread, BaseContext, GridCell } from '../types';
 /**
- * Options for managing Comments and Comment Threads in AdapTable
+ * Comments on cells. A thread is the list of comments for one cell.
+ *
+ * Comments are not stored in AdapTable State. The application loads them with {@link loadCommentThreads} and saves them with {@link persistCommentThreads}.
  */
 export interface CommentOptions<TData = any> {
     /**
@@ -8,12 +10,18 @@ export interface CommentOptions<TData = any> {
      */
     isCellCommentable?: (commentableCellContext: CommentableCellContext) => boolean;
     /**
-     * Loads the Comment Threads
+     * Loads every comment thread when the grid starts.
+     *
+     * @param commentLoadContext The grid the comments belong to
+     * @returns The threads to show. An empty list when there are none
      */
     loadCommentThreads?(commentLoadContext: CommentLoadContext): Promise<CommentThread[]>;
     /**
-     * Persists the current Comment Threads
-     * @param commentThreads
+     * Saves the threads after a comment is added, edited or deleted.
+     *
+     * Called with the full set, not only the thread that changed.
+     *
+     * @param commentThreads Every thread, including the one that just changed
      */
     persistCommentThreads?(commentThreads: CommentThread[]): Promise<void>;
     /**

package/src/AdaptableOptions/ContextMenuOptions.d.ts

@@ -40,10 +40,25 @@ export type CustomContextMenuItem = AgGridMenuItem<AgGridContextMenuItemType> |
  * Defines a Grouped Menu Item in the Context Menu
  */
 export type CustomGroupContextMenuItem = {
+    /**
+     * Always `Group`. The item is a submenu, not a clickable command.
+     */
     menuType: 'Group';
+    /**
+     * Text of the submenu.
+     */
     label: string;
+    /**
+     * Items shown when the submenu opens.
+     */
     subMenuItems: CustomContextMenuItem[];
+    /**
+     * When `true`, the submenu cannot be opened.
+     */
     disabled?: boolean;
+    /**
+     * Icon drawn next to the submenu label.
+     */
     icon?: AdaptableIcon;
 };
 /**
@@ -126,12 +141,27 @@ export type AgGridContextMenuItemType = 'autoSizeAll' | 'expandAll' | 'contractA
  */
 export type DefaultAdaptableMenuStructure = (AdaptableSystemContextMenuItem<AdaptableContextMenuItemName> | MenuSeparator)[];
 /**
- * AG Grid section of Context Menu provided by AadapTable by default
+ * AG Grid section of the Context Menu that AdapTable provides by default.
  */
 export type DefaultAgGridMenuStructure = (AgGridMenuItem<AgGridContextMenuItemType> | {
+    /**
+     * Always `Group`. The item is a submenu of AG Grid context-menu entries.
+     */
     menuType: 'Group';
+    /**
+     * Text of the submenu.
+     */
     label: string;
+    /**
+     * AG Grid context-menu entries shown when the submenu opens.
+     */
     subMenuItems: AgGridMenuItem<AgGridContextMenuItemType>[];
+    /**
+     * When `true`, the submenu cannot be opened.
+     */
     disabled?: boolean;
+    /**
+     * Icon drawn next to the submenu label.
+     */
     icon?: AdaptableIcon;
 })[];

package/src/AdaptableOptions/DashboardOptions.d.ts

@@ -11,14 +11,12 @@ export interface DashboardOptions {
      * Whether the Dashboard can be floated; if true (the default), double-clicking Dashboard puts it in float mode
      *
      * @defaultValue true
-     * @noCodeItem
      */
     canFloat?: boolean;
     /**
      * Shows Quick Search input in Dashboard Header
      *
      * @defaultValue true
-     * @noCodeItem
      */
     showQuickSearchInHeader?: boolean;
     /**
@@ -32,7 +30,6 @@ export interface DashboardOptions {
     /**
      * Where in Dashboard to display Module and Custom Buttons
      * @defaultValue 'right'
-     * @noCodeItem
      */
     buttonsLocation?: DashboardButtonsLocation;
 }

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -8,7 +8,6 @@ export interface DataChangeHistoryOptions<TData = any> {
      * Make Data Change History active by default
      *
      * @defaultValue false
-     * @noCodeItem
      */
     activeByDefault?: boolean;
     /**
@@ -32,7 +31,6 @@ export interface DataChangeHistoryOptions<TData = any> {
      * How many data changes are held in State at any one time; when limit is reached, oldest change(s) are deleted from memory
      *
      * @defaultValue undefined (all data changes are logged)
-     * @noCodeItem
      */
     maxDataChangesInStore?: number;
 }
@@ -69,5 +67,8 @@ export interface DataChangeHistoryContext<TData = any> extends ActionColumnConte
  * A custom AdaptableButton which provides a build in `undo` action
  */
 export interface DataChangeHistoryButton<TData = any> extends AdaptableButton<DataChangeHistoryContext<TData>> {
+    /**
+     * Built-in action the button runs. `'undo'` restores the previous value. `'clear'` removes the change from the log.
+     */
     action?: AdaptableDataChangeHistoryAction;
 }

package/src/AdaptableOptions/DefaultAdaptableOptions.js

@@ -1,5 +1,5 @@
 import * as GeneralConstants from '../Utilities/Constants/GeneralConstants';
-import { getGraySwatchColor, getSwatchColorVar } from '../Utilities/Helpers/UIHelper';
+import { themeColorVar } from '../Utilities/Helpers/UIHelper';
 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 { addUuidsToInitialState } from '../Utilities/Helpers/AdaptableHelper';
 import { defaultsDeep } from '../Utilities/Extensions/ObjectExtensions';
@@ -200,13 +200,13 @@ const DefaultAdaptableOptions = {
         defaultFlashDuration: 500,
         defaultFlashTarget: 'cell',
         defaultDownChangeStyle: {
-            BackColor: getSwatchColorVar(18),
+            BackColor: themeColorVar('flash-down'),
         },
         defaultUpChangeStyle: {
-            BackColor: getSwatchColorVar(7),
+            BackColor: themeColorVar('flash-up'),
         },
         defaultNeutralChangeStyle: {
-            BackColor: getGraySwatchColor(),
+            BackColor: themeColorVar('flash-neutral'),
         },
     },
     formatColumnOptions: {
@@ -279,7 +279,7 @@ const DefaultAdaptableOptions = {
         position: undefined,
         size: undefined,
         customSettingsPanels: undefined,
-        gridInfoTabs: ['Grid Options', 'Grid Summary', 'Grid State'],
+        gridInfoTabs: ['Grid Summary', 'Layout', 'Grid State', 'Grid Options'],
     },
     wizardOptions: {
         popupType: undefined,
@@ -334,6 +334,12 @@ const DefaultAdaptableOptions = {
             showOutsideDays: true,
             datepickerButtons: ['close', 'today'],
         },
+        colourPickerOptions: {
+            tabs: ['Custom', 'Palette'],
+            orderPaletteColours: true,
+            removeDuplicates: true,
+            showGroupLabels: false,
+        },
         editableCellStyle: undefined,
         readOnlyCellStyle: undefined,
         editedCellStyle: undefined,

package/src/AdaptableOptions/EditOptions.d.ts

@@ -29,11 +29,15 @@ export interface EditOptions<TData = any> {
      */
     customEditColumnValues?: (context: CustomEditColumnValuesContext<TData>) => CustomEditColumnValueInfo[] | Promise<CustomEditColumnValueInfo[]>;
     /**
-     * Options for Plus Minus module (keyboard increment / decrement)
+     * Keys that nudge a numeric cell up or down.
+     *
+     * A Plus Minus rule can set its own key. These are the keys used when it does not.
      */
     plusMinusOptions?: PlusMinusOptions;
     /**
-     * Options for Smart Edit module
+     * Extra Smart Edit operations, beyond the ones AdapTable ships.
+     *
+     * A Smart Edit applies one operation to every selected cell.
      */
     smartEditOptions?: SmartEditOptions<TData>;
 }
@@ -58,14 +62,26 @@ export interface CustomEditColumnValuesContext<TData = any> extends AdaptableCol
  * Information about items in the Edit Controls
  */
 export interface EditColumnValueInfo {
+    /**
+     * Value written into the cell when this item is chosen.
+     */
     value: any;
+    /**
+     * Text shown for this item. The value is shown when this is omitted.
+     */
     label?: string;
 }
 /**
  * Information about items in the custom Edit Controls
  */
 export interface CustomEditColumnValueInfo {
+    /**
+     * Value written into the cell when this item is chosen.
+     */
     value: any;
+    /**
+     * Text shown for this item. The value is shown when this is omitted.
+     */
     label?: string;
 }
 /**

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -257,14 +257,37 @@ export interface ExportFormContext extends FormContext {
 /**
  * Type of Export result data: string (CSV), ReportData (JSON), or Blob (Excel)
  */
+/**
+ * Data produced by an export, or returned from `processExport` to replace AdapTable's output.
+ *
+ * `type` selects the shape of `data`.
+ */
 export type ExportResultData = {
+    /**
+     * CSV export.
+     */
     type: 'csv';
+    /**
+     * CSV text.
+     */
     data: string;
 } | {
+    /**
+     * JSON export.
+     */
     type: 'json';
+    /**
+     * Columns and rows of the report.
+     */
     data: ReportData;
 } | {
+    /**
+     * Excel export.
+     */
     type: 'excel';
+    /**
+     * Excel file contents. A `Blob`, or a base64 string.
+     */
     data: Blob | string;
 };
 /**

package/src/AdaptableOptions/ExpressionOptions.d.ts

@@ -166,14 +166,12 @@ export interface ExpressionOptions<TData = any> {
      * Reference a Column's Header (i.e. FriendlyName) in all Expression overviews (instead of ColumnId)
      *
      * @defaultValue true
-     * @noCodeItem
      */
     displayColumnFriendlyNamesForExpressions?: boolean;
     /**
      * Perform case-sensitive text comparisons when evaluating Expressions
      *
      * @defaultValue false
-     * @noCodeItem
      */
     caseSensitiveExpressions?: boolean;
     /**
@@ -186,7 +184,6 @@ export interface ExpressionOptions<TData = any> {
      * When an `IN` right-hand value is an ISO string containing `T`, the exact instant is used regardless.
      *
      * @defaultValue false
-     * @noCodeItem
      */
     evaluateDatesUsingTime?: boolean | ((context: AdaptableColumnContext) => boolean);
     /**