@adaptabletools/adaptable 10.0.4-canary.4 → 11.0.0-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 (507) hide show
  1. package/LICENSE.md +1 -1
  2. package/agGrid.d.ts +2 -2
  3. package/base.css +216 -47
  4. package/bundle.cjs.js +118 -113
  5. package/index.css +257 -49
  6. package/package.json +4 -3
  7. package/publishTimestamp.d.ts +1 -1
  8. package/publishTimestamp.js +1 -1
  9. package/src/AdaptableInterfaces/IAdaptable.d.ts +12 -7
  10. package/src/AdaptableOptions/AdaptableOptions.d.ts +19 -3
  11. package/src/AdaptableOptions/ContainerOptions.d.ts +0 -7
  12. package/src/AdaptableOptions/DashboardOptions.d.ts +7 -9
  13. package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts +2 -2
  14. package/src/AdaptableOptions/EditOptions.d.ts +2 -2
  15. package/src/AdaptableOptions/ExportOptions.d.ts +1 -1
  16. package/src/AdaptableOptions/FilterOptions.d.ts +2 -2
  17. package/src/AdaptableOptions/FinancePluginOptions.d.ts +1 -1
  18. package/src/AdaptableOptions/FlashingCellOptions.d.ts +31 -0
  19. package/src/AdaptableOptions/{ChartPluginOptions.js → FlashingCellOptions.js} +0 -0
  20. package/src/AdaptableOptions/GeneralOptions.d.ts +1 -1
  21. package/src/AdaptableOptions/MenuOptions.d.ts +2 -2
  22. package/src/AdaptableOptions/NotificationsOptions.d.ts +2 -8
  23. package/src/AdaptableOptions/SettingsPanelOptions.d.ts +87 -0
  24. package/src/{Api/ChartApi.js → AdaptableOptions/SettingsPanelOptions.js} +0 -0
  25. package/src/AdaptableOptions/TeamSharingOptions.d.ts +1 -1
  26. package/src/AdaptableOptions/ToolPanelOptions.d.ts +0 -14
  27. package/src/AdaptableOptions/UserInterfaceOptions.d.ts +34 -0
  28. package/src/Api/AdaptableApi.d.ts +9 -7
  29. package/src/Api/AlertApi.d.ts +4 -79
  30. package/src/Api/ChartingApi.d.ts +9 -0
  31. package/src/Api/{Events/FlashingAlertFired.js → ChartingApi.js} +0 -0
  32. package/src/Api/ColumnApi.d.ts +11 -1
  33. package/src/Api/ConfigApi.d.ts +0 -12
  34. package/src/Api/DataChangeHistoryApi.d.ts +4 -0
  35. package/src/Api/EventApi.d.ts +8 -8
  36. package/src/Api/Events/AdaptableReady.d.ts +1 -1
  37. package/src/Api/Events/FlashingCellDisplayed.d.ts +11 -0
  38. package/src/Api/{SparklineColumnApi.js → Events/FlashingCellDisplayed.js} +0 -0
  39. package/src/Api/Events/GridDataChanged.d.ts +3 -1
  40. package/src/Api/Events/SearchChanged.d.ts +1 -1
  41. package/src/Api/FlashingCellApi.d.ts +89 -0
  42. package/src/{PredefinedConfig/ChartState.js → Api/FlashingCellApi.js} +0 -0
  43. package/src/Api/GridApi.d.ts +28 -5
  44. package/src/Api/Implementation/AdaptableApiImpl.d.ts +4 -2
  45. package/src/Api/Implementation/AdaptableApiImpl.js +4 -2
  46. package/src/Api/Implementation/AlertApiImpl.d.ts +8 -22
  47. package/src/Api/Implementation/AlertApiImpl.js +40 -107
  48. package/src/Api/Implementation/CalculatedColumnApiImpl.js +1 -1
  49. package/src/Api/Implementation/ChartingApiImpl.d.ts +5 -0
  50. package/src/Api/Implementation/ChartingApiImpl.js +10 -0
  51. package/src/Api/Implementation/ColumnApiImpl.d.ts +3 -1
  52. package/src/Api/Implementation/ColumnApiImpl.js +9 -3
  53. package/src/Api/Implementation/ConfigApiImpl.d.ts +0 -4
  54. package/src/Api/Implementation/ConfigApiImpl.js +0 -21
  55. package/src/Api/Implementation/DataChangeHistoryApiImpl.d.ts +1 -0
  56. package/src/Api/Implementation/DataChangeHistoryApiImpl.js +5 -0
  57. package/src/Api/Implementation/FlashingCellApiImpl.d.ts +24 -0
  58. package/src/Api/Implementation/FlashingCellApiImpl.js +111 -0
  59. package/src/Api/Implementation/FreeTextColumnApiImpl.js +1 -1
  60. package/src/Api/Implementation/GridApiImpl.d.ts +13 -8
  61. package/src/Api/Implementation/GridApiImpl.js +39 -17
  62. package/src/Api/Implementation/InternalApiImpl.d.ts +2 -7
  63. package/src/Api/Implementation/InternalApiImpl.js +5 -18
  64. package/src/Api/Implementation/LayoutApiImpl.js +12 -0
  65. package/src/Api/Implementation/PluginsApiImpl.d.ts +0 -2
  66. package/src/Api/Implementation/PluginsApiImpl.js +0 -6
  67. package/src/Api/Implementation/PlusMinusApiImpl.js +1 -1
  68. package/src/Api/Implementation/QueryApiImpl.js +1 -1
  69. package/src/Api/Implementation/ScheduleApiImpl.js +5 -5
  70. package/src/Api/Implementation/SmartEditApiImpl.d.ts +1 -1
  71. package/src/Api/Implementation/SystemStatusApiImpl.js +1 -1
  72. package/src/Api/Implementation/ToolPanelApiImpl.js +2 -2
  73. package/src/Api/InternalApi.d.ts +4 -9
  74. package/src/Api/PluginsApi.d.ts +0 -2
  75. package/src/Api/SmartEditApi.d.ts +4 -4
  76. package/src/PredefinedConfig/AdaptableState.d.ts +2 -4
  77. package/src/PredefinedConfig/AlertState.d.ts +13 -54
  78. package/src/PredefinedConfig/Common/AdaptableColumn.d.ts +4 -0
  79. package/src/PredefinedConfig/Common/AdaptableComparerFunction.d.ts +2 -2
  80. package/src/PredefinedConfig/Common/{AdaptableFlashingAlert.d.ts → AdaptableFlashingCell.d.ts} +6 -6
  81. package/src/PredefinedConfig/Common/{AdaptableFlashingAlert.js → AdaptableFlashingCell.js} +0 -0
  82. package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts +4 -4
  83. package/src/PredefinedConfig/Common/AdaptablePredicate.js +38 -38
  84. package/src/PredefinedConfig/Common/CellHighlightInfo.d.ts +14 -3
  85. package/src/PredefinedConfig/Common/CellSummary.d.ts +2 -2
  86. package/src/PredefinedConfig/Common/Enums.js +1 -0
  87. package/src/PredefinedConfig/Common/Menu.d.ts +16 -20
  88. package/src/PredefinedConfig/Common/Schedule.d.ts +4 -14
  89. package/src/PredefinedConfig/Common/Schedule.js +0 -14
  90. package/src/PredefinedConfig/Common/SpecialColumnSettings.d.ts +4 -0
  91. package/src/PredefinedConfig/Common/Types.d.ts +6 -5
  92. package/src/PredefinedConfig/Common/Types.js +0 -2
  93. package/src/PredefinedConfig/CustomSortState.d.ts +1 -1
  94. package/src/PredefinedConfig/DashboardState.d.ts +6 -5
  95. package/src/PredefinedConfig/FlashingCellState.d.ts +65 -0
  96. package/src/PredefinedConfig/{SparklineColumnState.js → FlashingCellState.js} +0 -0
  97. package/src/PredefinedConfig/FreeTextColumnState.d.ts +2 -2
  98. package/src/PredefinedConfig/LayoutState.d.ts +1 -1
  99. package/src/PredefinedConfig/PredefinedConfig.d.ts +2 -10
  100. package/src/PredefinedConfig/ScheduleState.d.ts +1 -5
  101. package/src/PredefinedConfig/ShortcutState.d.ts +1 -1
  102. package/src/PredefinedConfig/SystemState.d.ts +17 -8
  103. package/src/PredefinedConfig/ThemeState.d.ts +2 -1
  104. package/src/Redux/ActionsReducers/AlertRedux.d.ts +3 -38
  105. package/src/Redux/ActionsReducers/AlertRedux.js +9 -68
  106. package/src/Redux/ActionsReducers/DashboardRedux.d.ts +0 -7
  107. package/src/Redux/ActionsReducers/DashboardRedux.js +3 -13
  108. package/src/Redux/ActionsReducers/FlashingCellRedux.d.ts +55 -0
  109. package/src/Redux/ActionsReducers/FlashingCellRedux.js +100 -0
  110. package/src/Redux/ActionsReducers/PopupRedux.d.ts +1 -3
  111. package/src/Redux/ActionsReducers/SystemRedux.d.ts +34 -25
  112. package/src/Redux/ActionsReducers/SystemRedux.js +94 -60
  113. package/src/Redux/ActionsReducers/ToolPanelRedux.js +1 -1
  114. package/src/Redux/Store/AdaptableStore.js +90 -66
  115. package/src/Strategy/AdaptableModuleBase.d.ts +1 -1
  116. package/src/Strategy/AdaptableModuleBase.js +0 -3
  117. package/src/Strategy/AlertModule.d.ts +14 -5
  118. package/src/Strategy/AlertModule.js +40 -123
  119. package/src/Strategy/CalculatedColumnModule.d.ts +28 -0
  120. package/src/Strategy/CalculatedColumnModule.js +34 -0
  121. package/src/Strategy/ChartingModule.d.ts +7 -0
  122. package/src/Strategy/ChartingModule.js +15 -0
  123. package/src/Strategy/ConditionalStyleModule.d.ts +12 -0
  124. package/src/Strategy/ConditionalStyleModule.js +28 -0
  125. package/src/Strategy/CustomSortModule.d.ts +12 -1
  126. package/src/Strategy/CustomSortModule.js +26 -0
  127. package/src/Strategy/DashboardModule.d.ts +0 -1
  128. package/src/Strategy/DashboardModule.js +1 -7
  129. package/src/Strategy/DataChangeHistoryModule.js +1 -1
  130. package/src/Strategy/DataSourceModule.d.ts +9 -1
  131. package/src/Strategy/DataSourceModule.js +28 -0
  132. package/src/Strategy/ExportModule.d.ts +12 -0
  133. package/src/Strategy/ExportModule.js +43 -0
  134. package/src/Strategy/FilterModule.d.ts +8 -1
  135. package/src/Strategy/FilterModule.js +28 -0
  136. package/src/Strategy/FlashingCellModule.d.ts +33 -0
  137. package/src/Strategy/FlashingCellModule.js +219 -0
  138. package/src/Strategy/FormatColumnModule.d.ts +11 -1
  139. package/src/Strategy/FormatColumnModule.js +35 -0
  140. package/src/Strategy/FreeTextColumnModule.d.ts +9 -1
  141. package/src/Strategy/FreeTextColumnModule.js +45 -0
  142. package/src/Strategy/GridInfoModule.js +58 -36
  143. package/src/Strategy/Interface/IModule.d.ts +70 -1
  144. package/src/Strategy/LayoutModule.js +15 -3
  145. package/src/Strategy/PlusMinusModule.d.ts +11 -0
  146. package/src/Strategy/PlusMinusModule.js +34 -0
  147. package/src/Strategy/QueryModule.d.ts +20 -0
  148. package/src/Strategy/QueryModule.js +25 -0
  149. package/src/Strategy/ScheduleModule.d.ts +17 -1
  150. package/src/Strategy/ScheduleModule.js +148 -2
  151. package/src/Strategy/SetingsPanelModule.d.ts +11 -0
  152. package/src/Strategy/SetingsPanelModule.js +30 -0
  153. package/src/Strategy/ShortcutModule.d.ts +11 -0
  154. package/src/Strategy/ShortcutModule.js +22 -0
  155. package/src/Strategy/ToolPanelModule.js +1 -1
  156. package/src/Strategy/Utilities/getAlertBehaviourViewItems.d.ts +8 -0
  157. package/src/Strategy/Utilities/getAlertBehaviourViewItems.js +15 -0
  158. package/src/Strategy/Utilities/getAlertPreviewViewItems.d.ts +4 -0
  159. package/src/Strategy/Utilities/getAlertPreviewViewItems.js +19 -0
  160. package/src/Strategy/Utilities/getCustomSortColumnViewItems.d.ts +5 -0
  161. package/src/Strategy/Utilities/getCustomSortColumnViewItems.js +9 -0
  162. package/src/Strategy/Utilities/getCustomSortSortOrderViewItems.d.ts +5 -0
  163. package/src/Strategy/Utilities/getCustomSortSortOrderViewItems.js +9 -0
  164. package/src/Strategy/Utilities/getExportColumnsViewItems.d.ts +3 -0
  165. package/src/Strategy/Utilities/getExportColumnsViewItems.js +22 -0
  166. package/src/Strategy/Utilities/getExportRowsViewItems.d.ts +5 -0
  167. package/src/Strategy/Utilities/getExportRowsViewItems.js +26 -0
  168. package/src/Strategy/Utilities/getExpressionViewItems.d.ts +5 -0
  169. package/src/Strategy/Utilities/getExpressionViewItems.js +9 -0
  170. package/src/Strategy/Utilities/getFlashingCellDurationViewItems.d.ts +5 -0
  171. package/src/Strategy/Utilities/getFlashingCellDurationViewItems.js +9 -0
  172. package/src/Strategy/Utilities/getFlashingCellStyleViewItems.d.ts +5 -0
  173. package/src/Strategy/Utilities/getFlashingCellStyleViewItems.js +10 -0
  174. package/src/Strategy/Utilities/getFlashingTargetViewItems.d.ts +5 -0
  175. package/src/Strategy/Utilities/getFlashingTargetViewItems.js +9 -0
  176. package/src/Strategy/Utilities/getFormatColumnSettingsViewItems.d.ts +5 -0
  177. package/src/Strategy/Utilities/getFormatColumnSettingsViewItems.js +15 -0
  178. package/src/Strategy/Utilities/getFormatColumnStyleViewItems.d.ts +3 -0
  179. package/src/Strategy/Utilities/getFormatColumnStyleViewItems.js +10 -0
  180. package/src/Strategy/Utilities/getRuleViewItems.d.ts +6 -0
  181. package/src/Strategy/Utilities/getRuleViewItems.js +15 -0
  182. package/src/Strategy/Utilities/getScopeViewItems.d.ts +3 -0
  183. package/src/Strategy/Utilities/getScopeViewItems.js +20 -0
  184. package/src/Strategy/Utilities/getShortcutSettingsViewItems.d.ts +5 -0
  185. package/src/Strategy/Utilities/getShortcutSettingsViewItems.js +15 -0
  186. package/src/Strategy/Utilities/getStyleViewItems.d.ts +2 -0
  187. package/src/Strategy/Utilities/getStyleViewItems.js +15 -0
  188. package/src/Utilities/Constants/ConfigConstants.d.ts +0 -1
  189. package/src/Utilities/Constants/ConfigConstants.js +1 -2
  190. package/src/Utilities/Constants/GeneralConstants.d.ts +0 -9
  191. package/src/Utilities/Constants/GeneralConstants.js +1 -12
  192. package/src/Utilities/Constants/ModuleConstants.d.ts +3 -2
  193. package/src/Utilities/Constants/ModuleConstants.js +4 -3
  194. package/src/Utilities/Defaults/DefaultAdaptableOptions.js +26 -18
  195. package/src/Utilities/Defaults/DefaultSettingsPanel.d.ts +7 -0
  196. package/src/Utilities/Defaults/DefaultSettingsPanel.js +35 -0
  197. package/src/Utilities/Extensions/ArrayExtensions.js +1 -1
  198. package/src/Utilities/Helpers/AdaptableHelper.js +3 -2
  199. package/src/Utilities/Helpers/StyleHelper.d.ts +4 -0
  200. package/src/Utilities/Helpers/StyleHelper.js +4 -1
  201. package/src/Utilities/Interface/MessagePopups.d.ts +0 -3
  202. package/src/Utilities/MenuItem.d.ts +1 -1
  203. package/src/Utilities/MenuItem.js +2 -2
  204. package/src/Utilities/ObjectFactory.d.ts +6 -17
  205. package/src/Utilities/ObjectFactory.js +14 -84
  206. package/src/Utilities/Services/AlertService.d.ts +3 -3
  207. package/src/Utilities/Services/AlertService.js +11 -17
  208. package/src/Utilities/Services/EntitlementService.d.ts +1 -0
  209. package/src/Utilities/Services/EntitlementService.js +9 -1
  210. package/src/Utilities/Services/Interface/IAlertService.d.ts +3 -7
  211. package/src/Utilities/Services/Interface/IEntitlementService.d.ts +1 -0
  212. package/src/Utilities/Services/ModuleService.js +13 -17
  213. package/src/Utilities/Services/TeamSharingService.js +3 -4
  214. package/src/View/AdaptableView.js +3 -9
  215. package/src/View/AdaptableViewFactory.js +0 -26
  216. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/ColumnsList.d.ts +4 -3
  217. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/ColumnsList.js +2 -1
  218. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/ConfigurationForm.js +10 -10
  219. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/index.js +6 -6
  220. package/src/View/AdaptableWizardView/index.js +1 -1
  221. package/src/View/Alert/AlertEmptyView.d.ts +5 -0
  222. package/src/View/Alert/AlertEmptyView.js +16 -0
  223. package/src/View/Alert/Wizard/AlertBehaviourWizardSection.d.ts +2 -1
  224. package/src/View/Alert/Wizard/AlertBehaviourWizardSection.js +10 -5
  225. package/src/View/Alert/Wizard/AlertDisplayWizardSection.d.ts +8 -1
  226. package/src/View/Alert/Wizard/AlertDisplayWizardSection.js +6 -7
  227. package/src/View/Alert/Wizard/AlertRulesWizardSection.d.ts +1 -0
  228. package/src/View/Alert/Wizard/AlertRulesWizardSection.js +4 -6
  229. package/src/View/Alert/Wizard/AlertWizard.js +20 -6
  230. package/src/View/Alert/Wizard/BaseAlertRulesWizardSection.d.ts +5 -2
  231. package/src/View/Alert/Wizard/BaseAlertRulesWizardSection.js +5 -2
  232. package/src/View/Alert/Wizard/BaseAlertScopeWizardSection.d.ts +5 -4
  233. package/src/View/Alert/Wizard/BaseAlertScopeWizardSection.js +2 -2
  234. package/src/View/Alert/Wizard/isValidAlertRules.d.ts +2 -3
  235. package/src/View/BulkUpdate/BulkUpdatePopup.js +1 -1
  236. package/src/View/CalculatedColumn/Utilities/getCalculatedColumnSettingTags.d.ts +2 -0
  237. package/src/View/CalculatedColumn/Utilities/getCalculatedColumnSettingTags.js +16 -0
  238. package/src/View/CalculatedColumn/Wizard/CalculatedColumnSettingsWizardSection.d.ts +1 -0
  239. package/src/View/CalculatedColumn/Wizard/CalculatedColumnSettingsWizardSection.js +17 -40
  240. package/src/View/CalculatedColumn/Wizard/CalculatedColumnWizard.js +20 -3
  241. package/src/View/CellSummary/CellSummaryPopup.js +2 -2
  242. package/src/View/ColorPicker.d.ts +1 -1
  243. package/src/View/Components/AdaptableDateInput/index.d.ts +1 -1
  244. package/src/View/Components/AdaptableInput/index.d.ts +1 -1
  245. package/src/View/Components/AdaptableObjectList/AdaptableObjectList.d.ts +14 -0
  246. package/src/View/Components/AdaptableObjectList/AdaptableObjectList.js +82 -0
  247. package/src/View/Components/AdaptableObjectList/index.d.ts +1 -0
  248. package/src/View/Components/AdaptableObjectList/index.js +5 -0
  249. package/src/View/Components/Buttons/ButtonDelete.d.ts +1 -1
  250. package/src/View/Components/Buttons/ButtonDelete.js +3 -2
  251. package/src/View/Components/Buttons/ButtonEdit.d.ts +1 -3
  252. package/src/View/Components/Buttons/ButtonEdit.js +4 -6
  253. package/src/View/Components/Buttons/ButtonShare.js +3 -2
  254. package/src/View/Components/Buttons/EntityListActionButtons.js +1 -1
  255. package/src/View/Components/Buttons/{SuspendToggleButton.d.ts → SuspendToggleButton/SuspendToggleButton.d.ts} +5 -3
  256. package/src/View/Components/Buttons/SuspendToggleButton/SuspendToggleButton.js +19 -0
  257. package/src/View/Components/Buttons/SuspendToggleButton/index.d.ts +1 -0
  258. package/src/View/Components/Buttons/SuspendToggleButton/index.js +4 -0
  259. package/src/View/Components/ExternalRenderer.d.ts +14 -0
  260. package/src/View/Components/ExternalRenderer.js +32 -0
  261. package/src/View/Components/FilterForm/QuickFilterForm.js +8 -3
  262. package/src/View/Components/FilterForm/getDefaultColumnFilterPredicate.d.ts +1 -1
  263. package/src/View/Components/Forms/AdaptableFormControlTextClear.d.ts +1 -1
  264. package/src/View/Components/ModuleValueSelector/index.d.ts +3 -1
  265. package/src/View/Components/ModuleValueSelector/index.js +1 -1
  266. package/src/View/Components/NewScopeComponent.js +1 -1
  267. package/src/View/Components/Panels/PanelWithImage.d.ts +4 -4
  268. package/src/View/Components/Panels/PanelWithImage.js +2 -2
  269. package/src/View/Components/Popups/AdaptablePopup/AdaptablePopup.d.ts +20 -0
  270. package/src/View/Components/Popups/AdaptablePopup/AdaptablePopup.js +120 -0
  271. package/src/View/Components/Popups/AdaptablePopup/AdaptablePopupBody.d.ts +15 -0
  272. package/src/View/Components/Popups/AdaptablePopup/AdaptablePopupBody.js +35 -0
  273. package/src/View/Components/Popups/AdaptablePopup/AdaptablePopupModuleView.d.ts +9 -0
  274. package/src/View/Components/Popups/AdaptablePopup/AdaptablePopupModuleView.js +67 -0
  275. package/src/View/Components/Popups/AdaptablePopup/CustomSettingsPanelView.d.ts +6 -0
  276. package/src/View/Components/Popups/AdaptablePopup/CustomSettingsPanelView.js +9 -0
  277. package/src/View/Components/Popups/AdaptablePopup/Navigation.d.ts +13 -0
  278. package/src/View/Components/Popups/AdaptablePopup/Navigation.js +63 -0
  279. package/src/View/Components/Popups/{PopupContext.d.ts → AdaptablePopup/PopupContext.d.ts} +0 -0
  280. package/src/View/Components/Popups/{PopupContext.js → AdaptablePopup/PopupContext.js} +0 -0
  281. package/src/View/Components/Popups/AdaptablePopup/PopupPanel.d.ts +10 -0
  282. package/src/View/Components/Popups/AdaptablePopup/PopupPanel.js +22 -0
  283. package/src/View/Components/Popups/AdaptablePopup/TopBar.d.ts +7 -0
  284. package/src/View/Components/Popups/AdaptablePopup/TopBar.js +29 -0
  285. package/src/View/Components/Popups/AdaptablePopup/Utilities.d.ts +15 -0
  286. package/src/View/Components/Popups/AdaptablePopup/Utilities.js +28 -0
  287. package/src/View/Components/Popups/AdaptablePopup/index.d.ts +1 -0
  288. package/src/View/Components/Popups/AdaptablePopup/index.js +5 -0
  289. package/src/View/Components/ToolPanel/AdaptableToolPanel.js +45 -80
  290. package/src/View/Components/ToolPanel/ToolPanelPopup.js +12 -4
  291. package/src/View/Components/ValueSelector/index.d.ts +1 -0
  292. package/src/View/Components/ValueSelector/index.js +6 -6
  293. package/src/View/ConditionalStyle/Wizard/ConditionalStyleWizard.d.ts +2 -2
  294. package/src/View/ConditionalStyle/Wizard/ConditionalStyleWizard.js +19 -5
  295. package/src/View/CustomSort/Wizard/CustomSortColumnWizardSection.js +3 -4
  296. package/src/View/CustomSort/Wizard/CustomSortWizard.js +18 -3
  297. package/src/View/Dashboard/Dashboard.d.ts +0 -1
  298. package/src/View/Dashboard/Dashboard.js +13 -83
  299. package/src/View/Dashboard/DashboardPopup.d.ts +6 -2
  300. package/src/View/Dashboard/DashboardPopup.js +38 -8
  301. package/src/View/DataChangeHistory/DataChangeHistoryGrid.js +4 -4
  302. package/src/View/DataChangeHistory/DataChangeHistoryPopup.js +3 -3
  303. package/src/View/DataSource/Wizard/DataSourceSettingsSummary.js +3 -3
  304. package/src/View/DataSource/Wizard/DataSourceWizard.d.ts +1 -2
  305. package/src/View/DataSource/Wizard/DataSourceWizard.js +17 -2
  306. package/src/View/Export/ReportExportDropdown.d.ts +5 -0
  307. package/src/View/Export/ReportExportDropdown.js +37 -0
  308. package/src/View/Export/Wizard/NewReportWizard.js +15 -2
  309. package/src/View/Export/Wizard/ReportNameWizardSection.js +2 -1
  310. package/src/View/Export/Wizard/ReportRowsWizardSection.js +2 -2
  311. package/src/View/FlashingCell/FlashingCellStyle.d.ts +7 -0
  312. package/src/View/FlashingCell/FlashingCellStyle.js +20 -0
  313. package/src/View/{Alert/Wizard/FlashingAlertWizard/FlashingAlertRulesWizardSection.d.ts → FlashingCell/Wizard/FlashingCellRulesWizardSection.d.ts} +3 -3
  314. package/src/View/{Alert/Wizard/FlashingAlertWizard/FlashingAlertRulesWizardSection.js → FlashingCell/Wizard/FlashingCellRulesWizardSection.js} +14 -14
  315. package/src/View/{Alert/Wizard/FlashingAlertWizard/FlashingAlertScopeWizardSection.d.ts → FlashingCell/Wizard/FlashingCellScopeWizardSection.d.ts} +1 -2
  316. package/src/View/{Alert/Wizard/FlashingAlertWizard/FlashingAlertScopeWizardSection.js → FlashingCell/Wizard/FlashingCellScopeWizardSection.js} +1 -1
  317. package/src/View/FlashingCell/Wizard/FlashingCellSettingsWizardSection.d.ts +10 -0
  318. package/src/View/FlashingCell/Wizard/FlashingCellSettingsWizardSection.js +66 -0
  319. package/src/View/FlashingCell/Wizard/FlashingCellStyleWizardSection.d.ts +15 -0
  320. package/src/View/{Alert/Wizard/FlashingAlertWizard/FlashingAlertStyleWizardSection.js → FlashingCell/Wizard/FlashingCellStyleWizardSection.js} +17 -16
  321. package/src/View/FlashingCell/Wizard/FlashingCellWizard.d.ts +6 -0
  322. package/src/View/FlashingCell/Wizard/FlashingCellWizard.js +97 -0
  323. package/src/View/FlashingCell/Wizard/isValidFlashingCellRules.d.ts +3 -0
  324. package/src/View/FlashingCell/Wizard/isValidFlashingCellRules.js +30 -0
  325. package/src/View/FormatColumn/Wizard/FormatColumnFormatWizardSection.d.ts +1 -0
  326. package/src/View/FormatColumn/Wizard/FormatColumnFormatWizardSection.js +18 -14
  327. package/src/View/FormatColumn/Wizard/FormatColumnScopeWizardSection.js +2 -2
  328. package/src/View/FormatColumn/Wizard/FormatColumnSettingsWizardSection.js +4 -4
  329. package/src/View/FormatColumn/Wizard/FormatColumnWizard.js +17 -2
  330. package/src/View/FreeTextColumn/Wizard/FreeTextColumnSettingsWizardSection.d.ts +1 -0
  331. package/src/View/FreeTextColumn/Wizard/FreeTextColumnSettingsWizardSection.js +15 -10
  332. package/src/View/FreeTextColumn/Wizard/FreeTextColumnWizard.js +19 -5
  333. package/src/View/GridInfo/AdaptableOptionsComponent.js +2 -2
  334. package/src/View/GridInfo/GridInfoPopup.d.ts +2 -1
  335. package/src/View/GridInfo/GridInfoPopup.js +22 -16
  336. package/src/View/GridInfo/GridOptionsComponent.js +1 -1
  337. package/src/View/Layout/LayoutPopup.js +4 -6
  338. package/src/View/Layout/Wizard/LayoutEditor/ColumnList.js +3 -1
  339. package/src/View/Layout/Wizard/LayoutEditor/index.js +5 -2
  340. package/src/View/PlusMinus/Wizard/PlusMinusSettingsWizardSection.js +2 -2
  341. package/src/View/PlusMinus/Wizard/PlusMinusWizard.d.ts +1 -2
  342. package/src/View/PlusMinus/Wizard/PlusMinusWizard.js +18 -4
  343. package/src/View/Query/Wizard/NamedQueryExpressionWizardSection.js +2 -2
  344. package/src/View/Query/Wizard/NamedQuerySettingsWizardSection.js +2 -2
  345. package/src/View/Query/Wizard/NamedQueryWizard.js +17 -2
  346. package/src/View/QuickSearch/QuickSearchPopup.js +3 -3
  347. package/src/View/Schedule/Wizard/ScheduleScheduleSummary.js +2 -2
  348. package/src/View/Schedule/Wizard/ScheduleScheduleWizard.js +7 -8
  349. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsOpenFin.js +1 -1
  350. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsReminder.js +9 -9
  351. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsSummary.d.ts +5 -0
  352. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsSummary.js +59 -48
  353. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/isSettingsValid.js +9 -9
  354. package/src/View/Schedule/Wizard/ScheduleWizard.d.ts +1 -2
  355. package/src/View/Schedule/Wizard/ScheduleWizard.js +75 -2
  356. package/src/View/Shortcut/Wizard/ShortcutSettingsWizard.js +6 -6
  357. package/src/View/Shortcut/Wizard/ShortcutWizard.d.ts +1 -2
  358. package/src/View/Shortcut/Wizard/ShortcutWizard.js +31 -4
  359. package/src/View/Shortcut/shortcutKeys.js +0 -1
  360. package/src/View/SmartEdit/SmartEditPopup.js +2 -2
  361. package/src/View/SpecialColumnSettingsWizardStep.d.ts +9 -0
  362. package/src/View/SpecialColumnSettingsWizardStep.js +62 -0
  363. package/src/View/StateManagement/StateManagementPopup.js +16 -15
  364. package/src/View/SystemStatus/SystemStatusPopup.js +3 -3
  365. package/src/View/TeamSharing/TeamSharingPopup.js +2 -2
  366. package/src/View/Theme/ThemePopup.js +5 -7
  367. package/src/View/UIHelper.d.ts +3 -5
  368. package/src/View/UIHelper.js +35 -49
  369. package/src/View/Wizard/Interface/IAdaptableWizard.d.ts +5 -0
  370. package/src/View/Wizard/OnePageAdaptableWizard.d.ts +2 -0
  371. package/src/View/Wizard/OnePageAdaptableWizard.js +10 -2
  372. package/src/agGrid/Adaptable.d.ts +24 -11
  373. package/src/agGrid/Adaptable.js +227 -81
  374. package/src/agGrid/agGridHelper.d.ts +2 -2
  375. package/src/agGrid/agGridHelper.js +21 -6
  376. package/src/agGrid/agGridMenuHelper.js +11 -7
  377. package/src/components/ApplicationIcon.d.ts +5 -0
  378. package/src/components/ApplicationIcon.js +13 -0
  379. package/src/components/Dashboard/Dashboard.js +1 -1
  380. package/src/components/Dashboard/DashboardManager.js +1 -1
  381. package/src/components/Datepicker/index.d.ts +1 -1
  382. package/src/components/Dialog/index.d.ts +4 -1
  383. package/src/components/Dialog/index.js +10 -3
  384. package/src/components/DropdownButton/index.d.ts +1 -0
  385. package/src/components/DropdownButton/index.js +2 -2
  386. package/src/components/EllipsisContainer/index.js +1 -1
  387. package/src/components/EmptyContent/index.js +2 -1
  388. package/src/components/Input/index.d.ts +1 -1
  389. package/src/components/List/ListGroupItem/index.d.ts +1 -1
  390. package/src/components/PopupWithFooter.d.ts +1 -1
  391. package/src/components/PopupWithFooter.js +2 -7
  392. package/src/components/StylePreview.d.ts +8 -0
  393. package/src/components/StylePreview.js +11 -0
  394. package/src/components/Tag/Tag.d.ts +3 -0
  395. package/src/components/Tag/Tag.js +11 -0
  396. package/src/components/Tag/index.d.ts +1 -0
  397. package/src/components/Tag/index.js +5 -0
  398. package/src/components/Textarea/index.d.ts +1 -1
  399. package/src/components/ToggleButton/index.d.ts +1 -0
  400. package/src/components/ToggleButton/index.js +8 -4
  401. package/src/components/WindowModal/WindowModal.d.ts +23 -0
  402. package/src/components/WindowModal/WindowModal.js +102 -0
  403. package/src/components/WindowModal/index.d.ts +1 -0
  404. package/src/components/WindowModal/index.js +4 -0
  405. package/src/components/icons/column-add.d.ts +3 -0
  406. package/src/components/icons/column-add.js +10 -0
  407. package/src/components/icons/index.js +6 -0
  408. package/src/components/icons/menu.d.ts +3 -0
  409. package/src/components/icons/menu.js +7 -0
  410. package/src/components/icons/state-management.js +1 -1
  411. package/src/components/icons/tool-panel.d.ts +3 -0
  412. package/src/components/icons/tool-panel.js +7 -0
  413. package/src/components/utils/useDraggable.d.ts +3 -1
  414. package/src/components/utils/useDraggable.js +15 -2
  415. package/src/metamodel/adaptable.metamodel.d.ts +93 -105
  416. package/src/metamodel/adaptable.metamodel.js +425 -455
  417. package/src/types.d.ts +10 -11
  418. package/version.d.ts +1 -1
  419. package/version.js +1 -1
  420. package/src/AdaptableOptions/ChartPluginOptions.d.ts +0 -20
  421. package/src/Api/ChartApi.d.ts +0 -20
  422. package/src/Api/Events/FlashingAlertFired.d.ts +0 -11
  423. package/src/Api/Implementation/SparklineColumnApiImpl.d.ts +0 -9
  424. package/src/Api/Implementation/SparklineColumnApiImpl.js +0 -24
  425. package/src/Api/SparklineColumnApi.d.ts +0 -23
  426. package/src/PredefinedConfig/ChartState.d.ts +0 -144
  427. package/src/PredefinedConfig/Common/ChartEnums.d.ts +0 -123
  428. package/src/PredefinedConfig/Common/ChartEnums.js +0 -152
  429. package/src/PredefinedConfig/SparklineColumnState.d.ts +0 -40
  430. package/src/Redux/ActionsReducers/SparklineColumnRedux.d.ts +0 -35
  431. package/src/Redux/ActionsReducers/SparklineColumnRedux.js +0 -70
  432. package/src/Utilities/Defaults/DefaultCategoryChartProperties.d.ts +0 -2
  433. package/src/Utilities/Defaults/DefaultCategoryChartProperties.js +0 -56
  434. package/src/Utilities/Defaults/DefaultPieChartProperties.d.ts +0 -2
  435. package/src/Utilities/Defaults/DefaultPieChartProperties.js +0 -13
  436. package/src/Utilities/Defaults/DefaultSparklinesChartProperties.d.ts +0 -2
  437. package/src/Utilities/Defaults/DefaultSparklinesChartProperties.js +0 -25
  438. package/src/View/Alert/AlertPopup.d.ts +0 -42
  439. package/src/View/Alert/AlertPopup.js +0 -205
  440. package/src/View/Alert/FlashingAlertEntityRow.d.ts +0 -7
  441. package/src/View/Alert/FlashingAlertEntityRow.js +0 -22
  442. package/src/View/Alert/Wizard/FlashingAlertWizard/FlashingAlertDurationWizardSection.d.ts +0 -10
  443. package/src/View/Alert/Wizard/FlashingAlertWizard/FlashingAlertDurationWizardSection.js +0 -60
  444. package/src/View/Alert/Wizard/FlashingAlertWizard/FlashingAlertStyleWizardSection.d.ts +0 -10
  445. package/src/View/Alert/Wizard/FlashingAlertWizard/FlashingAlertWizard.d.ts +0 -6
  446. package/src/View/Alert/Wizard/FlashingAlertWizard/FlashingAlertWizard.js +0 -89
  447. package/src/View/CalculatedColumn/CalculatedColumnEntityRow.d.ts +0 -9
  448. package/src/View/CalculatedColumn/CalculatedColumnEntityRow.js +0 -28
  449. package/src/View/CalculatedColumn/CalculatedColumnPopup.d.ts +0 -25
  450. package/src/View/CalculatedColumn/CalculatedColumnPopup.js +0 -117
  451. package/src/View/Components/Buttons/SuspendToggleButton.js +0 -17
  452. package/src/View/Components/Panels/PanelWithIImageThreeButtons.d.ts +0 -11
  453. package/src/View/Components/Panels/PanelWithIImageThreeButtons.js +0 -28
  454. package/src/View/Components/Popups/AdaptableChart.d.ts +0 -18
  455. package/src/View/Components/Popups/AdaptableChart.js +0 -40
  456. package/src/View/Components/Popups/AdaptablePopup.d.ts +0 -23
  457. package/src/View/Components/Popups/AdaptablePopup.js +0 -59
  458. package/src/View/Components/SharedProps/ChartDisplayPopupPropsBase.d.ts +0 -7
  459. package/src/View/Components/SharedProps/ChartDisplayPopupPropsBase.js +0 -2
  460. package/src/View/ConditionalStyle/ConditionalStyleEntityRow.d.ts +0 -5
  461. package/src/View/ConditionalStyle/ConditionalStyleEntityRow.js +0 -26
  462. package/src/View/ConditionalStyle/ConditionalStylePopup.d.ts +0 -30
  463. package/src/View/ConditionalStyle/ConditionalStylePopup.js +0 -144
  464. package/src/View/CustomSort/CustomSortEntityRow.d.ts +0 -12
  465. package/src/View/CustomSort/CustomSortEntityRow.js +0 -32
  466. package/src/View/CustomSort/CustomSortPopup.d.ts +0 -27
  467. package/src/View/CustomSort/CustomSortPopup.js +0 -138
  468. package/src/View/DataSource/DataSourceEntityRow.d.ts +0 -12
  469. package/src/View/DataSource/DataSourceEntityRow.js +0 -29
  470. package/src/View/DataSource/DataSourcePopup.d.ts +0 -28
  471. package/src/View/DataSource/DataSourcePopup.js +0 -97
  472. package/src/View/Export/ExportPopup.d.ts +0 -34
  473. package/src/View/Export/ExportPopup.js +0 -139
  474. package/src/View/Export/ReportEntityRow.d.ts +0 -10
  475. package/src/View/Export/ReportEntityRow.js +0 -49
  476. package/src/View/Export/Wizard/ReportWizard.d.ts +0 -7
  477. package/src/View/Export/Wizard/ReportWizard.js +0 -50
  478. package/src/View/Filter/FilterEntityRow.d.ts +0 -12
  479. package/src/View/Filter/FilterEntityRow.js +0 -20
  480. package/src/View/Filter/FilterPopup.d.ts +0 -20
  481. package/src/View/Filter/FilterPopup.js +0 -50
  482. package/src/View/FormatColumn/FormatColumnEntityRow.d.ts +0 -9
  483. package/src/View/FormatColumn/FormatColumnEntityRow.js +0 -103
  484. package/src/View/FormatColumn/FormatColumnPopup.d.ts +0 -27
  485. package/src/View/FormatColumn/FormatColumnPopup.js +0 -133
  486. package/src/View/FreeTextColumn/FreeTextColumnEntityRow.d.ts +0 -5
  487. package/src/View/FreeTextColumn/FreeTextColumnEntityRow.js +0 -31
  488. package/src/View/FreeTextColumn/FreeTextColumnPopup.d.ts +0 -25
  489. package/src/View/FreeTextColumn/FreeTextColumnPopup.js +0 -118
  490. package/src/View/PlusMinus/PlusMinusEntityRow.d.ts +0 -9
  491. package/src/View/PlusMinus/PlusMinusEntityRow.js +0 -24
  492. package/src/View/PlusMinus/PlusMinusPopup.d.ts +0 -30
  493. package/src/View/PlusMinus/PlusMinusPopup.js +0 -124
  494. package/src/View/Query/NamedQueryEntityRow.d.ts +0 -8
  495. package/src/View/Query/NamedQueryEntityRow.js +0 -21
  496. package/src/View/Query/QueryPopup.d.ts +0 -28
  497. package/src/View/Query/QueryPopup.js +0 -114
  498. package/src/View/Schedule/ScheduleEntityRow.d.ts +0 -5
  499. package/src/View/Schedule/ScheduleEntityRow.js +0 -58
  500. package/src/View/Schedule/SchedulePopup.d.ts +0 -58
  501. package/src/View/Schedule/SchedulePopup.js +0 -317
  502. package/src/View/Shortcut/ShortcutEntityRow.d.ts +0 -17
  503. package/src/View/Shortcut/ShortcutEntityRow.js +0 -47
  504. package/src/View/Shortcut/ShortcutPopup.d.ts +0 -30
  505. package/src/View/Shortcut/ShortcutPopup.js +0 -121
  506. package/src/components/ChartContainer/index.d.ts +0 -15
  507. package/src/components/ChartContainer/index.js +0 -22
@@ -192,6 +192,13 @@ exports.ADAPTABLE_METAMODEL = {
192
192
  "uiLabel": "Cell Summary Api",
193
193
  "reference": "CellSummaryApi"
194
194
  },
195
+ {
196
+ "name": "chartingApi",
197
+ "kind": "REFERENCE",
198
+ "description": "Provides run-time access to Charting Module and state",
199
+ "uiLabel": "Charting Api",
200
+ "reference": "unknown"
201
+ },
195
202
  {
196
203
  "name": "columnApi",
197
204
  "kind": "REFERENCE",
@@ -230,7 +237,7 @@ exports.ADAPTABLE_METAMODEL = {
230
237
  {
231
238
  "name": "dataChangeHistoryApi",
232
239
  "kind": "REFERENCE",
233
- "description": "Provides run-time access to the Data Change History Module",
240
+ "description": "Provides run-time access to the Data Changes Module",
234
241
  "uiLabel": "Data Change History Api",
235
242
  "reference": "DataChangeHistoryApi"
236
243
  },
@@ -306,7 +313,7 @@ exports.ADAPTABLE_METAMODEL = {
306
313
  {
307
314
  "name": "pluginsApi",
308
315
  "kind": "REFERENCE",
309
- "description": "Offers access to AdapTable Plugin (e.g. charts, ipushpull, OpenFin etc)",
316
+ "description": "Offers access to AdapTable Plugin (e.g. ipushpull, OpenFin etc)",
310
317
  "uiLabel": "Plugins Api",
311
318
  "reference": "PluginsApi"
312
319
  },
@@ -373,13 +380,6 @@ exports.ADAPTABLE_METAMODEL = {
373
380
  "uiLabel": "Smart Edit Api",
374
381
  "reference": "SmartEditApi"
375
382
  },
376
- {
377
- "name": "sparklineColumnApi",
378
- "kind": "REFERENCE",
379
- "description": "Provides access to the Sparkline Column in the Charts Plugin",
380
- "uiLabel": "Sparkline Column Api",
381
- "reference": "SparklineColumnApi"
382
- },
383
383
  {
384
384
  "name": "systemStatusApi",
385
385
  "kind": "REFERENCE",
@@ -568,6 +568,12 @@ exports.ADAPTABLE_METAMODEL = {
568
568
  "description": "Can Column be moved at run-time to a new position",
569
569
  "uiLabel": "Moveable"
570
570
  },
571
+ {
572
+ "name": "pinned",
573
+ "kind": "unknown",
574
+ "description": "The pinned position of the column",
575
+ "uiLabel": "Pinned"
576
+ },
571
577
  {
572
578
  "name": "pivotable",
573
579
  "kind": "boolean",
@@ -656,15 +662,15 @@ exports.ADAPTABLE_METAMODEL = {
656
662
  }
657
663
  ]
658
664
  },
659
- "AdaptableFlashingAlert": {
660
- "name": "AdaptableFlashingAlert",
665
+ "AdaptableFlashingCell": {
666
+ "name": "AdaptableFlashingCell",
661
667
  "kind": "Interface",
662
668
  "description": "Defines an Alert fired by AdapTable",
663
669
  "properties": [
664
670
  {
665
671
  "name": "dataChangedInfo",
666
672
  "kind": "REFERENCE",
667
- "description": "Data change which triggered the FlashingAlert",
673
+ "description": "Data change which triggered the FlashingCell",
668
674
  "uiLabel": "Data Changed Info",
669
675
  "isOptional": true,
670
676
  "reference": "DataChangedInfo"
@@ -682,11 +688,11 @@ exports.ADAPTABLE_METAMODEL = {
682
688
  "uiLabel": "Flash Column Ids"
683
689
  },
684
690
  {
685
- "name": "flashingAlertDefinition",
691
+ "name": "flashingCellDefinition",
686
692
  "kind": "REFERENCE",
687
- "description": "Rule that caused the FlashingAlert to fire",
688
- "uiLabel": "Flashing Alert Definition",
689
- "reference": "FlashingAlertDefinition"
693
+ "description": "Rule that caused the FlashingCell to fire",
694
+ "uiLabel": "Flashing Cell Definition",
695
+ "reference": "FlashingCellDefinition"
690
696
  },
691
697
  {
692
698
  "name": "flashTarget",
@@ -817,7 +823,7 @@ exports.ADAPTABLE_METAMODEL = {
817
823
  "AdaptableMenuItem": {
818
824
  "name": "AdaptableMenuItem",
819
825
  "kind": "Interface",
820
- "description": "Menu item used by Adaptable in 3 places: Module Menu (at left of Dashboard Header), Column Header Menu and Context Menu",
826
+ "description": "Menu item used by Adaptable in both Column and Context Menus",
821
827
  "properties": [
822
828
  {
823
829
  "name": "icon",
@@ -937,7 +943,7 @@ exports.ADAPTABLE_METAMODEL = {
937
943
  {
938
944
  "name": "containerOptions",
939
945
  "kind": "REFERENCE",
940
- "description": "Options for setting the 'Div' elements in which AdapTable, AG Grid, popups and charts are placed",
946
+ "description": "Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed",
941
947
  "uiLabel": "Container Options",
942
948
  "isOptional": true,
943
949
  "reference": "ContainerOptions"
@@ -1003,6 +1009,15 @@ exports.ADAPTABLE_METAMODEL = {
1003
1009
  "gridInfo": "container",
1004
1010
  "reference": "FilterOptions"
1005
1011
  },
1012
+ {
1013
+ "name": "flashingCellOptions",
1014
+ "kind": "REFERENCE",
1015
+ "description": "Options for managing Flashing Cells - primarily default values",
1016
+ "uiLabel": "Flashing Cell Options",
1017
+ "isOptional": true,
1018
+ "gridInfo": "container",
1019
+ "reference": "FlashingCellOptions"
1020
+ },
1006
1021
  {
1007
1022
  "name": "generalOptions",
1008
1023
  "kind": "REFERENCE",
@@ -1012,6 +1027,15 @@ exports.ADAPTABLE_METAMODEL = {
1012
1027
  "gridInfo": "container",
1013
1028
  "reference": "GeneralOptions"
1014
1029
  },
1030
+ {
1031
+ "name": "gridOptions",
1032
+ "kind": "REFERENCE",
1033
+ "description": "The AG Grid object which AdapTable interacts with. Note: if using React or Angular Wrapper, no need to populate this property as AdapTable wires it up differently",
1034
+ "uiLabel": "Grid Options",
1035
+ "isOptional": true,
1036
+ "defaultValue": "n/a (Mandatory)",
1037
+ "reference": "unknown"
1038
+ },
1015
1039
  {
1016
1040
  "name": "layoutOptions",
1017
1041
  "kind": "REFERENCE",
@@ -1087,6 +1111,15 @@ exports.ADAPTABLE_METAMODEL = {
1087
1111
  "gridInfo": "container",
1088
1112
  "reference": "SearchOptions"
1089
1113
  },
1114
+ {
1115
+ "name": "settingsPanelOptions",
1116
+ "kind": "REFERENCE",
1117
+ "description": "Setting panel options",
1118
+ "uiLabel": "Settings Panel Options",
1119
+ "isOptional": true,
1120
+ "gridInfo": "container",
1121
+ "reference": "unknown"
1122
+ },
1090
1123
  {
1091
1124
  "name": "stateOptions",
1092
1125
  "kind": "REFERENCE",
@@ -1130,14 +1163,6 @@ exports.ADAPTABLE_METAMODEL = {
1130
1163
  "isOptional": true,
1131
1164
  "gridInfo": "item",
1132
1165
  "defaultValue": "'anonymous'"
1133
- },
1134
- {
1135
- "name": "vendorGrid",
1136
- "kind": "unknown",
1137
- "description": "The AG Grid object which AdapTable interacts with. Note: if using React or Angular Wrapper, no need to populate this property (as `gridOptions` is a separate prop and AdapTable wires up everything)",
1138
- "uiLabel": "Vendor Grid",
1139
- "isOptional": true,
1140
- "defaultValue": "n/a (Mandatory)"
1141
1166
  }
1142
1167
  ]
1143
1168
  },
@@ -1213,7 +1238,7 @@ exports.ADAPTABLE_METAMODEL = {
1213
1238
  {
1214
1239
  "name": "moduleScope",
1215
1240
  "kind": "unknown",
1216
- "description": "Modules where Predicate can run: 'filter', 'alert', 'conditionalstyle'",
1241
+ "description": "Modules where the Predicate can run",
1217
1242
  "uiLabel": "Module Scope"
1218
1243
  },
1219
1244
  {
@@ -1247,7 +1272,7 @@ exports.ADAPTABLE_METAMODEL = {
1247
1272
  {
1248
1273
  "name": "gridOptions",
1249
1274
  "kind": "REFERENCE",
1250
- "description": "Underlying AG Grid instance",
1275
+ "description": "Underlying AG Grid GridOptions object",
1251
1276
  "uiLabel": "Grid Options",
1252
1277
  "reference": "unknown"
1253
1278
  }
@@ -1491,18 +1516,6 @@ exports.ADAPTABLE_METAMODEL = {
1491
1516
  "description": "Adds new Alert Definition",
1492
1517
  "uiLabel": "Add Alert Definition"
1493
1518
  },
1494
- {
1495
- "name": "addFlashingAlertDefinition",
1496
- "kind": "function",
1497
- "description": "Adds a Flashing Alert Definition to State",
1498
- "uiLabel": "Add Flashing Alert Definition"
1499
- },
1500
- {
1501
- "name": "addFlashingAlertDefinitions",
1502
- "kind": "function",
1503
- "description": "Adds provided Flashing Alert Definitions",
1504
- "uiLabel": "Add Flashing Alert Definitions"
1505
- },
1506
1519
  {
1507
1520
  "name": "displayAlert",
1508
1521
  "kind": "function",
@@ -1521,18 +1534,6 @@ exports.ADAPTABLE_METAMODEL = {
1521
1534
  "description": "Edits Alert in State with given one",
1522
1535
  "uiLabel": "Edit Alert Definition"
1523
1536
  },
1524
- {
1525
- "name": "editFlashingAlertDefinition",
1526
- "kind": "function",
1527
- "description": "Edits Flashing Alert in State with given one",
1528
- "uiLabel": "Edit Flashing Alert Definition"
1529
- },
1530
- {
1531
- "name": "editFlashingAlertDefinitions",
1532
- "kind": "function",
1533
- "description": "Edits provided Flashing Alert Definitions",
1534
- "uiLabel": "Edit Flashing Alert Definitions"
1535
- },
1536
1537
  {
1537
1538
  "name": "executeAlertAction",
1538
1539
  "kind": "function",
@@ -1551,24 +1552,12 @@ exports.ADAPTABLE_METAMODEL = {
1551
1552
  "description": "Retrieves all active (non-suspended) Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)",
1552
1553
  "uiLabel": "Get Active Non Reactive Alert Definitions"
1553
1554
  },
1554
- {
1555
- "name": "getActiveNonReactiveFlashingAlertDefinitions",
1556
- "kind": "function",
1557
- "description": "Retrieves all active (non-suspended) Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)",
1558
- "uiLabel": "Get Active Non Reactive Flashing Alert Definitions"
1559
- },
1560
1555
  {
1561
1556
  "name": "getActiveReactiveAlertDefinitions",
1562
1557
  "kind": "function",
1563
1558
  "description": "Retrieves all active (non-suspended) Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)",
1564
1559
  "uiLabel": "Get Active Reactive Alert Definitions"
1565
1560
  },
1566
- {
1567
- "name": "getActiveReactiveFlashingAlertDefinitions",
1568
- "kind": "function",
1569
- "description": "Retrieves all active (non-suspended) Flashing Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)",
1570
- "uiLabel": "Get Active Reactive Flashing Alert Definitions"
1571
- },
1572
1561
  {
1573
1562
  "name": "getAdaptableFormByName",
1574
1563
  "kind": "function",
@@ -1629,48 +1618,18 @@ exports.ADAPTABLE_METAMODEL = {
1629
1618
  "description": "Retrieves Alert section from Adaptable State",
1630
1619
  "uiLabel": "Get Alert State"
1631
1620
  },
1632
- {
1633
- "name": "getFlashingAlertDefinitionById",
1634
- "kind": "function",
1635
- "description": "Retrieves Flashing Alert Definition By Id",
1636
- "uiLabel": "Get Flashing Alert Definition By Id"
1637
- },
1638
- {
1639
- "name": "getFlashingAlertDefinitions",
1640
- "kind": "function",
1641
- "description": "Retrieves all Flashing Alert Definitions in Alert State",
1642
- "uiLabel": "Get Flashing Alert Definitions"
1643
- },
1644
- {
1645
- "name": "getFlashingAlertFlashTarget",
1646
- "kind": "function",
1647
- "description": "Returns where a Flashing Alert Definition will flash a single cell or a whole row",
1648
- "uiLabel": "Get Flashing Alert Flash Target"
1649
- },
1650
1621
  {
1651
1622
  "name": "getNonReactiveAlertDefinitions",
1652
1623
  "kind": "function",
1653
1624
  "description": "Retrieves all Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)",
1654
1625
  "uiLabel": "Get Non Reactive Alert Definitions"
1655
1626
  },
1656
- {
1657
- "name": "getNonReactiveFlashingAlertDefinitions",
1658
- "kind": "function",
1659
- "description": "Retrieves all Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)",
1660
- "uiLabel": "Get Non Reactive Flashing Alert Definitions"
1661
- },
1662
1627
  {
1663
1628
  "name": "getReactiveAlertDefinitions",
1664
1629
  "kind": "function",
1665
1630
  "description": "Retrieves all Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)",
1666
1631
  "uiLabel": "Get Reactive Alert Definitions"
1667
1632
  },
1668
- {
1669
- "name": "getReactiveFlashingAlertDefinitions",
1670
- "kind": "function",
1671
- "description": "Retrieves all Flashing Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)",
1672
- "uiLabel": "Get Reactive Flashing Alert Definitions"
1673
- },
1674
1633
  {
1675
1634
  "name": "publishAlertFiredEvent",
1676
1635
  "kind": "function",
@@ -1713,35 +1672,17 @@ exports.ADAPTABLE_METAMODEL = {
1713
1672
  "description": "Creates Alert formed from inputted values and displays it as Warning Alert.",
1714
1673
  "uiLabel": "Show Alert Warning"
1715
1674
  },
1716
- {
1717
- "name": "showFlashingAlert",
1718
- "kind": "function",
1719
- "description": "Displays a Flashing Alert",
1720
- "uiLabel": "Show Flashing Alert"
1721
- },
1722
1675
  {
1723
1676
  "name": "suspendAlertDefinition",
1724
1677
  "kind": "function",
1725
1678
  "description": "Suspends Alert Definition",
1726
1679
  "uiLabel": "Suspend Alert Definition"
1727
1680
  },
1728
- {
1729
- "name": "suspendFlashingAlertDefinition",
1730
- "kind": "function",
1731
- "description": "Suspends a Flashing Alert Definition",
1732
- "uiLabel": "Suspend Flashing Alert Definition"
1733
- },
1734
1681
  {
1735
1682
  "name": "unSuspendAlertDefinition",
1736
1683
  "kind": "function",
1737
1684
  "description": "Activates a suspended Alert Definition",
1738
1685
  "uiLabel": "Un Suspend Alert Definition"
1739
- },
1740
- {
1741
- "name": "unSuspendFlashingAlertDefinition",
1742
- "kind": "function",
1743
- "description": "Activates a suspended Flashing Alert Definition",
1744
- "uiLabel": "Un Suspend Flashing Alert Definition"
1745
1686
  }
1746
1687
  ]
1747
1688
  },
@@ -1835,6 +1776,20 @@ exports.ADAPTABLE_METAMODEL = {
1835
1776
  "description": "Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging",
1836
1777
  "uiLabel": "Message Type",
1837
1778
  "reference": "AdaptableMessageType"
1779
+ },
1780
+ {
1781
+ "name": "Rule",
1782
+ "kind": "REFERENCE",
1783
+ "description": "When Alert should be triggered",
1784
+ "uiLabel": "Rule",
1785
+ "reference": "unknown"
1786
+ },
1787
+ {
1788
+ "name": "Scope",
1789
+ "kind": "REFERENCE",
1790
+ "description": "Where Alert can be triggered: one, some or all columns or DataTypes",
1791
+ "uiLabel": "Scope",
1792
+ "reference": "AdaptableScope"
1838
1793
  }
1839
1794
  ]
1840
1795
  },
@@ -1871,11 +1826,18 @@ exports.ADAPTABLE_METAMODEL = {
1871
1826
  },
1872
1827
  {
1873
1828
  "name": "HighlightCell",
1874
- "kind": "boolean",
1829
+ "kind": "unknown",
1875
1830
  "description": "Colours updated cell using `MessageType` property of triggering Alert Definition",
1876
1831
  "uiLabel": "Highlight Cell",
1877
1832
  "isOptional": true
1878
1833
  },
1834
+ {
1835
+ "name": "HighlightRow",
1836
+ "kind": "unknown",
1837
+ "description": "Colours updated cell using `MessageType` property of triggering Alert Definition",
1838
+ "uiLabel": "Highlight Row",
1839
+ "isOptional": true
1840
+ },
1879
1841
  {
1880
1842
  "name": "JumpToCell",
1881
1843
  "kind": "boolean",
@@ -1900,7 +1862,7 @@ exports.ADAPTABLE_METAMODEL = {
1900
1862
  {
1901
1863
  "name": "ShowInDiv",
1902
1864
  "kind": "boolean",
1903
- "description": "Shows Alert text in the div specificed in `AlertDisplayDiv` property of Alert State.",
1865
+ "description": "Shows Alert text in the div specificed in `alertContainer` property of Container Options",
1904
1866
  "uiLabel": "Show In Div",
1905
1867
  "isOptional": true
1906
1868
  }
@@ -1918,14 +1880,6 @@ exports.ADAPTABLE_METAMODEL = {
1918
1880
  "uiLabel": "Alert Definitions",
1919
1881
  "isOptional": true,
1920
1882
  "defaultValue": "null"
1921
- },
1922
- {
1923
- "name": "FlashingAlertDefinitions",
1924
- "kind": "unknown",
1925
- "description": "Flashing Alert Definitions - will colour cells/rows when rule is met",
1926
- "uiLabel": "Flashing Alert Definitions",
1927
- "isOptional": true,
1928
- "defaultValue": "null"
1929
1883
  }
1930
1884
  ]
1931
1885
  },
@@ -2042,27 +1996,6 @@ exports.ADAPTABLE_METAMODEL = {
2042
1996
  }
2043
1997
  ]
2044
1998
  },
2045
- "BaseAlertDefinition": {
2046
- "name": "BaseAlertDefinition",
2047
- "kind": "Interface",
2048
- "description": "Base object used in all Alert Definitions - contains `Scope` and a `Rule`",
2049
- "properties": [
2050
- {
2051
- "name": "Rule",
2052
- "kind": "REFERENCE",
2053
- "description": "When Alert should be triggered",
2054
- "uiLabel": "Rule",
2055
- "reference": "unknown"
2056
- },
2057
- {
2058
- "name": "Scope",
2059
- "kind": "REFERENCE",
2060
- "description": "Where Alert can be triggered: one, some or all columns or DataTypes",
2061
- "uiLabel": "Scope",
2062
- "reference": "AdaptableScope"
2063
- }
2064
- ]
2065
- },
2066
1999
  "BulkUpdateApi": {
2067
2000
  "name": "BulkUpdateApi",
2068
2001
  "kind": "Interface",
@@ -2312,14 +2245,6 @@ exports.ADAPTABLE_METAMODEL = {
2312
2245
  "description": "Id of Column containing Cell",
2313
2246
  "uiLabel": "Column Id"
2314
2247
  },
2315
- {
2316
- "name": "highlightType",
2317
- "kind": "REFERENCE",
2318
- "description": "Whether cell should show 'Info' (default), 'Success', 'Warning' or'Error' colour",
2319
- "uiLabel": "Highlight Type",
2320
- "isOptional": true,
2321
- "reference": "AdaptableMessageType"
2322
- },
2323
2248
  {
2324
2249
  "name": "primaryKeyValue",
2325
2250
  "kind": "unknown",
@@ -2420,67 +2345,6 @@ exports.ADAPTABLE_METAMODEL = {
2420
2345
  "kind": "TypeAlias",
2421
2346
  "description": "Use PermittedValues instead"
2422
2347
  },
2423
- "ChartApi": {
2424
- "name": "ChartApi",
2425
- "kind": "Interface",
2426
- "description": "Provides run time access to the Chart Plugin",
2427
- "properties": [
2428
- {
2429
- "name": "getAllChartDefinitions",
2430
- "kind": "function",
2431
- "description": "Returns all the Chart Definitions in the State",
2432
- "uiLabel": "Get All Chart Definitions"
2433
- },
2434
- {
2435
- "name": "getChartState",
2436
- "kind": "function",
2437
- "description": "Retrieves the Chart section of Adaptable State",
2438
- "uiLabel": "Get Chart State"
2439
- },
2440
- {
2441
- "name": "showChartPopup",
2442
- "kind": "function",
2443
- "description": "Opens the Chart popup screen",
2444
- "uiLabel": "Show Chart Popup"
2445
- }
2446
- ]
2447
- },
2448
- "ChartDefinition": {
2449
- "name": "ChartDefinition",
2450
- "kind": "Interface",
2451
- "description": "Our Chart Definitions which will get added to and updated as we add new charts But the basic idea is that each chart will have a base chart defintion that just includes a name, description, type and chart properties These chart properties are specialised for each chart type: they are all nullable types because we use defaults in the DefaultXXXProperties that we assign"
2452
- },
2453
- "ChartPluginOptions": {
2454
- "name": "ChartPluginOptions",
2455
- "kind": "Interface",
2456
- "description": "Options for managing Charts in Adaptable",
2457
- "properties": [
2458
- {
2459
- "name": "displayOnStartUp",
2460
- "kind": "boolean",
2461
- "description": "Whether a chart is displayed at start-up; only applies if *CurrentChartName* property in Chart State is set",
2462
- "uiLabel": "Display On Start Up",
2463
- "isOptional": true,
2464
- "defaultValue": "false"
2465
- },
2466
- {
2467
- "name": "pieChartMaxItems",
2468
- "kind": "number",
2469
- "description": "Maximum number of items to show in a pie chart.",
2470
- "uiLabel": "Pie Chart Max Items",
2471
- "isOptional": true,
2472
- "defaultValue": "50"
2473
- },
2474
- {
2475
- "name": "showModal",
2476
- "kind": "boolean",
2477
- "description": "Displays charts in a modal popup; if false, charts appear in the div specified im *chartContainer* property of Container Options",
2478
- "uiLabel": "Show Modal",
2479
- "isOptional": true,
2480
- "defaultValue": "false"
2481
- }
2482
- ]
2483
- },
2484
2348
  "CheckboxColumnClickedInfo": {
2485
2349
  "name": "CheckboxColumnClickedInfo",
2486
2350
  "kind": "Interface",
@@ -2518,6 +2382,18 @@ exports.ADAPTABLE_METAMODEL = {
2518
2382
  "kind": "Interface",
2519
2383
  "description": "A large range of column-related functions in AdapTable",
2520
2384
  "properties": [
2385
+ {
2386
+ "name": "addColumnsToSelection",
2387
+ "kind": "function",
2388
+ "description": "Adds (highlights) a group of Columns to any existing selection",
2389
+ "uiLabel": "Add Columns To Selection"
2390
+ },
2391
+ {
2392
+ "name": "addColumnToSelection",
2393
+ "kind": "function",
2394
+ "description": "Adds (highlights) a Column to any existing selection",
2395
+ "uiLabel": "Add Column To Selection"
2396
+ },
2521
2397
  {
2522
2398
  "name": "autosizeAllColumns",
2523
2399
  "kind": "function",
@@ -2879,7 +2755,7 @@ exports.ADAPTABLE_METAMODEL = {
2879
2755
  "ColumnMenuContext": {
2880
2756
  "name": "ColumnMenuContext",
2881
2757
  "kind": "Interface",
2882
- "description": "Provides full details about current Column where Column Header Menu will appear",
2758
+ "description": "Provides full details about the Column in which the Column Menu will appear",
2883
2759
  "properties": [
2884
2760
  {
2885
2761
  "name": "adaptableColumn",
@@ -3178,12 +3054,6 @@ exports.ADAPTABLE_METAMODEL = {
3178
3054
  "description": "Returns Calculated Column section of Adaptable State",
3179
3055
  "uiLabel": "Get Calculated Column State"
3180
3056
  },
3181
- {
3182
- "name": "getChartState",
3183
- "kind": "function",
3184
- "description": "Returns Chart section of Adaptable State",
3185
- "uiLabel": "Get Chart State"
3186
- },
3187
3057
  {
3188
3058
  "name": "getConditionalStyleState",
3189
3059
  "kind": "function",
@@ -3286,12 +3156,6 @@ exports.ADAPTABLE_METAMODEL = {
3286
3156
  "description": "Returns Shortcut section of Adaptable State",
3287
3157
  "uiLabel": "Get Shortcut State"
3288
3158
  },
3289
- {
3290
- "name": "getSparklineColumnState",
3291
- "kind": "function",
3292
- "description": "Returns Sparkline Column section of Adaptable State",
3293
- "uiLabel": "Get Sparkline Column State"
3294
- },
3295
3159
  {
3296
3160
  "name": "getThemeState",
3297
3161
  "kind": "function",
@@ -3391,15 +3255,6 @@ exports.ADAPTABLE_METAMODEL = {
3391
3255
  "gridInfo": "item",
3392
3256
  "defaultValue": "undefined"
3393
3257
  },
3394
- {
3395
- "name": "chartContainer",
3396
- "kind": "string",
3397
- "description": "Name of div where charts appear (if null, will be centre of page)",
3398
- "uiLabel": "Chart Container",
3399
- "isOptional": true,
3400
- "gridInfo": "item",
3401
- "defaultValue": "undefined"
3402
- },
3403
3258
  {
3404
3259
  "name": "modalContainer",
3405
3260
  "kind": "string",
@@ -3423,15 +3278,8 @@ exports.ADAPTABLE_METAMODEL = {
3423
3278
  "ContextMenuContext": {
3424
3279
  "name": "ContextMenuContext",
3425
3280
  "kind": "Interface",
3426
- "description": "Provides full details about current cell (and selected cells) where Context Menu will appear",
3281
+ "description": "Provides full details about current cell (and selected cells) where the Context Menu will appear",
3427
3282
  "properties": [
3428
- {
3429
- "name": "adaptableApi",
3430
- "kind": "REFERENCE",
3431
- "description": "The Adaptable Api - included as a convenience",
3432
- "uiLabel": "Adaptable Api",
3433
- "reference": "AdaptableApi"
3434
- },
3435
3283
  {
3436
3284
  "name": "adaptableColumn",
3437
3285
  "kind": "REFERENCE",
@@ -3566,7 +3414,7 @@ exports.ADAPTABLE_METAMODEL = {
3566
3414
  {
3567
3415
  "name": "SortedValues",
3568
3416
  "kind": "unknown",
3569
- "description": "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",
3417
+ "description": "Order of values by which Column will be sorted",
3570
3418
  "uiLabel": "Sorted Values",
3571
3419
  "isOptional": true
3572
3420
  }
@@ -4067,6 +3915,14 @@ exports.ADAPTABLE_METAMODEL = {
4067
3915
  "kind": "Interface",
4068
3916
  "description": "Options related to the Dashboard in Adaptable.",
4069
3917
  "properties": [
3918
+ {
3919
+ "name": "buttonsLocation",
3920
+ "kind": "unknown",
3921
+ "description": "Position in the Dashboard to show the Module and Custom Buttons",
3922
+ "uiLabel": "Buttons Location",
3923
+ "isOptional": true,
3924
+ "defaultValue": "'right'"
3925
+ },
4070
3926
  {
4071
3927
  "name": "canFloat",
4072
3928
  "kind": "boolean",
@@ -4079,7 +3935,7 @@ exports.ADAPTABLE_METAMODEL = {
4079
3935
  {
4080
3936
  "name": "customDashboardButtons",
4081
3937
  "kind": "unknown",
4082
- "description": "Custom Adaptable Buttons to appear in top corner of Dashboard - next to Module Buttons",
3938
+ "description": "Custom Adaptable Buttons to appear in Dashboard (alongside Module Buttons)",
4083
3939
  "uiLabel": "Custom Dashboard Buttons",
4084
3940
  "isOptional": true
4085
3941
  },
@@ -4090,19 +3946,10 @@ exports.ADAPTABLE_METAMODEL = {
4090
3946
  "uiLabel": "Custom Toolbars",
4091
3947
  "isOptional": true
4092
3948
  },
4093
- {
4094
- "name": "showModulesDropdown",
4095
- "kind": "boolean",
4096
- "description": "Shows Modules dropdown in Dashboard Header (the 'home' icon); each item connects to an AdapTable Module, opening its popup screen",
4097
- "uiLabel": "Show Modules Dropdown",
4098
- "isOptional": true,
4099
- "gridInfo": "item",
4100
- "defaultValue": "true"
4101
- },
4102
3949
  {
4103
3950
  "name": "showQuickSearchInHeader",
4104
3951
  "kind": "boolean",
4105
- "description": "Shows Quick Search textbox in the Dashboard Header; the UI component is still subject to the QuickSearch Entitlements",
3952
+ "description": "Shows Quick Search textbox in the Dashboard Header",
4106
3953
  "uiLabel": "Show Quick Search In Header",
4107
3954
  "isOptional": true,
4108
3955
  "gridInfo": "item",
@@ -4125,7 +3972,7 @@ exports.ADAPTABLE_METAMODEL = {
4125
3972
  {
4126
3973
  "name": "DashboardTitle",
4127
3974
  "kind": "string",
4128
- "description": "Title to display in Dashboard Header; if missing, 'adaptableId' property in Adaptable Options is used",
3975
+ "description": "Title to display in Dashboard Header",
4129
3976
  "uiLabel": "Dashboard Title",
4130
3977
  "isOptional": true,
4131
3978
  "defaultValue": "`adaptableId` in Adaptable Options"
@@ -4133,7 +3980,7 @@ exports.ADAPTABLE_METAMODEL = {
4133
3980
  {
4134
3981
  "name": "FloatingPosition",
4135
3982
  "kind": "REFERENCE",
4136
- "description": "Position of Dashboard in 'floating mode' - set and stored by AdapTable",
3983
+ "description": "Position of Dashboard when in 'floating mode'",
4137
3984
  "uiLabel": "Floating Position",
4138
3985
  "isOptional": true,
4139
3986
  "reference": "AdaptableCoordinate"
@@ -4173,18 +4020,19 @@ exports.ADAPTABLE_METAMODEL = {
4173
4020
  {
4174
4021
  "name": "ModuleButtons",
4175
4022
  "kind": "REFERENCE",
4176
- "description": "Module Buttons visible in Dasbhoard Header when application loads - open popup screen for associated AdapTable Module",
4023
+ "description": "Module Buttons which open screen in Settings Panel for associated AdapTable Module",
4177
4024
  "uiLabel": "Module Buttons",
4178
4025
  "isOptional": true,
4179
- "defaultValue": "['SystemStatus', 'GridInfo', 'Layout' 'ConditionalStyle']",
4026
+ "defaultValue": "['SettingsPanel']",
4180
4027
  "reference": "unknown"
4181
4028
  },
4182
4029
  {
4183
4030
  "name": "Tabs",
4184
4031
  "kind": "unknown",
4185
- "description": "Named group of Toolbars - each Toolbar should only be in one Tab; if no Tabs are provided, AdapTable creates one named 'Toolbars'",
4032
+ "description": "Named group of Toolbars",
4186
4033
  "uiLabel": "Tabs",
4187
- "isOptional": true
4034
+ "isOptional": true,
4035
+ "defaultValue": "Empty Array"
4188
4036
  }
4189
4037
  ]
4190
4038
  },
@@ -4296,6 +4144,12 @@ exports.ADAPTABLE_METAMODEL = {
4296
4144
  "description": "Retrieves current Data Change History mode: 'ACTIVE', 'INACTIVE', 'SUSPENDED'",
4297
4145
  "uiLabel": "Get Data Change History Mode"
4298
4146
  },
4147
+ {
4148
+ "name": "showDataChangeHistoryPopup",
4149
+ "kind": "function",
4150
+ "description": "Opens Data Change History screen",
4151
+ "uiLabel": "Show Data Change History Popup"
4152
+ },
4299
4153
  {
4300
4154
  "name": "suspendDataChangeHistory",
4301
4155
  "kind": "function",
@@ -4318,7 +4172,7 @@ exports.ADAPTABLE_METAMODEL = {
4318
4172
  {
4319
4173
  "name": "activeByDefault",
4320
4174
  "kind": "boolean",
4321
- "description": "Whether data change history should be active by default; it may be changed at runtime via the UI controls",
4175
+ "description": "Whether data change history should be active by default",
4322
4176
  "uiLabel": "Active By Default",
4323
4177
  "isOptional": true,
4324
4178
  "gridInfo": "item",
@@ -4327,7 +4181,7 @@ exports.ADAPTABLE_METAMODEL = {
4327
4181
  {
4328
4182
  "name": "showDataChange",
4329
4183
  "kind": "unknown",
4330
- "description": "Function enabling specific data changes to be included/excluded from the Data Change History",
4184
+ "description": "Function specifying which data changes to include in Data Change History",
4331
4185
  "uiLabel": "Show Data Change",
4332
4186
  "isOptional": true,
4333
4187
  "gridInfo": "item",
@@ -4559,7 +4413,7 @@ exports.ADAPTABLE_METAMODEL = {
4559
4413
  {
4560
4414
  "name": "displayServerValidationMessages",
4561
4415
  "kind": "boolean",
4562
- "description": "Displays message after Server Validation; if true, Info Message appears with ValidationMessage sent by ServerValidation; if there is no Validation Message then no popup is displayed",
4416
+ "description": "Displays message after Server Validation",
4563
4417
  "uiLabel": "Display Server Validation Messages",
4564
4418
  "isOptional": true,
4565
4419
  "gridInfo": "item",
@@ -4703,7 +4557,7 @@ exports.ADAPTABLE_METAMODEL = {
4703
4557
  {
4704
4558
  "name": "off",
4705
4559
  "kind": "function",
4706
- "description": "Unsubscribe from FlashingAlertFired",
4560
+ "description": "Unsubscribe from FlashingCellDisplayed",
4707
4561
  "uiLabel": "Off"
4708
4562
  },
4709
4563
  {
@@ -4799,7 +4653,7 @@ exports.ADAPTABLE_METAMODEL = {
4799
4653
  {
4800
4654
  "name": "on",
4801
4655
  "kind": "function",
4802
- "description": "Event fired whenever a **FlashingAlert is triggered** in AdapTable.",
4656
+ "description": "Event fired whenever **Cell Flashing** is triggered in AdapTable.",
4803
4657
  "uiLabel": "On"
4804
4658
  }
4805
4659
  ]
@@ -4986,7 +4840,7 @@ exports.ADAPTABLE_METAMODEL = {
4986
4840
  {
4987
4841
  "name": "appendFileTimestamp",
4988
4842
  "kind": "boolean",
4989
- "description": "Whether to add a timestamp ('yyyyMMdd_HHmmss') as a suffix to exported file name",
4843
+ "description": "Whether to add a timestamp as a suffix to exported file name",
4990
4844
  "uiLabel": "Append File Timestamp",
4991
4845
  "isOptional": true,
4992
4846
  "gridInfo": "item",
@@ -5539,7 +5393,7 @@ exports.ADAPTABLE_METAMODEL = {
5539
5393
  {
5540
5394
  "name": "useAdaptableFilterForm",
5541
5395
  "kind": "unknown",
5542
- "description": "Uses Adaptable's Filter Form in Column header menu for all columns if 'true' (the default) or those listed, in preference to AG Grid's Filter Form",
5396
+ "description": "Uses Adaptable's Filter Form in Column Menu for all columns if 'true' (the default) or those listed, in preference to AG Grid's Filter Form",
5543
5397
  "uiLabel": "Use Adaptable Filter Form",
5544
5398
  "isOptional": true,
5545
5399
  "defaultValue": "true"
@@ -5547,7 +5401,7 @@ exports.ADAPTABLE_METAMODEL = {
5547
5401
  {
5548
5402
  "name": "useAdaptableQuickFilter",
5549
5403
  "kind": "unknown",
5550
- "description": "Use Adaptable's Quick Filter for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter",
5404
+ "description": "Use Adaptable's Quick Filter Bar for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter",
5551
5405
  "uiLabel": "Use Adaptable Quick Filter",
5552
5406
  "isOptional": true,
5553
5407
  "gridInfo": "item",
@@ -5634,29 +5488,107 @@ exports.ADAPTABLE_METAMODEL = {
5634
5488
  }
5635
5489
  ]
5636
5490
  },
5637
- "FlashingAlertDefinition": {
5638
- "name": "FlashingAlertDefinition",
5639
- "kind": "Interface",
5640
- "description": "The Flashing Alert Definition object used in the Alert function"
5641
- },
5642
- "FlashingAlertFiredInfo": {
5643
- "name": "FlashingAlertFiredInfo",
5491
+ "FlashingCellApi": {
5492
+ "name": "FlashingCellApi",
5644
5493
  "kind": "Interface",
5645
- "description": "Object returned by the `FlashingAlertFired` event",
5494
+ "description": "Provides run-time access to Flashing Cell functionality and associated State",
5646
5495
  "properties": [
5647
5496
  {
5648
- "name": "flashingAlert",
5649
- "kind": "REFERENCE",
5650
- "description": "FlashingAlert which has been fired",
5651
- "uiLabel": "Flashing Alert",
5652
- "reference": "AdaptableFlashingAlert"
5497
+ "name": "addFlashingCellDefinition",
5498
+ "kind": "function",
5499
+ "description": "Adds a Flashing cell Definition to State",
5500
+ "uiLabel": "Add Flashing Cell Definition"
5501
+ },
5502
+ {
5503
+ "name": "addFlashingCellDefinitions",
5504
+ "kind": "function",
5505
+ "description": "Adds provided Flashing cell Definitions",
5506
+ "uiLabel": "Add Flashing Cell Definitions"
5507
+ },
5508
+ {
5509
+ "name": "editFlashingCellDefinition",
5510
+ "kind": "function",
5511
+ "description": "Edits Flashing Cell Definition in State with given one",
5512
+ "uiLabel": "Edit Flashing Cell Definition"
5513
+ },
5514
+ {
5515
+ "name": "editFlashingCellDefinitions",
5516
+ "kind": "function",
5517
+ "description": "Edits provided Flashing cell Definitions",
5518
+ "uiLabel": "Edit Flashing Cell Definitions"
5519
+ },
5520
+ {
5521
+ "name": "getActiveFlashingCellDefinitions",
5522
+ "kind": "function",
5523
+ "description": "Retrieves all active (non-suspended) cell Definitions in Flashing Cell State",
5524
+ "uiLabel": "Get Active Flashing Cell Definitions"
5525
+ },
5526
+ {
5527
+ "name": "getFlashingCellDefinitionById",
5528
+ "kind": "function",
5529
+ "description": "Retrieves Flashing cell Definition By Id",
5530
+ "uiLabel": "Get Flashing Cell Definition By Id"
5531
+ },
5532
+ {
5533
+ "name": "getFlashingCellDefinitions",
5534
+ "kind": "function",
5535
+ "description": "Retrieves all Flashing cell Definitions in Flashing Cell State",
5536
+ "uiLabel": "Get Flashing Cell Definitions"
5537
+ },
5538
+ {
5539
+ "name": "getFlashingCellFlashTarget",
5540
+ "kind": "function",
5541
+ "description": "Returns where a Flashing cell Definition will flash a single cell or a whole row",
5542
+ "uiLabel": "Get Flashing Cell Flash Target"
5543
+ },
5544
+ {
5545
+ "name": "getFlashingCellPredicateDefs",
5546
+ "kind": "function",
5547
+ "description": "Retrieves all Predicate Defs with Module Scope of Flashing Cell",
5548
+ "uiLabel": "Get Flashing Cell Predicate Defs"
5549
+ },
5550
+ {
5551
+ "name": "getFlashingCellPredicateDefsForScope",
5552
+ "kind": "function",
5553
+ "description": "Retrieves all Predicate Defs that match given Scope",
5554
+ "uiLabel": "Get Flashing Cell Predicate Defs For Scope"
5555
+ },
5556
+ {
5557
+ "name": "getFlashingCellState",
5558
+ "kind": "function",
5559
+ "description": "Retrieves Flashing Cell section from Adaptable State",
5560
+ "uiLabel": "Get Flashing Cell State"
5561
+ },
5562
+ {
5563
+ "name": "setFlashingCellDefinitions",
5564
+ "kind": "function",
5565
+ "description": "Sets a collection of Flashing Cell Definitions into State",
5566
+ "uiLabel": "Set Flashing Cell Definitions"
5567
+ },
5568
+ {
5569
+ "name": "showFlashingCell",
5570
+ "kind": "function",
5571
+ "description": "Displays a Flashing Cell Definition",
5572
+ "uiLabel": "Show Flashing Cell"
5573
+ },
5574
+ {
5575
+ "name": "suspendFlashingCellDefinition",
5576
+ "kind": "function",
5577
+ "description": "Suspends a Flashing cell Definition",
5578
+ "uiLabel": "Suspend Flashing Cell Definition"
5579
+ },
5580
+ {
5581
+ "name": "unSuspendFlashingCellDefinition",
5582
+ "kind": "function",
5583
+ "description": "Activates a suspended Flashing cell Definition",
5584
+ "uiLabel": "Un Suspend Flashing Cell Definition"
5653
5585
  }
5654
5586
  ]
5655
5587
  },
5656
- "FlashingAlertProperties": {
5657
- "name": "FlashingAlertProperties",
5588
+ "FlashingCellDefinition": {
5589
+ "name": "FlashingCellDefinition",
5658
5590
  "kind": "Interface",
5659
- "description": "Properties to use in Flashing Alerts",
5591
+ "description": "The Flashing Cell Definition",
5660
5592
  "properties": [
5661
5593
  {
5662
5594
  "name": "DownChangeStyle",
@@ -5692,6 +5624,20 @@ exports.ADAPTABLE_METAMODEL = {
5692
5624
  "defaultValue": "Gray BackColour",
5693
5625
  "reference": "AdaptableStyle"
5694
5626
  },
5627
+ {
5628
+ "name": "Rule",
5629
+ "kind": "REFERENCE",
5630
+ "description": "When Flashing Cell should be triggered",
5631
+ "uiLabel": "Rule",
5632
+ "reference": "unknown"
5633
+ },
5634
+ {
5635
+ "name": "Scope",
5636
+ "kind": "REFERENCE",
5637
+ "description": "Where Flashing Cell can be triggered: one, some or all columns or DataTypes",
5638
+ "uiLabel": "Scope",
5639
+ "reference": "AdaptableScope"
5640
+ },
5695
5641
  {
5696
5642
  "name": "UpChangeStyle",
5697
5643
  "kind": "REFERENCE",
@@ -5703,6 +5649,85 @@ exports.ADAPTABLE_METAMODEL = {
5703
5649
  }
5704
5650
  ]
5705
5651
  },
5652
+ "FlashingCellDisplayedInfo": {
5653
+ "name": "FlashingCellDisplayedInfo",
5654
+ "kind": "Interface",
5655
+ "description": "Object returned by the `FlashingCellDisplayed` event",
5656
+ "properties": [
5657
+ {
5658
+ "name": "flashingCell",
5659
+ "kind": "REFERENCE",
5660
+ "description": "Details of the Cell (or row) which has just flashed",
5661
+ "uiLabel": "Flashing Cell",
5662
+ "reference": "AdaptableFlashingCell"
5663
+ }
5664
+ ]
5665
+ },
5666
+ "FlashingCellOptions": {
5667
+ "name": "FlashingCellOptions",
5668
+ "kind": "Interface",
5669
+ "description": "Properties for Flashing Cell",
5670
+ "properties": [
5671
+ {
5672
+ "name": "defaultDownChangeStyle",
5673
+ "kind": "REFERENCE",
5674
+ "description": "Style for 'Down' value changes",
5675
+ "uiLabel": "Default Down Change Style",
5676
+ "isOptional": true,
5677
+ "defaultValue": "Red BackColour",
5678
+ "reference": "AdaptableStyle"
5679
+ },
5680
+ {
5681
+ "name": "defaultFlashDuration",
5682
+ "kind": "unknown",
5683
+ "description": "Duration of Flash - can be number (in ms) or 'always'",
5684
+ "uiLabel": "Default Flash Duration",
5685
+ "isOptional": true,
5686
+ "defaultValue": "500ms"
5687
+ },
5688
+ {
5689
+ "name": "defaultFlashTarget",
5690
+ "kind": "unknown",
5691
+ "description": "Should a cell or whole row flash",
5692
+ "uiLabel": "Default Flash Target",
5693
+ "isOptional": true,
5694
+ "defaultValue": "'cell'"
5695
+ },
5696
+ {
5697
+ "name": "defaultNeutralChangeStyle",
5698
+ "kind": "REFERENCE",
5699
+ "description": "Style for 'Neutral' value changes",
5700
+ "uiLabel": "Default Neutral Change Style",
5701
+ "isOptional": true,
5702
+ "defaultValue": "Gray BackColour",
5703
+ "reference": "AdaptableStyle"
5704
+ },
5705
+ {
5706
+ "name": "defaultUpChangeStyle",
5707
+ "kind": "REFERENCE",
5708
+ "description": "Style for 'Up' value changes",
5709
+ "uiLabel": "Default Up Change Style",
5710
+ "isOptional": true,
5711
+ "defaultValue": "Green BackColour",
5712
+ "reference": "AdaptableStyle"
5713
+ }
5714
+ ]
5715
+ },
5716
+ "FlashingCellState": {
5717
+ "name": "FlashingCellState",
5718
+ "kind": "Interface",
5719
+ "description": "Predefined Configuration for Flashing Cell module",
5720
+ "properties": [
5721
+ {
5722
+ "name": "FlashingCellDefinitions",
5723
+ "kind": "unknown",
5724
+ "description": "Flashing Cell Definitions - will colour cells/rows when rule is met",
5725
+ "uiLabel": "Flashing Cell Definitions",
5726
+ "isOptional": true,
5727
+ "defaultValue": "null"
5728
+ }
5729
+ ]
5730
+ },
5706
5731
  "FormatColumn": {
5707
5732
  "name": "FormatColumn",
5708
5733
  "kind": "Interface",
@@ -5984,7 +6009,7 @@ exports.ADAPTABLE_METAMODEL = {
5984
6009
  {
5985
6010
  "name": "DataType",
5986
6011
  "kind": "unknown",
5987
- "description": "Whether Column is String, Number, Boolean or Date; the appropriate Cell Editor will be used",
6012
+ "description": "Whether Column is String, Number, Boolean or Date",
5988
6013
  "uiLabel": "Data Type",
5989
6014
  "isOptional": true,
5990
6015
  "defaultValue": "'String'"
@@ -6021,7 +6046,7 @@ exports.ADAPTABLE_METAMODEL = {
6021
6046
  {
6022
6047
  "name": "TextEditor",
6023
6048
  "kind": "unknown",
6024
- "description": "Cell editor to use when editing a Free Text Column with DataType of 'String' *",
6049
+ "description": "Cell editor to use when editing a string Free Text Column *",
6025
6050
  "uiLabel": "Text Editor",
6026
6051
  "isOptional": true,
6027
6052
  "defaultValue": "'Inline'"
@@ -6176,7 +6201,7 @@ exports.ADAPTABLE_METAMODEL = {
6176
6201
  {
6177
6202
  "name": "caseSensitiveTextComparisons",
6178
6203
  "kind": "boolean",
6179
- "description": "Maintain upper and lower case when performing text operations (applies to both Expressions and Predicates)",
6204
+ "description": "Perform case-sensitive text comparisons in all search and filter operations: QuickSearch, Filters, Query, Predicates",
6180
6205
  "uiLabel": "Case Sensitive Text Comparisons",
6181
6206
  "isOptional": true,
6182
6207
  "gridInfo": "item",
@@ -6782,6 +6807,12 @@ exports.ADAPTABLE_METAMODEL = {
6782
6807
  "description": "Highlights a Cell in AdapTable",
6783
6808
  "uiLabel": "Highlight Cell"
6784
6809
  },
6810
+ {
6811
+ "name": "highlightRow",
6812
+ "kind": "function",
6813
+ "description": "Highlight a row using an adaptable style",
6814
+ "uiLabel": "Highlight Row"
6815
+ },
6785
6816
  {
6786
6817
  "name": "isGridGroupable",
6787
6818
  "kind": "function",
@@ -6855,10 +6886,16 @@ exports.ADAPTABLE_METAMODEL = {
6855
6886
  "uiLabel": "Refresh Cells"
6856
6887
  },
6857
6888
  {
6858
- "name": "refreshRow",
6889
+ "name": "refreshRowByPrimaryKey",
6859
6890
  "kind": "function",
6860
6891
  "description": "Forces a render of a row",
6861
- "uiLabel": "Refresh Row"
6892
+ "uiLabel": "Refresh Row By Primary Key"
6893
+ },
6894
+ {
6895
+ "name": "refreshRowNode",
6896
+ "kind": "function",
6897
+ "description": "",
6898
+ "uiLabel": "Refresh Row Node"
6862
6899
  },
6863
6900
  {
6864
6901
  "name": "selectAll",
@@ -6932,6 +6969,12 @@ exports.ADAPTABLE_METAMODEL = {
6932
6969
  "description": "Sets the grid to Row Group",
6933
6970
  "uiLabel": "Set Row Group Columns"
6934
6971
  },
6972
+ {
6973
+ "name": "showGridInfoPopup",
6974
+ "kind": "function",
6975
+ "description": "Opens Grid Info popup screen",
6976
+ "uiLabel": "Show Grid Info Popup"
6977
+ },
6935
6978
  {
6936
6979
  "name": "undoCellEdit",
6937
6980
  "kind": "function",
@@ -6939,16 +6982,28 @@ exports.ADAPTABLE_METAMODEL = {
6939
6982
  "uiLabel": "Undo Cell Edit"
6940
6983
  },
6941
6984
  {
6942
- "name": "unhighlightAllCells",
6985
+ "name": "unHighlightAllCells",
6943
6986
  "kind": "function",
6944
6987
  "description": "Unhighlights all highlighted Cells in AdapTable",
6945
- "uiLabel": "Unhighlight All Cells"
6988
+ "uiLabel": "Un Highlight All Cells"
6989
+ },
6990
+ {
6991
+ "name": "unHighlightAllRows",
6992
+ "kind": "function",
6993
+ "description": "Remove all highlighted rows",
6994
+ "uiLabel": "Un Highlight All Rows"
6946
6995
  },
6947
6996
  {
6948
- "name": "unhighlightCell",
6997
+ "name": "unHighlightCell",
6949
6998
  "kind": "function",
6950
6999
  "description": "Unhighlights a Cell in AdapTable",
6951
- "uiLabel": "Unhighlight Cell"
7000
+ "uiLabel": "Un Highlight Cell"
7001
+ },
7002
+ {
7003
+ "name": "unHighlightRow",
7004
+ "kind": "function",
7005
+ "description": "Remove highlight from row",
7006
+ "uiLabel": "Un Highlight Row"
6952
7007
  },
6953
7008
  {
6954
7009
  "name": "updateGridData",
@@ -7016,10 +7071,10 @@ exports.ADAPTABLE_METAMODEL = {
7016
7071
  "uiLabel": "Data Rows"
7017
7072
  },
7018
7073
  {
7019
- "name": "rowTigger",
7074
+ "name": "rowTrigger",
7020
7075
  "kind": "unknown",
7021
7076
  "description": "Trigger for row change: 'Add', 'Edit' or 'Delete'",
7022
- "uiLabel": "Row Tigger"
7077
+ "uiLabel": "Row Trigger"
7023
7078
  }
7024
7079
  ]
7025
7080
  },
@@ -7079,7 +7134,7 @@ exports.ADAPTABLE_METAMODEL = {
7079
7134
  {
7080
7135
  "name": "columnId",
7081
7136
  "kind": "string",
7082
- "description": "Column to be defined as an Instrument - its value will provide the `name` property in the FDC3 message",
7137
+ "description": "Column defined as an Instrument - its value provides the `name` property in the FDC3 message",
7083
7138
  "uiLabel": "Column Id"
7084
7139
  },
7085
7140
  {
@@ -7517,7 +7572,7 @@ exports.ADAPTABLE_METAMODEL = {
7517
7572
  {
7518
7573
  "name": "ExpandedRowGroupValues",
7519
7574
  "kind": "unknown",
7520
- "description": "Values of opened row groups - only used if `includeExpandedRowGroups` in LayoutOptions is true",
7575
+ "description": "Values of opened row groups",
7521
7576
  "uiLabel": "Expanded Row Group Values",
7522
7577
  "isOptional": true
7523
7578
  },
@@ -7864,7 +7919,7 @@ exports.ADAPTABLE_METAMODEL = {
7864
7919
  {
7865
7920
  "name": "columnMenuItems",
7866
7921
  "kind": "unknown",
7867
- "description": "A collection of UserMenuItem objects to be added to the Column Header Menu (the one that appears as a dropdown in each Column Header).",
7922
+ "description": "User-defined Menu Items to add to the Column Menu",
7868
7923
  "uiLabel": "Column Menu Items",
7869
7924
  "isOptional": true
7870
7925
  },
@@ -7880,7 +7935,7 @@ exports.ADAPTABLE_METAMODEL = {
7880
7935
  {
7881
7936
  "name": "contextMenuItems",
7882
7937
  "kind": "unknown",
7883
- "description": "A collection of UserMenuItem objects to be added to the Context Menu (the one that appears when you right-click on a cell, or cells, in the Grid).",
7938
+ "description": "User-defined Menu Items to add to the Context Menu",
7884
7939
  "uiLabel": "Context Menu Items",
7885
7940
  "isOptional": true
7886
7941
  },
@@ -8002,15 +8057,6 @@ exports.ADAPTABLE_METAMODEL = {
8002
8057
  "gridInfo": "item",
8003
8058
  "defaultValue": "3000"
8004
8059
  },
8005
- {
8006
- "name": "flashingAlertDefaultProperties",
8007
- "kind": "REFERENCE",
8008
- "description": "Flashing Alert Defaults",
8009
- "uiLabel": "Flashing Alert Default Properties",
8010
- "isOptional": true,
8011
- "defaultValue": "BackColors: Green (up), Red (down), Gray (neutral), Duration: 500ms",
8012
- "reference": "FlashingAlertProperties"
8013
- },
8014
8060
  {
8015
8061
  "name": "isDraggable",
8016
8062
  "kind": "boolean",
@@ -8084,10 +8130,10 @@ exports.ADAPTABLE_METAMODEL = {
8084
8130
  "defaultValue": "false"
8085
8131
  },
8086
8132
  {
8087
- "name": "showSystemStatusMessageAsAlert",
8133
+ "name": "showSystemStatusMessageNotifications",
8088
8134
  "kind": "boolean",
8089
8135
  "description": "Display an Alert when a System Status Message is set",
8090
- "uiLabel": "Show System Status Message As Alert",
8136
+ "uiLabel": "Show System Status Message Notifications",
8091
8137
  "isOptional": true,
8092
8138
  "gridInfo": "item",
8093
8139
  "defaultValue": "false"
@@ -8532,14 +8578,6 @@ exports.ADAPTABLE_METAMODEL = {
8532
8578
  "isOptional": true,
8533
8579
  "reference": "CalculatedColumnState"
8534
8580
  },
8535
- {
8536
- "name": "Chart",
8537
- "kind": "REFERENCE",
8538
- "description": "Collection of Charts to enable seeing grid data visually in chart format (requires Chart plugin)",
8539
- "uiLabel": "Chart",
8540
- "isOptional": true,
8541
- "reference": "unknown"
8542
- },
8543
8581
  {
8544
8582
  "name": "ConditionalStyle",
8545
8583
  "kind": "REFERENCE",
@@ -8652,14 +8690,6 @@ exports.ADAPTABLE_METAMODEL = {
8652
8690
  "isOptional": true,
8653
8691
  "reference": "ShortcutState"
8654
8692
  },
8655
- {
8656
- "name": "SparklineColumn",
8657
- "kind": "REFERENCE",
8658
- "description": "Columns - where data type is a numeric array - which is rendered as a Sparkline Chart - only populated at Design Time",
8659
- "uiLabel": "Sparkline Column",
8660
- "isOptional": true,
8661
- "reference": "SparklineColumnState"
8662
- },
8663
8693
  {
8664
8694
  "name": "Theme",
8665
8695
  "kind": "REFERENCE",
@@ -8760,7 +8790,7 @@ exports.ADAPTABLE_METAMODEL = {
8760
8790
  {
8761
8791
  "name": "column",
8762
8792
  "kind": "REFERENCE",
8763
- "description": "Column which contains the cell",
8793
+ "description": "Adaptable Column which contains the cell",
8764
8794
  "uiLabel": "Column",
8765
8795
  "reference": "AdaptableColumn"
8766
8796
  },
@@ -8779,7 +8809,7 @@ exports.ADAPTABLE_METAMODEL = {
8779
8809
  {
8780
8810
  "name": "node",
8781
8811
  "kind": "REFERENCE",
8782
- "description": "Row node which contains the cell",
8812
+ "description": "AG Grid Row node which contains the cell",
8783
8813
  "uiLabel": "Node",
8784
8814
  "reference": "unknown"
8785
8815
  },
@@ -9102,7 +9132,34 @@ exports.ADAPTABLE_METAMODEL = {
9102
9132
  "ReminderSchedule": {
9103
9133
  "name": "ReminderSchedule",
9104
9134
  "kind": "Interface",
9105
- "description": "Schedules a Reminder (a.k.a. an Alert)"
9135
+ "description": "Schedules a Reminder to appear at a given point in time",
9136
+ "properties": [
9137
+ {
9138
+ "name": "DisplayNotification",
9139
+ "kind": "boolean",
9140
+ "description": "Displays Reminder as a Toast Notification",
9141
+ "uiLabel": "Display Notification"
9142
+ },
9143
+ {
9144
+ "name": "Header",
9145
+ "kind": "string",
9146
+ "description": "Reminder header text",
9147
+ "uiLabel": "Header"
9148
+ },
9149
+ {
9150
+ "name": "Message",
9151
+ "kind": "string",
9152
+ "description": "Reminder body text",
9153
+ "uiLabel": "Message"
9154
+ },
9155
+ {
9156
+ "name": "MessageType",
9157
+ "kind": "REFERENCE",
9158
+ "description": "Type of Message - 'Success', 'Info', 'Warning' or 'Error'",
9159
+ "uiLabel": "Message Type",
9160
+ "reference": "AdaptableMessageType"
9161
+ }
9162
+ ]
9106
9163
  },
9107
9164
  "ReportData": {
9108
9165
  "name": "ReportData",
@@ -9206,10 +9263,11 @@ exports.ADAPTABLE_METAMODEL = {
9206
9263
  "properties": [
9207
9264
  {
9208
9265
  "name": "DaysOfWeek",
9209
- "kind": "unknown",
9210
- "description": "Days on which Shedule will run",
9266
+ "kind": "REFERENCE",
9267
+ "description": "Days on which Schedule will run",
9211
9268
  "uiLabel": "Days Of Week",
9212
- "isOptional": true
9269
+ "isOptional": true,
9270
+ "reference": "unknown"
9213
9271
  },
9214
9272
  {
9215
9273
  "name": "Hour",
@@ -9700,7 +9758,7 @@ exports.ADAPTABLE_METAMODEL = {
9700
9758
  {
9701
9759
  "name": "searchChangedTrigger",
9702
9760
  "kind": "unknown",
9703
- "description": "What action caused event to fire: DataSource, CurrentQuery, Filter, DataChange or Sort",
9761
+ "description": "What search-related change caused the event to fire",
9704
9762
  "uiLabel": "Search Changed Trigger"
9705
9763
  }
9706
9764
  ]
@@ -9888,7 +9946,7 @@ exports.ADAPTABLE_METAMODEL = {
9888
9946
  {
9889
9947
  "name": "Scope",
9890
9948
  "kind": "unknown",
9891
- "description": "On which numeric Columns the Rule is applied",
9949
+ "description": "Numeric Columns where Shortcut is applied",
9892
9950
  "uiLabel": "Scope"
9893
9951
  },
9894
9952
  {
@@ -10017,7 +10075,7 @@ exports.ADAPTABLE_METAMODEL = {
10017
10075
  {
10018
10076
  "name": "getSmartEditOperation",
10019
10077
  "kind": "function",
10020
- "description": "Gets current Smart Edit Operation ('Add','Subtract','Multiply','Divide' or 'Replace')",
10078
+ "description": "Gets current Smart Edit Operation",
10021
10079
  "uiLabel": "Get Smart Edit Operation"
10022
10080
  },
10023
10081
  {
@@ -10029,13 +10087,13 @@ exports.ADAPTABLE_METAMODEL = {
10029
10087
  {
10030
10088
  "name": "setSmartEditOperation",
10031
10089
  "kind": "function",
10032
- "description": "Sets operation to use in Smart Edit",
10090
+ "description": "Sets Smart Edit operation: ('Add','Subtract','Multiply','Divide'",
10033
10091
  "uiLabel": "Set Smart Edit Operation"
10034
10092
  },
10035
10093
  {
10036
10094
  "name": "setSmartEditValue",
10037
10095
  "kind": "function",
10038
- "description": "Sets Smart Edit Value (e.g. to multiply by 10 then smartEditValue is 10)",
10096
+ "description": "Sets Smart Edit Value",
10039
10097
  "uiLabel": "Set Smart Edit Value"
10040
10098
  },
10041
10099
  {
@@ -10046,99 +10104,6 @@ exports.ADAPTABLE_METAMODEL = {
10046
10104
  }
10047
10105
  ]
10048
10106
  },
10049
- "SparklineColumn": {
10050
- "name": "SparklineColumn",
10051
- "kind": "Interface",
10052
- "description": "SparklineColumn object used in Sparkline Column function;",
10053
- "properties": [
10054
- {
10055
- "name": "ColumnId",
10056
- "kind": "string",
10057
- "description": "Id of the Column",
10058
- "uiLabel": "Column Id"
10059
- },
10060
- {
10061
- "name": "LineColor",
10062
- "kind": "string",
10063
- "description": "Colour of Sparkline line (if Type is 'Line')",
10064
- "uiLabel": "Line Color",
10065
- "isOptional": true
10066
- },
10067
- {
10068
- "name": "MaximumValue",
10069
- "kind": "number",
10070
- "description": "Maximum value for Sparkline chart of column",
10071
- "uiLabel": "Maximum Value",
10072
- "isOptional": true
10073
- },
10074
- {
10075
- "name": "MinimumValue",
10076
- "kind": "number",
10077
- "description": "Minimum value for Sparkline chart of column",
10078
- "uiLabel": "Minimum Value",
10079
- "isOptional": true
10080
- },
10081
- {
10082
- "name": "ShowToolTip",
10083
- "kind": "boolean",
10084
- "description": "Shows tooltip displaying underlying Sparkline values",
10085
- "uiLabel": "Show Tool Tip",
10086
- "isOptional": true
10087
- },
10088
- {
10089
- "name": "SparklineType",
10090
- "kind": "unknown",
10091
- "description": "Type of Sparkline Chart: 'Line', 'Column' or 'Area'",
10092
- "uiLabel": "Sparkline Type",
10093
- "isOptional": true
10094
- }
10095
- ]
10096
- },
10097
- "SparklineColumnApi": {
10098
- "name": "SparklineColumnApi",
10099
- "kind": "Interface",
10100
- "description": "Provides run-time access to Sparkline Column Module and associated state",
10101
- "properties": [
10102
- {
10103
- "name": "getAllSparklineColumn",
10104
- "kind": "function",
10105
- "description": "Returns all Sparkline columns in Adaptable State",
10106
- "uiLabel": "Get All Sparkline Column"
10107
- },
10108
- {
10109
- "name": "getSparklineByColumn",
10110
- "kind": "function",
10111
- "description": "Returns a Sparkline column by id",
10112
- "uiLabel": "Get Sparkline By Column"
10113
- },
10114
- {
10115
- "name": "getSparklineColumnState",
10116
- "kind": "function",
10117
- "description": "Retrieves SparklineColumn section from Adaptable State",
10118
- "uiLabel": "Get Sparkline Column State"
10119
- },
10120
- {
10121
- "name": "isSparklineColumn",
10122
- "kind": "function",
10123
- "description": "True if the Column with given `columnId` is Sparkline Column",
10124
- "uiLabel": "Is Sparkline Column"
10125
- }
10126
- ]
10127
- },
10128
- "SparklineColumnState": {
10129
- "name": "SparklineColumnState",
10130
- "kind": "Interface",
10131
- "description": "Predefined Configuration for Sparkline Columns",
10132
- "properties": [
10133
- {
10134
- "name": "SparklineColumns",
10135
- "kind": "unknown",
10136
- "description": "List of columns to be displayed as Sparkline",
10137
- "uiLabel": "Sparkline Columns",
10138
- "isOptional": true
10139
- }
10140
- ]
10141
- },
10142
10107
  "SpecialColumnSettings": {
10143
10108
  "name": "SpecialColumnSettings",
10144
10109
  "kind": "Interface",
@@ -10152,6 +10117,13 @@ exports.ADAPTABLE_METAMODEL = {
10152
10117
  "isOptional": true,
10153
10118
  "defaultValue": "true"
10154
10119
  },
10120
+ {
10121
+ "name": "ColumnTypes",
10122
+ "kind": "unknown",
10123
+ "description": "Custom column types to be added to AG Grid Column Types when object is created",
10124
+ "uiLabel": "Column Types",
10125
+ "isOptional": true
10126
+ },
10155
10127
  {
10156
10128
  "name": "Filterable",
10157
10129
  "kind": "boolean",
@@ -10496,7 +10468,7 @@ exports.ADAPTABLE_METAMODEL = {
10496
10468
  {
10497
10469
  "name": "updateNotification",
10498
10470
  "kind": "unknown",
10499
- "description": "How user is informed when Active Shared Entities have newer revisions: can be 'Alert', 'AlertWithNotification' or 'SystemStatus'",
10471
+ "description": "How user is informed when Active Shared Entities have newer revisions",
10500
10472
  "uiLabel": "Update Notification",
10501
10473
  "isOptional": true,
10502
10474
  "gridInfo": "item",
@@ -10628,7 +10600,7 @@ exports.ADAPTABLE_METAMODEL = {
10628
10600
  "properties": [
10629
10601
  {
10630
10602
  "name": "CurrentTheme",
10631
- "kind": "string",
10603
+ "kind": "unknown",
10632
10604
  "description": "Name of current theme (or theme to set at startup); leave blank if using 'Light Theme', set to 'dark' for 'Dark Theme' or provide name of Custom Theme",
10633
10605
  "uiLabel": "Current Theme",
10634
10606
  "isOptional": true
@@ -10786,24 +10758,6 @@ exports.ADAPTABLE_METAMODEL = {
10786
10758
  "gridInfo": "item",
10787
10759
  "defaultValue": "true"
10788
10760
  },
10789
- {
10790
- "name": "showColumnsDropdown",
10791
- "kind": "boolean",
10792
- "description": "Display the Columns dropdown",
10793
- "uiLabel": "Show Columns Dropdown",
10794
- "isOptional": true,
10795
- "gridInfo": "item",
10796
- "defaultValue": "true"
10797
- },
10798
- {
10799
- "name": "showModulesDropdown",
10800
- "kind": "boolean",
10801
- "description": "Display the Modules dropdown",
10802
- "uiLabel": "Show Modules Dropdown",
10803
- "isOptional": true,
10804
- "gridInfo": "item",
10805
- "defaultValue": "true"
10806
- },
10807
10761
  {
10808
10762
  "name": "showToolPanelsDropdown",
10809
10763
  "kind": "boolean",
@@ -10981,6 +10935,13 @@ exports.ADAPTABLE_METAMODEL = {
10981
10935
  "uiLabel": "Color Palette",
10982
10936
  "isOptional": true
10983
10937
  },
10938
+ {
10939
+ "name": "columnTypes",
10940
+ "kind": "unknown",
10941
+ "description": "Optional list of Column Types - used primarily for special columns",
10942
+ "uiLabel": "Column Types",
10943
+ "isOptional": true
10944
+ },
10984
10945
  {
10985
10946
  "name": "customSortPermittedValues",
10986
10947
  "kind": "unknown",
@@ -11018,6 +10979,15 @@ exports.ADAPTABLE_METAMODEL = {
11018
10979
  "uiLabel": "Filter Permitted Values",
11019
10980
  "isOptional": true
11020
10981
  },
10982
+ {
10983
+ "name": "gridInfoSections",
10984
+ "kind": "REFERENCE",
10985
+ "description": "Which sections to show in the Grid Info Screen",
10986
+ "uiLabel": "Grid Info Sections",
10987
+ "isOptional": true,
10988
+ "defaultValue": "['GridSummary', 'AdaptableOptions','ColumnInfo']",
10989
+ "reference": "unknown"
10990
+ },
11021
10991
  {
11022
10992
  "name": "permittedValues",
11023
10993
  "kind": "unknown",
@@ -11064,7 +11034,7 @@ exports.ADAPTABLE_METAMODEL = {
11064
11034
  "UserMenuItem": {
11065
11035
  "name": "UserMenuItem",
11066
11036
  "kind": "Interface",
11067
- "description": "Menu Item created at design-time which is added to Column Header or Context Menu, and can contain sub items",
11037
+ "description": "Menu Item which is added to Column Header or Context Menu, and can contain sub items",
11068
11038
  "properties": [
11069
11039
  {
11070
11040
  "name": "disabled",
@@ -11083,14 +11053,14 @@ exports.ADAPTABLE_METAMODEL = {
11083
11053
  {
11084
11054
  "name": "icon",
11085
11055
  "kind": "string",
11086
- "description": "Optional icon to show in the Column Menu Item",
11056
+ "description": "Optional icon to display",
11087
11057
  "uiLabel": "Icon",
11088
11058
  "isOptional": true
11089
11059
  },
11090
11060
  {
11091
11061
  "name": "label",
11092
11062
  "kind": "unknown",
11093
- "description": "The text that will appear in the Menu Item",
11063
+ "description": "Text that will appear in the Menu Item",
11094
11064
  "uiLabel": "Label"
11095
11065
  },
11096
11066
  {
@@ -11103,7 +11073,7 @@ exports.ADAPTABLE_METAMODEL = {
11103
11073
  {
11104
11074
  "name": "subMenuItems",
11105
11075
  "kind": "unknown",
11106
- "description": "Array of Menu Items, enabling creation of (limitless levels of) sub menus",
11076
+ "description": "Array of Menu Items, enabling limitless levels of menus",
11107
11077
  "uiLabel": "Sub Menu Items",
11108
11078
  "isOptional": true
11109
11079
  }
@@ -11117,7 +11087,7 @@ exports.ADAPTABLE_METAMODEL = {
11117
11087
  {
11118
11088
  "name": "NewValue",
11119
11089
  "kind": "unknown",
11120
- "description": "Value to use for edit (instead one provided by user); can be previous (i.e. unchanged) value or a new value, or left empty to accept the edit",
11090
+ "description": "Cell Value to use for after Server Validation",
11121
11091
  "uiLabel": "New Value",
11122
11092
  "isOptional": true
11123
11093
  },