@adaptabletools/adaptable 10.0.4-canary.1 → 10.0.4-canary.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. package/LICENSE.md +1 -1
  2. package/README.md +1 -1
  3. package/base.css +16 -6
  4. package/bundle.cjs.js +350 -0
  5. package/index.css +20 -6
  6. package/package.json +1 -5
  7. package/publishTimestamp.d.ts +1 -1
  8. package/publishTimestamp.js +1 -1
  9. package/src/AdaptableInterfaces/AdaptableNoCodeWizard.d.ts +1 -1
  10. package/src/AdaptableInterfaces/IAdaptable.d.ts +14 -12
  11. package/src/AdaptableOptions/AdaptableOptions.d.ts +3 -3
  12. package/src/AdaptableOptions/ContainerOptions.d.ts +4 -5
  13. package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts +1 -1
  14. package/src/AdaptableOptions/DateInputOptions.d.ts +5 -1
  15. package/src/AdaptableOptions/EditOptions.d.ts +2 -3
  16. package/src/AdaptableOptions/FilterOptions.d.ts +8 -8
  17. package/src/AdaptableOptions/GeneralOptions.d.ts +3 -2
  18. package/src/AdaptableOptions/MenuOptions.d.ts +11 -11
  19. package/src/AdaptableOptions/NotificationsOptions.d.ts +8 -0
  20. package/src/AdaptableOptions/ToolPanelOptions.d.ts +2 -2
  21. package/src/AdaptableOptions/UserInterfaceOptions.d.ts +3 -3
  22. package/src/Api/AdaptableApi.d.ts +12 -12
  23. package/src/Api/ColumnApi.d.ts +10 -5
  24. package/src/Api/EventApi.d.ts +1 -1
  25. package/src/Api/Events/AdaptableReady.d.ts +3 -2
  26. package/src/Api/GridApi.d.ts +10 -10
  27. package/src/Api/Implementation/ColumnApiImpl.d.ts +4 -3
  28. package/src/Api/Implementation/ColumnApiImpl.js +11 -9
  29. package/src/Api/Implementation/ConfigApiImpl.js +0 -24
  30. package/src/Api/Implementation/GridApiImpl.d.ts +2 -2
  31. package/src/Api/Implementation/GridApiImpl.js +3 -4
  32. package/src/Api/Implementation/InternalApiImpl.d.ts +1 -1
  33. package/src/Api/Implementation/InternalApiImpl.js +2 -2
  34. package/src/Api/Implementation/LayoutApiImpl.d.ts +2 -0
  35. package/src/Api/Implementation/LayoutApiImpl.js +15 -0
  36. package/src/Api/Implementation/PluginsApiImpl.d.ts +2 -2
  37. package/src/Api/Implementation/PluginsApiImpl.js +1 -1
  38. package/src/Api/Implementation/ScheduleApiImpl.js +6 -6
  39. package/src/Api/Implementation/ToolPanelApiImpl.js +1 -1
  40. package/src/Api/Implementation/UserInterfaceApiImpl.d.ts +3 -3
  41. package/src/Api/Implementation/UserInterfaceApiImpl.js +4 -4
  42. package/src/Api/InternalApi.d.ts +1 -1
  43. package/src/Api/LayoutApi.d.ts +7 -0
  44. package/src/Api/PluginsApi.d.ts +1 -7
  45. package/src/Api/TeamSharingApi.d.ts +1 -1
  46. package/src/Api/ThemeApi.d.ts +2 -2
  47. package/src/Api/UserInterfaceApi.d.ts +3 -3
  48. package/src/PredefinedConfig/AdaptableState.d.ts +2 -10
  49. package/src/PredefinedConfig/AlertState.d.ts +1 -1
  50. package/src/PredefinedConfig/ApplicationState.d.ts +1 -1
  51. package/src/PredefinedConfig/CalculatedColumnState.d.ts +1 -1
  52. package/src/PredefinedConfig/Common/AdaptableColumn.d.ts +3 -3
  53. package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts +4 -4
  54. package/src/PredefinedConfig/Common/AdaptableStyle.d.ts +7 -7
  55. package/src/PredefinedConfig/Common/DataChangedInfo.d.ts +1 -1
  56. package/src/PredefinedConfig/Common/Menu.d.ts +40 -17
  57. package/src/PredefinedConfig/Common/SpecialColumnSettings.d.ts +1 -1
  58. package/src/PredefinedConfig/Common/Types.d.ts +5 -5
  59. package/src/PredefinedConfig/Common/Types.js +9 -7
  60. package/src/PredefinedConfig/ConditionalStyleState.d.ts +1 -1
  61. package/src/PredefinedConfig/CustomSortState.d.ts +1 -1
  62. package/src/PredefinedConfig/DataSourceState.d.ts +1 -1
  63. package/src/PredefinedConfig/ExportState.d.ts +3 -3
  64. package/src/PredefinedConfig/FilterState.d.ts +2 -2
  65. package/src/PredefinedConfig/FormatColumnState.d.ts +1 -1
  66. package/src/PredefinedConfig/FreeTextColumnState.d.ts +1 -1
  67. package/src/PredefinedConfig/LayoutState.d.ts +1 -1
  68. package/src/PredefinedConfig/PredefinedConfig.d.ts +0 -40
  69. package/src/PredefinedConfig/QuickSearchState.d.ts +3 -3
  70. package/src/PredefinedConfig/ScheduleState.d.ts +1 -1
  71. package/src/PredefinedConfig/ThemeState.d.ts +5 -1
  72. package/src/Redux/ActionsReducers/DashboardRedux.js +2 -1
  73. package/src/Redux/ActionsReducers/GridRedux.d.ts +3 -2
  74. package/src/Redux/ActionsReducers/GridRedux.js +2 -2
  75. package/src/Redux/ActionsReducers/LayoutRedux.d.ts +12 -2
  76. package/src/Redux/ActionsReducers/LayoutRedux.js +24 -1
  77. package/src/Redux/DeadRedux.d.ts +4 -8
  78. package/src/Redux/Store/AdaptableReduxLocalStorageEngine.js +6 -1
  79. package/src/Redux/Store/AdaptableStore.d.ts +3 -3
  80. package/src/Redux/Store/AdaptableStore.js +18 -13
  81. package/src/Strategy/AdaptableModuleBase.d.ts +2 -2
  82. package/src/Strategy/AlertModule.d.ts +2 -2
  83. package/src/Strategy/AlertModule.js +1 -94
  84. package/src/Strategy/BulkUpdateModule.d.ts +2 -2
  85. package/src/Strategy/BulkUpdateModule.js +4 -4
  86. package/src/Strategy/CellSummaryModule.d.ts +2 -2
  87. package/src/Strategy/DashboardModule.d.ts +2 -2
  88. package/src/Strategy/DataChangeHistoryModule.js +2 -2
  89. package/src/Strategy/ExportModule.d.ts +2 -2
  90. package/src/Strategy/FilterModule.d.ts +2 -2
  91. package/src/Strategy/FormatColumnModule.js +1 -1
  92. package/src/Strategy/GridInfoModule.d.ts +2 -2
  93. package/src/Strategy/Interface/IModule.d.ts +2 -2
  94. package/src/Strategy/LayoutModule.d.ts +2 -2
  95. package/src/Strategy/LayoutModule.js +21 -8
  96. package/src/Strategy/SmartEditModule.d.ts +2 -2
  97. package/src/Strategy/SmartEditModule.js +3 -4
  98. package/src/Strategy/SystemStatusModule.d.ts +2 -2
  99. package/src/Utilities/Constants/GeneralConstants.d.ts +1 -0
  100. package/src/Utilities/Constants/GeneralConstants.js +2 -1
  101. package/src/Utilities/Constants/ModuleConstants.d.ts +6 -6
  102. package/src/Utilities/Constants/ModuleConstants.js +7 -7
  103. package/src/Utilities/Defaults/DefaultAdaptableOptions.js +8 -7
  104. package/src/Utilities/Helpers/PreviewHelper.js +2 -2
  105. package/src/Utilities/Interface/Preview.d.ts +2 -1
  106. package/src/Utilities/Services/LicenseService.js +16 -2
  107. package/src/Utilities/Services/ValidationService.js +1 -1
  108. package/src/View/AdaptableViewFactory.d.ts +2 -1
  109. package/src/View/AdaptableViewFactory.js +2 -0
  110. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/ConfigurationForm.js +7 -7
  111. package/src/View/CellSummary/CellSummaryViewPanel.js +2 -2
  112. package/src/View/Components/FilterForm/FilterForm.js +5 -7
  113. package/src/View/Components/FilterForm/ListBoxFilterForm.d.ts +1 -1
  114. package/src/View/Components/FilterForm/ListBoxFilterForm.js +7 -7
  115. package/src/View/Components/FilterForm/QuickFilterForm.js +3 -5
  116. package/src/View/Components/Panels/FilterFormPanel.d.ts +1 -1
  117. package/src/View/Components/Panels/PanelWithImage.d.ts +423 -1
  118. package/src/View/Components/Popups/AdaptablePopupAlert.js +22 -9
  119. package/src/View/Components/ToolPanel/AdaptableToolPanel.js +3 -4
  120. package/src/View/Components/ToolPanel/ToolPanelPopup.js +2 -3
  121. package/src/View/CustomSort/CustomSortEntityRow.d.ts +3 -1
  122. package/src/View/CustomSort/CustomSortEntityRow.js +3 -3
  123. package/src/View/CustomSort/CustomSortPopup.js +1 -1
  124. package/src/View/CustomSort/Wizard/CustomSortColumnWizardSection.js +1 -1
  125. package/src/View/Dashboard/Dashboard.js +3 -3
  126. package/src/View/DataChangeHistory/DataChangeHistoryGrid.d.ts +1 -1
  127. package/src/View/DataChangeHistory/DataChangeHistoryGrid.js +6 -5
  128. package/src/View/DataChangeHistory/DataChangeHistoryPopup.js +6 -6
  129. package/src/View/Export/ExportViewPanel.js +6 -6
  130. package/src/View/GridInfo/GridOptionsComponent.js +1 -1
  131. package/src/View/Layout/LayoutViewPanel.js +2 -2
  132. package/src/View/Query/QueryViewPanel.js +1 -1
  133. package/src/View/QuickSearch/useQuickSearchDebounced.js +2 -3
  134. package/src/View/Schedule/SchedulePopup.js +3 -3
  135. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsWizard.js +1 -1
  136. package/src/View/SmartEdit/SmartEditPopup.js +1 -1
  137. package/src/View/StateManagement/StateManagementPopup.d.ts +2 -12
  138. package/src/View/StateManagement/StateManagementPopup.js +21 -114
  139. package/src/View/StateManagement/StateManagementViewPanel.d.ts +5 -0
  140. package/src/View/StateManagement/StateManagementViewPanel.js +22 -0
  141. package/src/View/StateManagement/components/ClearButton.d.ts +6 -0
  142. package/src/View/StateManagement/components/ClearButton.js +9 -0
  143. package/src/View/StateManagement/components/ExportDropdown.d.ts +8 -0
  144. package/src/View/StateManagement/components/ExportDropdown.js +43 -0
  145. package/src/View/StateManagement/components/LoadButton.d.ts +7 -0
  146. package/src/View/StateManagement/components/LoadButton.js +38 -0
  147. package/src/View/StateManagement/handleExportState.d.ts +1 -0
  148. package/src/View/StateManagement/handleExportState.js +22 -0
  149. package/src/View/Theme/ThemeViewPanel.js +1 -1
  150. package/src/agGrid/Adaptable.d.ts +9 -8
  151. package/src/agGrid/Adaptable.js +99 -78
  152. package/src/agGrid/agGridHelper.d.ts +4 -4
  153. package/src/agGrid/agGridHelper.js +15 -16
  154. package/src/agGrid/agGridMenuHelper.d.ts +15 -13
  155. package/src/agGrid/agGridMenuHelper.js +53 -45
  156. package/src/agGrid/editors/AdaptableDateEditor/InternalAdaptableDateEditor.d.ts +1 -1
  157. package/src/agGrid/editors/AdaptableDateEditor/InternalAdaptableDateEditor.js +11 -6
  158. package/src/agGrid/editors/AdaptableDateEditor/index.d.ts +3 -2
  159. package/src/agGrid/editors/AdaptableDateEditor/index.js +16 -6
  160. package/src/agGrid/editors/AdaptableNumberEditor/index.d.ts +1 -0
  161. package/src/agGrid/editors/AdaptableNumberEditor/index.js +7 -2
  162. package/src/components/Datepicker/DatepickerContext.d.ts +2 -2
  163. package/src/components/Datepicker/index.js +9 -5
  164. package/src/components/Modal/index.d.ts +1 -1
  165. package/src/components/OverlayTrigger/index.js +3 -3
  166. package/src/components/OverlayTrigger/useAgGridClassName.d.ts +2 -0
  167. package/src/components/OverlayTrigger/{useVendorClassName.js → useAgGridClassName.js} +3 -3
  168. package/src/components/ProgressIndicator/ProgressIndicator.js +1 -1
  169. package/src/components/icons/index.js +2 -0
  170. package/src/components/icons/upload.d.ts +3 -0
  171. package/src/components/icons/upload.js +8 -0
  172. package/src/metamodel/adaptable.metamodel.d.ts +52 -37
  173. package/src/metamodel/adaptable.metamodel.js +261 -265
  174. package/src/types.d.ts +1 -1
  175. package/version.d.ts +1 -1
  176. package/version.js +1 -1
  177. package/src/PredefinedConfig/DeprecatedState.d.ts +0 -82
  178. package/src/PredefinedConfig/DeprecatedState.js +0 -5
  179. package/src/components/OverlayTrigger/useVendorClassName.d.ts +0 -2
@@ -7,11 +7,11 @@ import { RowNode } from '@ag-grid-community/all-modules';
7
7
  */
8
8
  export interface AdaptablePredicate {
9
9
  /**
10
- * Id of Predicate (e.g. 'Equals', 'GreaterThan')
10
+ * Id of Predicate (e.g. `Equals`, `GreaterThan`)
11
11
  */
12
12
  PredicateId: string;
13
13
  /**
14
- * Optional inputs - needed to evaluate some Predicates (e.g. 'GreaterThan')
14
+ * Optional Inputs that might be needed for evaluation
15
15
  */
16
16
  Inputs?: any[];
17
17
  }
@@ -32,7 +32,7 @@ export interface AdaptablePredicateDef {
32
32
  */
33
33
  columnScope: AdaptableScope;
34
34
  /**
35
- * Adaptable Modules where Predicate can run
35
+ * Modules where Predicate can run: 'filter', 'alert', 'conditionalstyle'
36
36
  */
37
37
  moduleScope: ModuleScope[];
38
38
  /**
@@ -60,7 +60,7 @@ export interface AdaptablePredicateDef {
60
60
  */
61
61
  shortcuts?: string[];
62
62
  /**
63
- * Wether to display this predicate only in QuickFilter (and NOT in Column Filter)
63
+ * Display this predicate only in Quick Filter Bar (and NOT in Filter Form)
64
64
  */
65
65
  onlyQuickFilter?: boolean;
66
66
  }
@@ -3,31 +3,31 @@
3
3
  */
4
4
  export interface AdaptableStyle {
5
5
  /**
6
- * Colour background of cell - provide a hex value.
6
+ * Colour background of cell: provide hex value or name
7
7
  */
8
8
  BackColor?: string;
9
9
  /**
10
- * Font colour in cell - provide a hex value.
10
+ * Font colour in cell: provide hex value or name
11
11
  */
12
12
  ForeColor?: string;
13
13
  /**
14
- * Whether font appears as 'Normal' or 'Bold'
14
+ * Weight of font: `Normal` or `Bold`
15
15
  */
16
16
  FontWeight?: 'Normal' | 'Bold';
17
17
  /**
18
- * Style of the font: 'Normal' or 'Italic'
18
+ * Style of font: `Normal` or `Italic`
19
19
  */
20
20
  FontStyle?: 'Normal' | 'Italic';
21
21
  /**
22
- * Size of font: 'XSmall', 'Small', 'Medium', 'Large' or 'XLarge'
22
+ * Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge`
23
23
  */
24
24
  FontSize?: 'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge';
25
25
  /**
26
- * Colour of cell border - provide a hex value.
26
+ * Colour of cell border: provide hex value or name
27
27
  */
28
28
  BorderColor?: string;
29
29
  /**
30
- * Name of existing Css Class; use instead of setting other object properties
30
+ * Existing CSS Class; use instead of setting other object properties
31
31
  */
32
32
  ClassName?: string;
33
33
  }
@@ -25,7 +25,7 @@ export interface DataChangedInfo {
25
25
  */
26
26
  primaryKeyValue: any;
27
27
  /**
28
- * RowNode that contains the cell (an AG Grid object)
28
+ * AG Grid RowNode that contains the cell
29
29
  */
30
30
  rowNode?: RowNode;
31
31
  /**
@@ -6,6 +6,12 @@ import { AdaptableApi } from '../../Api/AdaptableApi';
6
6
  import { SelectedCellInfo } from '../Selection/SelectedCellInfo';
7
7
  import { SelectedRowInfo } from '../Selection/SelectedRowInfo';
8
8
  import { Column, RowNode } from '@ag-grid-community/all-modules';
9
+ export interface MenuContext {
10
+ /**
11
+ * The Adaptable Api - included as a convenience
12
+ */
13
+ adaptableApi: AdaptableApi;
14
+ }
9
15
  /**
10
16
  * Menu item used by Adaptable in 3 places: Module Menu (at left of Dashboard Header), Column Header Menu and Context Menu
11
17
  */
@@ -15,15 +21,15 @@ export interface AdaptableMenuItem {
15
21
  */
16
22
  label: string;
17
23
  /**
18
- * Adaptable Module associated with (shipped) menu item.
24
+ * Adaptable Module associated with (Adaptable) menu item.
19
25
  */
20
26
  module?: AdaptableModule | 'General';
21
27
  /**
22
- * Adaptable Redux Action to invoke when (shipped) menu item is clicked
28
+ * Adaptable Redux Action to invoke when (Adaptable) menu item is clicked
23
29
  */
24
30
  reduxAction?: Redux.Action;
25
31
  /**
26
- * Function to invoice when (custom) menu item is clicked
32
+ * Function to invoke when (custom) menu item is clicked
27
33
  */
28
34
  onClick?: () => void;
29
35
  /**
@@ -40,38 +46,55 @@ export interface AdaptableMenuItem {
40
46
  subItems?: AdaptableMenuItem[];
41
47
  }
42
48
  /**
43
- * Defines a Menu Item created at design-time, can be added to Column Header or Context Menu, and can contain sub items.
49
+ * Menu Item created at design-time which is added to Column Header or Context Menu, and can contain sub items
44
50
  */
45
- export interface UserMenuItem {
51
+ export interface UserMenuItem<CONTEXT_TYPE extends MenuContext> {
46
52
  /**
47
53
  * The text that will appear in the Menu Item
48
54
  */
49
- label: string | ((menuContext: MenuContext) => string);
55
+ label: string | ((context: CONTEXT_TYPE) => string);
50
56
  /**
51
57
  * Function to invoke when the Menu Item is clicked
52
58
  */
53
- onClick?: (menuContext: MenuContext) => void;
59
+ onClick?: (menuContext: CONTEXT_TYPE) => void;
54
60
  /**
55
61
  * Function to evaluate whether Menu Item is visible
56
62
  */
57
- hidden?: (menuContext: MenuContext) => boolean;
63
+ hidden?: (menuContext: CONTEXT_TYPE) => boolean;
58
64
  /**
59
65
  * Function to evaluate whether Menu Item is enabled
60
66
  */
61
- disabled?: (menuContext: MenuContext) => boolean;
67
+ disabled?: (menuContext: CONTEXT_TYPE) => boolean;
62
68
  /**
63
- * Optional icon to show in the Menu Item
69
+ * Optional icon to show in the Column Menu Item
64
70
  */
65
71
  icon?: string;
66
72
  /**
67
73
  * Array of Menu Items, enabling creation of (limitless levels of) sub menus
68
74
  */
69
- subMenuItems?: UserMenuItem[];
75
+ subMenuItems?: UserMenuItem<CONTEXT_TYPE>[];
70
76
  }
71
77
  /**
72
- * Provides full details about current Menu; used for both Column and Context Menus
78
+ * Provides full details about current Column where Column Header Menu will appear
73
79
  */
74
- export interface MenuContext {
80
+ export interface ColumnMenuContext extends MenuContext {
81
+ /**
82
+ * Current Adaptable Column
83
+ */
84
+ adaptableColumn: AdaptableColumn;
85
+ /**
86
+ * Current AG Grid Column
87
+ */
88
+ agGridColumn: Column;
89
+ /**
90
+ * Whether current Column is Row Group
91
+ */
92
+ isRowGroupColumn: boolean;
93
+ }
94
+ /**
95
+ * Provides full details about current cell (and selected cells) where Context Menu will appear
96
+ */
97
+ export interface ContextMenuContext extends MenuContext {
75
98
  /**
76
99
  * Cell that has been clicked; contains cell value
77
100
  */
@@ -81,9 +104,9 @@ export interface MenuContext {
81
104
  */
82
105
  adaptableColumn: AdaptableColumn;
83
106
  /**
84
- * Current Vendor Grid Column
107
+ * Current AG Grid Column
85
108
  */
86
- vendorColumn: Column;
109
+ agGridColumn: Column;
87
110
  /**
88
111
  * Whether cell that was clicked is also currently selected
89
112
  */
@@ -97,11 +120,11 @@ export interface MenuContext {
97
120
  */
98
121
  rowNode: RowNode;
99
122
  /**
100
- * Whether current row node is grouped
123
+ * Whether current AG Grid row node is grouped
101
124
  */
102
125
  isGroupedNode: boolean;
103
126
  /**
104
- * Whether current Column is Row Group
127
+ * Whether current Column is Row Grouped
105
128
  */
106
129
  isRowGroupColumn: boolean;
107
130
  /**
@@ -3,7 +3,7 @@
3
3
  */
4
4
  export interface SpecialColumnSettings {
5
5
  /**
6
- * Preferred width (in pixels) for Column; if unset, calculated dynamically by underlying Grid
6
+ * Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid
7
7
  */
8
8
  Width?: number;
9
9
  /**
@@ -5,10 +5,10 @@ export declare type AdaptableDashboardToolbars = AdaptableDashboardToolbar[];
5
5
  /**
6
6
  * List of all the Toolbars that Adaptable provides
7
7
  */
8
- export declare type AdaptableDashboardToolbar = 'Query' | 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Chart' | 'Filter' | 'DataSource' | 'Export' | 'Glue42' | 'OpenFin' | 'IPushPull' | 'Layout' | 'QuickSearch' | 'SmartEdit' | 'SystemStatus' | 'Theme' | 'DataChangeHistory';
8
+ export declare type AdaptableDashboardToolbar = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Chart' | 'DataChangeHistory' | 'DataSource' | 'Export' | 'Filter' | 'Glue42' | 'IPushPull' | 'Layout' | 'OpenFin' | 'Query' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
9
9
  export declare const ALL_TOOLBARS: AdaptableDashboardToolbar[];
10
10
  export declare type AdaptableToolPanels = AdaptableToolPanel[];
11
- export declare type AdaptableToolPanel = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Chart' | 'Filter' | 'Dashboard' | 'Export' | 'IPushPull' | 'OpenFin' | 'Layout' | 'Query' | 'QuickSearch' | 'SmartEdit' | 'SystemStatus' | 'Theme' | 'DataChangeHistory';
11
+ export declare type AdaptableToolPanel = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Chart' | 'Dashboard' | 'DataChangeHistory' | 'Export' | 'Filter' | 'IPushPull' | 'Layout' | 'OpenFin' | 'Query' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
12
12
  export declare const ALL_TOOL_PANELS: AdaptableToolPanels;
13
13
  /**
14
14
  * Adaptable Module Button collection
@@ -19,10 +19,10 @@ export declare type AdaptableModuleButtons = AdaptableModuleButton[];
19
19
  /**
20
20
  * List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
21
21
  */
22
- export declare type AdaptableModuleButton = 'Query' | 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'Filter' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Export' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'DataChangeHistory';
22
+ 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';
23
23
  export declare type AdaptableStateKeys = AdaptableStateKey[];
24
- export declare type AdaptableStateKey = 'Query' | 'Alert' | 'Application' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Entitlement' | 'Export' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'Filter' | 'SystemStatus' | 'Theme' | 'ToolPanel' | 'UserInterface';
25
- export declare type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Chart' | 'Filter' | 'ConditionalStyle' | 'CustomSort' | 'Dashboard' | 'DataSource' | 'Export' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'SmartEdit' | 'SparklineColumn' | 'StateManagement' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'DataChangeHistory';
24
+ 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';
25
+ 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';
26
26
  export declare type TypeHint<Base, Literals> = (Base & {
27
27
  __subType?: true;
28
28
  }) | Literals;
@@ -5,21 +5,22 @@ This page includes frequently used typed - particularly helpful for State and Ap
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.ALL_TOOL_PANELS = exports.ALL_TOOLBARS = void 0;
7
7
  exports.ALL_TOOLBARS = [
8
- 'Query',
9
8
  'Alert',
10
9
  'BulkUpdate',
11
10
  'CellSummary',
12
11
  'Chart',
13
- 'Filter',
14
12
  'DataChangeHistory',
15
13
  'DataSource',
16
14
  'Export',
15
+ 'Filter',
17
16
  'Glue42',
18
- 'OpenFin',
19
17
  'IPushPull',
20
18
  'Layout',
21
- 'SmartEdit',
19
+ 'OpenFin',
20
+ 'Query',
22
21
  'QuickSearch',
22
+ 'SmartEdit',
23
+ 'StateManagement',
23
24
  'SystemStatus',
24
25
  'Theme',
25
26
  ];
@@ -28,16 +29,17 @@ exports.ALL_TOOL_PANELS = [
28
29
  'BulkUpdate',
29
30
  'CellSummary',
30
31
  'Chart',
31
- 'Filter',
32
32
  'Dashboard',
33
+ 'DataChangeHistory',
33
34
  'Export',
35
+ 'Filter',
34
36
  'IPushPull',
35
- 'OpenFin',
36
37
  'Layout',
38
+ 'OpenFin',
37
39
  'Query',
38
40
  'QuickSearch',
39
41
  'SmartEdit',
42
+ 'StateManagement',
40
43
  'SystemStatus',
41
44
  'Theme',
42
- 'DataChangeHistory',
43
45
  ];
@@ -7,7 +7,7 @@ import { XOR } from '../Utilities/Extensions/TypeExtensions';
7
7
  import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
8
8
  import { SuspendableObject } from './Common/SuspendableObject';
9
9
  /**
10
- * Predefined Configuration for the Conditional Style function
10
+ * Predefined Configuration for the Conditional Style Module
11
11
  **/
12
12
  export interface ConditionalStyleState extends ConfigState {
13
13
  /**
@@ -1,7 +1,7 @@
1
1
  import { ConfigState } from './ConfigState';
2
2
  import { SuspendableObject } from './Common/SuspendableObject';
3
3
  /**
4
- * Predefined Configuration for Custom Sort function
4
+ * Predefined Configuration for Custom Sort Module
5
5
  */
6
6
  export interface CustomSortState extends ConfigState {
7
7
  /**
@@ -3,7 +3,7 @@ import { AdaptableObject } from './Common/AdaptableObject';
3
3
  import { AdaptableForm } from './Common/AdaptableForm';
4
4
  import { ButtonContext } from './Common/AdaptableButton';
5
5
  /**
6
- * Predefined Configuration for Data Source function
6
+ * Predefined Configuration for Data Source Module
7
7
  */
8
8
  export interface DataSourceState extends ConfigState {
9
9
  /**
@@ -12,7 +12,7 @@ export interface ExportCustomDestinationPopup {
12
12
  ReportName: Report['Name'];
13
13
  }
14
14
  /**
15
- * Predefined Configuration for Export function
15
+ * Predefined Configuration for Export Module
16
16
  */
17
17
  export interface ExportState extends ConfigState {
18
18
  /**
@@ -34,11 +34,11 @@ export interface Report extends AdaptableObject {
34
34
  */
35
35
  Name: SystemReportName | string;
36
36
  /**
37
- * Columns to display in Report
37
+ * Columns to display: options are 'AllColumns', 'VisibleColumns', 'SelectedColumns', 'ScopeColumns', 'CustomColumns'
38
38
  */
39
39
  ReportColumnScope: 'AllColumns' | 'VisibleColumns' | 'SelectedColumns' | 'ScopeColumns' | 'CustomColumns';
40
40
  /**
41
- * Rows to export when Report runs
41
+ * Rows to export: options are 'AllRows', 'VisibleRows', 'SelectedCellRows', 'SelectedRows', 'ExpressionRows', 'CustomRows'
42
42
  */
43
43
  ReportRowScope: 'AllRows' | 'VisibleRows' | 'SelectedCellRows' | 'SelectedRows' | 'ExpressionRows' | 'CustomRows';
44
44
  /**
@@ -12,7 +12,7 @@ export interface FilterState extends ConfigState {
12
12
  */
13
13
  ColumnFilters?: ColumnFilter[];
14
14
  /**
15
- * Whether to display Quick Filter Bar - at least one column must have Quick Filter set to true
15
+ * Whether to display Quick Filter Bar between Column Header and the Grid
16
16
  * @defaultValue true
17
17
  */
18
18
  IsQuickFilterVisible?: boolean;
@@ -40,7 +40,7 @@ export interface ColumnFilter extends AdaptableObject {
40
40
  */
41
41
  ColumnId: string;
42
42
  /**
43
- * Predicate function to evaluate when Filter is run
43
+ * `AdaptablePredicate` which AdaptableQL will evaluate when the Filter is run
44
44
  */
45
45
  Predicate: ColumnFilterPredicate;
46
46
  }
@@ -4,7 +4,7 @@ import { AdaptableFormat } from './Common/AdaptableFormat';
4
4
  import { AdaptableScope } from './Common/AdaptableScope';
5
5
  import { SuspendableObject } from './Common/SuspendableObject';
6
6
  /**
7
- * Predefined Configuration for Format Column function
7
+ * Predefined Configuration for Format Column Module
8
8
  */
9
9
  export interface FormatColumnState extends ConfigState {
10
10
  /**
@@ -2,7 +2,7 @@ import { ConfigState } from './ConfigState';
2
2
  import { AdaptableObject } from './Common/AdaptableObject';
3
3
  import { SpecialColumnSettings } from './Common/SpecialColumnSettings';
4
4
  /**
5
- * Predefined Configuration for the Free Text Column function
5
+ * Predefined Configuration for the Free Text Column Module
6
6
  */
7
7
  export interface FreeTextColumnState extends ConfigState {
8
8
  /**
@@ -2,7 +2,7 @@ import { ConfigState } from './ConfigState';
2
2
  import { AdaptableObject } from './Common/AdaptableObject';
3
3
  import { ColumnSort } from './Common/ColumnSort';
4
4
  /**
5
- * Predefined Configuration for the Layout function
5
+ * Predefined Configuration for the Layout Module
6
6
  */
7
7
  export interface LayoutState extends ConfigState {
8
8
  /**
@@ -7,12 +7,9 @@ import { CustomSortState } from './CustomSortState';
7
7
  import { DashboardState } from './DashboardState';
8
8
  import { DataSourceState } from './DataSourceState';
9
9
  import { ExportState } from './ExportState';
10
- import { FlashingCellState } from './DeprecatedState';
11
- import { UpdatedRowState } from './DeprecatedState';
12
10
  import { FormatColumnState } from './FormatColumnState';
13
11
  import { FreeTextColumnState } from './FreeTextColumnState';
14
12
  import { LayoutState } from './LayoutState';
15
- import { PercentBarState } from './DeprecatedState';
16
13
  import { ScheduleState } from './ScheduleState';
17
14
  import { PlusMinusState } from './PlusMinusState';
18
15
  import { QuickSearchState } from './QuickSearchState';
@@ -21,7 +18,6 @@ import { ThemeState } from './ThemeState';
21
18
  import { ChartState } from './ChartState';
22
19
  import { SparklineColumnState } from './SparklineColumnState';
23
20
  import { ToolPanelState } from './ToolPanelState';
24
- import { GradientColumnState } from './DeprecatedState';
25
21
  import { QueryState } from './QueryState';
26
22
  /**
27
23
  * This is the main Predefined Config interface which developers will populate at design-time
@@ -111,40 +107,4 @@ export interface PredefinedConfig {
111
107
  * Sets the order and visibility of the Tool Panel controls in the AdapTable ToolPanel (on right of grid)
112
108
  */
113
109
  ToolPanel?: ToolPanelState;
114
- /**
115
- * Section (only populated at Design Time) that manages UI-related elements in AdapTable
116
- */
117
- UserInterface?: any;
118
- /**
119
- * @deprecated - entitlements are now set in Entitlement Options
120
- */
121
- Entitlements?: any;
122
- /**
123
- * @deprecated - **DO NOT USE** - flashing cell is now part of Alert
124
- */
125
- FlashingCell?: FlashingCellState;
126
- /**
127
- * @deprecated - flashing cell is now part of Alert
128
- */
129
- UpdatedRow?: UpdatedRowState;
130
- /**
131
- * @deprecated - **DO NOT USE** - Gradient Column is now part of Format Column
132
- */
133
- GradientColumn?: GradientColumnState;
134
- /**
135
- * @deprecated - **DO NOT USE** - Percent Bar is now part of Format Column
136
- */
137
- PercentBar?: PercentBarState;
138
- /**
139
- * @deprecated - use System Status Options
140
- */
141
- SystemStatus?: any;
142
- /**
143
- * @deprecated - use General Options
144
- */
145
- CellSummary?: any;
146
- /**
147
- * @deprecated - use User Interface Options
148
- */
149
- ActionColumn?: any;
150
110
  }
@@ -1,15 +1,15 @@
1
1
  import { AdaptableStyle } from './Common/AdaptableStyle';
2
2
  import { ConfigState } from './ConfigState';
3
3
  /**
4
- * Predefined Configuration for Quick Search function
4
+ * Predefined Configuration for Quick Search Module
5
5
  */
6
6
  export interface QuickSearchState extends ConfigState {
7
7
  /**
8
- * Quick Search to run at start up (rarely set at design time)
8
+ * Last Quick Search that was run (and will run again at start up)
9
9
  */
10
10
  QuickSearchText?: string;
11
11
  /**
12
- * Style to use for Quick Search; uses standard `AdaptableStyle` Object
12
+ * Style to use to highlight matching cells - uses common `AdaptableStyle` object
13
13
  */
14
14
  Style?: AdaptableStyle;
15
15
  }
@@ -6,7 +6,7 @@ import { AdaptableMessageType, ReportSchedule } from '../types';
6
6
  import { BaseSchedule } from './Common/Schedule';
7
7
  import { AdaptableObject } from './Common/AdaptableObject';
8
8
  /**
9
- * Predefined Configuration for the Schedule function
9
+ * Predefined Configuration for the Schedule Module
10
10
  *
11
11
  */
12
12
  export interface ScheduleState extends ConfigState {
@@ -30,7 +30,11 @@ export interface AdaptableTheme extends AdaptableObject {
30
30
  */
31
31
  Description: string;
32
32
  /**
33
- * Vendor Grid related css className to be applied
33
+ * deprecated use `AgGridClassName` property instead
34
34
  */
35
35
  VendorGridClassName?: string;
36
+ /**
37
+ * Ag Grid theme to apply when loading theme
38
+ */
39
+ AgGridClassName?: string;
36
40
  }
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.DashboardReducer = exports.DashboardReady = exports.DashboardSetTitle = exports.DashboardCloseToolbar = exports.DashboardCreateDefaultTab = exports.DashboardSetTabs = exports.DashboardSetFloatingPosition = exports.DashboardSetIsInline = exports.DashboardSetIsHidden = exports.DashboardSetIsFloating = exports.DashboardSetIsCollapsed = exports.DashboardSetActiveTabIndex = exports.DashboardSetModuleButtons = exports.DASHBOARD_READY = exports.DASHBOARD_SET_TITLE = exports.DASHBOARD_CLOSE_TOOLBAR = exports.DASHBOARD_CREATE_DEFAULT_TAB = exports.DASHBOARD_SET_TABS = exports.DASHBOARD_SET_FLOATING_POSITION = exports.DASHBOARD_SET_IS_HIDDEN = exports.DASHBOARD_SET_IS_INLINE = exports.DASHBOARD_SET_IS_FLOATING = exports.DASHBOARD_SET_IS_COLLAPSED = exports.DASHBOARD_ACTIVE_TAB_INDEX_CHANGE = exports.DASHBOARD_SET_MODULE_BUTTONS = void 0;
4
+ const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
4
5
  /**
5
6
  * @ReduxAction The Module Buttons have been set in the Dashboard
6
7
  */
@@ -104,7 +105,7 @@ const initialState = {
104
105
  IsHidden: false,
105
106
  IsInline: false,
106
107
  FloatingPosition: { x: 100, y: 100 },
107
- ModuleButtons: ['SystemStatus', 'GridInfo', 'Layout', 'ConditionalStyle'],
108
+ ModuleButtons: GeneralConstants_1.EMPTY_ARRAY,
108
109
  DashboardTitle: '',
109
110
  };
110
111
  exports.DashboardReducer = (state = initialState, action) => {
@@ -7,6 +7,7 @@ import { AdaptableMenuItem } from '../../PredefinedConfig/Common/Menu';
7
7
  import { DataChangedInfo } from '../../PredefinedConfig/Common/DataChangedInfo';
8
8
  import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
9
9
  import { CellSummmary } from '../../types';
10
+ import { RowNode } from '@ag-grid-community/all-modules';
10
11
  /**
11
12
  * @ReduxAction Columns have been set in the Grid
12
13
  */
@@ -129,7 +130,7 @@ export interface GridSetCellSummaryAction extends Redux.Action {
129
130
  cellSummary: CellSummmary;
130
131
  }
131
132
  export interface GridRefreshCellsAction extends Redux.Action {
132
- rows: any[];
133
+ rowNodes: RowNode[];
133
134
  columnIds: string[];
134
135
  }
135
136
  export interface SetModuleDropdownMenuItemsAction extends Redux.Action {
@@ -161,7 +162,7 @@ export declare const GridSetSelectedCells: (SelectedCellInfo: SelectedCellInfo)
161
162
  export declare const GridSetSelectedRows: (SelectedRowInfo: SelectedRowInfo) => GridSetSelectedRowsAction;
162
163
  export declare const GridCreateCellSummary: () => GridCreateCellSummaryAction;
163
164
  export declare const GridSetCellSummary: (CellSummary: CellSummmary) => GridSetCellSummaryAction;
164
- export declare const GridRefreshCells: (rows: any[], columnIds: string[]) => GridRefreshCellsAction;
165
+ export declare const GridRefreshCells: (rowNodes: RowNode[], columnIds: string[]) => GridRefreshCellsAction;
165
166
  export declare const SetPivotModeOn: () => SetPivotModeOnAction;
166
167
  export declare const SetPivotModeOff: () => SetPivotModeOffAction;
167
168
  export declare const SetTreeModeOn: () => SetTreeModeOnAction;
@@ -117,9 +117,9 @@ exports.GridSetCellSummary = (CellSummary) => ({
117
117
  type: exports.GRID_SET_CELLS_SUMMARY,
118
118
  cellSummary: CellSummary,
119
119
  });
120
- exports.GridRefreshCells = (rows, columnIds) => ({
120
+ exports.GridRefreshCells = (rowNodes, columnIds) => ({
121
121
  type: exports.GRID_REFRESH_CELLS,
122
- rows,
122
+ rowNodes,
123
123
  columnIds,
124
124
  });
125
125
  exports.SetPivotModeOn = () => ({
@@ -20,6 +20,10 @@ export declare const LAYOUT_SELECT = "LAYOUT_SELECT";
20
20
  * @ReduxAction A Layout has been (auto)saved
21
21
  */
22
22
  export declare const LAYOUT_SAVE = "LAYOUT_SAVE";
23
+ /**
24
+ * @ReduxAction A new caption / header has been set for a Column in the Layout
25
+ */
26
+ export declare const LAYOUT_SET_COLUMN_CAPTION = "LAYOUT_SET_COLUMN_CAPTION";
23
27
  export declare const LAYOUT_UPDATE_CURRENT_DRAFT = "LAYOUT_UPDATE_CURRENT_DRAFT";
24
28
  /**
25
29
  * @ReduxAction Layout Module is ready
@@ -36,14 +40,19 @@ export interface LayoutDeleteAction extends LayoutAction {
36
40
  }
37
41
  export interface LayoutSaveAction extends LayoutAction {
38
42
  }
43
+ export interface LayoutSetColumnCaptionAction extends Redux.Action {
44
+ layoutName: string;
45
+ columnId: string;
46
+ caption: string;
47
+ }
39
48
  export interface LayoutUpdateCurrentDraftAction extends LayoutAction {
40
49
  }
41
50
  export interface LayoutSelectAction extends Redux.Action {
42
51
  layoutName: string;
43
52
  }
44
- export interface LayoutIncludeVendorStateAction extends Redux.Action {
53
+ export interface LayoutIncludeAgGridStateAction extends Redux.Action {
45
54
  }
46
- export interface LayoutExcludeVendorStateAction extends Redux.Action {
55
+ export interface LayoutExcludeAgGridStateAction extends Redux.Action {
47
56
  }
48
57
  export interface LayoutReadyAction extends Redux.Action {
49
58
  layoutState: LayoutState;
@@ -51,6 +60,7 @@ export interface LayoutReadyAction extends Redux.Action {
51
60
  export declare const LayoutAdd: (layout: Layout) => LayoutAddAction;
52
61
  export declare const LayoutDelete: (layout: Layout) => LayoutDeleteAction;
53
62
  export declare const LayoutSave: (layout: Layout) => LayoutSaveAction;
63
+ export declare const LayoutSetColumnCaption: (layoutName: string, columnId: string, caption: string) => LayoutSetColumnCaptionAction;
54
64
  export declare const LayoutSelect: (layoutName: string) => LayoutSelectAction;
55
65
  export declare const LayoutUpdateCurrentDraft: (layout: Layout) => LayoutUpdateCurrentDraftAction;
56
66
  export declare const LayoutReady: (layoutState: LayoutState) => LayoutReadyAction;