@adaptabletools/adaptable 10.0.4-canary.5 → 11.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 (179) hide show
  1. package/base.css +1 -5
  2. package/bundle.cjs.js +115 -113
  3. package/index.css +1 -7
  4. package/package.json +2 -2
  5. package/publishTimestamp.d.ts +1 -1
  6. package/publishTimestamp.js +1 -1
  7. package/src/AdaptableInterfaces/IAdaptable.d.ts +9 -3
  8. package/src/AdaptableOptions/AdaptableOptions.d.ts +13 -2
  9. package/src/AdaptableOptions/ContainerOptions.d.ts +0 -7
  10. package/src/AdaptableOptions/DashboardOptions.d.ts +4 -7
  11. package/src/AdaptableOptions/FlashingCellOptions.d.ts +31 -0
  12. package/src/AdaptableOptions/{ChartPluginOptions.js → FlashingCellOptions.js} +0 -0
  13. package/src/AdaptableOptions/GeneralOptions.d.ts +1 -1
  14. package/src/AdaptableOptions/MenuOptions.d.ts +2 -2
  15. package/src/AdaptableOptions/NotificationsOptions.d.ts +0 -7
  16. package/src/AdaptableOptions/SettingsPanelOptions.d.ts +14 -2
  17. package/src/AdaptableOptions/ToolPanelOptions.d.ts +0 -14
  18. package/src/AdaptableOptions/UserInterfaceOptions.d.ts +5 -0
  19. package/src/Api/AdaptableApi.d.ts +6 -6
  20. package/src/Api/ChartingApi.d.ts +9 -0
  21. package/src/Api/{ChartApi.js → ChartingApi.js} +0 -0
  22. package/src/Api/ColumnApi.d.ts +11 -1
  23. package/src/Api/ConfigApi.d.ts +0 -12
  24. package/src/Api/EventApi.d.ts +3 -3
  25. package/src/Api/Events/AdaptableReady.d.ts +1 -1
  26. package/src/Api/Events/FlashingCellDisplayed.d.ts +2 -2
  27. package/src/Api/FlashingCellApi.d.ts +35 -24
  28. package/src/Api/Implementation/AdaptableApiImpl.d.ts +2 -2
  29. package/src/Api/Implementation/AdaptableApiImpl.js +2 -2
  30. package/src/Api/Implementation/CalculatedColumnApiImpl.js +1 -1
  31. package/src/Api/Implementation/ChartingApiImpl.d.ts +5 -0
  32. package/src/Api/Implementation/ChartingApiImpl.js +10 -0
  33. package/src/Api/Implementation/ColumnApiImpl.d.ts +3 -1
  34. package/src/Api/Implementation/ColumnApiImpl.js +9 -3
  35. package/src/Api/Implementation/ConfigApiImpl.d.ts +0 -4
  36. package/src/Api/Implementation/ConfigApiImpl.js +0 -16
  37. package/src/Api/Implementation/FlashingCellApiImpl.d.ts +8 -4
  38. package/src/Api/Implementation/FlashingCellApiImpl.js +39 -24
  39. package/src/Api/Implementation/FreeTextColumnApiImpl.js +1 -1
  40. package/src/Api/Implementation/GridApiImpl.js +1 -1
  41. package/src/Api/Implementation/InternalApiImpl.d.ts +0 -4
  42. package/src/Api/Implementation/InternalApiImpl.js +1 -7
  43. package/src/Api/Implementation/PluginsApiImpl.d.ts +0 -2
  44. package/src/Api/Implementation/PluginsApiImpl.js +0 -6
  45. package/src/Api/Implementation/PlusMinusApiImpl.js +1 -1
  46. package/src/Api/Implementation/QueryApiImpl.js +1 -1
  47. package/src/Api/Implementation/ToolPanelApiImpl.js +2 -2
  48. package/src/Api/InternalApi.d.ts +0 -4
  49. package/src/Api/PluginsApi.d.ts +0 -2
  50. package/src/PredefinedConfig/AdaptableState.d.ts +0 -4
  51. package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts +4 -4
  52. package/src/PredefinedConfig/Common/AdaptablePredicate.js +38 -38
  53. package/src/PredefinedConfig/Common/Enums.js +1 -0
  54. package/src/PredefinedConfig/Common/Menu.d.ts +15 -19
  55. package/src/PredefinedConfig/Common/SpecialColumnSettings.d.ts +4 -0
  56. package/src/PredefinedConfig/Common/Types.d.ts +5 -5
  57. package/src/PredefinedConfig/Common/Types.js +0 -2
  58. package/src/PredefinedConfig/FlashingCellState.d.ts +14 -19
  59. package/src/PredefinedConfig/PredefinedConfig.d.ts +0 -10
  60. package/src/PredefinedConfig/SystemState.d.ts +0 -4
  61. package/src/PredefinedConfig/ThemeState.d.ts +2 -1
  62. package/src/Redux/ActionsReducers/DashboardRedux.js +1 -1
  63. package/src/Redux/ActionsReducers/PopupRedux.d.ts +0 -2
  64. package/src/Redux/ActionsReducers/SystemRedux.d.ts +0 -12
  65. package/src/Redux/ActionsReducers/SystemRedux.js +1 -21
  66. package/src/Redux/ActionsReducers/ToolPanelRedux.js +1 -2
  67. package/src/Redux/Store/AdaptableStore.js +10 -20
  68. package/src/Strategy/AdaptableModuleBase.d.ts +1 -1
  69. package/src/Strategy/AdaptableModuleBase.js +0 -3
  70. package/src/Strategy/AlertModule.js +1 -1
  71. package/src/Strategy/CalculatedColumnModule.js +17 -12
  72. package/src/Strategy/ChartingModule.d.ts +7 -0
  73. package/src/Strategy/ChartingModule.js +15 -0
  74. package/src/Strategy/ConditionalStyleModule.js +1 -1
  75. package/src/Strategy/FilterModule.js +3 -2
  76. package/src/Strategy/FlashingCellModule.js +4 -4
  77. package/src/Strategy/FormatColumnModule.js +2 -2
  78. package/src/Strategy/Interface/IModule.d.ts +0 -1
  79. package/src/Strategy/LayoutModule.js +15 -3
  80. package/src/Strategy/QueryModule.d.ts +1 -1
  81. package/src/Strategy/QueryModule.js +1 -3
  82. package/src/Strategy/SetingsPanelModule.d.ts +1 -0
  83. package/src/Strategy/SetingsPanelModule.js +7 -1
  84. package/src/Strategy/Utilities/getFlashingTargetViewItems.d.ts +5 -0
  85. package/src/Strategy/Utilities/getFlashingTargetViewItems.js +9 -0
  86. package/src/Strategy/Utilities/getFormatColumnStyleViewItems.d.ts +3 -0
  87. package/src/Strategy/Utilities/getFormatColumnStyleViewItems.js +10 -0
  88. package/src/Utilities/Constants/ConfigConstants.d.ts +0 -1
  89. package/src/Utilities/Constants/ConfigConstants.js +1 -2
  90. package/src/Utilities/Constants/GeneralConstants.d.ts +0 -9
  91. package/src/Utilities/Constants/GeneralConstants.js +1 -12
  92. package/src/Utilities/Constants/ModuleConstants.d.ts +1 -2
  93. package/src/Utilities/Constants/ModuleConstants.js +2 -3
  94. package/src/Utilities/Defaults/DefaultAdaptableOptions.js +19 -18
  95. package/src/Utilities/Defaults/DefaultSettingsPanel.d.ts +2 -1
  96. package/src/Utilities/Helpers/AdaptableHelper.js +2 -2
  97. package/src/Utilities/Interface/MessagePopups.d.ts +0 -3
  98. package/src/Utilities/ObjectFactory.d.ts +0 -10
  99. package/src/Utilities/ObjectFactory.js +2 -65
  100. package/src/Utilities/Services/EntitlementService.js +1 -1
  101. package/src/Utilities/Services/ModuleService.js +7 -11
  102. package/src/View/AdaptableView.js +1 -7
  103. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/ColumnsList.d.ts +4 -3
  104. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/ColumnsList.js +2 -1
  105. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/ConfigurationForm.js +9 -9
  106. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/index.js +3 -3
  107. package/src/View/AdaptableWizardView/index.js +1 -1
  108. package/src/View/Alert/AlertEmptyView.js +1 -1
  109. package/src/View/Alert/Wizard/AlertRulesWizardSection.d.ts +1 -0
  110. package/src/View/Alert/Wizard/AlertWizard.js +3 -3
  111. package/src/View/Alert/Wizard/BaseAlertRulesWizardSection.d.ts +1 -0
  112. package/src/View/Alert/Wizard/BaseAlertRulesWizardSection.js +4 -1
  113. package/src/View/CalculatedColumn/Utilities/getCalculatedColumnSettingTags.js +0 -1
  114. package/src/View/CalculatedColumn/Wizard/CalculatedColumnSettingsWizardSection.d.ts +1 -0
  115. package/src/View/CalculatedColumn/Wizard/CalculatedColumnSettingsWizardSection.js +1 -1
  116. package/src/View/CalculatedColumn/Wizard/CalculatedColumnWizard.js +2 -1
  117. package/src/View/Components/ModuleValueSelector/index.d.ts +3 -1
  118. package/src/View/Components/ModuleValueSelector/index.js +1 -1
  119. package/src/View/Components/NewScopeComponent.js +1 -1
  120. package/src/View/Components/Popups/AdaptablePopup/AdaptablePopup.js +5 -4
  121. package/src/View/Components/ToolPanel/AdaptableToolPanel.js +45 -80
  122. package/src/View/Components/ToolPanel/ToolPanelPopup.js +8 -1
  123. package/src/View/Components/ValueSelector/index.d.ts +1 -0
  124. package/src/View/Components/ValueSelector/index.js +2 -2
  125. package/src/View/Dashboard/Dashboard.js +11 -34
  126. package/src/View/Dashboard/DashboardPopup.js +22 -14
  127. package/src/View/DataChangeHistory/DataChangeHistoryGrid.js +3 -2
  128. package/src/View/FlashingCell/Wizard/FlashingCellDurationWizardSection.js +1 -1
  129. package/src/View/FlashingCell/Wizard/FlashingCellRulesWizardSection.js +6 -6
  130. package/src/View/FlashingCell/Wizard/FlashingCellWizard.js +1 -3
  131. package/src/View/FlashingCell/Wizard/isValidFlashingCellRules.js +1 -1
  132. package/src/View/GridInfo/GridInfoPopup.js +3 -2
  133. package/src/View/Query/Wizard/NamedQueryWizard.js +10 -7
  134. package/src/View/QuickSearch/QuickSearchPopup.js +1 -1
  135. package/src/View/Shortcut/shortcutKeys.js +0 -1
  136. package/src/View/UIHelper.d.ts +0 -4
  137. package/src/View/UIHelper.js +1 -34
  138. package/src/agGrid/Adaptable.d.ts +10 -5
  139. package/src/agGrid/Adaptable.js +59 -49
  140. package/src/agGrid/agGridHelper.d.ts +1 -2
  141. package/src/agGrid/agGridHelper.js +7 -4
  142. package/src/agGrid/agGridMenuHelper.js +11 -7
  143. package/src/components/ApplicationIcon.d.ts +1 -1
  144. package/src/components/icons/column-add.d.ts +3 -0
  145. package/src/components/icons/column-add.js +10 -0
  146. package/src/components/icons/index.js +2 -0
  147. package/src/metamodel/adaptable.metamodel.d.ts +58 -91
  148. package/src/metamodel/adaptable.metamodel.js +239 -288
  149. package/src/types.d.ts +4 -7
  150. package/version.d.ts +1 -1
  151. package/version.js +1 -1
  152. package/src/AdaptableOptions/ChartPluginOptions.d.ts +0 -20
  153. package/src/Api/ChartApi.d.ts +0 -20
  154. package/src/Api/Implementation/SparklineColumnApiImpl.d.ts +0 -9
  155. package/src/Api/Implementation/SparklineColumnApiImpl.js +0 -24
  156. package/src/Api/SparklineColumnApi.d.ts +0 -23
  157. package/src/Api/SparklineColumnApi.js +0 -2
  158. package/src/PredefinedConfig/ChartState.d.ts +0 -144
  159. package/src/PredefinedConfig/ChartState.js +0 -2
  160. package/src/PredefinedConfig/Common/ChartEnums.d.ts +0 -123
  161. package/src/PredefinedConfig/Common/ChartEnums.js +0 -152
  162. package/src/PredefinedConfig/SparklineColumnState.d.ts +0 -40
  163. package/src/PredefinedConfig/SparklineColumnState.js +0 -2
  164. package/src/Redux/ActionsReducers/SparklineColumnRedux.d.ts +0 -35
  165. package/src/Redux/ActionsReducers/SparklineColumnRedux.js +0 -70
  166. package/src/Utilities/Defaults/DefaultCategoryChartProperties.d.ts +0 -2
  167. package/src/Utilities/Defaults/DefaultCategoryChartProperties.js +0 -56
  168. package/src/Utilities/Defaults/DefaultPieChartProperties.d.ts +0 -2
  169. package/src/Utilities/Defaults/DefaultPieChartProperties.js +0 -13
  170. package/src/Utilities/Defaults/DefaultSparklinesChartProperties.d.ts +0 -2
  171. package/src/Utilities/Defaults/DefaultSparklinesChartProperties.js +0 -25
  172. package/src/View/Components/Panels/PanelWithIImageThreeButtons.d.ts +0 -11
  173. package/src/View/Components/Panels/PanelWithIImageThreeButtons.js +0 -28
  174. package/src/View/Components/Popups/AdaptableChart.d.ts +0 -18
  175. package/src/View/Components/Popups/AdaptableChart.js +0 -40
  176. package/src/View/Components/SharedProps/ChartDisplayPopupPropsBase.d.ts +0 -7
  177. package/src/View/Components/SharedProps/ChartDisplayPopupPropsBase.js +0 -2
  178. package/src/components/ChartContainer/index.d.ts +0 -15
  179. package/src/components/ChartContainer/index.js +0 -22
package/index.css CHANGED
@@ -2402,9 +2402,6 @@ template {
2402
2402
  box-shadow: var(--ab-focus__box-shadow);
2403
2403
  outline: var(--ab-focus__outline); }
2404
2404
 
2405
- .ab-Dialog > * {
2406
- flex: 1; }
2407
-
2408
2405
  .ab-Dialog__close-button {
2409
2406
  position: absolute;
2410
2407
  right: 6px;
@@ -3012,9 +3009,6 @@ input[type="number"].ab-Input:hover::-webkit-inner-spin-button:active {
3012
3009
  .ab-FileDroppable, .ab-FileDroppable *, .ab-FileDroppable *:before, .ab-FileDroppable *:after {
3013
3010
  box-sizing: border-box; }
3014
3011
 
3015
- .ab-ChartContainer canvas {
3016
- left: 0; }
3017
-
3018
3012
  .ab-WizardPanel > .ab-Panel__body {
3019
3013
  display: flex;
3020
3014
  flex-flow: column; }
@@ -3666,7 +3660,7 @@ html.ab--theme-dark .ab-ListBoxFilterForm--aggrid-style {
3666
3660
  .ab_div-colour-render-text {
3667
3661
  position: absolute;
3668
3662
  font-weight: normal;
3669
- font-size: 12p;
3663
+ font-size: 12px;
3670
3664
  z-index: 100; }
3671
3665
 
3672
3666
  .ab_div-colour-render-div {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adaptabletools/adaptable",
3
- "version": "10.0.4-canary.5",
3
+ "version": "11.0.0-canary.0",
4
4
  "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
5
5
  "main": "index.js",
6
6
  "typings": "index.d.ts",
@@ -15,7 +15,7 @@
15
15
  "re-resizable": "^6.9.1",
16
16
  "react": ">=16.8.0",
17
17
  "react-beautiful-dnd": "13.1.0",
18
- "react-day-picker": "8.0.0-beta.36",
18
+ "react-day-picker": "8.0.0-beta.37",
19
19
  "react-dom": ">=16.8.0",
20
20
  "react-redux": "7.2.4",
21
21
  "react-remove-scroll": "2.4.2",
@@ -1,2 +1,2 @@
1
- declare const _default: 1643056480240;
1
+ declare const _default: 1643291530490;
2
2
  export default _default;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.default = 1643056480240;
3
+ exports.default = 1643291530490;
@@ -37,7 +37,7 @@ export interface IAdaptable {
37
37
  api: AdaptableApi;
38
38
  adaptableOptions: AdaptableOptions;
39
39
  adaptableStore: IAdaptableStore;
40
- modules: IModuleCollection;
40
+ adaptableModules: IModuleCollection;
41
41
  /**
42
42
  * If using AG Grid community (which has no menu)
43
43
  */
@@ -124,8 +124,12 @@ export interface IAdaptable {
124
124
  updateRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
125
125
  addRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
126
126
  deleteRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
127
- selectColumn(columnId: string): void;
128
- selectColumns(columnIds: string[]): void;
127
+ selectColumn(columnId: string, config?: {
128
+ keepExistingSelection?: boolean;
129
+ }): void;
130
+ selectColumns(columnIds: string[], config?: {
131
+ keepExistingSelection?: boolean;
132
+ }): void;
129
133
  selectAll(): void;
130
134
  deselectAll(): void;
131
135
  hideColumn(columnId: string): void;
@@ -185,6 +189,8 @@ export interface IAdaptable {
185
189
  canExportToExcel(): boolean;
186
190
  exportToExcel(reportData: ReportData, fileName: string): void;
187
191
  exportVisualDataToExcel(): void;
192
+ canGenerateCharts(): boolean;
193
+ canHaveSparklines(): boolean;
188
194
  getCurrentIPPStyle(): IPPStyle;
189
195
  getDefaultIPPStyle(): IPPStyle;
190
196
  getRowCount(): number;
@@ -19,6 +19,8 @@ import { FilterOptions } from './FilterOptions';
19
19
  import { QueryLanguageOptions } from './QueryLanguageOptions';
20
20
  import { DataChangeHistoryOptions } from './DataChangeHistoryOptions';
21
21
  import { SettingsPanelOptions } from './SettingsPanelOptions';
22
+ import { GridOptions, Module } from '@ag-grid-community/all-modules';
23
+ import { FlashingCellOptions } from './FlashingCellOptions';
22
24
  /**
23
25
  * Group of property options enabling developers to set up AdapTable at design time to fit precise requirements - provides AG Grid, Predefined Config and other information required to ensure a full, rich user experience
24
26
  */
@@ -74,7 +76,8 @@ export interface AdaptableOptions {
74
76
  *
75
77
  * @defaultValue n/a (Mandatory)
76
78
  */
77
- agGridOptions?: any;
79
+ gridOptions?: GridOptions;
80
+ modules?: Module[];
78
81
  /**
79
82
  * Options for managing Notifications in AdapTable
80
83
  *
@@ -82,7 +85,7 @@ export interface AdaptableOptions {
82
85
  */
83
86
  notificationsOptions?: NotificationsOptions;
84
87
  /**
85
- * Options for setting the 'Div' elements in which AdapTable, AG Grid, popups and charts are placed
88
+ * Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed
86
89
  */
87
90
  containerOptions?: ContainerOptions;
88
91
  /**
@@ -109,6 +112,12 @@ export interface AdaptableOptions {
109
112
  * @gridInfoContainer
110
113
  */
111
114
  exportOptions?: ExportOptions;
115
+ /**
116
+ * Options for managing Flashing Cells - primarily default values
117
+ *
118
+ * @gridInfoContainer
119
+ */
120
+ flashingCellOptions?: FlashingCellOptions;
112
121
  /**
113
122
  * General options to manage AdapTable e.g. grouping behaviour, Primary Keys
114
123
  *
@@ -183,6 +192,8 @@ export interface AdaptableOptions {
183
192
  customPredicateDefs?: AdaptablePredicateDef[];
184
193
  /**
185
194
  * Setting panel options
195
+ *
196
+ * @gridInfoContainer
186
197
  */
187
198
  settingsPanelOptions?: SettingsPanelOptions;
188
199
  }
@@ -30,13 +30,6 @@ export interface ContainerOptions {
30
30
  * @gridInfoItem
31
31
  */
32
32
  modalContainer?: string;
33
- /**
34
- * Name of div where charts appear (if null, will be centre of page)
35
- *
36
- * @defaultValue undefined
37
- * @gridInfoItem
38
- */
39
- chartContainer?: string;
40
33
  /**
41
34
  * Div to show System Status messages - string Id or HTMLElement
42
35
  *
@@ -14,13 +14,6 @@ export interface DashboardOptions {
14
14
  * @gridInfoItem
15
15
  */
16
16
  canFloat?: boolean;
17
- /**
18
- * Displays a button which opens the Settings Panel
19
- *
20
- * @defaultValue true
21
- * @gridInfoItem
22
- */
23
- showSettingsPanel?: boolean;
24
17
  /**
25
18
  * Shows Quick Search textbox in the Dashboard Header; the UI component is still subject to the QuickSearch Entitlements
26
19
  *
@@ -36,6 +29,10 @@ export interface DashboardOptions {
36
29
  * Toolbars provided by Users which contain custom content
37
30
  */
38
31
  customToolbars?: CustomToolbar[];
32
+ /**
33
+ * @defaultValue 'right'
34
+ */
35
+ buttonsLocation?: 'left' | 'right';
39
36
  }
40
37
  /**
41
38
  * Custom Toolbar (which AdapTable will manage) enabling devs to populate Dashboard with bepoke content
@@ -0,0 +1,31 @@
1
+ import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
2
+ /**
3
+ * Properties for Flashing Cell
4
+ */
5
+ export interface FlashingCellOptions {
6
+ /**
7
+ * Should a cell or whole row flash
8
+ * @defaultValue 'cell'
9
+ */
10
+ defaultFlashTarget?: 'row' | 'cell';
11
+ /**
12
+ * Style for 'Down' value changes
13
+ * @defaultValue Red BackColour
14
+ */
15
+ defaultDownChangeStyle?: AdaptableStyle;
16
+ /**
17
+ * Style for 'Up' value changes
18
+ * @defaultValue Green BackColour
19
+ */
20
+ defaultUpChangeStyle?: AdaptableStyle;
21
+ /**
22
+ * Style for 'Neutral' value changes
23
+ * @defaultValue Gray BackColour
24
+ */
25
+ defaultNeutralChangeStyle?: AdaptableStyle;
26
+ /**
27
+ * Duration of Flash - can be number (in ms) or 'always'
28
+ * @defaultValue 500ms
29
+ */
30
+ defaultFlashDuration?: number | 'always';
31
+ }
@@ -71,7 +71,7 @@ export interface GeneralOptions {
71
71
  */
72
72
  customSortComparers?: ColumnValuesComparer[];
73
73
  /**
74
- * Maintain upper and lower case when performing text operations (applies to both Expressions and Predicates)
74
+ * Keep case sensitivity when AdapTableQL evaluates string-based Expressions and Predicates
75
75
  *
76
76
  * @defaultValue false
77
77
  * @gridInfoItem
@@ -39,11 +39,11 @@ export interface MenuOptions {
39
39
  */
40
40
  contextMenuOrder?: ('aggrid' | 'adaptable' | 'user')[];
41
41
  /**
42
- * A collection of UserMenuItem objects to be added to the Column Menu (the one that appears as a dropdown in each Column Header).
42
+ * User-defined Menu Items to add to the Column Menu
43
43
  */
44
44
  columnMenuItems?: UserMenuItem<ColumnMenuContext>[];
45
45
  /**
46
- * 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).
46
+ * User-defined Menu Items to add to the Context Menu
47
47
  */
48
48
  contextMenuItems?: UserMenuItem<ContextMenuContext>[];
49
49
  }
@@ -2,7 +2,6 @@ import { AlertButton, AlertDefinition } from '../PredefinedConfig/AlertState';
2
2
  import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
3
3
  import { ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
4
4
  import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
5
- import { FlashingCellProperties } from '../PredefinedConfig/FlashingCellState';
6
5
  import { DataChangedInfo } from '../types';
7
6
  /**
8
7
  * Options related to Alerts, System Status Messages and Notifications in Adaptable.
@@ -22,12 +21,6 @@ export interface NotificationsOptions {
22
21
  * @gridInfoItem
23
22
  */
24
23
  maxNotifications?: number;
25
- /**
26
- * Flashing Alert Defaults
27
- *
28
- * @defaultValue BackColors: Green (up), Red (down), Gray (neutral), Duration: 500ms
29
- */
30
- flashingCellDefaultProperties?: FlashingCellProperties;
31
24
  /**
32
25
  * Where Notification will appear (if anywhere)
33
26
  *
@@ -11,9 +11,21 @@ export interface SettingsPanelOptions {
11
11
  /**
12
12
  * Icon for Settings Panel Can be `ConfigurationIcon`, `ApplicationIcon` or a custom Icon
13
13
  *
14
- * @defdefaultValueault 'ConfigurationIcon'
14
+ * @defaultValue 'ConfigurationIcon'
15
15
  */
16
16
  icon?: 'ConfigurationIcon' | 'ApplicationIcon' | AdaptableIcon;
17
+ /**
18
+ * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of Dashboard
19
+ * @defaultValue false
20
+ * @gridInfoItem
21
+ */
22
+ alwaysShowInDashboard?: boolean;
23
+ /**
24
+ * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of ToolPanel
25
+ * @defaultValue false
26
+ * @gridInfoItem
27
+ */
28
+ alwaysShowInToolPanel?: boolean;
17
29
  /**
18
30
  * Ordered items to display at side of Settings Panel
19
31
  */
@@ -43,7 +55,7 @@ export interface SettingsPanelOptions {
43
55
  *
44
56
  * @defaultValue 'window'
45
57
  */
46
- type?: 'modal' | 'window';
58
+ popupType?: 'modal' | 'window';
47
59
  /**
48
60
  * Custom Settings Panels provided by developers at design-time
49
61
  */
@@ -52,20 +52,6 @@ export interface ToolPanelOptions {
52
52
  * @defaultValue ['filters', 'columns', 'adaptable']
53
53
  */
54
54
  toolPanelOrder?: ('adaptable' | 'columns' | 'filters')[];
55
- /**
56
- * Display the Modules dropdown
57
- *
58
- * @defaultValue true
59
- * @gridInfoItem
60
- */
61
- showModulesDropdown?: boolean;
62
- /**
63
- * Display the Columns dropdown
64
- *
65
- * @defaultValue true
66
- * @gridInfoItem
67
- */
68
- showColumnsDropdown?: boolean;
69
55
  /**
70
56
  * Display the Tool Panels dropdown
71
57
  *
@@ -74,6 +74,11 @@ export interface UserInterfaceOptions {
74
74
  * @gridInfoItem
75
75
  */
76
76
  styleClassNames?: string[];
77
+ /**
78
+ * Optional list of Column Types - used primarily for special columns
79
+ *
80
+ */
81
+ columnTypes?: string[];
77
82
  /**
78
83
  * Provide links to AdapTable documentation (in Module popups and Expression Editor)
79
84
  *
@@ -1,4 +1,3 @@
1
- import { SparklineColumnApi } from './SparklineColumnApi';
2
1
  import { AlertApi } from './AlertApi';
3
2
  import { PluginsApi } from './PluginsApi';
4
3
  import { BulkUpdateApi } from './BulkUpdateApi';
@@ -35,6 +34,7 @@ import { ScopeApi } from './ScopeApi';
35
34
  import { PredicateApi } from './PredicateApi';
36
35
  import { DataChangeHistoryApi } from './DataChangeHistoryApi';
37
36
  import { FlashingCellApi } from './FlashingCellApi';
37
+ import { ChartingApi } from './ChartingApi';
38
38
  /**
39
39
  *
40
40
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -124,7 +124,7 @@ export interface AdaptableApi {
124
124
  */
125
125
  plusMinusApi: PlusMinusApi;
126
126
  /**
127
- * Offers access to AdapTable Plugin (e.g. charts, ipushpull, OpenFin etc)
127
+ * Offers access to AdapTable Plugin (e.g. ipushpull, OpenFin etc)
128
128
  */
129
129
  pluginsApi: PluginsApi;
130
130
  /**
@@ -159,10 +159,6 @@ export interface AdaptableApi {
159
159
  * Provides access to the Smart Edit Module
160
160
  */
161
161
  smartEditApi: SmartEditApi;
162
- /**
163
- * Provides access to the Sparkline Column in the Charts Plugin
164
- */
165
- sparklineColumnApi: SparklineColumnApi;
166
162
  /**
167
163
  * Methods related to displaying System Status and application health messages
168
164
  */
@@ -183,6 +179,10 @@ export interface AdaptableApi {
183
179
  * Manages User Interface Options where colours, styles and permitted values are configured
184
180
  */
185
181
  userInterfaceApi: UserInterfaceApi;
182
+ /**
183
+ * Provides run-time access to Charting Module and state
184
+ */
185
+ chartingApi: ChartingApi;
186
186
  /**
187
187
  * Api methods used *internally* within AdapTable.
188
188
  */
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Provides run-time access to Charting Module and state
3
+ */
4
+ export interface ChartingApi {
5
+ /**
6
+ * Whether this Adaptable instance has Charting functions available.
7
+ */
8
+ isChartingEnabled(): boolean;
9
+ }
File without changes
@@ -12,7 +12,7 @@ export interface ColumnApi {
12
12
  getColumns(): AdaptableColumn[];
13
13
  /**
14
14
  * Retrieves 'ColumnType' property for a given Column
15
- * @param columnId Colmun to use
15
+ * @param columnId Column to use
16
16
  */
17
17
  getAgGridColumnType(columnId: string): string | string[];
18
18
  /**
@@ -69,11 +69,21 @@ export interface ColumnApi {
69
69
  * @param columnId Column to select
70
70
  */
71
71
  selectColumn(columnId: string): void;
72
+ /**
73
+ * Adds (highlights) a Column to any existing selection
74
+ * @param columnId Column to select
75
+ */
76
+ addColumnToSelection(columnId: string): void;
72
77
  /**
73
78
  * Selects (highlights) group of Columns
74
79
  * @param columnIds columns to select
75
80
  */
76
81
  selectColumns(columnIds: string[]): void;
82
+ /**
83
+ * Adds (highlights) a group of Columns to any existing selection
84
+ * @param columnIds columns to select
85
+ */
86
+ addColumnsToSelection(columnIds: string[]): void;
77
87
  /**
78
88
  * Selects all Columns
79
89
  */
@@ -1,4 +1,3 @@
1
- import { ChartState } from '../PredefinedConfig/ChartState';
2
1
  import { ThemeState } from '../PredefinedConfig/ThemeState';
3
2
  import { ShortcutState } from '../PredefinedConfig/ShortcutState';
4
3
  import { QuickSearchState } from '../PredefinedConfig/QuickSearchState';
@@ -14,7 +13,6 @@ import { AlertState } from '../PredefinedConfig/AlertState';
14
13
  import { ConfigState } from '../PredefinedConfig/ConfigState';
15
14
  import { PlusMinusState } from '../PredefinedConfig/PlusMinusState';
16
15
  import { ApplicationState } from '../PredefinedConfig/ApplicationState';
17
- import { SparklineColumnState } from '../PredefinedConfig/SparklineColumnState';
18
16
  import { AdaptableState } from '../PredefinedConfig/AdaptableState';
19
17
  import { FreeTextColumnState } from '../PredefinedConfig/FreeTextColumnState';
20
18
  import { FilterState } from '../PredefinedConfig/FilterState';
@@ -114,11 +112,6 @@ export interface ConfigApi {
114
112
  * @param returnJson return as JSON rather than object
115
113
  */
116
114
  getCalculatedColumnState(returnJson: boolean): CalculatedColumnState;
117
- /**
118
- * Returns Chart section of Adaptable State
119
- * @param returnJson return as JSON rather than object
120
- */
121
- getChartState(returnJson: boolean): ChartState;
122
115
  /**
123
116
  * Returns Conditional Style section of Adaptable State
124
117
  * @param returnJson return as JSON rather than object
@@ -189,11 +182,6 @@ export interface ConfigApi {
189
182
  * @param returnJson return as JSON rather than object
190
183
  */
191
184
  getShortcutState(returnJson: boolean): ShortcutState;
192
- /**
193
- * Returns Sparkline Column section of Adaptable State
194
- * @param returnJson return as JSON rather than object
195
- */
196
- getSparklineColumnState(returnJson: boolean): SparklineColumnState;
197
185
  /**
198
186
  * Returns Theme section of Adaptable State
199
187
  * @param returnJson return as JSON rather than object
@@ -115,9 +115,9 @@ export interface EventApi {
115
115
  */
116
116
  off(eventName: 'AlertFired', callback: (alertFiredInfo: AlertFiredInfo) => void): void;
117
117
  /**
118
- * Event fired whenever a **FlashingCell is triggered** in AdapTable.
119
- * @param eventName FlashingCellFired
120
- * @param callback FlashingCellFiredInfo which wrap the FlashingCell that was fired
118
+ * Event fired whenever **Cell Flashing** is triggered in AdapTable.
119
+ * @param eventName FlashingCellDisplayed
120
+ * @param callback FlashingCellDisplayedInfo which wrap the `AdaptableFlashingCell` that was displayed
121
121
  * @returns the unsubscribe function
122
122
  */
123
123
  on(eventName: 'FlashingCellDisplayed', callback: (flashingCellDisplayedInfo: FlashingCellDisplayedInfo) => void): VoidFunction;
@@ -7,5 +7,5 @@ export interface AdaptableReadyInfo extends BaseEventInfo {
7
7
  /**
8
8
  * Underlying AG Grid GridOptions object
9
9
  */
10
- agGridOptions: GridOptions;
10
+ gridOptions: GridOptions;
11
11
  }
@@ -1,11 +1,11 @@
1
1
  import { AdaptableFlashingCell } from '../../PredefinedConfig/Common/AdaptableFlashingCell';
2
2
  import { BaseEventInfo } from './BaseEventInfo';
3
3
  /**
4
- * Object returned by the `FlashingAlertFired` event
4
+ * Object returned by the `FlashingCellDisplayed` event
5
5
  */
6
6
  export interface FlashingCellDisplayedInfo extends BaseEventInfo {
7
7
  /**
8
- * FlashingAlert which has been fired
8
+ * Details of the Cell (or row) which has just flashed
9
9
  */
10
10
  flashingCell: AdaptableFlashingCell;
11
11
  }
@@ -1,78 +1,89 @@
1
1
  import { AdaptableFlashingCell } from '../PredefinedConfig/Common/AdaptableFlashingCell';
2
+ import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
3
+ import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
2
4
  import { FlashingCellDefinition, FlashingCellState } from '../PredefinedConfig/FlashingCellState';
3
5
  /**
4
- * Provides run-time access to Alert function and associated State
6
+ * Provides run-time access to Flashing Cell functionality and associated State
5
7
  */
6
8
  export interface FlashingCellApi {
7
9
  /**
8
- * Retrieves Alert section from Adaptable State
9
- * @returns alert state
10
+ * Retrieves Flashing Cell section from Adaptable State
11
+ * @returns Flashing Cell state
10
12
  */
11
13
  getFlashingCellState(): FlashingCellState;
12
14
  /**
13
- * Retrieves all Flashing cell Definitions in Alert State
15
+ * Retrieves all Flashing cell Definitions in Flashing Cell State
14
16
  */
15
17
  getFlashingCellDefinitions(): FlashingCellDefinition[];
16
18
  /**
17
19
  * Retrieves Flashing cell Definition By Id
18
- * @param id Flashing Alert id
20
+ * @param id Flashing Cell Definition Id
19
21
  * @returns flashing cell definition
20
22
  */
21
23
  getFlashingCellDefinitionById(id: FlashingCellDefinition['Uuid']): FlashingCellDefinition;
22
24
  /**
23
- * Retrieves all cell Definitions in Alert State which are NOT Reactive (BooleanQuery)
25
+ * Retrieves all active (non-suspended) cell Definitions in Flashing Cell State
24
26
  * @returns flashing cell definitions
25
27
  */
26
- getNonReactiveFlashingCellDefinitions(): FlashingCellDefinition[];
27
- /**
28
- * Retrieves all active (non-suspended) cell Definitions in Alert State which are NOT Reactive (BooleanQuery)
29
- * @returns flashing cell definitions
30
- */
31
- getActiveNonReactiveFlashingCellDefinitions(): FlashingCellDefinition[];
28
+ getActiveFlashingCellDefinitions(): FlashingCellDefinition[];
32
29
  /**
33
30
  * Returns where a Flashing cell Definition will flash a single cell or a whole row
34
31
  * @param flashingCellDefinition Flashing cell Definition to check
35
32
  */
36
33
  getFlashingCellFlashTarget(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition['FlashTarget'];
37
34
  /**
38
- * Displays a Flashing Alert
39
- * @param flashingCellToShow Flashing Alert to show
35
+ * Displays a Flashing Cell Definition
36
+ * @param flashingCellToShow Flashing Cell Definition to show
40
37
  */
41
38
  showFlashingCell(flashingCellToShow: AdaptableFlashingCell): void;
42
39
  /**
43
- * Edits Flashing Alert in State with given one
44
- * @param flashingCellDefinition Flashing Alert to Edit
45
- * @returns alert flashing definition
40
+ * Edits Flashing Cell Definition in State with given one
41
+ * @param flashingCellDefinition Flashing Cell Definition to Edit
42
+ * @returns flashing definition
46
43
  */
47
44
  editFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
48
45
  /**
49
46
  * Edits provided Flashing cell Definitions
50
- * @param flashingCellDefinitions Flashing Alerts to Edit
51
- * @returns flashing alerts definitions
47
+ * @param flashingCellDefinitions Flashing Cell Definitions to Edit
48
+ * @returns flashing cell definitions
52
49
  */
53
50
  editFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];
54
51
  /**
55
52
  * Adds a Flashing cell Definition to State
56
- * @param flashingCellDefinition Flashing Alert to Add
53
+ * @param flashingCellDefinition Flashing Cell Definition to Add
57
54
  */
58
55
  addFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
59
- setFlashingCellDefinition(flashingCellDefinitions: FlashingCellDefinition[]): void;
56
+ /**
57
+ * Sets a collection of Flashing Cell Definitions into State
58
+ * @param flashingCellDefinitions Flashing Cell Definitions to Add to State
59
+ */
60
+ setFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): void;
61
+ mergeFlashingCellDefinitionWithDefaults(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
60
62
  /**
61
63
  * Adds provided Flashing cell Definitions
62
- * @param flashingCellDefinitions Flashing Alerts to Add
64
+ * @param flashingCellDefinitions Flashing Cell Definition to Add
63
65
  * @returns flashing cell definition
64
66
  */
65
67
  addFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];
66
68
  /**
67
69
  * Suspends a Flashing cell Definition
68
- * @param flashingCellDefinition Alert to Suspend
70
+ * @param flashingCellDefinition Flashing Cell Definition to Suspend
69
71
  * @returns flashing cell definition
70
72
  */
71
73
  suspendFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
72
74
  /**
73
75
  * Activates a suspended Flashing cell Definition
74
- * @param flashingCellDefinition Flashing Alert to Un-Suspend (activate)
76
+ * @param flashingCellDefinition Flashing Cell Definition to Un-Suspend (activate)
75
77
  * @returns flashing cell definition
76
78
  */
77
79
  unSuspendFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
80
+ /**
81
+ * Retrieves all Predicate Defs with Module Scope of Flashing Cell
82
+ */
83
+ getFlashingCellPredicateDefs(): AdaptablePredicateDef[];
84
+ /**
85
+ * Retrieves all Predicate Defs that match given Scope
86
+ * @param scope the Scope to check
87
+ */
88
+ getFlashingCellPredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
78
89
  }
@@ -21,7 +21,6 @@ import { PlusMinusApi } from '../PlusMinusApi';
21
21
  import { QuickSearchApi } from '../QuickSearchApi';
22
22
  import { ShortcutApi } from '../ShortcutApi';
23
23
  import { SmartEditApi } from '../SmartEditApi';
24
- import { SparklineColumnApi } from '../SparklineColumnApi';
25
24
  import { FilterApi } from '../FilterApi';
26
25
  import { SystemStatusApi } from '../SystemStatusApi';
27
26
  import { UserInterfaceApi } from '../UserInterfaceApi';
@@ -37,6 +36,7 @@ import { ScopeApi } from '../ScopeApi';
37
36
  import { PredicateApi } from '../PredicateApi';
38
37
  import { DataChangeHistoryApi } from '../DataChangeHistoryApi';
39
38
  import { FlashingCellApi } from '../FlashingCellApi';
39
+ import { ChartingApi } from '../ChartingApi';
40
40
  export declare class AdaptableApiImpl implements AdaptableApi {
41
41
  protected adaptable: IAdaptable;
42
42
  applicationApi: ApplicationApi;
@@ -64,7 +64,6 @@ export declare class AdaptableApiImpl implements AdaptableApi {
64
64
  scheduleApi: ScheduleApi;
65
65
  shortcutApi: ShortcutApi;
66
66
  smartEditApi: SmartEditApi;
67
- sparklineColumnApi: SparklineColumnApi;
68
67
  filterApi: FilterApi;
69
68
  systemStatusApi: SystemStatusApi;
70
69
  pluginsApi: PluginsApi;
@@ -76,6 +75,7 @@ export declare class AdaptableApiImpl implements AdaptableApi {
76
75
  teamSharingApi: TeamSharingApi;
77
76
  scopeApi: ScopeApi;
78
77
  dataChangeHistoryApi: DataChangeHistoryApi;
78
+ chartingApi: ChartingApi;
79
79
  constructor(adaptable: IAdaptable);
80
80
  destroy(config?: {
81
81
  unmount: boolean;