@adaptabletools/adaptable 22.0.0-canary.3 → 22.0.0-canary.5

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 (150) hide show
  1. package/index.css +58 -29
  2. package/index.css.map +1 -1
  3. package/package.json +1 -1
  4. package/src/AdaptableOptions/ActionColumnOptions.d.ts +2 -2
  5. package/src/AdaptableOptions/CustomSortOptions.d.ts +5 -0
  6. package/src/AdaptableOptions/DashboardOptions.d.ts +1 -2
  7. package/src/AdaptableOptions/ToolPanelOptions.d.ts +1 -2
  8. package/src/AdaptableState/AlertState.d.ts +2 -2
  9. package/src/AdaptableState/ChartingState.d.ts +3 -3
  10. package/src/AdaptableState/Common/AdaptableAlert.d.ts +2 -2
  11. package/src/AdaptableState/Common/AdaptableButton.d.ts +2 -2
  12. package/src/AdaptableState/Common/AdaptableFlashingCell.d.ts +2 -2
  13. package/src/AdaptableState/Common/AdaptableObject.d.ts +25 -2
  14. package/src/AdaptableState/Common/AdaptableStyle.d.ts +1 -1
  15. package/src/AdaptableState/Common/RowSummary.d.ts +1 -1
  16. package/src/AdaptableState/Common/Schedule.d.ts +3 -4
  17. package/src/AdaptableState/Common/SystemStatusMessageInfo.d.ts +2 -2
  18. package/src/AdaptableState/CustomSortState.d.ts +2 -2
  19. package/src/AdaptableState/DashboardState.d.ts +2 -2
  20. package/src/AdaptableState/ExportState.d.ts +2 -2
  21. package/src/AdaptableState/FlashingCellState.d.ts +2 -2
  22. package/src/AdaptableState/FormatColumnState.d.ts +2 -2
  23. package/src/AdaptableState/LayoutState.d.ts +8 -3
  24. package/src/AdaptableState/NamedQueryState.d.ts +2 -2
  25. package/src/AdaptableState/PlusMinusState.d.ts +2 -2
  26. package/src/AdaptableState/ShortcutState.d.ts +2 -2
  27. package/src/AdaptableState/StyledColumnState.d.ts +1 -1
  28. package/src/AdaptableState/ThemeState.d.ts +2 -2
  29. package/src/Api/CustomSortApi.d.ts +6 -3
  30. package/src/Api/Implementation/CustomSortApiImpl.d.ts +5 -1
  31. package/src/Api/Implementation/CustomSortApiImpl.js +2 -2
  32. package/src/Api/Implementation/LayoutHelpers.js +7 -0
  33. package/src/Api/Implementation/ScheduleApiImpl.js +1 -0
  34. package/src/Redux/ActionsReducers/LayoutRedux.d.ts +1 -1
  35. package/src/Strategy/AlertModule.js +4 -0
  36. package/src/Strategy/CustomSortModule.js +4 -0
  37. package/src/Strategy/FlashingCellModule.js +5 -0
  38. package/src/Strategy/FormatColumnModule.js +4 -0
  39. package/src/Strategy/LayoutModule.js +4 -4
  40. package/src/Strategy/PlusMinusModule.js +4 -0
  41. package/src/Strategy/ScheduleModule.js +4 -0
  42. package/src/Strategy/ShortcutModule.js +4 -0
  43. package/src/Utilities/Extensions/StringExtensions.d.ts +2 -0
  44. package/src/Utilities/Extensions/StringExtensions.js +16 -0
  45. package/src/Utilities/Helpers/FormatHelper.js +9 -2
  46. package/src/Utilities/ObjectFactory.js +15 -2
  47. package/src/View/Alert/Utilities/getDefaultAlertDefinition.d.ts +2 -1
  48. package/src/View/Alert/Wizard/AlertTypeWizardSection.d.ts +5 -2
  49. package/src/View/Alert/Wizard/AlertTypeWizardSection.js +47 -12
  50. package/src/View/Alert/Wizard/AlertWizard.js +14 -10
  51. package/src/View/Components/Buttons/EntityListActionButtons.d.ts +1 -2
  52. package/src/View/Components/Buttons/SuspendToggleButton/SuspendToggleButton.d.ts +1 -2
  53. package/src/View/Components/StyleComponent.d.ts +1 -0
  54. package/src/View/Components/StyleComponent.js +84 -33
  55. package/src/View/CustomSort/Wizard/CustomSortColumnWizardSection.d.ts +2 -1
  56. package/src/View/CustomSort/Wizard/CustomSortColumnWizardSection.js +40 -14
  57. package/src/View/CustomSort/Wizard/CustomSortWizard.js +4 -4
  58. package/src/View/DataChangeHistory/DataChangeHistoryGrid.js +1 -0
  59. package/src/View/FlashingCell/Wizard/FlashingCellSettingsWizardSection.d.ts +2 -1
  60. package/src/View/FlashingCell/Wizard/FlashingCellSettingsWizardSection.js +34 -14
  61. package/src/View/FlashingCell/Wizard/FlashingCellWizard.js +14 -10
  62. package/src/View/FormatColumn/Wizard/FormatColumnSettingsWizardSection.js +47 -29
  63. package/src/View/FormatColumn/Wizard/FormatColumnWizard.js +20 -9
  64. package/src/View/GridFilter/GridFilterExpressionEditor.js +6 -1
  65. package/src/View/GridFilter/GridFilterViewPanel.js +33 -70
  66. package/src/View/Layout/Wizard/sections/PivotColumnsSection.js +8 -0
  67. package/src/View/PlusMinus/Wizard/PlusMinusSettingsWizardSection.js +32 -9
  68. package/src/View/PlusMinus/Wizard/PlusMinusWizard.js +20 -15
  69. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsIPushPull.js +12 -1
  70. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsOpenFin.js +12 -1
  71. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsReminder.js +12 -2
  72. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsReport.js +12 -1
  73. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/isSettingsValid.d.ts +2 -1
  74. package/src/View/Schedule/Wizard/ScheduleSettingsWizard/isSettingsValid.js +10 -1
  75. package/src/View/Shortcut/Wizard/ShortcutSettingsWizard.d.ts +2 -1
  76. package/src/View/Shortcut/Wizard/ShortcutSettingsWizard.js +25 -4
  77. package/src/View/Shortcut/Wizard/ShortcutWizard.js +18 -14
  78. package/src/components/ColorPicker/ColorPicker.js +5 -4
  79. package/src/components/ExpressionEditor/ExpressionFunctionDocumentation.js +1 -1
  80. package/src/env.js +2 -2
  81. package/src/layout-manager/src/LayoutManagerModel.d.ts +1 -0
  82. package/src/layout-manager/src/index.js +25 -7
  83. package/src/layout-manager/src/normalizeLayoutModel.js +3 -0
  84. package/src/metamodel/adaptable.metamodel.d.ts +30 -0
  85. package/src/metamodel/adaptable.metamodel.js +1 -1
  86. package/src/migration/AdaptableUpgradeHelper.js +1 -1
  87. package/src/migration/VersionUpgrade22.d.ts +15 -0
  88. package/src/migration/VersionUpgrade22.js +160 -0
  89. package/src/types.d.ts +1 -2
  90. package/tsconfig.esm.tsbuildinfo +1 -1
  91. package/src/AdaptableState/Common/SuspendableObject.d.ts +0 -10
  92. package/src/AdaptableState/Common/SuspendableObject.js +0 -1
  93. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/FinanceForm/FinanceForm.d.ts +0 -1
  94. package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/FinanceForm/FinanceForm.js +0 -632
  95. package/src/View/Alert/AlertEntityRow.d.ts +0 -11
  96. package/src/View/Alert/AlertEntityRow.js +0 -28
  97. package/src/View/CalculatedColumn/CalculatedColumnSummary.d.ts +0 -21
  98. package/src/View/CalculatedColumn/CalculatedColumnSummary.js +0 -58
  99. package/src/View/Components/Buttons/ButtonFunction.d.ts +0 -7
  100. package/src/View/Components/Buttons/ButtonFunction.js +0 -8
  101. package/src/View/Components/Buttons/ButtonGeneral.d.ts +0 -5
  102. package/src/View/Components/Buttons/ButtonGeneral.js +0 -7
  103. package/src/View/Components/Buttons/ButtonPreviewDelete.d.ts +0 -4
  104. package/src/View/Components/Buttons/ButtonPreviewDelete.js +0 -5
  105. package/src/View/Components/Buttons/ButtonShow.d.ts +0 -5
  106. package/src/View/Components/Buttons/ButtonShow.js +0 -7
  107. package/src/View/Components/Buttons/ButtonShowChart.d.ts +0 -5
  108. package/src/View/Components/Buttons/ButtonShowChart.js +0 -7
  109. package/src/View/Components/Buttons/ButtonUndo.d.ts +0 -5
  110. package/src/View/Components/Buttons/ButtonUndo.js +0 -7
  111. package/src/View/Components/ExpressionWizard.d.ts +0 -24
  112. package/src/View/Components/ExpressionWizard.js +0 -77
  113. package/src/View/Components/FilterForm/Waiting.d.ts +0 -10
  114. package/src/View/Components/FilterForm/Waiting.js +0 -14
  115. package/src/View/Components/Panels/PanelFooter.d.ts +0 -10
  116. package/src/View/Components/Panels/PanelFooter.js +0 -9
  117. package/src/View/Components/Panels/PanelWithTwoButtons.d.ts +0 -12
  118. package/src/View/Components/Panels/PanelWithTwoButtons.js +0 -15
  119. package/src/View/Components/Panels/ToolPanelSettingsPanel.d.ts +0 -8
  120. package/src/View/Components/Panels/ToolPanelSettingsPanel.js +0 -26
  121. package/src/View/Components/Selectors/ColumnSelectorOld.d.ts +0 -18
  122. package/src/View/Components/Selectors/ColumnSelectorOld.js +0 -45
  123. package/src/View/Components/SharedProps/WizardScopeState.d.ts +0 -4
  124. package/src/View/Components/SharedProps/WizardScopeState.js +0 -1
  125. package/src/View/Components/WizardSummaryRow.d.ts +0 -9
  126. package/src/View/Components/WizardSummaryRow.js +0 -11
  127. package/src/View/CustomSort/CustomSortSummary.d.ts +0 -23
  128. package/src/View/CustomSort/CustomSortSummary.js +0 -105
  129. package/src/View/DataImport/DataImportWizard/sections/ImportSection.d.ts +0 -9
  130. package/src/View/DataImport/DataImportWizard/sections/ImportSection.js +0 -19
  131. package/src/View/Export/Wizard/ReportColumnTypeWizard.d.ts +0 -19
  132. package/src/View/Export/Wizard/ReportColumnTypeWizard.js +0 -68
  133. package/src/View/Export/Wizard/ReportRowTypeWizard.d.ts +0 -19
  134. package/src/View/Export/Wizard/ReportRowTypeWizard.js +0 -68
  135. package/src/View/Export/Wizard/ReportSettingsWizard.d.ts +0 -21
  136. package/src/View/Export/Wizard/ReportSettingsWizard.js +0 -56
  137. package/src/View/Export/Wizard/ReportSummaryWizard.d.ts +0 -15
  138. package/src/View/Export/Wizard/ReportSummaryWizard.js +0 -35
  139. package/src/View/Filter/FilterSummary.d.ts +0 -18
  140. package/src/View/Filter/FilterSummary.js +0 -48
  141. package/src/View/FormatColumn/FormatColumnSummary.d.ts +0 -22
  142. package/src/View/FormatColumn/FormatColumnSummary.js +0 -90
  143. package/src/View/FreeTextColumn/FreeTextColumnSummary.d.ts +0 -22
  144. package/src/View/FreeTextColumn/FreeTextColumnSummary.js +0 -88
  145. package/src/View/GridInfo/GridInfoPopup/AdaptableOptionsComponent.d.ts +0 -7
  146. package/src/View/GridInfo/GridInfoPopup/AdaptableOptionsComponent.js +0 -94
  147. package/src/View/PlusMinus/PlusMinusSummary.d.ts +0 -22
  148. package/src/View/PlusMinus/PlusMinusSummary.js +0 -95
  149. package/src/View/Wizard/WizardLegend.d.ts +0 -12
  150. package/src/View/Wizard/WizardLegend.js +0 -23
@@ -13,6 +13,11 @@ export interface CustomSortOptions<TData = any> {
13
13
  * Comparer object for Column Values - used for custom sorting
14
14
  */
15
15
  export interface ColumnValuesComparer<TData = any> {
16
+ /**
17
+ * Name of the CustomSort Comparer
18
+ * FIXME AFL - switch to mandatory
19
+ */
20
+ name?: string;
16
21
  /**
17
22
  * Column for which to compare values
18
23
  */
@@ -1,5 +1,4 @@
1
1
  import { AdaptableButton } from '../AdaptableState/Common/AdaptableButton';
2
- import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
3
2
  import { DashboardState } from '../AdaptableState/DashboardState';
4
3
  import { BaseContext, CustomRenderContext } from '../types';
5
4
  import { AdaptableFrameworkComponent } from '../agGrid/AdaptableFrameworkComponent';
@@ -41,7 +40,7 @@ export interface DashboardOptions {
41
40
  /**
42
41
  * Custom Toolbar (which AdapTable will manage) enabling devs to populate Dashboard with bepoke content
43
42
  */
44
- export interface CustomToolbar extends AdaptableObject {
43
+ export interface CustomToolbar {
45
44
  /**
46
45
  * How Toolbar is referenced (e.g. in Dashboard Popup when managing toolbars)
47
46
  */
@@ -1,4 +1,3 @@
1
- import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
2
1
  import { AdaptableFrameworkComponent } from '../agGrid/AdaptableFrameworkComponent';
3
2
  import { AdaptableButton } from '../AdaptableState/Common/AdaptableButton';
4
3
  import { ToolPanelState } from '../AdaptableState/ToolPanelState';
@@ -27,7 +26,7 @@ export interface ToolPanelOptions {
27
26
  /**
28
27
  * Defines a Custom ToolPanel - provided by Users and contains custom content
29
28
  */
30
- export interface CustomToolPanel extends AdaptableObject {
29
+ export interface CustomToolPanel {
31
30
  /**
32
31
  * Name of Custom ToolPanel - should be unique
33
32
  */
@@ -5,12 +5,12 @@ import { TypeHint } from './Common/Types';
5
5
  import { AdaptableMessageType } from './Common/AdaptableMessageType';
6
6
  import { AdaptableForm } from './Common/AdaptableForm';
7
7
  import { AdaptableButton } from './Common/AdaptableButton';
8
- import { SuspendableObject } from './Common/SuspendableObject';
9
8
  import { AdaptableStyle } from './Common/AdaptableStyle';
10
9
  import { XOR } from '../Utilities/Extensions/TypeExtensions';
11
10
  import { AdaptableAggregatedBooleanQuery, AdaptableBooleanQuery, AdaptableObservableQuery } from './Common/AdaptableQuery';
12
11
  import { ButtonStyle } from './Common/ButtonStyle';
13
12
  import { AlertFormContext, BaseContext, NotificationsOptions } from '../types';
13
+ import { NamedObject, SuspendableObject } from './Common/AdaptableObject';
14
14
  /**
15
15
  * Adaptable State section for Alert Module
16
16
  */
@@ -23,7 +23,7 @@ export interface AlertState extends BaseState {
23
23
  /**
24
24
  * The Alert Definition object used in the Alert function
25
25
  */
26
- export interface AlertDefinition extends SuspendableObject {
26
+ export interface AlertDefinition extends NamedObject, SuspendableObject {
27
27
  /**
28
28
  * Where Alert can be triggered: one, some or all columns or DataTypes
29
29
  */
@@ -1,5 +1,5 @@
1
1
  import { ChartModel } from 'ag-grid-enterprise';
2
- import { AdaptableObject } from '../types';
2
+ import { NamedObject } from '../types';
3
3
  import { BaseState } from './BaseState';
4
4
  export declare const isExternalChartDefinition: (chartDefinition: ChartDefinition | ExternalChartDefinition) => chartDefinition is ExternalChartDefinition;
5
5
  export declare const isAgChartDefinition: (chartDefinition: ChartDefinition | ExternalChartDefinition) => chartDefinition is ChartDefinition;
@@ -7,7 +7,7 @@ export declare const isAgChartDefinition: (chartDefinition: ChartDefinition | Ex
7
7
  * Wraps external chart definitions
8
8
  * Can be used to store charts in Adaptable State
9
9
  */
10
- export interface ExternalChartDefinition<T = unknown> extends AdaptableObject {
10
+ export interface ExternalChartDefinition<T = unknown> extends NamedObject {
11
11
  /**
12
12
  * The name needs to be unique.
13
13
  */
@@ -25,7 +25,7 @@ export interface ExternalChartDefinition<T = unknown> extends AdaptableObject {
25
25
  /**
26
26
  * Wraps an AG Grid Chart Model
27
27
  */
28
- export interface ChartDefinition extends AdaptableObject {
28
+ export interface ChartDefinition extends NamedObject {
29
29
  /**
30
30
  * Name of the Chart
31
31
  */
@@ -1,4 +1,4 @@
1
- import { AdaptableObject } from './AdaptableObject';
1
+ import { Identifiable } from './AdaptableObject';
2
2
  import { CellDataChangedInfo } from './CellDataChangedInfo';
3
3
  import { AlertDefinition } from '../AlertState';
4
4
  import { RowDataChangedInfo } from './RowDataChangedInfo';
@@ -36,7 +36,7 @@ export interface AdaptableRowChangedAlert<TData = any> extends AdaptableAlertBas
36
36
  /**
37
37
  * Defines the base(common) properties of an Alert fired by AdapTable, regardless of the type of change
38
38
  */
39
- export interface AdaptableAlertBase<T> extends AdaptableObject {
39
+ export interface AdaptableAlertBase<T> extends Identifiable {
40
40
  /**
41
41
  * The type of Alert
42
42
  */
@@ -1,11 +1,11 @@
1
1
  import { ButtonStyle } from './ButtonStyle';
2
- import { AdaptableObject } from './AdaptableObject';
2
+ import { Identifiable } from './AdaptableObject';
3
3
  import { AdaptableIcon } from './AdaptableIcon';
4
4
  import { BaseContext } from '../../types';
5
5
  /**
6
6
  * Defines a Button that appears in numerous places including Adaptable Form
7
7
  */
8
- export interface AdaptableButton<CONTEXT_TYPE extends BaseContext> extends AdaptableObject {
8
+ export interface AdaptableButton<CONTEXT_TYPE extends BaseContext> extends Identifiable {
9
9
  /**
10
10
  * Label for Button - can be string or function that provides string
11
11
  */
@@ -1,10 +1,10 @@
1
- import { AdaptableObject } from './AdaptableObject';
1
+ import { Identifiable } from './AdaptableObject';
2
2
  import { CellDataChangedInfo } from '../../types';
3
3
  import { FlashingCellDefinition } from '../../../types';
4
4
  /**
5
5
  * Defines an Alert fired by AdapTable
6
6
  */
7
- export interface AdaptableFlashingCell extends AdaptableObject {
7
+ export interface AdaptableFlashingCell extends Identifiable {
8
8
  /**
9
9
  * Rule that caused the FlashingCell to fire
10
10
  */
@@ -5,13 +5,18 @@ import { ColumnScope } from './ColumnScope';
5
5
  */
6
6
  export type AdaptableVersion = `${string}.${string}.${string}`;
7
7
  /**
8
- * Base interface which all other Adaptable State-related objects extend
8
+ * Interface for objects that can be uniquely identified by a UUID
9
9
  */
10
- export interface AdaptableObject {
10
+ export interface Identifiable {
11
11
  /**
12
12
  * Unique identifier for the Object, generated and used internally by AdapTable
13
13
  */
14
14
  Uuid?: TypeUuid;
15
+ }
16
+ /**
17
+ * Base interface which all other Adaptable State-related objects extend
18
+ */
19
+ export interface AdaptableObject extends Identifiable {
15
20
  /**
16
21
  * Source of state object: 'InitialState' if provided via `AdaptableOptions.initialState`, 'User' or undefined for runtime state
17
22
  */
@@ -57,3 +62,21 @@ export interface AdaptableObjectLookupCriteria {
57
62
  export interface AdaptableObjectWithScope extends AdaptableObject {
58
63
  Scope: ColumnScope;
59
64
  }
65
+ /**
66
+ * Interface that extends Adaptable Object for those config items that can be suspended at run-time
67
+ */
68
+ export interface SuspendableObject extends AdaptableObject {
69
+ /**
70
+ * Suspends (i.e. turns off) an Adaptable Object
71
+ */
72
+ IsSuspended?: boolean;
73
+ }
74
+ /**
75
+ * Interface that extends Adaptable Object for those config items that have a Name
76
+ */
77
+ export interface NamedObject extends AdaptableObject {
78
+ /**
79
+ * Name of the Adaptable Object
80
+ */
81
+ Name: string;
82
+ }
@@ -39,7 +39,7 @@ export interface AdaptableStyle {
39
39
  */
40
40
  ClassName?: string;
41
41
  /**
42
- * Align to 'Left' or 'Right' or 'Center'
42
+ * Align to `Left`, `Right` or `Center`
43
43
  */
44
44
  Alignment?: Alignment;
45
45
  }
@@ -1,5 +1,5 @@
1
- import { SuspendableObject } from './SuspendableObject';
2
1
  import { TypeHint } from './Types';
2
+ import { SuspendableObject } from './AdaptableObject';
3
3
  export declare const ROW_SUMMARY_ROW_ID = "__ROW_SUMMARY_ROW_ID";
4
4
  export declare const WEIGHTED_AVERAGE_AGGREGATED_FUNCTION = "WEIGHTED_AVERAGE";
5
5
  export declare const summarySupportedExpressions: readonly ["MIN", "MAX", "SUM", "AVG", "COUNT", "MEDIAN", "MODE", "DISTINCT", "ONLY", "STD_DEVIATION", "WEIGHTED_AVERAGE"];
@@ -1,9 +1,8 @@
1
- import { AdaptableObject } from './AdaptableObject';
2
- import { SuspendableObject } from './SuspendableObject';
1
+ import { NamedObject, SuspendableObject } from './AdaptableObject';
3
2
  /**
4
3
  * Defines when an action will be run - either one-off or recurring
5
4
  */
6
- export interface Schedule extends AdaptableObject {
5
+ export interface Schedule {
7
6
  /**
8
7
  * Hour the Schedule will run
9
8
  */
@@ -24,7 +23,7 @@ export interface Schedule extends AdaptableObject {
24
23
  /**
25
24
  * Base Schedule object - typically overriden by Functions
26
25
  */
27
- export interface BaseSchedule extends SuspendableObject {
26
+ export interface BaseSchedule extends NamedObject, SuspendableObject {
28
27
  /**
29
28
  * The Schedule to run
30
29
  */
@@ -1,9 +1,9 @@
1
1
  import { AdaptableMessageType } from './AdaptableMessageType';
2
- import { AdaptableObject } from '../../types';
2
+ import { Identifiable } from '../../types';
3
3
  /**
4
4
  * Wraps a System Status Message
5
5
  */
6
- export interface SystemStatusMessageInfo extends AdaptableObject {
6
+ export interface SystemStatusMessageInfo extends Identifiable {
7
7
  /**
8
8
  * The Message to be displayed
9
9
  */
@@ -1,5 +1,5 @@
1
1
  import { BaseState } from './BaseState';
2
- import { SuspendableObject } from './Common/SuspendableObject';
2
+ import { NamedObject, SuspendableObject } from './Common/AdaptableObject';
3
3
  /**
4
4
  * Adaptable State Section for Custom Sort Module
5
5
  */
@@ -12,7 +12,7 @@ export interface CustomSortState extends BaseState {
12
12
  /**
13
13
  * Custom Sort object used in Custom Sort function.
14
14
  */
15
- export interface CustomSort extends SuspendableObject {
15
+ export interface CustomSort extends SuspendableObject, NamedObject {
16
16
  /**
17
17
  * Id of Column on which Custom Sort will be applied
18
18
  */
@@ -1,6 +1,6 @@
1
1
  import { BaseState } from './BaseState';
2
2
  import { AdaptableDashboardToolbars, AdaptableModuleButtons } from './Common/Types';
3
- import { AdaptableObject } from './Common/AdaptableObject';
3
+ import { AdaptableObject, NamedObject } from './Common/AdaptableObject';
4
4
  /**
5
5
  * Adaptable State Section for the AdapTable Dashboard
6
6
  */
@@ -56,7 +56,7 @@ export interface DashboardState extends BaseState {
56
56
  /**
57
57
  * Defines a named set of Toolbars in the AdapTable Dashboard
58
58
  */
59
- export interface DashboardTab extends AdaptableObject {
59
+ export interface DashboardTab extends NamedObject {
60
60
  /**
61
61
  * Name of the tab - as appears in the Dashboard
62
62
  */
@@ -2,7 +2,7 @@ import { BaseState } from './BaseState';
2
2
  import { BaseSchedule } from './Common/Schedule';
3
3
  import { ColumnScope } from './Common/ColumnScope';
4
4
  import { AdaptableColumnBase } from './Common/AdaptableColumn';
5
- import { AdaptableObject } from './Common/AdaptableObject';
5
+ import { NamedObject } from './Common/AdaptableObject';
6
6
  import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
7
7
  import { TypeHint } from './Common/Types';
8
8
  import { ExportDestinationType } from '../AdaptableOptions/ExportOptions';
@@ -26,7 +26,7 @@ export interface ExportState extends BaseState {
26
26
  /**
27
27
  * A Report which can export data from AdapTable
28
28
  */
29
- export interface Report extends AdaptableObject {
29
+ export interface Report extends NamedObject {
30
30
  /**
31
31
  * Name of Report
32
32
  */
@@ -4,7 +4,7 @@ import { AdaptableColumnPredicate, ColumnScope } from '../types';
4
4
  import { XOR } from '../Utilities/Extensions/TypeExtensions';
5
5
  import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
6
6
  import { TypeHint } from './Common/Types';
7
- import { SuspendableObject } from '../../types';
7
+ import { NamedObject, SuspendableObject } from '../../types';
8
8
  /**
9
9
  * Adaptable State Section for Flashing Cell module
10
10
  */
@@ -33,7 +33,7 @@ export type FlashTargetTypes = 'row' | 'cell' | 'aggFuncCell';
33
33
  /**
34
34
  * The Flashing Cell Definition
35
35
  */
36
- export interface FlashingCellDefinition extends SuspendableObject {
36
+ export interface FlashingCellDefinition extends NamedObject, SuspendableObject {
37
37
  /**
38
38
  * Which Columns, DataTypes or Column Types can Flash
39
39
  */
@@ -3,11 +3,11 @@ import { AdaptableStyle } from './Common/AdaptableStyle';
3
3
  import { AdaptableFormat } from './Common/AdaptableFormat';
4
4
  import { ColumnScope } from './Common/ColumnScope';
5
5
  import { RowScope } from './Common/RowScope';
6
- import { SuspendableObject } from './Common/SuspendableObject';
7
6
  import { XOR } from '../Utilities/Extensions/TypeExtensions';
8
7
  import { TypeHint } from './Common/Types';
9
8
  import { AdaptableBooleanQuery, LayoutExtendedConfig } from '../types';
10
9
  import { AdaptableColumnPredicate } from './Common/AdaptablePredicate';
10
+ import { NamedObject, SuspendableObject } from './Common/AdaptableObject';
11
11
  /**
12
12
  * Adaptable State Section for Format Column Module
13
13
  */
@@ -20,7 +20,7 @@ export interface FormatColumnState extends BaseState {
20
20
  /**
21
21
  * Object used in Format Column function
22
22
  */
23
- export interface FormatColumn extends SuspendableObject {
23
+ export interface FormatColumn extends SuspendableObject, NamedObject {
24
24
  /**
25
25
  * Where Format will be applied: whole Row, some Columns, or Columns of DataType
26
26
  */
@@ -1,8 +1,8 @@
1
1
  import { BaseState } from './BaseState';
2
- import { AdaptableObject } from './Common/AdaptableObject';
2
+ import { AdaptableObject, NamedObject } from './Common/AdaptableObject';
3
3
  import { ColumnSort } from './Common/ColumnSort';
4
4
  import { ColumnFilter, GridFilter } from '../types';
5
- import { TableAggregationColumns, PivotAggregationColumns } from './Common/AggregationColumns';
5
+ import { PivotAggregationColumns, TableAggregationColumns } from './Common/AggregationColumns';
6
6
  import { RowSummary } from './Common/RowSummary';
7
7
  import { NonEmptyArray } from '../Utilities/Extensions/ArrayExtensions';
8
8
  import { XOR } from '../Utilities/Extensions/TypeExtensions';
@@ -30,7 +30,7 @@ export interface LayoutState extends BaseState {
30
30
  /**
31
31
  * Base object for both Table and Pivot Layouts
32
32
  */
33
- export interface LayoutBase extends AdaptableObject {
33
+ export interface LayoutBase extends NamedObject {
34
34
  /**
35
35
  * Name of Layout as will appear in Layout toolbar and tool panel
36
36
  */
@@ -165,6 +165,11 @@ export interface PivotLayout extends LayoutBase {
165
165
  * Display automatically calculated Totals within EACH Pivot Column Group, in the position specified
166
166
  */
167
167
  PivotColumnTotal?: PivotTotalPosition;
168
+ /**
169
+ * Ordered list of Pivot Result Column Ids to control their display order.
170
+ * Set to `true` to enable tracking the current display order (will be populated automatically).
171
+ */
172
+ PivotResultColumnsOrder?: string[] | boolean;
168
173
  }
169
174
  /**
170
175
  * Defines the position of Pivot Total position - 'before' or 'after' the Value Column(s)
@@ -1,6 +1,6 @@
1
1
  import { BaseState } from './BaseState';
2
2
  import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
3
- import { AdaptableObject } from './Common/AdaptableObject';
3
+ import { NamedObject } from './Common/AdaptableObject';
4
4
  /**
5
5
  * Adaptable State Section for Named Query Module
6
6
  */
@@ -13,7 +13,7 @@ export interface NamedQueryState extends BaseState {
13
13
  /**
14
14
  * Defines a Query which can be referenced in AdaptableQL Expressions
15
15
  */
16
- export interface NamedQuery extends AdaptableBooleanQuery, AdaptableObject {
16
+ export interface NamedQuery extends AdaptableBooleanQuery, NamedObject {
17
17
  /**
18
18
  * Name of the Query - how it will appear in the Expression
19
19
  */
@@ -1,7 +1,7 @@
1
1
  import { BaseState } from './BaseState';
2
2
  import { ColumnScope } from './Common/ColumnScope';
3
3
  import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
4
- import { SuspendableObject } from './Common/SuspendableObject';
4
+ import { NamedObject, SuspendableObject } from './Common/AdaptableObject';
5
5
  /**
6
6
  * Adaptable State Section for Plus Minus Module
7
7
  */
@@ -14,7 +14,7 @@ export interface PlusMinusState extends BaseState {
14
14
  /**
15
15
  * Defines a Plus Minus Rule - used in the Plus Minus Module
16
16
  */
17
- export interface PlusMinusNudge extends SuspendableObject {
17
+ export interface PlusMinusNudge extends NamedObject, SuspendableObject {
18
18
  /**
19
19
  * Where Rule is applied
20
20
  */
@@ -1,6 +1,6 @@
1
1
  import { BaseState } from './BaseState';
2
2
  import { ColumnScope } from './Common/ColumnScope';
3
- import { SuspendableObject } from './Common/SuspendableObject';
3
+ import { NamedObject, SuspendableObject } from './Common/AdaptableObject';
4
4
  /**
5
5
  * Adaptable State Section for Shortcut Module
6
6
  */
@@ -17,7 +17,7 @@ export type ShortcutScopeDataType = 'number';
17
17
  /**
18
18
  * Used to define a Shortcut as used in Shortcut State
19
19
  */
20
- export interface Shortcut extends SuspendableObject {
20
+ export interface Shortcut extends NamedObject, SuspendableObject {
21
21
  /**
22
22
  * Numeric Columns where Shortcut is applied
23
23
  */
@@ -1,9 +1,9 @@
1
1
  import { BaseState } from './BaseState';
2
- import { SuspendableObject } from './Common/SuspendableObject';
3
2
  import { AdaptablePredicate, AdaptableStyle, AdaptableBooleanQuery, AdaptableIcon } from '../types';
4
3
  import { TypeHint } from './Common/Types';
5
4
  import { RowScope } from './Common/RowScope';
6
5
  import { AgSparklineOptions } from 'ag-charts-types';
6
+ import { SuspendableObject } from './Common/AdaptableObject';
7
7
  /**
8
8
  * Adaptable State Section for Styled Column Module
9
9
  */
@@ -1,5 +1,5 @@
1
1
  import { BaseState } from './BaseState';
2
- import { AdaptableObject } from './Common/AdaptableObject';
2
+ import { NamedObject } from './Common/AdaptableObject';
3
3
  import { TypeHint } from './Common/Types';
4
4
  /**
5
5
  * Theme section of Adaptable State
@@ -21,7 +21,7 @@ export interface ThemeState extends BaseState {
21
21
  /**
22
22
  * Used for creating User (i.e. Custom) Themes
23
23
  */
24
- export interface AdaptableTheme extends AdaptableObject {
24
+ export interface AdaptableTheme extends NamedObject {
25
25
  /**
26
26
  * Name of the Theme
27
27
  */
@@ -52,11 +52,14 @@ export interface CustomSortApi {
52
52
  addCustomSort(customSort: CustomSort): CustomSort;
53
53
  /**
54
54
  * Creates new Custom Sort based on given values
55
- * @param columnId Id of Column to which to apply Custom Sort
56
- * @param values Custom Sort values to apply
55
+ * @param params Parameters for creating a Custom Sort
57
56
  * @returns Custom Sort
58
57
  */
59
- createCustomSort(columnId: string, values: string[]): CustomSort;
58
+ createCustomSort(params: {
59
+ name: string;
60
+ columnId: string;
61
+ values: string[];
62
+ }): CustomSort;
60
63
  /**
61
64
  * Updates existing Custom Sort with new set of Sorted Values
62
65
  * @param columnId Id of Column on which to edit the Custom Sort
@@ -18,7 +18,11 @@ export declare class CustomSortApiImpl extends ApiBase implements CustomSortApi
18
18
  getCustomSortByColumn(column: string): CustomSort;
19
19
  getCustomSortForColumn(columnId: string): CustomSort | undefined;
20
20
  addCustomSort(customSort: CustomSort): CustomSort;
21
- createCustomSort(columnId: string, values: string[]): CustomSort;
21
+ createCustomSort(params: {
22
+ name: string;
23
+ columnId: string;
24
+ values: string[];
25
+ }): CustomSort;
22
26
  editCustomSortValues(columnId: string, values: string[]): CustomSort;
23
27
  editCustomSort(customSort: CustomSort): CustomSort;
24
28
  deleteCustomSort(column: string): void;
@@ -70,8 +70,8 @@ export class CustomSortApiImpl extends ApiBase {
70
70
  this.dispatchAction(CustomSortRedux.CustomSortAdd(customSort));
71
71
  return this.getCustomSortById(customSort.Uuid);
72
72
  }
73
- createCustomSort(columnId, values) {
74
- let customSort = { ColumnId: columnId, SortedValues: values };
73
+ createCustomSort(params) {
74
+ let customSort = { Name: params.name, ColumnId: params.columnId, SortedValues: params.values };
75
75
  return this.addCustomSort(customSort);
76
76
  }
77
77
  editCustomSortValues(columnId, values) {
@@ -274,6 +274,7 @@ export const pivotLayoutToPivotLayoutModel = (pivotLayout) => {
274
274
  GrandTotalRow: pivotLayout.GrandTotalRow,
275
275
  PivotGrandTotal: pivotLayout.PivotGrandTotal,
276
276
  PivotColumnTotal: pivotLayout.PivotColumnTotal,
277
+ PivotResultColumnsOrder: pivotLayout.PivotResultColumnsOrder,
277
278
  RowGroupValues: toRowGroupValuesForLayoutModel(pivotLayout.RowGroupValues),
278
279
  ColumnGroupValues: pivotLayout.ColumnGroupValues
279
280
  ? pivotLayout.ColumnGroupValues.ColumnGroupDefaultBehavior === 'always-expanded' ||
@@ -507,6 +508,12 @@ export const pivotLayoutModelToPivotLayout = (layoutModel) => {
507
508
  else {
508
509
  delete pivotLayout.PivotColumnTotal;
509
510
  }
511
+ if (layoutModel.PivotResultColumnsOrder != null) {
512
+ pivotLayout.PivotResultColumnsOrder = layoutModel.PivotResultColumnsOrder;
513
+ }
514
+ else {
515
+ delete pivotLayout.PivotResultColumnsOrder;
516
+ }
510
517
  if (layoutModel.PivotAggregationColumns) {
511
518
  pivotLayout.PivotAggregationColumns = (layoutModel.PivotAggregationColumns || []).map(({ ColumnId, AggFunc, Total }) => ({
512
519
  ColumnId,
@@ -154,6 +154,7 @@ export class ScheduleApiImpl extends ApiBase {
154
154
  header: reminderSchedule.Header,
155
155
  message: reminderSchedule.Message,
156
156
  alertDefinition: {
157
+ Name: reminderSchedule.Header,
157
158
  MessageType: reminderSchedule.MessageType,
158
159
  AlertProperties: {
159
160
  DisplayNotification: reminderSchedule.DisplayNotification,
@@ -168,11 +168,11 @@ export declare const getColumnFilterSelector: (state: AdaptableState, columnId:
168
168
  Predicates: import("../../types").ColumnFilterPredicate[];
169
169
  PredicatesOperator?: import("../../types").PredicatesOperator;
170
170
  IsSuspended?: boolean;
171
- Uuid?: import("../../AdaptableState/Uuid").TypeUuid;
172
171
  Source?: "InitialState" | "User";
173
172
  AdaptableVersion?: import("../../types").AdaptableVersion;
174
173
  IsReadOnly?: boolean;
175
174
  Tags?: import("../../types").AdaptableObjectTag[];
176
175
  Metadata?: any;
176
+ Uuid?: import("../../AdaptableState/Uuid").TypeUuid;
177
177
  };
178
178
  export declare const LayoutReducer: Redux.Reducer<LayoutState>;
@@ -183,6 +183,10 @@ export class AlertModule extends AdaptableModuleBase {
183
183
  const alertType = getAlertType(alert);
184
184
  return {
185
185
  items: [
186
+ {
187
+ name: 'Name',
188
+ values: [alert.Name],
189
+ },
186
190
  getAlertTypeViewItems(alert),
187
191
  alertType === 'DataChange' && {
188
192
  ...getScopeViewItems(alert.Scope, this.api),
@@ -47,6 +47,10 @@ export class CustomSortModule extends AdaptableModuleBase {
47
47
  toView(customSort) {
48
48
  return {
49
49
  items: [
50
+ {
51
+ name: 'Name',
52
+ values: [customSort.Name],
53
+ },
50
54
  getCustomSortColumnViewItems(customSort, this.api),
51
55
  getCustomSortSortOrderViewItems(customSort),
52
56
  getObjectTagsViewItems(customSort, this.api),
@@ -182,6 +182,7 @@ export class FlashingCellModule extends AdaptableModuleBase {
182
182
  }
183
183
  return [
184
184
  this.createMenuItemReduxAction('flashing-cell-add', 'Add Flashing Cell', this.moduleInfo.Glyph, FlashingCellRedux.FlashingCellDefinitionAdd({
185
+ Name: `Any Change [${column.columnId}]`,
185
186
  Scope: {
186
187
  ColumnIds: [column.columnId],
187
188
  },
@@ -247,6 +248,10 @@ export class FlashingCellModule extends AdaptableModuleBase {
247
248
  toView(flashingCell) {
248
249
  return {
249
250
  items: [
251
+ {
252
+ name: 'Name',
253
+ values: [flashingCell.Name],
254
+ },
250
255
  { ...getScopeViewItems(flashingCell.Scope, this.api), label: 'Trigger' },
251
256
  {
252
257
  ...getRuleViewItems(flashingCell.Rule, this.api),
@@ -82,6 +82,10 @@ export class FormatColumnModule extends AdaptableModuleBase {
82
82
  return {
83
83
  abObject: formatColumn,
84
84
  items: [
85
+ {
86
+ name: 'Name',
87
+ values: [formatColumn.Name],
88
+ },
85
89
  getScopeViewItems(formatColumn.Scope, this.api),
86
90
  getFormatColumnSettingsTargetItems(formatColumn),
87
91
  formatColumn.Rule && getRuleViewItems(formatColumn.Rule, this.api),
@@ -299,14 +299,14 @@ export class LayoutModule extends AdaptableModuleBase {
299
299
  }
300
300
  return {
301
301
  items: [
302
- {
303
- name: 'Grid Type',
304
- values: [isPivotLayout(layout) ? 'Pivot' : 'Table'],
305
- },
306
302
  {
307
303
  name: 'Name',
308
304
  values: [layout.Name],
309
305
  },
306
+ {
307
+ name: 'Grid Type',
308
+ values: [isPivotLayout(layout) ? 'Pivot' : 'Table'],
309
+ },
310
310
  /**
311
311
  * Hide pivot columns.
312
312
  *
@@ -200,6 +200,10 @@ export class PlusMinusModule extends AdaptableModuleBase {
200
200
  return {
201
201
  abObject: plusMinus,
202
202
  items: [
203
+ {
204
+ name: 'Name',
205
+ values: [plusMinus.Name],
206
+ },
203
207
  {
204
208
  name: 'Target',
205
209
  ...getScopeViewItems(plusMinus.Scope, this.api),
@@ -132,6 +132,10 @@ export class ScheduleModule extends AdaptableModuleBase {
132
132
  return {
133
133
  abObject: schedule,
134
134
  items: [
135
+ {
136
+ name: 'Name',
137
+ values: [schedule.Name],
138
+ },
135
139
  {
136
140
  name: 'Settings',
137
141
  values: getScheduleSettingsValues(schedule).map((description) => `${description.label}: ${description.value}`),