@adaptabletools/adaptable 15.4.3 → 16.0.0-canary.0

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 (278) hide show
  1. package/base.css +1 -1
  2. package/base.css.map +1 -1
  3. package/bundle.cjs.js +234 -228
  4. package/index.css +1 -1
  5. package/index.css.map +1 -1
  6. package/package.json +2 -2
  7. package/publishTimestamp.d.ts +1 -1
  8. package/publishTimestamp.js +1 -1
  9. package/src/AdaptableInterfaces/IAdaptable.d.ts +3 -2
  10. package/src/AdaptableOptions/ActionColumnOptions.d.ts +82 -0
  11. package/src/AdaptableOptions/{ActionOptions.d.ts → ActionRowOptions.d.ts} +15 -90
  12. package/src/AdaptableOptions/AdaptableOptions.d.ts +32 -7
  13. package/src/AdaptableOptions/AdaptableQLOptions.d.ts +1 -12
  14. package/src/AdaptableOptions/AlertOptions.d.ts +9 -0
  15. package/src/AdaptableOptions/CalendarOptions.d.ts +11 -0
  16. package/src/AdaptableOptions/CellSummaryOptions.d.ts +10 -0
  17. package/src/AdaptableOptions/ColumnOptions.d.ts +0 -4
  18. package/src/AdaptableOptions/CustomSortOptions.d.ts +24 -0
  19. package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts +5 -1
  20. package/src/AdaptableOptions/DataSetOptions.d.ts +41 -0
  21. package/src/AdaptableOptions/DataSetOptions.js +2 -0
  22. package/src/AdaptableOptions/EditOptions.d.ts +4 -4
  23. package/src/AdaptableOptions/EntitlementOptions.d.ts +0 -16
  24. package/src/AdaptableOptions/ExportOptions.d.ts +2 -4
  25. package/src/AdaptableOptions/ExpressionOptions.d.ts +7 -0
  26. package/src/AdaptableOptions/FinancePluginOptions.d.ts +1 -1
  27. package/src/AdaptableOptions/GroupingOptions.d.ts +50 -0
  28. package/src/AdaptableOptions/GroupingOptions.js +2 -0
  29. package/src/AdaptableOptions/MasterDetailPluginOptions.d.ts +9 -0
  30. package/src/AdaptableOptions/PredicateOptions.d.ts +4 -0
  31. package/src/AdaptableOptions/TeamSharingOptions.d.ts +0 -8
  32. package/src/AdaptableOptions/UserInterfaceOptions.d.ts +30 -1
  33. package/src/Api/ActionColumnApi.d.ts +10 -0
  34. package/src/Api/ActionColumnApi.js +2 -0
  35. package/src/Api/{ActionApi.d.ts → ActionRowApi.d.ts} +4 -15
  36. package/src/Api/ActionRowApi.js +2 -0
  37. package/src/Api/AdaptableApi.d.ts +11 -6
  38. package/src/Api/AlertApi.d.ts +2 -111
  39. package/src/Api/BulkUpdateApi.d.ts +0 -7
  40. package/src/Api/CalculatedColumnApi.d.ts +0 -31
  41. package/src/Api/CalendarApi.d.ts +1 -1
  42. package/src/Api/CellSummaryApi.d.ts +0 -7
  43. package/src/Api/ChartingApi.d.ts +0 -7
  44. package/src/Api/ColumnApi.d.ts +1 -131
  45. package/src/Api/ConfigApi.d.ts +1 -7
  46. package/src/Api/CustomSortApi.d.ts +0 -25
  47. package/src/Api/DashboardApi.d.ts +0 -16
  48. package/src/Api/DataChangeHistoryApi.d.ts +0 -7
  49. package/src/Api/DataSetApi.d.ts +1 -16
  50. package/src/Api/EventApi.d.ts +1 -9
  51. package/src/Api/Events/AdaptableStateChanged.d.ts +0 -8
  52. package/src/Api/Events/AdaptableStateReloaded.d.ts +0 -4
  53. package/src/Api/Events/BaseEventInfo.d.ts +9 -1
  54. package/src/Api/Events/LiveDataChanged.d.ts +3 -7
  55. package/src/Api/ExportApi.d.ts +7 -31
  56. package/src/Api/{QueryLanguageApi.d.ts → ExpressionApi.d.ts} +2 -2
  57. package/src/Api/ExpressionApi.js +2 -0
  58. package/src/Api/FilterApi.d.ts +1 -59
  59. package/src/Api/FlashingCellApi.d.ts +0 -15
  60. package/src/Api/FormatColumnApi.d.ts +1 -91
  61. package/src/Api/FreeTextColumnApi.d.ts +0 -39
  62. package/src/Api/GridApi.d.ts +0 -31
  63. package/src/Api/Implementation/ActionColumnApiImpl.d.ts +7 -0
  64. package/src/Api/Implementation/ActionColumnApiImpl.js +14 -0
  65. package/src/Api/Implementation/ActionRowApiImpl.d.ts +12 -0
  66. package/src/Api/Implementation/{ActionApiImpl.js → ActionRowApiImpl.js} +8 -15
  67. package/src/Api/Implementation/AdaptableApiImpl.d.ts +6 -4
  68. package/src/Api/Implementation/AdaptableApiImpl.js +7 -5
  69. package/src/Api/Implementation/AlertApiImpl.d.ts +1 -43
  70. package/src/Api/Implementation/AlertApiImpl.js +4 -94
  71. package/src/Api/Implementation/ApiBase.d.ts +15 -5
  72. package/src/Api/Implementation/ApiBase.js +26 -8
  73. package/src/Api/Implementation/CalculatedColumnApiImpl.d.ts +0 -7
  74. package/src/Api/Implementation/CalculatedColumnApiImpl.js +0 -32
  75. package/src/Api/Implementation/CalendarApiImpl.d.ts +1 -0
  76. package/src/Api/Implementation/CalendarApiImpl.js +20 -17
  77. package/src/Api/Implementation/CellSummaryApiImpl.d.ts +0 -1
  78. package/src/Api/Implementation/CellSummaryApiImpl.js +1 -6
  79. package/src/Api/Implementation/ChartingApiImpl.d.ts +0 -1
  80. package/src/Api/Implementation/ChartingApiImpl.js +0 -5
  81. package/src/Api/Implementation/ColumnApiImpl.d.ts +0 -35
  82. package/src/Api/Implementation/ColumnApiImpl.js +1 -138
  83. package/src/Api/Implementation/ConfigApiImpl.js +2 -1
  84. package/src/Api/Implementation/CustomSortApiImpl.d.ts +1 -5
  85. package/src/Api/Implementation/CustomSortApiImpl.js +0 -16
  86. package/src/Api/Implementation/DashboardApiImpl.d.ts +0 -4
  87. package/src/Api/Implementation/DashboardApiImpl.js +2 -24
  88. package/src/Api/Implementation/DataChangeHistoryApiImpl.d.ts +0 -1
  89. package/src/Api/Implementation/DataChangeHistoryApiImpl.js +0 -5
  90. package/src/Api/Implementation/DataSetApiImpl.d.ts +1 -4
  91. package/src/Api/Implementation/DataSetApiImpl.js +1 -14
  92. package/src/Api/Implementation/ExportApiImpl.d.ts +4 -10
  93. package/src/Api/Implementation/ExportApiImpl.js +15 -34
  94. package/src/Api/Implementation/{QueryLanguageApiImpl.d.ts → ExpressionApiImpl.d.ts} +4 -4
  95. package/src/Api/Implementation/{QueryLanguageApiImpl.js → ExpressionApiImpl.js} +7 -5
  96. package/src/Api/Implementation/FilterApiImpl.d.ts +1 -17
  97. package/src/Api/Implementation/FilterApiImpl.js +0 -53
  98. package/src/Api/Implementation/FlashingCellApiImpl.d.ts +0 -3
  99. package/src/Api/Implementation/FlashingCellApiImpl.js +2 -13
  100. package/src/Api/Implementation/FormatColumnApiImpl.d.ts +2 -34
  101. package/src/Api/Implementation/FormatColumnApiImpl.js +0 -73
  102. package/src/Api/Implementation/FreeTextColumnApiImpl.d.ts +0 -8
  103. package/src/Api/Implementation/FreeTextColumnApiImpl.js +0 -29
  104. package/src/Api/Implementation/GridApiImpl.d.ts +0 -7
  105. package/src/Api/Implementation/GridApiImpl.js +3 -32
  106. package/src/Api/Implementation/LayoutApiImpl.d.ts +1 -6
  107. package/src/Api/Implementation/LayoutApiImpl.js +2 -27
  108. package/src/Api/Implementation/OptionsApiImpl.d.ts +10 -5
  109. package/src/Api/Implementation/OptionsApiImpl.js +19 -7
  110. package/src/Api/Implementation/PlusMinusApiImpl.d.ts +0 -1
  111. package/src/Api/Implementation/PlusMinusApiImpl.js +0 -5
  112. package/src/Api/Implementation/PredicateApiImpl.d.ts +1 -8
  113. package/src/Api/Implementation/PredicateApiImpl.js +2 -30
  114. package/src/Api/Implementation/QueryApiImpl.d.ts +0 -5
  115. package/src/Api/Implementation/QueryApiImpl.js +0 -21
  116. package/src/Api/Implementation/QuickSearchApiImpl.d.ts +0 -1
  117. package/src/Api/Implementation/QuickSearchApiImpl.js +0 -5
  118. package/src/Api/Implementation/ScheduleApiImpl.d.ts +1 -18
  119. package/src/Api/Implementation/ScheduleApiImpl.js +0 -69
  120. package/src/Api/Implementation/ScopeApiImpl.js +1 -1
  121. package/src/Api/Implementation/SettingsPanelApiImpl.d.ts +0 -2
  122. package/src/Api/Implementation/SettingsPanelApiImpl.js +0 -9
  123. package/src/Api/Implementation/ShortcutApiImpl.d.ts +1 -6
  124. package/src/Api/Implementation/ShortcutApiImpl.js +0 -21
  125. package/src/Api/Implementation/SmartEditApiImpl.d.ts +0 -1
  126. package/src/Api/Implementation/SmartEditApiImpl.js +0 -5
  127. package/src/Api/Implementation/StyledColumnApiImpl.d.ts +1 -5
  128. package/src/Api/Implementation/StyledColumnApiImpl.js +2 -17
  129. package/src/Api/Implementation/SystemStatusApiImpl.d.ts +0 -2
  130. package/src/Api/Implementation/SystemStatusApiImpl.js +0 -9
  131. package/src/Api/Implementation/TeamSharingApiImpl.d.ts +0 -5
  132. package/src/Api/Implementation/TeamSharingApiImpl.js +0 -21
  133. package/src/Api/Implementation/ThemeApiImpl.d.ts +0 -4
  134. package/src/Api/Implementation/ThemeApiImpl.js +2 -17
  135. package/src/Api/Implementation/ToolPanelApiImpl.js +2 -2
  136. package/src/Api/Implementation/UserInterfaceApiImpl.d.ts +4 -2
  137. package/src/Api/Implementation/UserInterfaceApiImpl.js +17 -10
  138. package/src/Api/Internal/{ActionInternalApi.d.ts → ActionRowInternalApi.d.ts} +2 -2
  139. package/src/Api/Internal/{ActionInternalApi.js → ActionRowInternalApi.js} +12 -5
  140. package/src/Api/Internal/AdaptableInternalApi.d.ts +1 -10
  141. package/src/Api/Internal/AdaptableInternalApi.js +9 -20
  142. package/src/Api/Internal/AlertInternalApi.js +9 -6
  143. package/src/Api/Internal/CalculatedColumnInternalApi.js +2 -2
  144. package/src/Api/Internal/CustomSortInternalApi.d.ts +1 -1
  145. package/src/Api/Internal/CustomSortInternalApi.js +1 -1
  146. package/src/Api/Internal/DashboardInternalApi.js +2 -0
  147. package/src/Api/Internal/DataSetInternalApi.d.ts +1 -1
  148. package/src/Api/Internal/DataSetInternalApi.js +2 -1
  149. package/src/Api/Internal/ExportInternalApi.js +1 -1
  150. package/src/Api/Internal/{QueryLanguageInternalApi.d.ts → ExpressionnternalApi.d.ts} +1 -1
  151. package/src/Api/Internal/{QueryLanguageInternalApi.js → ExpressionnternalApi.js} +9 -5
  152. package/src/Api/Internal/FilterInternalApi.js +4 -1
  153. package/src/Api/Internal/FormatColumnInternalApi.js +1 -1
  154. package/src/Api/Internal/GridInternalApi.js +8 -0
  155. package/src/Api/Internal/LayoutInternalApi.js +6 -1
  156. package/src/Api/Internal/PredicateInternalApi.js +10 -0
  157. package/src/Api/Internal/QueryInternalApi.js +3 -1
  158. package/src/Api/Internal/SystemStatusInternalApi.js +4 -1
  159. package/src/Api/Internal/TeamSharingInternalApi.js +2 -0
  160. package/src/Api/LayoutApi.d.ts +3 -27
  161. package/src/Api/OptionsApi.d.ts +28 -10
  162. package/src/Api/PlusMinusApi.d.ts +0 -7
  163. package/src/Api/PredicateApi.d.ts +1 -32
  164. package/src/Api/QueryApi.d.ts +0 -23
  165. package/src/Api/QuickSearchApi.d.ts +0 -4
  166. package/src/Api/ScheduleApi.d.ts +0 -81
  167. package/src/Api/SettingsPanelApi.d.ts +0 -11
  168. package/src/Api/ShortcutApi.d.ts +0 -25
  169. package/src/Api/SmartEditApi.d.ts +0 -7
  170. package/src/Api/StyledColumnApi.d.ts +0 -21
  171. package/src/Api/SystemStatusApi.d.ts +0 -11
  172. package/src/Api/TeamSharingApi.d.ts +0 -23
  173. package/src/Api/ThemeApi.d.ts +0 -19
  174. package/src/Api/UserInterfaceApi.d.ts +4 -9
  175. package/src/PredefinedConfig/AlertState.d.ts +4 -1
  176. package/src/PredefinedConfig/Common/AdaptableFormat.d.ts +3 -3
  177. package/src/PredefinedConfig/Common/AdaptableIcon.d.ts +4 -1
  178. package/src/PredefinedConfig/Common/AggregationColumns.d.ts +3 -0
  179. package/src/PredefinedConfig/Common/BaseContext.d.ts +8 -0
  180. package/src/PredefinedConfig/Common/DataChangedScope.d.ts +9 -0
  181. package/src/PredefinedConfig/Common/Entitlement.d.ts +1 -1
  182. package/src/PredefinedConfig/LayoutState.d.ts +0 -6
  183. package/src/PredefinedConfig/SystemState.d.ts +1 -1
  184. package/src/PredefinedConfig/TeamSharingState.d.ts +1 -1
  185. package/src/PredefinedConfig/ThemeState.d.ts +3 -0
  186. package/src/Strategy/AdaptableModuleBase.js +3 -3
  187. package/src/Strategy/AlertModule.js +3 -3
  188. package/src/Strategy/CalculatedColumnModule.js +2 -2
  189. package/src/Strategy/CellSummaryModule.js +2 -0
  190. package/src/Strategy/DataSetModule.d.ts +1 -1
  191. package/src/Strategy/DataSetModule.js +1 -1
  192. package/src/Strategy/ExportModule.js +4 -0
  193. package/src/Strategy/FlashingCellModule.js +4 -4
  194. package/src/Strategy/FormatColumnModule.js +3 -3
  195. package/src/Strategy/QueryModule.js +1 -1
  196. package/src/Strategy/SmartEditModule.js +2 -0
  197. package/src/Utilities/Defaults/DefaultAdaptableOptions.js +24 -22
  198. package/src/Utilities/ExpressionFunctions/expressionFunctionUtils.js +4 -0
  199. package/src/Utilities/Helpers/AdaptableHelper.js +12 -6
  200. package/src/Utilities/Helpers/FormatHelper.js +7 -0
  201. package/src/Utilities/ObjectFactory.d.ts +2 -2
  202. package/src/Utilities/ObjectFactory.js +6 -4
  203. package/src/Utilities/Services/AlertService.js +1 -1
  204. package/src/Utilities/Services/CalculatedColumnExpressionService.js +2 -2
  205. package/src/Utilities/Services/ChartingService.js +2 -0
  206. package/src/Utilities/Services/EntitlementService.js +2 -2
  207. package/src/Utilities/Services/ModuleService.js +10 -10
  208. package/src/Utilities/Services/QueryLanguageService.js +16 -0
  209. package/src/Utilities/Services/ReportService.js +8 -6
  210. package/src/Utilities/Services/RowEditService.js +4 -2
  211. package/src/Utilities/Services/ValidationService.js +2 -0
  212. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/UIOptions/UIOptionsActionColumnsForm.js +3 -3
  213. package/src/View/CalculatedColumn/Wizard/CalculatedColumnExpressionWizardSection.js +1 -1
  214. package/src/View/CellSummary/CellSummaryStatusPanel.js +1 -1
  215. package/src/View/Components/AdaptableIconSelector/index.d.ts +6 -0
  216. package/src/View/Components/AdaptableIconSelector/index.js +18 -0
  217. package/src/View/Components/AdaptableObjectList/AdaptableObjectList.js +2 -2
  218. package/src/View/Components/AdaptableViewIcon/index.d.ts +10 -0
  219. package/src/View/Components/AdaptableViewIcon/index.js +18 -0
  220. package/src/View/Components/EntityRulesEditor/Utilities.js +3 -3
  221. package/src/View/Components/ExternalRenderer.js +14 -2
  222. package/src/View/Components/FilterForm/QuickFilterForm.js +4 -0
  223. package/src/View/Components/Popups/AdaptablePopupAlert.js +2 -0
  224. package/src/View/Components/RangesComponent.d.ts +4 -4
  225. package/src/View/Components/RangesComponent.js +13 -22
  226. package/src/View/Components/ToolPanel/AdaptableToolPanel.js +2 -0
  227. package/src/View/Components/ToolPanel/CustomToolPanelContent.js +11 -1
  228. package/src/View/CustomSort/Wizard/CustomSortColumnWizardSection.js +1 -1
  229. package/src/View/Dashboard/CustomDashboardButton.js +2 -0
  230. package/src/View/Dashboard/CustomToolbarWrapper.js +13 -1
  231. package/src/View/DataChangeHistory/DataChangeHistoryGrid.js +5 -5
  232. package/src/View/DataChangeHistory/buildActionColumnButton.d.ts +2 -2
  233. package/src/View/DataChangeHistory/buildActionColumnButton.js +3 -2
  234. package/src/View/Export/ExportViewPanel.js +4 -4
  235. package/src/View/FormatColumn/Wizard/FormatColumnFormatWizardSection.js +3 -1
  236. package/src/View/GridInfo/GridInfoPopup.d.ts +0 -1
  237. package/src/View/GridInfo/GridInfoPopup.js +1 -2
  238. package/src/View/GridInfo/GridOptionsComponent.js +1 -1
  239. package/src/View/Layout/LayoutViewPanel.js +1 -1
  240. package/src/View/Layout/PivotDetailsPopoup.js +2 -0
  241. package/src/View/Layout/SaveLayoutButton.js +1 -1
  242. package/src/View/Layout/Wizard/LayoutWizard.js +1 -1
  243. package/src/View/Query/Wizard/NamedQueryExpressionWizardSection.js +1 -1
  244. package/src/View/Shortcut/Wizard/ShortcutSettingsWizard.js +1 -1
  245. package/src/View/StyledColumn/Wizard/StyledColumnBadgeSection.js +2 -2
  246. package/src/View/StyledColumn/Wizard/StyledColumnWizardStyleSection/Components/StyledColumnBadgePreview.js +8 -1
  247. package/src/agGrid/ActionColumnRenderer.d.ts +1 -1
  248. package/src/agGrid/ActionColumnRenderer.js +5 -1
  249. package/src/agGrid/Adaptable.d.ts +14 -3
  250. package/src/agGrid/Adaptable.js +129 -30
  251. package/src/agGrid/BadgeRenderer.js +10 -2
  252. package/src/agGrid/CheckboxRenderer.d.ts +1 -2
  253. package/src/agGrid/agGridHelper.js +4 -5
  254. package/src/agGrid/agGridMenuHelper.js +4 -0
  255. package/src/agGrid/attachAddaptableColumnTypes.d.ts +11 -11
  256. package/src/agGrid/editors/AdaptableDateEditor/index.js +2 -0
  257. package/src/agGrid/editors/AdaptableNumberEditor/index.js +2 -2
  258. package/src/components/AdaptableFormComponent/AdaptableFormComponent.js +6 -3
  259. package/src/components/AdaptableIconComponent/index.js +6 -3
  260. package/src/components/ExpressionEditor/BaseEditorInput.js +2 -0
  261. package/src/components/ExpressionEditor/index.js +1 -1
  262. package/src/components/IconSelector/IconSelector.d.ts +2 -0
  263. package/src/components/IconSelector/IconSelector.js +21 -5
  264. package/src/components/Input/NumberInput.d.ts +10 -0
  265. package/src/components/Input/NumberInput.js +46 -0
  266. package/src/metamodel/adaptable.metamodel.d.ts +230 -145
  267. package/src/metamodel/adaptable.metamodel.js +1 -1
  268. package/src/types.d.ts +13 -8
  269. package/version.d.ts +1 -1
  270. package/version.js +1 -1
  271. package/src/AdaptableOptions/GeneralOptions.d.ts +0 -159
  272. package/src/Api/Events/SearchChanged.d.ts +0 -12
  273. package/src/Api/Implementation/ActionApiImpl.d.ts +0 -14
  274. /package/src/AdaptableOptions/{ActionOptions.js → ActionColumnOptions.js} +0 -0
  275. /package/src/AdaptableOptions/{GeneralOptions.js → ActionRowOptions.js} +0 -0
  276. /package/src/{Api/ActionApi.js → AdaptableOptions/CalendarOptions.js} +0 -0
  277. /package/src/{Api/Events/SearchChanged.js → AdaptableOptions/CellSummaryOptions.js} +0 -0
  278. /package/src/{Api/QueryLanguageApi.js → AdaptableOptions/CustomSortOptions.js} +0 -0
@@ -58,6 +58,15 @@ export interface AlertOptions<TData = any> {
58
58
  * Function providing Message to display in Alert; if empty, AdapTable provides dynamically
59
59
  */
60
60
  alertMessageText?: (alertMessageContext: AlertMessageContext<TData>) => string | undefined;
61
+ /**
62
+ * Shows Alert if Primary Key column in Adaptable Options is not present or incorrect
63
+ *
64
+ * @defaultValue false
65
+ * @gridInfoItem
66
+ * @noCodeItem
67
+ * @uiLabel Show Missing Primary Key Warning
68
+ */
69
+ showMissingPrimaryKeyAlert?: boolean;
61
70
  }
62
71
  /**
63
72
  * Handles a Form Button Action
@@ -0,0 +1,11 @@
1
+ import { BaseContext } from '../../types';
2
+ /**
3
+ * Options for managing Holidays and Working Days in AdapTable
4
+ */
5
+ export interface CalendarOptions<TData = any> {
6
+ /**
7
+ * Holidays - used to determine Working Days
8
+ * @defaultValue null
9
+ */
10
+ holidays?: string[] | ((baseContext: BaseContext) => string[] | undefined);
11
+ }
@@ -0,0 +1,10 @@
1
+ import { CellSummaryOperation } from '../PredefinedConfig/Common/CellSummary';
2
+ /**
3
+ * Options to provide custom Cell Summaries
4
+ */
5
+ export interface CellSummaryOptions<TData = any> {
6
+ /**
7
+ * Custom Cell Summary Operations to add to shipped set
8
+ */
9
+ cellSummaryOperations?: CellSummaryOperation<TData>[];
10
+ }
@@ -30,10 +30,6 @@ export interface ColumnOptions {
30
30
  * @noCodeItem
31
31
  */
32
32
  autoOrderGroupedColumns?: boolean;
33
- /**
34
- * @deprecated - this is now AG Grid behaviour
35
- */
36
- hideColumnWhenGrouped?: boolean;
37
33
  }
38
34
  /**
39
35
  * Context used when setting a Column Friendly Name
@@ -0,0 +1,24 @@
1
+ import { AdaptableScope } from '../../types';
2
+ import { AdaptableComparerFunction } from '../PredefinedConfig/Common/AdaptableComparerFunction';
3
+ /**
4
+ * Options for providing Custom Sorts comparers
5
+ */
6
+ export interface CustomSortOptions<TData = any> {
7
+ /**
8
+ * CustomSort column comparer functions
9
+ */
10
+ customSortComparers?: ColumnValuesComparer<TData>[];
11
+ }
12
+ /**
13
+ * Comparer object for Column Values - used for custom sorting
14
+ */
15
+ export interface ColumnValuesComparer<TData = any> {
16
+ /**
17
+ * Column for which to compare values
18
+ */
19
+ scope: AdaptableScope;
20
+ /**
21
+ * Comparer function to use
22
+ */
23
+ comparer: AdaptableComparerFunction<TData>;
24
+ }
@@ -1,5 +1,5 @@
1
1
  import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
2
- import { ActionColumnContext, AdaptableButton } from '../types';
2
+ import { ActionColumnContext, AdaptableApi, AdaptableButton } from '../types';
3
3
  /**
4
4
  * Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes
5
5
  */
@@ -46,6 +46,10 @@ export interface DataChangeHistoryContext<TData = any> extends ActionColumnConte
46
46
  * The initial data change
47
47
  */
48
48
  dataChangedInfo: CellDataChangedInfo<TData>;
49
+ /**
50
+ * AdapTable API of underlying Grid (not from Data History Monitor)
51
+ */
52
+ parentAdapTableApi: AdaptableApi;
49
53
  }
50
54
  /**
51
55
  * A custom AdaptableButton which provides a build in `undo` action
@@ -0,0 +1,41 @@
1
+ import { AdaptableForm, AdaptableObject } from '../../types';
2
+ import { FormContext } from '../PredefinedConfig/Common/FormContext';
3
+ /**
4
+ * Options to provide Data Sets
5
+ */
6
+ export interface DataSetOptions<TData = any> {
7
+ /**
8
+ * Collection of Data Sets to provide Data to AdapTable
9
+ */
10
+ dataSets?: DataSet[];
11
+ }
12
+ /**
13
+ * Defines a Data Set object that can provide data to AdapTable
14
+ */
15
+ export interface DataSet extends AdaptableObject {
16
+ /**
17
+ * Name of Data Set
18
+ */
19
+ name: string;
20
+ /**
21
+ * Describes the Data Set
22
+ */
23
+ description: string;
24
+ /**
25
+ * Params for Data Set popup form
26
+ */
27
+ form?: AdaptableForm<DataSetFormContext>;
28
+ /**
29
+ * Additional info for Data Set
30
+ */
31
+ info?: Record<string, string | number | boolean | Date>;
32
+ }
33
+ /**
34
+ * Used when a DataSet displays a Form
35
+ */
36
+ export interface DataSetFormContext extends FormContext {
37
+ /**
38
+ * The DataSet which triggered the Form
39
+ */
40
+ dataSet: DataSet;
41
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -81,8 +81,8 @@ export interface SmartEditOperationContext<TData = any> extends BaseContext {
81
81
  currentCell: GridCell<TData>;
82
82
  }
83
83
  /**
84
- * Context used when validating data edits on Server
85
- */
84
+ * Context used when validating data edits on Server
85
+ */
86
86
  export interface ServerValidationContext<TData = any> extends BaseContext {
87
87
  /**
88
88
  * Details of Cell Edit
@@ -90,8 +90,8 @@ export interface ServerValidationContext<TData = any> extends BaseContext {
90
90
  cellDataChangedInfo: CellDataChangedInfo<TData>;
91
91
  }
92
92
  /**
93
- * Context used when checking Cell editability
94
- */
93
+ * Context used when checking Cell editability
94
+ */
95
95
  export interface CellEditableContext<TData = any> extends BaseContext {
96
96
  /**
97
97
  * Cell being edited
@@ -27,14 +27,6 @@ export interface EntitlementContext extends BaseContext {
27
27
  * Module being entitled
28
28
  */
29
29
  adaptableModule: AdaptableModule;
30
- /**
31
- * Name of Current User
32
- */
33
- userName: string;
34
- /**
35
- * Id of current AdapTable instance
36
- */
37
- adaptableId: string;
38
30
  /**
39
31
  * The default Access Level for the current instance
40
32
  */
@@ -44,12 +36,4 @@ export interface EntitlementContext extends BaseContext {
44
36
  * Provided to defaultAccessLevel function when setting Default Entitlement value programatically
45
37
  */
46
38
  export interface DefaultAccessLevelContext extends BaseContext {
47
- /**
48
- * Name of Current User
49
- */
50
- userName: string;
51
- /**
52
- * Id of current AdapTable instance
53
- */
54
- adaptableId: string;
55
39
  }
@@ -29,10 +29,8 @@ export interface ExportOptions {
29
29
  customDestinations?: CustomDestination[];
30
30
  /**
31
31
  * Reports generated entirely by users (and not AdapTable)
32
- *
33
- * @deprecated It will be renamed to `externalReports` in version 16
34
32
  */
35
- serverReports?: ServerReport[];
33
+ externalReports?: ExternalReport[];
36
34
  /**
37
35
  * System Reports to use; leave blank for all, empty array for none
38
36
  *
@@ -112,7 +110,7 @@ export declare type DataFormatType = 'rawValue' | 'formattedValue';
112
110
  /**
113
111
  * Defines a Report where all the data is provided entirely by the user
114
112
  */
115
- export interface ServerReport {
113
+ export interface ExternalReport {
116
114
  /**
117
115
  * Name of the Report
118
116
  */
@@ -87,6 +87,13 @@ export interface ExpressionOptions {
87
87
  * Custom query variables allow values to be attached to variables so that a single value can easily be expressed multiple times within a query, or quickly changed to affect the results of a query. Variables are evaluated synchronously with each expression evaluation.
88
88
  */
89
89
  customQueryVariables?: Record<string, string | number | boolean | Date | ((context: CustomQueryVariableContext) => string | number | boolean | Date)>;
90
+ /**
91
+ * Reference a Column's Header (i.e. FriendlyName) in all Expression overviews (instead of ColumnId)
92
+ *
93
+ * @defaultValue true
94
+ * @noCodeItem
95
+ */
96
+ displayColumnFriendlyNamesForExpressions?: boolean;
90
97
  }
91
98
  /**
92
99
  * Module specific Expression Functions
@@ -215,7 +215,7 @@ export interface OrganizationColumn extends FDC3Column {
215
215
  intents?: OrganizationIntents;
216
216
  }
217
217
  /**
218
- *
218
+ * All available Organization Intents
219
219
  */
220
220
  export declare type OrganizationIntents = OrganizationIntent[];
221
221
  /**
@@ -0,0 +1,50 @@
1
+ import { AdaptableColumn, BaseContext } from '../../types';
2
+ import { KeyCreatorParams } from '@ag-grid-community/core';
3
+ /**
4
+ * Options for managing Row and Column Groups in AdapTable
5
+ */
6
+ export interface GroupingOptions<TData = any> {
7
+ /**
8
+ * Show aggregated totals row at top of Grid when row grouping
9
+ *
10
+ * @defaultValue false
11
+ * @gridInfoItem
12
+ */
13
+ showGroupingTotalsAsHeader?: boolean;
14
+ /**
15
+ * Value to use for 'Unbalanced Groups' (string columns)
16
+ */
17
+ unbalancedGroupsKey?: string | ((context: UnbalancedGroupsKeyContext<TData>) => string);
18
+ /**
19
+ * Places ungrouped columns at pre-grouping indexed position
20
+ * @defaultValue false
21
+ * @noCodeItem
22
+ */
23
+ restoreUngroupedColumns?: boolean;
24
+ }
25
+ /**
26
+ * Context used when setting a value for Unbalanced Row Groups
27
+ */
28
+ export interface UnbalancedGroupsKeyContext<TData = any> extends BaseContext {
29
+ /**
30
+ * Adaptable Column being grouped
31
+ */
32
+ adaptableColumn: AdaptableColumn<TData>;
33
+ /**
34
+ * AG Grid's Key Creator Params
35
+ */
36
+ params: KeyCreatorParams<TData>;
37
+ }
38
+ /**
39
+ * Context used when setting a value for Unbalanced Row Groups
40
+ */
41
+ export interface UnbalancedGroupsKeyContext<TData = any> extends BaseContext {
42
+ /**
43
+ * Adaptable Column being grouped
44
+ */
45
+ adaptableColumn: AdaptableColumn<TData>;
46
+ /**
47
+ * AG Grid's Key Creator Params
48
+ */
49
+ params: KeyCreatorParams<TData>;
50
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -17,7 +17,16 @@ export interface MasterDetailPluginOptions {
17
17
  * Context passed to Detail Grids when using Master Detail Plugin
18
18
  */
19
19
  export interface DetailInitContext extends BaseContext {
20
+ /**
21
+ * Row Node in the Master Grid that was opened
22
+ */
20
23
  rowNode: IRowNode;
24
+ /**
25
+ * The data in the Master Grid Row that was opened
26
+ */
21
27
  data: IRowNode['data'];
28
+ /**
29
+ * Primary Key Value of Master Grid Row that was opened
30
+ */
22
31
  primaryKeyValue: unknown;
23
32
  }
@@ -3,6 +3,10 @@ import { AdaptablePredicateDef, AdaptableScope, BaseContext, PredicateModuleScop
3
3
  * Options for managing Adaptable Predicates using AdaptableQL
4
4
  */
5
5
  export interface PredicateOptions {
6
+ /**
7
+ * Definitions for Custom provided Predicates
8
+ */
9
+ customPredicateDefs?: AdaptablePredicateDef[];
6
10
  /**
7
11
  * Which System Filter Predicates are available
8
12
  */
@@ -61,12 +61,4 @@ export interface TeamSharingOptions {
61
61
  * Context provided to `TeamSharingOptions.loadSharedEntities()` callback
62
62
  */
63
63
  export interface SharedEntitiesContext extends BaseContext {
64
- /**
65
- * `AdaptableOptions.adaptableId`
66
- */
67
- adaptableId: string;
68
- /**
69
- * `AdaptableOptions.userName`
70
- */
71
- userName: string;
72
64
  }
@@ -4,7 +4,7 @@ import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
4
4
  import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
5
5
  import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
6
6
  import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
7
- import { BaseContext, GridCell } from '../../types';
7
+ import { AlternativeModuleName, BaseContext, GridCell } from '../../types';
8
8
  import { IRowNode } from '@ag-grid-community/core';
9
9
  /**
10
10
  * Options for managing the User Interface of AdapTable
@@ -23,6 +23,13 @@ export interface UserInterfaceOptions<TData = any> {
23
23
  * @defaultValue null
24
24
  */
25
25
  applicationIcon?: AdaptableIcon;
26
+ /**
27
+ * A map of custom icons that can be used in Adaptable objects (e.g. Badges).
28
+ */
29
+ customIcons?: {
30
+ name: string;
31
+ icon: AdaptableIcon;
32
+ }[];
26
33
  /**
27
34
  * Options for managing and customizing date inputs in AdapTable
28
35
  */
@@ -92,7 +99,29 @@ export interface UserInterfaceOptions<TData = any> {
92
99
  * Custom Formatters to use in the Format Column Module
93
100
  */
94
101
  customDisplayFormatters?: CustomDisplayFormatter[];
102
+ /**
103
+ * English variant to use in UI labels
104
+ *
105
+ * @defaultValue 'GB'
106
+ * @gridInfoItem
107
+ */
108
+ englishVariant?: 'GB' | 'US';
109
+ /**
110
+ * Hides confirmation dialog which displays whenever an AdaptableObject is deleted
111
+ * @defaultValue false
112
+ * @noCodeItem
113
+ */
114
+ disableDeleteConfirmation?: boolean;
115
+ /**
116
+ * Alternative names to use for Adaptable Modules in toolbars and menus
117
+ *
118
+ * @defaultValue null
119
+ */
120
+ alternativeModuleNames?: AlternativeModuleName[];
95
121
  }
122
+ /**
123
+ * Base class for all Permitted Values related objects
124
+ */
96
125
  export interface BasePermittedValues {
97
126
  /**
98
127
  * Scope where Values will appear (Mandatory property)
@@ -0,0 +1,10 @@
1
+ import { ActionColumn } from '../../types';
2
+ /**
3
+ * Functions for accessing Action Columns
4
+ */
5
+ export interface ActionColumnApi {
6
+ /**
7
+ * Retrieves the Action Columns provided in Action Column Options
8
+ */
9
+ getActionColumns(): ActionColumn[];
10
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,14 +1,10 @@
1
- import { ActionColumn, ActionRowButtonType } from '../../types';
1
+ import { ActionRowButtonType } from '../../types';
2
2
  /**
3
- * A large range of column-related functions in AdapTable
3
+ * Functions for accessing Action Rows
4
4
  */
5
- export interface ActionApi {
5
+ export interface ActionRowApi {
6
6
  /**
7
- * Retrieves the Action Columns provided in Action Options
8
- */
9
- getActionColumns(): ActionColumn[];
10
- /**
11
- * Retrieves the Action Row Buttons provided in Action Options
7
+ * Retrieves the Action Row Buttons provided in Action Row Options
12
8
  */
13
9
  getActionRowButtons(): ActionRowButtonType[];
14
10
  /**
@@ -25,11 +21,4 @@ export interface ActionApi {
25
21
  * @param primaryKey - Primary Key of the duplicated row
26
22
  */
27
23
  displayCloneActionRow(primaryKey?: any): void;
28
- /**
29
- * TO BE REMOVED
30
- */
31
- /**
32
- * @deprecated use `getActionColumns()` instead
33
- */
34
- getAllActionColumn(): ActionColumn[];
35
24
  }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -26,10 +26,9 @@ import { UserInterfaceApi } from './UserInterfaceApi';
26
26
  import { GridApi } from './GridApi';
27
27
  import { ScheduleApi } from './ScheduleApi';
28
28
  import { QueryApi } from './QueryApi';
29
- import { QueryLanguageApi } from './QueryLanguageApi';
29
+ import { ExpressionApi } from './ExpressionApi';
30
30
  import { TeamSharingApi } from './TeamSharingApi';
31
31
  import { ColumnApi } from './ColumnApi';
32
- import { ActionApi } from './ActionApi';
33
32
  import { ApplicationApi } from './ApplicationApi';
34
33
  import { ScopeApi } from './ScopeApi';
35
34
  import { PredicateApi } from './PredicateApi';
@@ -40,6 +39,8 @@ import { SettingsPanelApi } from './SettingsPanelApi';
40
39
  import { StatusBarApi } from './StatusBarApi';
41
40
  import { StyledColumnApi } from './StyledColumnApi';
42
41
  import { OptionsApi } from './OptionsApi';
42
+ import { ActionColumnApi } from './ActionColumnApi';
43
+ import { ActionRowApi } from './ActionRowApi';
43
44
  /**
44
45
  *
45
46
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -48,9 +49,13 @@ import { OptionsApi } from './OptionsApi';
48
49
  */
49
50
  export interface AdaptableApi {
50
51
  /**
51
- * Provides access to Action Rows and Columns
52
+ * Provides access to Action Columns
52
53
  */
53
- actionApi: ActionApi;
54
+ actionColumnApi: ActionColumnApi;
55
+ /**
56
+ * Provides access to Action Rows
57
+ */
58
+ actionRowApi: ActionRowApi;
54
59
  /**
55
60
  * Provides access to the Alert Module
56
61
  */
@@ -160,9 +165,9 @@ export interface AdaptableApi {
160
165
  */
161
166
  queryApi: QueryApi;
162
167
  /**
163
- * Manages AdapTableQL (Query Language)
168
+ * Manages AdapTableQL Expressions
164
169
  */
165
- queryLanguageApi: QueryLanguageApi;
170
+ expressionApi: ExpressionApi;
166
171
  /**
167
172
  * Provides access to the Quick Search Module
168
173
  */
@@ -1,10 +1,6 @@
1
- import { AdaptableAlertAction, AlertButton, AlertDefinition, AlertState } from '../PredefinedConfig/AlertState';
2
- import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
3
- import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
4
- import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
1
+ import { AlertDefinition, AlertState } from '../PredefinedConfig/AlertState';
5
2
  import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
6
- import { AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
7
- import { AdaptableMessageType, AlertFormContext, AlertProperties, GridDataChangedInfo } from '../types';
3
+ import { AdaptableMessageType, AlertProperties } from '../types';
8
4
  import { AdaptableObjectLookupCriteria } from '../PredefinedConfig/Common/AdaptableObject';
9
5
  /**
10
6
  * Provides run-time access to Alert function and associated State
@@ -83,13 +79,6 @@ export interface AlertApi {
83
79
  * @param alertLookupCriteria lookup criteria
84
80
  */
85
81
  findAlertDefinitions(alertLookupCriteria: AdaptableObjectLookupCriteria): AlertDefinition[];
86
- /**
87
- * Displays given Alert as a Popup
88
- * @param alertToDisplay the Alert to show as a Popup
89
- *
90
- * @deprecated use `showAdaptableAlertAsToast()` instead
91
- */
92
- displayMessageAlertPopup(alertToDisplay: AdaptableAlert): void;
93
82
  /**
94
83
  * Displays given Alert as a Toast
95
84
  * @param alert the Alert to show as a Toast
@@ -130,102 +119,4 @@ export interface AlertApi {
130
119
  * @param alertMessage Main message of the alert
131
120
  */
132
121
  showAlertError(alertHeader: string, alertMessage: string): Promise<void>;
133
- /****
134
- * TO BE REMOVED
135
- */
136
- /**
137
- * @deprecated use `openAlertSettingsPanel` instead
138
- */
139
- showAlertPopup(): void;
140
- /**
141
- * @deprecated use `showAdaptableAlert()` instead
142
- */
143
- displayAlert(alert: AdaptableAlert): Promise<void>;
144
- /**
145
- * @deprecated internal method, will be removed in next major release
146
- */
147
- getNonReactiveAlertDefinitions(): AlertDefinition[];
148
- /**
149
- * @deprecated internal method, will be removed in next major release
150
- */
151
- getActiveNonReactiveAlertDefinitions(): AlertDefinition[];
152
- /**
153
- * @deprecated internal method, will be removed in next major release
154
- */
155
- getReactiveAlertDefinitions(): AlertDefinition[];
156
- /**
157
- * @deprecated internal method, will be removed in next major release
158
- */
159
- getActiveReactiveAlertDefinitions(): AlertDefinition[];
160
- /**
161
- * @deprecated internal method, will be removed in next major release
162
- */
163
- getAlertDefinitionsWithPreventEdit(): AlertDefinition[];
164
- /**
165
- * @deprecated internal method, will be removed in next major release
166
- */
167
- getAlertDefinitionsWithAllowEdit(): AlertDefinition[];
168
- /**
169
- * @deprecated internal method, will be removed in next major release
170
- */
171
- publishAlertFiredEvent(alertToFire: AdaptableAlert): void;
172
- /**
173
- * @deprecated internal method, will be removed in next major release
174
- */
175
- executeAlertButton(button: AlertButton<AlertFormContext>, context: AlertFormContext): void;
176
- /**
177
- * @deprecated internal method, will be removed in next major release
178
- */
179
- executeAlertAction(actionName: AdaptableAlertAction | string, details: {
180
- alertDefinition: AlertDefinition;
181
- cellDataChangedInfo?: CellDataChangedInfo;
182
- gridDataChangedInfo?: GridDataChangedInfo;
183
- formData?: AdaptableFormData;
184
- }): void;
185
- /**
186
- * @deprecated internal method, will be removed in next major release
187
- */
188
- getAlertPredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
189
- /**
190
- * @deprecated internal method, will be removed in next major release
191
- */
192
- getAlertDescription(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
193
- /**
194
- * @deprecated internal method, will be removed in next major release
195
- */
196
- getAlertMessageHeader(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
197
- /**
198
- * @deprecated internal method, will be removed in next major release
199
- */
200
- getCustomAlertDescription(alertDefinition: AlertDefinition, dataChangedInfo?: {
201
- cellDataChangedInfo?: CellDataChangedInfo;
202
- gridDataChangedInfo?: GridDataChangedInfo;
203
- }): string;
204
- /**
205
- * @deprecated internal method, will be removed in next major release
206
- */
207
- getCustomAlertMessageHeader(alertDefinition: AlertDefinition, dataChangedInfo?: {
208
- cellDataChangedInfo?: CellDataChangedInfo;
209
- gridDataChangedInfo?: GridDataChangedInfo;
210
- }): string;
211
- /**
212
- * @deprecated internal method, will be removed in next major release
213
- */
214
- getAlertRuleDescription(alertDefinition: AlertDefinition): string;
215
- /***
216
- * @deprecated internal method, will be removed in next major release
217
- */
218
- isCellChangedAdaptableAlert(alert: AdaptableAlert): boolean;
219
- /**
220
- * @deprecated internal method, will be removed in next major release
221
- */
222
- isRowChangedAdaptableAlert(alert: AdaptableAlert): boolean;
223
- /**
224
- * @deprecated internal method, will be removed in next major release
225
- */
226
- isGenericAdaptableAlert(alert: AdaptableAlert): boolean;
227
- /**
228
- * @deprecated internal method, will be removed in next major release
229
- */
230
- getAlertTypeForAdaptableAlert(alert: AdaptableAlert): 'cellChanged' | 'rowChanged' | 'generic';
231
122
  }
@@ -21,11 +21,4 @@ export interface BulkUpdateApi {
21
21
  * @param bulkUpdateValue the value to use in Bulk Update Operation
22
22
  */
23
23
  setBulkUpdateValue(bulkUpdateValue: string): void;
24
- /**
25
- * TO BE REMOVED
26
- */
27
- /**
28
- * @deprecated use `openBulkUpdateSettingsPanel` instead
29
- */
30
- showBulkUpdatePopup(): void;
31
24
  }
@@ -54,35 +54,4 @@ export interface CalculatedColumnApi {
54
54
  * @param columnId column ID of the aggregated CalculatedColumn
55
55
  */
56
56
  refreshAggregatedCalculatedColumn(columnId: string): void;
57
- /**
58
- * TO BE REMOVED
59
- */
60
- /**
61
- * @deprecated use `openCalculatedColumnSettingsPanel` instead
62
- */
63
- showCalculatedColumnPopup(): void;
64
- /**
65
- * @deprecated use `getCalculatedColumns()` instead
66
- */
67
- getAllCalculatedColumn(): CalculatedColumn[];
68
- /***
69
- * @deprecated internal method, will be removed in next major release
70
- */
71
- editCalculatedColumns(calcColumns: CalculatedColumn[]): CalculatedColumn[];
72
- /**
73
- * @deprecated internal method, will be removed in next major release
74
- */
75
- getCalculatedColumnModuleReferences(calculatedColumn: CalculatedColumn): string[];
76
- /**
77
- * @deprecated internal method, will be removed in next major release
78
- */
79
- getCalculatedColumnsReferencingColumnId(columnId: string): CalculatedColumn[];
80
- /**
81
- * @deprecated internal method, will be removed in next major release
82
- */
83
- getReferencedColumnIdsForCalculatedColumn(calculatedColumn: CalculatedColumn): string[];
84
- /**
85
- * @deprecated internal method, will be removed in next major release
86
- */
87
- getReferencedColumnIdsForCalculatedColumnId(calculatedColumnId: string): string[];
88
57
  }