@adaptabletools/adaptable 10.0.4-canary.2 → 11.0.0-canary.0

package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts

@@ -32,7 +32,7 @@ export interface AdaptablePredicateDef {
      */
     columnScope: AdaptableScope;
     /**
-     * Modules where Predicate can run: 'filter', 'alert', 'conditionalstyle'
+     * Modules where the Predicate can run
      */
     moduleScope: ModuleScope[];
     /**
@@ -86,7 +86,7 @@ export interface PredicateDefHandlerParams {
      */
     displayValue: any;
     /**
-     * Row node which contains the cell
+     * AG Grid Row node which contains the cell
      */
     node: RowNode;
     /**
@@ -94,7 +94,7 @@ export interface PredicateDefHandlerParams {
      */
     inputs: any[];
     /**
-     * Column which contains the cell
+     * Adaptable Column which contains the cell
      */
     column: AdaptableColumn;
     /**
@@ -105,7 +105,7 @@ export interface PredicateDefHandlerParams {
 export interface PredicateDefToStringParams {
     inputs: any[];
 }
-export declare type ModuleScope = 'filter' | 'alert' | 'conditionalstyle';
+export declare type ModuleScope = 'filter' | 'alert' | 'conditionalstyle' | 'flashingcell';
 /**
  * Array of Predicate Defs which are shipped by AdapTable
  */

package/src/PredefinedConfig/Common/AdaptablePredicate.js

@@ -36,7 +36,7 @@ exports.SystemPredicateDefs = [
         label: 'Blanks',
         icon: { path: 'blanks' },
         columnScope: { All: true },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => Helper_1.default.IsInputNullOrEmpty(value),
     },
     {
@@ -44,7 +44,7 @@ exports.SystemPredicateDefs = [
         label: 'Non Blanks',
         icon: { path: 'non-blanks' },
         columnScope: { All: true },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => Helper_1.default.IsInputNotNullOrEmpty(value),
     },
     // Numeric System Filters
@@ -53,7 +53,7 @@ exports.SystemPredicateDefs = [
         label: 'Greater Than',
         icon: { path: 'greater-than' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'number' }],
         handler: ({ value, inputs }) => Number(value) > Number(inputs[0]),
         toString: ({ inputs }) => `> ${inputs[0]}`,
@@ -64,7 +64,7 @@ exports.SystemPredicateDefs = [
         label: 'Less Than',
         icon: { path: 'less-than' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'number' }],
         handler: ({ value, inputs }) => Number(value) < Number(inputs[0]),
         toString: ({ inputs }) => `< ${inputs[0]}`,
@@ -75,7 +75,7 @@ exports.SystemPredicateDefs = [
         label: 'Positive',
         icon: { text: '>0' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => Number(value) > 0,
     },
     {
@@ -83,7 +83,7 @@ exports.SystemPredicateDefs = [
         label: 'Negative',
         icon: { text: '<0' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => Number(value) < 0,
     },
     {
@@ -91,7 +91,7 @@ exports.SystemPredicateDefs = [
         label: 'Zero',
         icon: { text: '=0' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => Number(value) == 0,
     },
     {
@@ -99,7 +99,7 @@ exports.SystemPredicateDefs = [
         label: 'Equals',
         icon: { path: 'equal' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'number' }],
         handler: ({ value, inputs }) => Number(value) === Number(inputs[0]),
         toString: ({ inputs }) => `= ${inputs[0]}`,
@@ -110,7 +110,7 @@ exports.SystemPredicateDefs = [
         label: 'Not Equals',
         icon: { path: 'not-equal' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'number' }],
         handler: ({ value, inputs }) => Number(value) !== Number(inputs[0]),
         toString: ({ inputs }) => `!= ${inputs[0]}`,
@@ -121,7 +121,7 @@ exports.SystemPredicateDefs = [
         label: 'Between',
         icon: { text: 'BE' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'number' }, { type: 'number' }],
         handler: ({ value, inputs }) => Number(value) >= Number(inputs[0]) && Number(value) <= Number(inputs[1]),
         toString: ({ inputs }) => `Between ${inputs[0]}:${inputs[1]}`,
@@ -132,7 +132,7 @@ exports.SystemPredicateDefs = [
         label: 'Not Between',
         icon: { text: '!BE' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'number' }, { type: 'number' }],
         handler: ({ value, inputs }) => Number(value) < Number(inputs[0]) || Number(value) > Number(inputs[1]),
         toString: ({ inputs }) => `Not Between ${inputs[0]}:${inputs[1]}`,
@@ -143,7 +143,7 @@ exports.SystemPredicateDefs = [
         label: 'Is Numeric',
         icon: { text: '1' },
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['alert'],
+        moduleScope: ['alert', 'flashingcell'],
         handler: ({ value }) => isNaN(Number(value)),
     },
     // String System Filters
@@ -152,7 +152,7 @@ exports.SystemPredicateDefs = [
         label: 'Equals',
         icon: { path: 'equal' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -171,7 +171,7 @@ exports.SystemPredicateDefs = [
         label: 'Not Equals',
         icon: { path: 'not-equal' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -190,7 +190,7 @@ exports.SystemPredicateDefs = [
         label: 'Contains',
         icon: { path: 'contains' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -208,7 +208,7 @@ exports.SystemPredicateDefs = [
         label: 'Not Contains',
         icon: { path: 'not-contains' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -226,7 +226,7 @@ exports.SystemPredicateDefs = [
         label: 'Starts With',
         icon: { path: 'format-letter-starts-with' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -244,7 +244,7 @@ exports.SystemPredicateDefs = [
         label: 'Ends With',
         icon: { path: 'format-letter-ends-with' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs, api }) => {
             if (!value) {
@@ -262,7 +262,7 @@ exports.SystemPredicateDefs = [
         label: 'Regex',
         icon: { path: 'regex' },
         columnScope: { DataTypes: ['String'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'text' }],
         handler: ({ value, inputs }) => new RegExp(inputs[0]).test(value),
         toString: ({ inputs }) => `Regex ${inputs[0]}`,
@@ -273,7 +273,7 @@ exports.SystemPredicateDefs = [
         label: 'Today',
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => isToday_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
@@ -281,7 +281,7 @@ exports.SystemPredicateDefs = [
         label: 'Yesterday',
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => isYesterday_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
@@ -289,7 +289,7 @@ exports.SystemPredicateDefs = [
         label: 'Tomorrow',
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => isTomorrow_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
@@ -297,7 +297,7 @@ exports.SystemPredicateDefs = [
         label: 'This Week',
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => isThisWeek_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
@@ -305,7 +305,7 @@ exports.SystemPredicateDefs = [
         label: 'This Month',
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => isThisMonth_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
@@ -313,7 +313,7 @@ exports.SystemPredicateDefs = [
         label: 'This Quarter',
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => isThisQuarter_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
@@ -321,7 +321,7 @@ exports.SystemPredicateDefs = [
         label: 'This Year',
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => isThisYear_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
@@ -329,7 +329,7 @@ exports.SystemPredicateDefs = [
         label: 'In Past',
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => isPast_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
@@ -337,7 +337,7 @@ exports.SystemPredicateDefs = [
         label: 'In Future',
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => isFuture_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
@@ -345,7 +345,7 @@ exports.SystemPredicateDefs = [
         label: 'After',
         icon: { path: 'greater-than' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'date' }],
         handler: ({ value, inputs }) => isAfter_1.default(DateHelper_1.parseDateValue(value), new Date(inputs[0])),
         toString: ({ inputs }) => `> ${inputs[0]}`,
@@ -355,7 +355,7 @@ exports.SystemPredicateDefs = [
         label: 'Before',
         icon: { path: 'less-than' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'date' }],
         handler: ({ value, inputs }) => isBefore_1.default(DateHelper_1.parseDateValue(value), new Date(inputs[0])),
         toString: ({ inputs }) => `< ${inputs[0]}`,
@@ -365,7 +365,7 @@ exports.SystemPredicateDefs = [
         label: 'Equals',
         icon: { path: 'equal' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'date' }],
         handler: ({ value, inputs }) => isSameDay_1.default(DateHelper_1.parseDateValue(value), new Date(inputs[0])),
         toString: ({ inputs }) => `= ${inputs[0]}`,
@@ -375,7 +375,7 @@ exports.SystemPredicateDefs = [
         label: 'NotEquals',
         icon: { path: 'not-equal' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         inputs: [{ type: 'date' }],
         handler: ({ value, inputs }) => !isSameDay_1.default(DateHelper_1.parseDateValue(value), new Date(inputs[0])),
         toString: ({ inputs }) => `!= ${inputs[0]}`,
@@ -385,7 +385,7 @@ exports.SystemPredicateDefs = [
         label: 'Next Work Day',
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value, api }) => isSameDay_1.default(DateHelper_1.parseDateValue(value), CalendarHelper_1.default.getNextWorkingDay()),
     },
     {
@@ -393,7 +393,7 @@ exports.SystemPredicateDefs = [
         label: 'Last Work Day',
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value, api }) => isSameDay_1.default(DateHelper_1.parseDateValue(value), CalendarHelper_1.default.getPreviousWorkingDay()),
     },
     {
@@ -411,7 +411,7 @@ exports.SystemPredicateDefs = [
         label: 'True',
         icon: { text: 'T' },
         columnScope: { DataTypes: ['Boolean'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => Boolean(value) === true,
     },
     {
@@ -419,7 +419,7 @@ exports.SystemPredicateDefs = [
         label: 'False',
         icon: { text: 'F' },
         columnScope: { DataTypes: ['Boolean'] },
-        moduleScope: ['filter', 'alert', 'conditionalstyle'],
+        moduleScope: ['filter', 'alert', 'flashingcell', 'conditionalstyle'],
         handler: ({ value }) => Boolean(value) === false,
     },
     {
@@ -445,14 +445,14 @@ exports.SystemPredicateDefs = [
         id: 'Any',
         label: 'Any Change',
         columnScope: { All: true },
-        moduleScope: ['alert'],
+        moduleScope: ['alert', 'flashingcell'],
         handler: ({ value, oldValue }) => value !== oldValue,
     },
     {
         id: 'PercentChange',
         label: 'Percent Change',
         columnScope: { DataTypes: ['Number'] },
-        moduleScope: ['alert'],
+        moduleScope: ['alert', 'flashingcell'],
         inputs: [{ type: 'number' }],
         handler: ({ value, oldValue, inputs }) => {
             const change = Math.abs(Number(value) - Number(oldValue));

package/src/PredefinedConfig/Common/AdaptableScope.d.ts

@@ -2,8 +2,8 @@ export declare type ScopeDataType = 'String' | 'Number' | 'Boolean' | 'Date';
 export declare type ScopeAll = {
     All: true;
 };
-export declare type ScopeDataTypes = {
-    DataTypes: ScopeDataType[];
+export declare type ScopeDataTypes<Type = ScopeDataType> = {
+    DataTypes: Type[];
 };
 export declare type ScopeColumnIds = {
     ColumnIds: string[];
@@ -11,4 +11,4 @@ export declare type ScopeColumnIds = {
 /**
  * Defines where a given Object / Module is active
  */
-export declare type AdaptableScope = ScopeAll | ScopeDataTypes | ScopeColumnIds;
+export declare type AdaptableScope<Type = ScopeDataType> = ScopeAll | ScopeDataTypes<Type> | ScopeColumnIds;

package/src/PredefinedConfig/Common/CellHighlightInfo.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableMessageType } from './AdaptableMessageType';
+import { AdaptableStyle } from '../../../types';
 /**
  * Defines how a given Cell in AdapTable should be highlighted
  */
@@ -15,8 +15,19 @@ export interface CellHighlightInfo {
      * Time after which Cell should be unhilighted
      */
     timeout?: number;
+    highlightStyle: AdaptableStyle;
+}
+export interface RowHighlightInfo {
+    /**
+     * Primary key value for the row to be highlighted
+     */
+    primaryKeyValue: any;
+    /**
+     * Timeout after which the highlight is removed
+     */
+    timeout?: number;
     /**
-     * Whether cell should show 'Info' (default), 'Success', 'Warning' or'Error' colour
+     * Highlight style
      */
-    highlightType?: AdaptableMessageType;
+    highlightStyle: AdaptableStyle;
 }

package/src/PredefinedConfig/Common/CellSummary.d.ts

@@ -16,11 +16,11 @@ export interface CellSummmary {
 }
 export interface CellSummaryOperation {
     /**
-     * Name of the Operation - will be displayed in the Cell Summary dropdowns.
+     * Name of the Operation - will be displayed in the Cell Summary components
      */
     operationName: string;
     /**
-     * Function to run when summary result is required
+     * Function to run when a summary result is required
      */
     operationFunction: (operationParam: CellSummaryOperationParams) => any;
 }

package/src/PredefinedConfig/Common/Enums.js

@@ -6,6 +6,7 @@ var DataType;
 (function (DataType) {
     DataType["String"] = "String";
     DataType["Number"] = "Number";
+    // FIXME AFL keep it or extend it to support https://www.ag-grid.com/javascript-data-grid/sparklines-data/ ?
     DataType["NumberArray"] = "NumberArray";
     DataType["Boolean"] = "Boolean";
     DataType["Date"] = "Date";

package/src/PredefinedConfig/Common/Menu.d.ts

@@ -6,14 +6,8 @@ import { AdaptableApi } from '../../Api/AdaptableApi';
 import { SelectedCellInfo } from '../Selection/SelectedCellInfo';
 import { SelectedRowInfo } from '../Selection/SelectedRowInfo';
 import { Column, RowNode } from '@ag-grid-community/all-modules';
-export interface MenuContext {
-    /**
-     * The Adaptable Api - included as a convenience
-     */
-    adaptableApi: AdaptableApi;
-}
 /**
- * Menu item used by Adaptable in 3 places: Module Menu (at left of Dashboard Header), Column Header Menu and Context Menu
+ * Menu item used by Adaptable in both Column and Context Menus
  */
 export interface AdaptableMenuItem {
     /**
@@ -46,11 +40,11 @@ export interface AdaptableMenuItem {
     subItems?: AdaptableMenuItem[];
 }
 /**
- * Menu Item created at design-time which is added to Column Header or Context Menu, and can contain sub items
+ * Menu Item which is added to Column Header or Context Menu, and can contain sub items
  */
-export interface UserMenuItem<CONTEXT_TYPE extends MenuContext> {
+export interface UserMenuItem<CONTEXT_TYPE extends BaseMenuContext> {
     /**
-     * The text that will appear in the Menu Item
+     * Text that will appear in the Menu Item
      */
     label: string | ((context: CONTEXT_TYPE) => string);
     /**
@@ -66,18 +60,24 @@ export interface UserMenuItem<CONTEXT_TYPE extends MenuContext> {
      */
     disabled?: (menuContext: CONTEXT_TYPE) => boolean;
     /**
-     * Optional icon to show in the Column Menu Item
+     * Optional icon to display
      */
     icon?: string;
     /**
-     * Array of Menu Items, enabling creation of (limitless levels of) sub menus
+     * Array of Menu Items, enabling limitless levels of menus
      */
     subMenuItems?: UserMenuItem<CONTEXT_TYPE>[];
 }
+export interface BaseMenuContext {
+    /**
+     * The Adaptable Api - included as a convenience
+     */
+    adaptableApi: AdaptableApi;
+}
 /**
- * Provides full details about current Column where Column Header Menu will appear
+ * Provides full details about the Column in which the Column Menu will appear
  */
-export interface ColumnMenuContext extends MenuContext {
+export interface ColumnMenuContext extends BaseMenuContext {
     /**
      * Current Adaptable Column
      */
@@ -92,9 +92,9 @@ export interface ColumnMenuContext extends MenuContext {
     isRowGroupColumn: boolean;
 }
 /**
- * Provides full details about current cell (and selected cells) where Context Menu will appear
+ * Provides full details about current cell (and selected cells) where the Context Menu will appear
  */
-export interface ContextMenuContext extends MenuContext {
+export interface ContextMenuContext extends BaseMenuContext {
     /**
      *  Cell that has been clicked; contains cell value
      */
@@ -131,10 +131,6 @@ export interface ContextMenuContext extends MenuContext {
      * Value of Primary Key column in current row
      */
     primaryKeyValue: any;
-    /**
-     * The Adaptable Api - included as a convenience
-     */
-    adaptableApi: AdaptableApi;
     /**
      * Currently selected cells in the grid
      */

package/src/PredefinedConfig/Common/Schedule.d.ts

@@ -17,9 +17,9 @@ export interface Schedule extends AdaptableObject {
      */
     OneOffDate?: string;
     /**
-     * Days on which Shedule will run
+     * Days on which Schedule will run
      */
-    DaysOfWeek?: DayOfWeek[];
+    DaysOfWeek?: Weekdays;
 }
 /**
  * Base Schedule object - typically overriden by Functions
@@ -34,15 +34,5 @@ export interface BaseSchedule extends SuspendableObject {
      */
     ScheduleType: 'Report' | 'ipushpull' | 'Glue42' | 'Reminder' | 'OpenFin';
 }
-/**
- * Enum listing Days of the Week by 0-based index
- */
-export declare enum DayOfWeek {
-    Sunday = 0,
-    Monday = 1,
-    Tuesday = 2,
-    Wednesday = 3,
-    Thursday = 4,
-    Friday = 5,
-    Saturday = 6
-}
+export declare type Weekdays = Weekday[];
+export declare type Weekday = 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday';

package/src/PredefinedConfig/Common/Schedule.js

@@ -1,16 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DayOfWeek = void 0;
-/**
- * Enum listing Days of the Week by 0-based index
- */
-var DayOfWeek;
-(function (DayOfWeek) {
-    DayOfWeek[DayOfWeek["Sunday"] = 0] = "Sunday";
-    DayOfWeek[DayOfWeek["Monday"] = 1] = "Monday";
-    DayOfWeek[DayOfWeek["Tuesday"] = 2] = "Tuesday";
-    DayOfWeek[DayOfWeek["Wednesday"] = 3] = "Wednesday";
-    DayOfWeek[DayOfWeek["Thursday"] = 4] = "Thursday";
-    DayOfWeek[DayOfWeek["Friday"] = 5] = "Friday";
-    DayOfWeek[DayOfWeek["Saturday"] = 6] = "Saturday";
-})(DayOfWeek = exports.DayOfWeek || (exports.DayOfWeek = {}));

package/src/PredefinedConfig/Common/SpecialColumnSettings.d.ts

@@ -46,4 +46,8 @@ export interface SpecialColumnSettings {
      * @defaultValue false
      */
     SuppressMovable?: boolean;
+    /**
+     * Custom column types to be added to AG Grid Column Types when object is created
+     */
+    ColumnTypes?: string[];
 }

package/src/PredefinedConfig/Common/Types.d.ts

@@ -5,10 +5,10 @@ export declare type AdaptableDashboardToolbars = AdaptableDashboardToolbar[];
 /**
  * List of all the Toolbars that Adaptable provides
  */
-export declare type AdaptableDashboardToolbar = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Chart' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'Glue42' | 'IPushPull' | 'Layout' | 'OpenFin' | 'Query' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
+export declare type AdaptableDashboardToolbar = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'Glue42' | 'IPushPull' | 'Layout' | 'OpenFin' | 'Query' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
 export declare const ALL_TOOLBARS: AdaptableDashboardToolbar[];
 export declare type AdaptableToolPanels = AdaptableToolPanel[];
-export declare type AdaptableToolPanel = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Chart' | 'Dashboard' | 'DataChangeHistory' | 'Export' | 'Filter' | 'IPushPull' | 'Layout' | 'OpenFin' | 'Query' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
+export declare type AdaptableToolPanel = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Dashboard' | 'DataChangeHistory' | 'Export' | 'Filter' | 'IPushPull' | 'Layout' | 'OpenFin' | 'Query' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
 export declare const ALL_TOOL_PANELS: AdaptableToolPanels;
 /**
  * Adaptable Module Button collection
@@ -19,10 +19,11 @@ export declare type AdaptableModuleButtons = AdaptableModuleButton[];
 /**
  * List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
  */
-export declare type AdaptableModuleButton = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme';
+export declare type AdaptableModuleButton = 'Alert' | 'FlashingCell' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme';
 export declare type AdaptableStateKeys = AdaptableStateKey[];
-export declare type AdaptableStateKey = 'Alert' | 'Application' | 'CalculatedColumn' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SparklineColumn' | 'Theme' | 'ToolPanel';
-export declare type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
+export declare type AdaptableStateKey = 'Alert' | 'FlashingCell' | 'Application' | 'CalculatedColumn' | 'Charting' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Export' | 'Filter' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'Theme' | 'ToolPanel';
+export declare type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
+export declare type AdaptableSettingsPanel = 'Alert' | 'CalculatedColumn' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
 export declare type TypeHint<Base, Literals> = (Base & {
     __subType?: true;
 }) | Literals;

package/src/PredefinedConfig/Common/Types.js

@@ -8,7 +8,6 @@ exports.ALL_TOOLBARS = [
     'Alert',
     'BulkUpdate',
     'CellSummary',
-    'Chart',
     'DataChangeHistory',
     'DataSource',
     'Export',
@@ -28,7 +27,6 @@ exports.ALL_TOOL_PANELS = [
     'Alert',
     'BulkUpdate',
     'CellSummary',
-    'Chart',
     'Dashboard',
     'DataChangeHistory',
     'Export',

package/src/PredefinedConfig/CustomSortState.d.ts

@@ -19,7 +19,7 @@ export interface CustomSort extends SuspendableObject {
      */
     ColumnId: string;
     /**
-     * Order of values by which Column will be sorted; any Column values NOT in this list will be sorted alphabetically AFTER all list values have been sorted
+     * Order of values by which Column will be sorted
      *
      */
     SortedValues?: string[];