@adaptabletools/adaptable 16.0.0-canary.2 → 16.0.0-canary.4

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 (189) hide show
  1. package/README.md +2 -0
  2. package/base.css +62 -54
  3. package/base.css.map +1 -1
  4. package/bundle.cjs.js +159 -159
  5. package/index.css +82 -70
  6. package/index.css.map +1 -1
  7. package/package.json +10 -2
  8. package/publishTimestamp.d.ts +1 -1
  9. package/publishTimestamp.js +1 -1
  10. package/src/AdaptableInterfaces/IAdaptable.d.ts +5 -1
  11. package/src/AdaptableOptions/ActionRowOptions.d.ts +8 -5
  12. package/src/AdaptableOptions/AdaptableOptions.d.ts +9 -4
  13. package/src/AdaptableOptions/ColumnOptions.d.ts +1 -10
  14. package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts +6 -2
  15. package/src/AdaptableOptions/Fdc3Options.d.ts +150 -0
  16. package/src/AdaptableOptions/Fdc3Options.js +5 -0
  17. package/src/AdaptableOptions/FilterOptions.d.ts +1 -0
  18. package/src/AdaptableOptions/FinancePluginOptions.d.ts +9 -9
  19. package/src/AdaptableOptions/FormatColumnOptions.d.ts +7 -7
  20. package/src/AdaptableOptions/GroupingOptions.d.ts +6 -11
  21. package/src/AdaptableOptions/OpenFinPluginOptions.d.ts +1 -1
  22. package/src/AdaptableOptions/QuickSearchOptions.d.ts +1 -1
  23. package/src/AdaptableOptions/TeamSharingOptions.d.ts +5 -0
  24. package/src/AdaptableOptions/UserInterfaceOptions.d.ts +21 -11
  25. package/src/Api/AdaptableApi.d.ts +7 -2
  26. package/src/Api/ColumnApi.d.ts +18 -7
  27. package/src/Api/DataChangeHistoryApi.d.ts +6 -0
  28. package/src/Api/EventApi.d.ts +22 -9
  29. package/src/Api/Events/ChexboxColumnClicked.d.ts +1 -0
  30. package/src/Api/Events/ScheduleTriggered.d.ts +11 -0
  31. package/src/Api/Events/ThemeChanged.d.ts +0 -6
  32. package/src/Api/Events/ThemeEdited.d.ts +11 -0
  33. package/src/Api/Events/ThemeEdited.js +2 -0
  34. package/src/Api/Fdc3Api.d.ts +83 -0
  35. package/src/Api/Fdc3Api.js +2 -0
  36. package/src/Api/FinanceApi.d.ts +12 -12
  37. package/src/Api/Implementation/ActionRowApiImpl.js +7 -5
  38. package/src/Api/Implementation/AdaptableApiImpl.d.ts +2 -0
  39. package/src/Api/Implementation/AdaptableApiImpl.js +3 -0
  40. package/src/Api/Implementation/ApiBase.d.ts +4 -0
  41. package/src/Api/Implementation/ApiBase.js +6 -0
  42. package/src/Api/Implementation/ChartingApiImpl.d.ts +1 -0
  43. package/src/Api/Implementation/ChartingApiImpl.js +4 -0
  44. package/src/Api/Implementation/ColumnApiImpl.d.ts +4 -1
  45. package/src/Api/Implementation/ColumnApiImpl.js +22 -3
  46. package/src/Api/Implementation/DataChangeHistoryApiImpl.d.ts +1 -0
  47. package/src/Api/Implementation/DataChangeHistoryApiImpl.js +3 -0
  48. package/src/Api/Implementation/Fdc3ApiImpl.d.ts +26 -0
  49. package/src/Api/Implementation/Fdc3ApiImpl.js +79 -0
  50. package/src/Api/Implementation/OptionsApiImpl.d.ts +2 -0
  51. package/src/Api/Implementation/OptionsApiImpl.js +3 -0
  52. package/src/Api/Implementation/PredicateApiImpl.d.ts +5 -5
  53. package/src/Api/Implementation/PredicateApiImpl.js +8 -8
  54. package/src/Api/Implementation/QuickSearchApiImpl.d.ts +2 -0
  55. package/src/Api/Implementation/QuickSearchApiImpl.js +7 -0
  56. package/src/Api/Implementation/ScheduleApiImpl.d.ts +4 -0
  57. package/src/Api/Implementation/ScheduleApiImpl.js +5 -0
  58. package/src/Api/Implementation/StyledColumnApiImpl.d.ts +0 -3
  59. package/src/Api/Implementation/StyledColumnApiImpl.js +0 -26
  60. package/src/Api/Implementation/UserInterfaceApiImpl.d.ts +5 -4
  61. package/src/Api/Implementation/UserInterfaceApiImpl.js +5 -0
  62. package/src/Api/Internal/AdaptableInternalApi.d.ts +5 -3
  63. package/src/Api/Internal/AdaptableInternalApi.js +18 -12
  64. package/src/Api/Internal/AlertInternalApi.js +7 -2
  65. package/src/Api/Internal/Fdc3InternalApi.d.ts +11 -0
  66. package/src/Api/Internal/Fdc3InternalApi.js +72 -0
  67. package/src/Api/Internal/FilterInternalApi.js +8 -4
  68. package/src/Api/Internal/FormatColumnInternalApi.js +11 -13
  69. package/src/Api/Internal/ScheduleInternalApi.d.ts +8 -0
  70. package/src/Api/Internal/ScheduleInternalApi.js +20 -0
  71. package/src/Api/Internal/StyledColumnInternalApi.d.ts +5 -2
  72. package/src/Api/Internal/StyledColumnInternalApi.js +29 -2
  73. package/src/Api/Internal/UserInterfaceInternalApi.d.ts +5 -0
  74. package/src/Api/Internal/UserInterfaceInternalApi.js +18 -0
  75. package/src/Api/OptionsApi.d.ts +6 -1
  76. package/src/Api/PredicateApi.d.ts +5 -5
  77. package/src/Api/QuickSearchApi.d.ts +8 -0
  78. package/src/Api/StyledColumnApi.d.ts +0 -14
  79. package/src/PredefinedConfig/Common/AdaptableColumn.d.ts +1 -1
  80. package/src/PredefinedConfig/Common/AdaptableIcon.d.ts +7 -7
  81. package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts +8 -15
  82. package/src/PredefinedConfig/Common/AdaptablePredicate.js +65 -41
  83. package/src/PredefinedConfig/Common/{FDC3Context.d.ts → FDC3Context_DEPR.d.ts} +19 -19
  84. package/src/PredefinedConfig/Common/FDC3Context_DEPR.js +2 -0
  85. package/src/PredefinedConfig/Common/Fdc3Context.d.ts +53 -0
  86. package/src/PredefinedConfig/Common/Fdc3Context.js +35 -0
  87. package/src/PredefinedConfig/Common/Fdc3Intent.d.ts +68 -0
  88. package/src/PredefinedConfig/Common/Fdc3Intent.js +75 -0
  89. package/src/PredefinedConfig/Common/Types.d.ts +2 -2
  90. package/src/PredefinedConfig/StyledColumnState.d.ts +3 -2
  91. package/src/PredefinedConfig/SystemState.d.ts +3 -0
  92. package/src/PredefinedConfig/TeamSharingState.d.ts +1 -1
  93. package/src/Redux/ActionsReducers/SystemRedux.d.ts +17 -6
  94. package/src/Redux/ActionsReducers/SystemRedux.js +33 -3
  95. package/src/Redux/Store/AdaptableStore.js +3 -4
  96. package/src/Strategy/AdaptableModuleBase.d.ts +6 -6
  97. package/src/Strategy/Fdc3Module.d.ts +13 -0
  98. package/src/Strategy/Fdc3Module.js +85 -0
  99. package/src/Strategy/FlashingCellModule.js +6 -2
  100. package/src/Strategy/Interface/IModule.d.ts +2 -2
  101. package/src/Strategy/ScheduleModule.js +3 -2
  102. package/src/Strategy/StyledColumnModule.js +24 -15
  103. package/src/Utilities/Constants/DocumentationLinkConstants.js +1 -1
  104. package/src/Utilities/Constants/ModuleConstants.d.ts +3 -0
  105. package/src/Utilities/Constants/ModuleConstants.js +5 -2
  106. package/src/Utilities/Defaults/DefaultAdaptableOptions.js +9 -3
  107. package/src/Utilities/MenuItem.d.ts +4 -4
  108. package/src/Utilities/Services/Fdc3Service.d.ts +20 -0
  109. package/src/Utilities/Services/Fdc3Service.js +87 -0
  110. package/src/Utilities/Services/MetamodelService.js +5 -1
  111. package/src/Utilities/Services/ModuleService.js +1 -1
  112. package/src/Utilities/Services/QueryLanguageService.js +1 -1
  113. package/src/Utilities/Services/RowEditService.js +1 -1
  114. package/src/Utilities/Services/TeamSharingService.d.ts +2 -0
  115. package/src/Utilities/Services/TeamSharingService.js +60 -3
  116. package/src/Utilities/Services/ValidationService.js +6 -2
  117. package/src/View/AdaptableView.js +9 -7
  118. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/AdaptableConfig.d.ts +9 -0
  119. package/src/View/Charting/useChartingElements.js +1 -1
  120. package/src/View/Components/AdaptableButton/index.d.ts +3 -0
  121. package/src/View/Components/AdaptableButton/index.js +18 -0
  122. package/src/View/Components/AdaptableIconComponent/index.d.ts +7 -0
  123. package/src/View/Components/AdaptableIconComponent/index.js +16 -0
  124. package/src/View/Components/AdaptableIconComponent/useCustomIcon.d.ts +2 -0
  125. package/src/View/Components/AdaptableIconComponent/useCustomIcon.js +12 -0
  126. package/src/{components → View/Components}/Badge/index.d.ts +1 -1
  127. package/src/{components → View/Components}/Badge/index.js +1 -1
  128. package/src/View/Components/FilterForm/FilterForm.js +1 -1
  129. package/src/View/Components/FilterForm/ListBoxMenu.js +2 -2
  130. package/src/View/Components/FilterForm/QuickFilterForm.js +3 -2
  131. package/src/View/Components/Panels/PanelWithButton.d.ts +2 -2
  132. package/src/View/Components/Panels/PanelWithImage.d.ts +3 -3
  133. package/src/View/Components/Popups/AdaptablePopup/Navigation.js +1 -1
  134. package/src/View/Components/Popups/AdaptablePopup/TopBar.js +2 -3
  135. package/src/View/Components/Popups/AdaptablePopupAlert.js +1 -1
  136. package/src/View/Components/PredicateEditor/PredicateEditor.js +4 -4
  137. package/src/View/Dashboard/CustomToolbarWrapper.js +2 -2
  138. package/src/View/Dashboard/Dashboard.js +3 -3
  139. package/src/View/DataChangeHistory/DataChangeHistoryGrid.d.ts +1 -0
  140. package/src/View/DataChangeHistory/DataChangeHistoryGrid.js +13 -7
  141. package/src/View/DataChangeHistory/DataChangeHistoryPopup.js +7 -1
  142. package/src/View/DataChangeHistory/buildActionColumnButton.d.ts +1 -1
  143. package/src/View/DataChangeHistory/buildActionColumnButton.js +9 -2
  144. package/src/View/FormatColumn/Wizard/FormatColumnSettingsWizardSection.js +1 -1
  145. package/src/View/QuickSearch/FloatingQuickSearch/FloatingQuickSearch.d.ts +2 -0
  146. package/src/View/QuickSearch/FloatingQuickSearch/FloatingQuickSearch.js +26 -0
  147. package/src/View/QuickSearch/QuickSearchInput.d.ts +6 -0
  148. package/src/View/QuickSearch/QuickSearchInput.js +22 -0
  149. package/src/View/QuickSearch/QuickSearchViewPanel.d.ts +2 -5
  150. package/src/View/QuickSearch/QuickSearchViewPanel.js +5 -19
  151. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsReminder.js +2 -2
  152. package/src/View/StyledColumn/Wizard/StyledColumnBadgeSection.js +2 -2
  153. package/src/View/StyledColumn/Wizard/StyledColumnWizardColumnSection.js +1 -5
  154. package/src/View/StyledColumn/Wizard/StyledColumnWizardStyleSection/Components/StyledColumnBadgePreview.js +2 -9
  155. package/src/View/StyledColumn/Wizard/StyledColumnWizardTypeSection.js +0 -1
  156. package/src/View/UIHelper.d.ts +2 -2
  157. package/src/agGrid/ActionColumnRenderer.d.ts +0 -2
  158. package/src/agGrid/ActionColumnRenderer.js +21 -6
  159. package/src/agGrid/Adaptable.d.ts +7 -2
  160. package/src/agGrid/Adaptable.js +82 -37
  161. package/src/agGrid/BadgeRenderer.js +19 -20
  162. package/src/agGrid/CheckboxRenderer.js +1 -1
  163. package/src/agGrid/agGridHelper.js +4 -0
  164. package/src/agGrid/agGridMenuHelper.js +11 -4
  165. package/src/agGrid/attachAddaptableColumnTypes.d.ts +1 -0
  166. package/src/agGrid/attachAddaptableColumnTypes.js +5 -4
  167. package/src/agGrid/editors/AdaptableNumberEditor/index.js +1 -1
  168. package/src/components/Drawer/index.d.ts +6 -0
  169. package/src/components/Drawer/index.js +60 -0
  170. package/src/components/ExpressionEditor/index.js +4 -2
  171. package/src/components/Icon/index.d.ts +11 -0
  172. package/src/components/{AdaptableIconComponent → Icon}/index.js +10 -10
  173. package/src/components/IconSelector/IconSelector.js +3 -3
  174. package/src/components/SimpleButton/index.js +10 -10
  175. package/src/components/Toggle/Toggle.d.ts +2 -2
  176. package/src/components/Toggle/Toggle.js +2 -2
  177. package/src/components/icons/fdc3.d.ts +3 -0
  178. package/src/components/icons/fdc3.js +9 -0
  179. package/src/components/icons/index.d.ts +4 -4
  180. package/src/components/icons/index.js +9 -7
  181. package/src/metamodel/adaptable.metamodel.d.ts +117 -47
  182. package/src/metamodel/adaptable.metamodel.js +1 -1
  183. package/src/types.d.ts +9 -5
  184. package/version.d.ts +1 -1
  185. package/version.js +1 -1
  186. package/src/View/Components/AdaptableViewIcon/index.d.ts +0 -10
  187. package/src/View/Components/AdaptableViewIcon/index.js +0 -18
  188. package/src/components/AdaptableIconComponent/index.d.ts +0 -11
  189. /package/src/{PredefinedConfig/Common/FDC3Context.js → Api/Events/ScheduleTriggered.js} +0 -0
@@ -0,0 +1,150 @@
1
+ import { ChartContext, ChatInitSettingsContext, ContactContext, ContactListContext, CountryContext, CurrencyContext, EmailContext, Fdc3Context, Fdc3ContextType, InstrumentContext, InstrumentListContext, OrganizationContext, PortfolioContext, PositionContext, TimeRangeContext, ValuationContext } from '../PredefinedConfig/Common/Fdc3Context';
2
+ import { BaseContext } from '../PredefinedConfig/Common/BaseContext';
3
+ import { IRowNode } from '@ag-grid-community/core';
4
+ import { Context, ContextMetadata, IntentResult } from '@finos/fdc3';
5
+ import { CompatibleContext, Fdc3IntentType } from '../PredefinedConfig/Common/Fdc3Intent';
6
+ /**
7
+ * Options for configuring FDC3 in AdapTable
8
+ */
9
+ export interface Fdc3Options {
10
+ /**
11
+ * Enable FDC3 in AdapTable
12
+ *
13
+ * @defaultValue false
14
+ */
15
+ enableFdc3?: boolean;
16
+ /**
17
+ * Enable logging of message exchanges in the Console
18
+ *
19
+ * @defaultValue false
20
+ */
21
+ enableLogging?: boolean;
22
+ /**
23
+ * Maps the Context Type to the AdapTable Grid Data
24
+ */
25
+ gridDataContextMapping?: GridDataContextMapping;
26
+ /**
27
+ * Builds the Context Data (useful for postprocessing the Context Data mapped from the grid data)
28
+ */
29
+ resolveContextData?: (context: ResolveContextDataContext) => Fdc3Context;
30
+ /**
31
+ * Configures the Intents that AdaptTable will listen for and raise
32
+ */
33
+ intents?: {
34
+ /**
35
+ * Subscribe to the given Intent(s)
36
+ */
37
+ listensFor?: Fdc3IntentType[];
38
+ /**
39
+ * Raises the given Intent(s) on various Grid Actions
40
+ */
41
+ raises?: {
42
+ [K in Fdc3IntentType]?: RaiseIntentConfig<K>[];
43
+ };
44
+ };
45
+ /**
46
+ * Configures the Contexts that AdaptTable will listen for and broadcast
47
+ */
48
+ contexts?: {
49
+ /**
50
+ * Subscribe to the given Context(s)
51
+ */
52
+ listensFor?: Fdc3ContextType[];
53
+ /**
54
+ * Broadcasts the given Context(s) on various Grid Actions
55
+ */
56
+ broadcasts?: {
57
+ [K in Fdc3ContextType]?: BroadcastConfig;
58
+ };
59
+ };
60
+ /**
61
+ * Handles incoming Intents from the Desktop Agent
62
+ */
63
+ handleIntent?: (context: HandleFdc3Context) => Promise<IntentResult> | void;
64
+ /**
65
+ * Handles incoming Contexts from the Desktop Agent
66
+ */
67
+ handleContext?: (context: HandleFdc3Context) => void;
68
+ }
69
+ /**
70
+ * Context used when resolving FDC3 Context Data
71
+ */
72
+ export interface ResolveContextDataContext extends BaseContext {
73
+ /**
74
+ * The FDC3 Context Type
75
+ */
76
+ contextType: Fdc3ContextType;
77
+ /**
78
+ * The FDC3 Context Data which has been mapped from the grid data based on the given configuration in `gridDataContextMapping`
79
+ */
80
+ contextMappedFromGridData?: Fdc3Context;
81
+ /**
82
+ * The row node which is the source of the context data
83
+ */
84
+ rowNode?: IRowNode;
85
+ /**
86
+ * The row data which is the source of the context data
87
+ */
88
+ rowData?: any;
89
+ }
90
+ /**
91
+ * Context used when handling incoming FDC3 messages
92
+ */
93
+ export interface HandleFdc3Context extends BaseContext {
94
+ /**
95
+ * The FDC3 Context
96
+ */
97
+ context: Context;
98
+ /**
99
+ * The FDC3 Context Metadata related to the context
100
+ */
101
+ metadata?: ContextMetadata;
102
+ }
103
+ /**
104
+ * Mapping of FDC3 Context Types to Grid Data/Columns
105
+ */
106
+ export interface GridDataContextMapping {
107
+ 'fdc3.chart'?: Fdc3ContentMapping<ChartContext>;
108
+ 'fdc3.chat.initSettings'?: Fdc3ContentMapping<ChatInitSettingsContext>;
109
+ 'fdc3.contact'?: Fdc3ContentMapping<ContactContext>;
110
+ 'fdc3.contactList'?: Fdc3ContentMapping<ContactListContext>;
111
+ 'fdc3.country'?: Fdc3ContentMapping<CountryContext>;
112
+ 'fdc3.currency'?: Fdc3ContentMapping<CurrencyContext>;
113
+ 'fdc3.email'?: Fdc3ContentMapping<EmailContext>;
114
+ 'fdc3.instrument'?: Fdc3ContentMapping<InstrumentContext>;
115
+ 'fdc3.instrumentList'?: Fdc3ContentMapping<InstrumentListContext>;
116
+ 'fdc3.organization'?: Fdc3ContentMapping<OrganizationContext>;
117
+ 'fdc3.portfolio'?: Fdc3ContentMapping<PortfolioContext>;
118
+ 'fdc3.position'?: Fdc3ContentMapping<PositionContext>;
119
+ 'fdc3.timerange'?: Fdc3ContentMapping<TimeRangeContext>;
120
+ 'fdc3.valuation'?: Fdc3ContentMapping<ValuationContext>;
121
+ }
122
+ export declare const ColumnRefTypePrefix = "_colId.";
123
+ export declare const FieldRefTypePrefix = "_field.";
124
+ export declare type GridDataRef = `_colId.${string}` | `_field.${string}`;
125
+ export declare type Fdc3ContentMapping<T> = PropertiesToGridRefs<Omit<T, 'type'>>;
126
+ export interface RaiseIntentConfig<K extends Fdc3IntentType> {
127
+ type: CompatibleContext<K>;
128
+ contextMenu?: {
129
+ columnIds: string[];
130
+ };
131
+ actionButton?: {
132
+ actionColumnId: string;
133
+ };
134
+ }
135
+ export interface BroadcastConfig {
136
+ contextMenu?: {
137
+ columnIds: string[];
138
+ };
139
+ actionButton?: {
140
+ columnId: string;
141
+ };
142
+ }
143
+ /**
144
+ * TypeScript magic to convert all non-string property types to string (but keep the object structures), incl. nested objects.
145
+ */
146
+ declare type PropertiesToGridRefs<Type> = Type extends object ? ReplaceTypes<Type> : Type extends string ? GridDataRef : Type extends Date ? GridDataRef : Type;
147
+ declare type ReplaceTypes<ObjType extends object> = {
148
+ [KeyType in keyof ObjType]: PropertiesToGridRefs<ObjType[KeyType]>;
149
+ };
150
+ export {};
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.FieldRefTypePrefix = exports.ColumnRefTypePrefix = void 0;
4
+ exports.ColumnRefTypePrefix = '_colId.';
5
+ exports.FieldRefTypePrefix = '_field.';
@@ -155,6 +155,7 @@ export interface FilterOptions<TData = any> {
155
155
  * @noCodeItem
156
156
  */
157
157
  showQuickFilter?: boolean;
158
+ filterUsingTime?: boolean;
158
159
  /**
159
160
  * Display only currently filtered distinct values in Filter controls
160
161
  *
@@ -1,5 +1,5 @@
1
- import { AdaptableApi, AdaptableIcon, ContextMenuContext, FDC3Context, GridCell } from '../../types';
2
- import { CustomFDC3Context } from '../PredefinedConfig/Common/FDC3Context';
1
+ import { AdaptableApi, AdaptableIcon, ContextMenuContext, FDC3Context_DEPR, GridCell } from '../../types';
2
+ import { CustomFDC3Context } from '../PredefinedConfig/Common/FDC3Context_DEPR';
3
3
  /**
4
4
  * Options required for when using the Finance plugin
5
5
  */
@@ -50,11 +50,11 @@ export interface FinancePluginOptions {
50
50
  /**
51
51
  * Called when an intent from `availableIntents` is raised.
52
52
  */
53
- onFDC3Intent?: (intent: FDC3Intent | CustomFDC3Intent, context: FDC3Context, adaptableApi: AdaptableApi) => void;
53
+ onFDC3Intent?: (intent: FDC3Intent | CustomFDC3Intent, context: FDC3Context_DEPR, adaptableApi: AdaptableApi) => void;
54
54
  /**
55
55
  * Called when a context changes.
56
56
  */
57
- onFDC3Context?: (context: FDC3Context, adaptableApi: AdaptableApi) => void;
57
+ onFDC3Context?: (context: FDC3Context_DEPR, adaptableApi: AdaptableApi) => void;
58
58
  }
59
59
  /**
60
60
  * An FDC3 Column - will raise FDC3 intents and broadcast FDC3 messages
@@ -280,7 +280,7 @@ export interface RaiseFDC3IntentContext extends ContextMenuContext {
280
280
  /**
281
281
  * Function that handles FDC3 Context
282
282
  */
283
- export declare type FDC3ContextHandler = (context: FDC3Context) => void;
283
+ export declare type FDC3ContextHandler = (context: FDC3Context_DEPR) => void;
284
284
  /**
285
285
  * Defines a Desktop Agent which supports FDC3
286
286
  */
@@ -288,19 +288,19 @@ export interface FDC3DesktopAgent {
288
288
  /**
289
289
  * Raises an Intent
290
290
  */
291
- raiseIntent: (intent: FDC3Intent, context: FDC3Context) => void;
291
+ raiseIntent: (intent: FDC3Intent, context: FDC3Context_DEPR) => void;
292
292
  /**
293
293
  * Broadcasts an FDC3 Message
294
294
  */
295
- broadcast: (context: FDC3Context) => void;
295
+ broadcast: (context: FDC3Context_DEPR) => void;
296
296
  /**
297
297
  * Raises an FDC3 Intent for a given Context
298
298
  */
299
- raiseIntentForContext: (context: FDC3Context) => void;
299
+ raiseIntentForContext: (context: FDC3Context_DEPR) => void;
300
300
  /**
301
301
  * Adds an FDC3 Intent Listener
302
302
  */
303
- addIntentListener: (intent: FDC3Intent | CustomFDC3Intent, listener: (context: FDC3Context) => void) => void;
303
+ addIntentListener: (intent: FDC3Intent | CustomFDC3Intent, listener: (context: FDC3Context_DEPR) => void) => void;
304
304
  /**
305
305
  * Adds an FDC3 Context Listener
306
306
  */
@@ -3,32 +3,32 @@ import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
3
3
  import { BaseContext } from '../../types';
4
4
  import { IRowNode } from '@ag-grid-community/core';
5
5
  /**
6
- * Options for managing the Format Column Module
6
+ * Provides Custom Formats used in Format Column Module
7
7
  */
8
8
  export interface FormatColumnOptions {
9
9
  /**
10
- * Custom Formatters to use in the Format Column Module
10
+ * Custom Formatters to use in Format Column Module
11
11
  */
12
12
  customDisplayFormatters?: CustomDisplayFormatter[];
13
13
  }
14
14
  /**
15
- * Provides Custom Display Formats
15
+ * Defines a Custom Display Format
16
16
  */
17
17
  export interface CustomDisplayFormatter {
18
18
  /**
19
- * Id of the Formatted
19
+ * Format Id
20
20
  */
21
21
  id: string;
22
22
  /**
23
- * Description
23
+ * Format Description
24
24
  */
25
25
  label?: string;
26
26
  /**
27
- * Function used to perform the Custom Display Format
27
+ * Function used to render Custom Display Format
28
28
  */
29
29
  handler: (customDisplayFormatterContext: CustomDisplayFormatterContext) => any;
30
30
  /**
31
- * Where the Custom Display Format can be applied
31
+ * Where Custom Display Format can be applied
32
32
  */
33
33
  scope: AdaptableScope;
34
34
  }
@@ -21,19 +21,14 @@ export interface GroupingOptions<TData = any> {
21
21
  * @noCodeItem
22
22
  */
23
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
24
  /**
34
- * AG Grid's Key Creator Params
25
+ * Order Row Grouped Columns automatically, using Adaptable State if available (Custom or Column Sort)
26
+ *
27
+ * @defaultValue true
28
+ * @gridInfoItem
29
+ * @noCodeItem
35
30
  */
36
- params: KeyCreatorParams<TData>;
31
+ autoOrderGroupedColumns?: boolean;
37
32
  }
38
33
  /**
39
34
  * Context used when setting a value for Unbalanced Row Groups
@@ -1,5 +1,5 @@
1
1
  import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
2
- import { AdaptableFDC3EventInfo } from '../PredefinedConfig/Common/FDC3Context';
2
+ import { AdaptableFDC3EventInfo } from '../PredefinedConfig/Common/FDC3Context_DEPR';
3
3
  /**
4
4
  * Options required for when using the OpenFin plugin
5
5
  */
@@ -17,7 +17,7 @@ export interface QuickSearchOptions<TData = any> {
17
17
  */
18
18
  quickSearchPlaceholder?: string;
19
19
  /**
20
- * Clears saved searches when AdapTable loads
20
+ * Clears saved searches (and Queries) when AdapTable loads
21
21
  *
22
22
  * @defaultValue false
23
23
  * @gridInfoItem
@@ -49,6 +49,11 @@ export interface TeamSharingOptions {
49
49
  * @gridInfoItem
50
50
  */
51
51
  updateNotification?: 'Alert' | 'AlertWithNotification' | 'SystemStatus';
52
+ /**
53
+ * Whether to show update notification once per update
54
+ * @defaultValue false
55
+ */
56
+ showUpdateNotificationOncePerUpdate?: boolean;
52
57
  /**
53
58
  * Suppress warning when an Import overrides existing Config item
54
59
  *
@@ -23,34 +23,31 @@ export interface UserInterfaceOptions<TData = any> {
23
23
  */
24
24
  applicationIcon?: AdaptableIcon;
25
25
  /**
26
- * A map of custom icons that can be used in Adaptable objects (e.g. Badges).
26
+ * Bespoke icons that can be used in Adaptable (e.g. Badge Styles and Buttons)
27
27
  */
28
- customIcons?: {
29
- name: string;
30
- icon: AdaptableIcon;
31
- }[];
28
+ customIcons?: CustomIcon[];
32
29
  /**
33
30
  * Options for managing and customizing date inputs in AdapTable
34
31
  */
35
32
  dateInputOptions?: DateInputOptions;
36
33
  /**
37
- * List of values which are permitted (e.g. to show in Filter, Custom Sort etc.)
34
+ * List of Column values to display (e.g. in Filter, Custom Sort etc.)
38
35
  */
39
36
  permittedValues?: PermittedValues<TData>[];
40
37
  /**
41
- * Dropdown values displayed when column is being edited; when not defined defaults to permittedValues
38
+ * Dropdown values displayed when column is being edited
42
39
  */
43
40
  editLookUpItems?: EditLookUpPermittedValues<TData>[];
44
41
  /**
45
- * Custom column values for 'IN' filter; when not defined defaults to permittedValues
42
+ * Custom column values for Values ('IN') Filter
46
43
  */
47
44
  filterPermittedValues?: FilterPermittedValues<TData>[];
48
45
  /**
49
- * Custom column values for defining Custom Sort; when not defined defaults to permittedValues
46
+ * Custom column values for defining Custom Sort
50
47
  */
51
48
  customSortPermittedValues?: CustomSortPermittedValues<TData>[];
52
49
  /**
53
- * Custom column values for editing via bulk-update; when not defined defaults to permittedValues
50
+ * Custom column values for editing via bulk-update
54
51
  */
55
52
  bulkUpdatePermittedValues?: BulkUpdatePermittedValues<TData>[];
56
53
  /**
@@ -95,7 +92,7 @@ export interface UserInterfaceOptions<TData = any> {
95
92
  */
96
93
  showAdapTableVersion?: boolean;
97
94
  /**
98
- * English variant to use in UI labels
95
+ * English variant to use in AdapTable UI
99
96
  *
100
97
  * @defaultValue 'GB'
101
98
  * @gridInfoItem
@@ -222,3 +219,16 @@ export declare type GridInfoSection = 'GridSummary' | 'AdaptableOptions' | 'Colu
222
219
  */
223
220
  export interface ObjectTagsContext extends BaseContext {
224
221
  }
222
+ /**
223
+ * Defines a bespoke Icon provided by a developer
224
+ */
225
+ export interface CustomIcon {
226
+ /**
227
+ * Name of Icon
228
+ */
229
+ name: string;
230
+ /**
231
+ * AdapTable Icon definition
232
+ */
233
+ icon: AdaptableIcon;
234
+ }
@@ -41,6 +41,7 @@ import { StyledColumnApi } from './StyledColumnApi';
41
41
  import { OptionsApi } from './OptionsApi';
42
42
  import { ActionColumnApi } from './ActionColumnApi';
43
43
  import { ActionRowApi } from './ActionRowApi';
44
+ import { Fdc3Api } from './Fdc3Api';
44
45
  /**
45
46
  *
46
47
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -53,8 +54,8 @@ export interface AdaptableApi {
53
54
  */
54
55
  actionColumnApi: ActionColumnApi;
55
56
  /**
56
- * Provides access to Action Rows
57
- */
57
+ * Provides access to Action Rows
58
+ */
58
59
  actionRowApi: ActionRowApi;
59
60
  /**
60
61
  * Provides access to the Alert Module
@@ -220,6 +221,10 @@ export interface AdaptableApi {
220
221
  * Manages User Interface Options where colours, styles and permitted values are configured
221
222
  */
222
223
  userInterfaceApi: UserInterfaceApi;
224
+ /**
225
+ * Manages the FDC3 capabilities of AdapTable
226
+ */
227
+ fdc3Api: Fdc3Api;
223
228
  /**
224
229
  * Cleanup method - should be called only when using the vanilla javascript component, as framework components cleanup is performed when the component is destroyed/unmounted.
225
230
  * This destroys the Adaptable instance.
@@ -23,26 +23,32 @@ export interface ColumnApi {
23
23
  * Returns all string Columns
24
24
  */
25
25
  getStringColumns(): AdaptableColumn[];
26
+ /**
27
+ * Returns all string array Columns
28
+ */
29
+ getStringArrayColumns(): AdaptableColumn[];
26
30
  /**
27
31
  * Returns all boolean Columns
28
32
  */
29
33
  getBooleanColumns(): AdaptableColumn[];
30
34
  /**
31
- * Returns all number-array, tuple-number-array or object-number-array columns
35
+ * Returns all array columns (number, tuple-number, object-number & string)
32
36
  */
33
37
  getArrayColumns(): AdaptableColumn[];
38
+ /**
39
+ * Returns all numeric array columns (number, tuple-number, object-number)
40
+ */
41
+ getNumericArrayColumns(): AdaptableColumn[];
34
42
  /**
35
43
  * Returns all number-array columns
36
44
  */
37
45
  getNumberArrayColumns(): AdaptableColumn[];
38
46
  /**
39
- * Returns all tuple-number-array columns
40
- * e.g. [[1, 2], [3, 4]]
47
+ * Returns all tuple-number-array columns e.g. [[1,2],[3,4]]
41
48
  */
42
49
  getTupleNumberArrayColumns(): AdaptableColumn[];
43
50
  /**
44
- * Returns all object-number-array columns
45
- * e.g. [{x : 1, y : 2}, {x : 3, y : 4}]
51
+ * Returns all object-number-array columns e.g. [{x:1,y:2},{x:3,y:4}]
46
52
  */
47
53
  getObjectNumberArrayColumns(): AdaptableColumn[];
48
54
  /**
@@ -172,10 +178,15 @@ export interface ColumnApi {
172
178
  */
173
179
  hasDateDataType(columnId: string): boolean;
174
180
  /**
175
- * Checks if the Column with the given `columnId` has an Array-like DataType (`NumberArray`,`TupleNumberArray` or `ObjectNumberArray`)
181
+ * Checks if the Column with the given `columnId` has an Numeric Array-like DataType (`NumberArray`,`TupleNumberArray` or `ObjectNumberArray`)
182
+ * @param columnId Column ID
183
+ */
184
+ hasNumericArrayDataType(columnId: string): boolean;
185
+ /**
186
+ * Checks if the Column with the given `columnId` has a String Array-like DataType (`StringArray`)
176
187
  * @param columnId Column ID
177
188
  */
178
- hasArrayDataType(columnId: string): boolean;
189
+ hasStringArrayDataType(columnId: string): boolean;
179
190
  /**
180
191
  * Returns Data Type for the Column with given ColumnId
181
192
  * @param columnId Column to check
@@ -31,6 +31,12 @@ export interface DataChangeHistoryApi {
31
31
  * @param dataChangeInfo the change to be undone
32
32
  */
33
33
  undoDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): void;
34
+ /**
35
+ * Clears a Row in Data Change Grid
36
+ *
37
+ * @param dataChangeInfo the change to be undone
38
+ */
39
+ clearDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): void;
34
40
  /**
35
41
  * Opens Data Change History panel
36
42
  */
@@ -1,6 +1,4 @@
1
- import { AdaptableFDC3EventInfo, SelectionChangedInfo, LiveDataChangedInfo, DashboardChangedInfo, ThemeChangedInfo, AlertFiredInfo, LayoutChangedInfo, AdaptableReadyInfo, CustomToolbarConfiguredInfo, CellChangedInfo, SystemStatusMessageDisplayedInfo, CheckboxColumnClickedInfo, AdaptableStateChangedInfo, FlashingCellDisplayedInfo, GridDataChangedInfo, TeamSharingEntityChangedInfo, ActionRowSubmittedInfo, DataSetSelectedInfo, AdaptableStateReloadedInfo, GridSortedInfo, QueryRunInfo, FilterAppliedInfo } from '../types';
2
- import { ChartChangedInfo } from './Events/ChartChanged';
3
- import { ThemeEditedInfo } from './Events/ThemeChanged';
1
+ import { AdaptableFDC3EventInfo, SelectionChangedInfo, LiveDataChangedInfo, DashboardChangedInfo, ThemeChangedInfo, AlertFiredInfo, LayoutChangedInfo, AdaptableReadyInfo, CustomToolbarConfiguredInfo, CellChangedInfo, SystemStatusMessageDisplayedInfo, CheckboxColumnClickedInfo, AdaptableStateChangedInfo, FlashingCellDisplayedInfo, GridDataChangedInfo, TeamSharingEntityChangedInfo, ActionRowSubmittedInfo, DataSetSelectedInfo, AdaptableStateReloadedInfo, GridSortedInfo, QueryRunInfo, ScheduleTriggeredInfo, ChartChangedInfo, ThemeEditedInfo, FilterAppliedInfo } from '../types';
4
2
  /**
5
3
  * Responsible for publishing the many Events that AdapTable fires
6
4
  */
@@ -31,10 +29,23 @@ export interface EventApi {
31
29
  * @param callback
32
30
  */
33
31
  off(eventName: 'QueryRun', callback: (queryRunInfo: QueryRunInfo) => void): void;
32
+ /**
33
+ * Event fired whenever a Schedule is triggered in AdapTable
34
+ * @param eventName ScheduleTriggered
35
+ * @param callback ScheduleTriggered which provides details of the Schedule that was triggered
36
+ * @returns the unsubscribe function
37
+ */
38
+ on(eventName: 'ScheduleTriggered', callback: (scheduleTriggeredInfo: ScheduleTriggeredInfo) => void): VoidFunction;
39
+ /**
40
+ * Unsubscribe from ScheduleTriggered
41
+ * @param eventName ScheduleTriggered
42
+ * @param callback
43
+ */
44
+ off(eventName: 'ScheduleTriggered', callback: (scheduleTriggeredInfo: ScheduleTriggeredInfo) => void): void;
34
45
  /**
35
46
  * Event fired whenever a Filter is Applied in AdapTable
36
47
  * @param eventName FilterApplied
37
- * @param callback FilterApplied which provides details of the Query and the associated AST
48
+ * @param callback FilterApplied which provides details of the Filter that was applied
38
49
  * @returns the unsubscribe function
39
50
  */
40
51
  on(eventName: 'FilterApplied', callback: (filterAppliedInfo: FilterAppliedInfo) => void): VoidFunction;
@@ -95,7 +106,7 @@ export interface EventApi {
95
106
  */
96
107
  off(eventName: 'SelectionChanged', callback: (selectionChangedInfo: SelectionChangedInfo) => void): void;
97
108
  /**
98
- * Event fired whenever the **selected theme of AdapTable is changed**.
109
+ * Event fired whenever the selected theme of AdapTable is changed
99
110
  * @param eventName ThemeChanged
100
111
  * @param callback ThemeChangedInfo which just contains the name of the current Theme
101
112
  * @returns the unsubscribe function
@@ -106,9 +117,9 @@ export interface EventApi {
106
117
  */
107
118
  off(eventName: 'ThemeChanged', callback: (themeChangedInfo: ThemeChangedInfo) => void): void;
108
119
  /**
109
- * Event fired whenever the a theme has been edited
120
+ * Event fired whenever a theme has been edited
110
121
  * @param eventName ThemeEdited
111
- * @param callback ThemeChangedInfo which just contains the name of the current Theme
122
+ * @param callback ThemeEditedInfo which just contains the name of the current Theme
112
123
  * @returns the unsubscribe function
113
124
  */
114
125
  on(eventName: 'ThemeEdited', callback: (themeEditedInfo: ThemeEditedInfo) => void): VoidFunction;
@@ -154,10 +165,12 @@ export interface EventApi {
154
165
  * @param eventName CheckboxColumnClicked
155
166
  * @param callback CheckboxColumnClickedInfo which includes details of the CheckboxColumn
156
167
  * @returns the unsubscribe function
168
+ * @deprecated
157
169
  */
158
170
  on(eventName: 'CheckboxColumnClicked', callback: (checkboxColumnClickedInfo: CheckboxColumnClickedInfo) => void): VoidFunction;
159
171
  /**
160
- * Unsubscribe from CheckboCxolumnClicked
172
+ * Unsubscribe from CheckboxColumnClicked
173
+ * @deprecated
161
174
  */
162
175
  off(eventName: 'CheckboxColumnClicked', callback: (checkboxColumnClickedInfo: CheckboxColumnClickedInfo) => void): void;
163
176
  /**
@@ -310,6 +323,6 @@ export interface EventApi {
310
323
  emitSync(eventName: 'DashboardChanged', data?: any): any[];
311
324
  emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
312
325
  emitSync(eventName: 'AdaptableDestroy'): any[];
313
- emit(eventName: 'ActionRowSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataSetSelected' | 'FDC3MessageSent' | 'FilterApplied' | 'GridDataChanged' | 'GridSorted' | 'LayoutChanged' | 'LiveDataChanged' | 'QueryRun' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'ThemeEdited', data?: any): Promise<any>;
326
+ emit(eventName: 'ActionRowSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataSetSelected' | 'FDC3MessageSent' | 'FilterApplied' | 'GridDataChanged' | 'GridSorted' | 'LayoutChanged' | 'LiveDataChanged' | 'QueryRun' | 'ScheduleTriggered' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'ThemeEdited', data?: any): Promise<any>;
314
327
  destroy(): void;
315
328
  }
@@ -2,6 +2,7 @@ import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
2
2
  import { BaseEventInfo } from './BaseEventInfo';
3
3
  /**
4
4
  * Event Info published by CheckboxColumnClicked event
5
+ * @deprecated - no longer used in AdapTable 16
5
6
  */
6
7
  export interface CheckboxColumnClickedInfo extends BaseEventInfo {
7
8
  /**
@@ -0,0 +1,11 @@
1
+ import { BaseSchedule } from '../../PredefinedConfig/Common/Schedule';
2
+ import { BaseEventInfo } from './BaseEventInfo';
3
+ /**
4
+ * EventInfo returned by the ScheduleTriggered event
5
+ */
6
+ export interface ScheduleTriggeredInfo extends BaseEventInfo {
7
+ /**
8
+ * Schedule that was Triggered
9
+ */
10
+ schedule: BaseSchedule;
11
+ }
@@ -9,9 +9,3 @@ export interface ThemeChangedInfo extends BaseEventInfo {
9
9
  */
10
10
  theme: AdaptableTheme | string;
11
11
  }
12
- export interface ThemeEditedInfo extends BaseEventInfo {
13
- /**
14
- * The has been edited
15
- */
16
- theme: AdaptableTheme;
17
- }
@@ -0,0 +1,11 @@
1
+ import { AdaptableTheme } from '../../PredefinedConfig/ThemeState';
2
+ import { BaseEventInfo } from './BaseEventInfo';
3
+ /**
4
+ * Object returned by the `ThemeEdited` event
5
+ */
6
+ export interface ThemeEditedInfo extends BaseEventInfo {
7
+ /**
8
+ * Theme which has been edited
9
+ */
10
+ theme: AdaptableTheme;
11
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });