@adaptabletools/adaptable 12.0.2 → 12.0.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 (69) hide show
  1. package/bundle.cjs.js +100 -100
  2. package/package.json +1 -1
  3. package/publishTimestamp.d.ts +1 -1
  4. package/publishTimestamp.js +1 -1
  5. package/src/AdaptableOptions/EditOptions.d.ts +6 -9
  6. package/src/AdaptableOptions/ExportOptions.d.ts +18 -3
  7. package/src/AdaptableOptions/Glue42PluginOptions.d.ts +1 -1
  8. package/src/AdaptableOptions/IPushPullPluginOptions.d.ts +1 -3
  9. package/src/Api/Events/SearchChanged.d.ts +1 -1
  10. package/src/Api/FinanceApi.d.ts +8 -8
  11. package/src/Api/FormatColumnApi.d.ts +5 -0
  12. package/src/Api/Implementation/FormatColumnApiImpl.d.ts +1 -0
  13. package/src/Api/Implementation/FormatColumnApiImpl.js +23 -1
  14. package/src/Api/Implementation/InternalApiImpl.js +1 -2
  15. package/src/Api/Implementation/LayoutApiImpl.d.ts +1 -0
  16. package/src/Api/Implementation/LayoutApiImpl.js +7 -1
  17. package/src/Api/LayoutApi.d.ts +5 -0
  18. package/src/Api/StatusBarApi.d.ts +3 -0
  19. package/src/PredefinedConfig/ChartingState.d.ts +1 -1
  20. package/src/PredefinedConfig/Common/CellSummary.d.ts +3 -0
  21. package/src/PredefinedConfig/Common/ColumnFilter.d.ts +9 -0
  22. package/src/PredefinedConfig/Common/FDC3Context.d.ts +12 -3
  23. package/src/PredefinedConfig/Common/FilterActionOnDataChange.d.ts +1 -2
  24. package/src/PredefinedConfig/Common/FilterActionOnDataChange.js +1 -2
  25. package/src/PredefinedConfig/ExportState.d.ts +6 -0
  26. package/src/PredefinedConfig/FormatColumnState.d.ts +4 -1
  27. package/src/PredefinedConfig/IPushPullState.d.ts +16 -5
  28. package/src/PredefinedConfig/LayoutState.d.ts +1 -1
  29. package/src/PredefinedConfig/ScheduleState.d.ts +1 -1
  30. package/src/PredefinedConfig/ShortcutState.d.ts +1 -1
  31. package/src/PredefinedConfig/TeamSharingState.d.ts +6 -0
  32. package/src/Redux/ActionsReducers/GridRedux.d.ts +30 -1
  33. package/src/Redux/ActionsReducers/GridRedux.js +105 -2
  34. package/src/Redux/ActionsReducers/LayoutRedux.d.ts +10 -11
  35. package/src/Redux/ActionsReducers/LayoutRedux.js +10 -10
  36. package/src/Redux/Store/AdaptableStore.js +43 -8
  37. package/src/Strategy/FormatColumnModule.js +1 -1
  38. package/src/Strategy/LayoutModule.js +2 -1
  39. package/src/Utilities/Constants/GeneralConstants.d.ts +1 -0
  40. package/src/Utilities/Constants/GeneralConstants.js +3 -2
  41. package/src/Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions.d.ts +3 -0
  42. package/src/Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions.js +4 -4
  43. package/src/Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions.d.ts +3 -0
  44. package/src/Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions.js +7 -7
  45. package/src/Utilities/ExpressionFunctions/booleanExpressionFunctions.d.ts +3 -0
  46. package/src/Utilities/ExpressionFunctions/booleanExpressionFunctions.js +26 -4
  47. package/src/Utilities/ExpressionFunctions/expressionFunctionUtils.js +5 -5
  48. package/src/Utilities/ExpressionFunctions/observableExpressionFunctions.d.ts +3 -0
  49. package/src/Utilities/ExpressionFunctions/observableExpressionFunctions.js +11 -11
  50. package/src/Utilities/ExpressionFunctions/scalarExpressionFunctions.d.ts +3 -0
  51. package/src/Utilities/ExpressionFunctions/scalarExpressionFunctions.js +2 -2
  52. package/src/Utilities/Helpers/FormatHelper.js +3 -2
  53. package/src/Utilities/Helpers/Helper.js +1 -1
  54. package/src/Utilities/ObjectFactory.js +1 -1
  55. package/src/Utilities/Services/QueryLanguageService.js +4 -4
  56. package/src/View/Filter/FilterSummary.d.ts +1 -1
  57. package/src/View/FormatColumn/Wizard/FormatColumnFormatWizardSection.d.ts +1 -2
  58. package/src/View/FormatColumn/Wizard/FormatColumnFormatWizardSection.js +30 -27
  59. package/src/View/Layout/LayoutViewPanel.d.ts +2 -2
  60. package/src/View/Layout/LayoutViewPanel.js +5 -5
  61. package/src/View/Layout/SaveLayoutButton.d.ts +2 -0
  62. package/src/View/Layout/SaveLayoutButton.js +30 -0
  63. package/src/components/ExpressionEditor/BaseEditorInput.js +1 -1
  64. package/src/metamodel/adaptable.metamodel.d.ts +149 -6
  65. package/src/metamodel/adaptable.metamodel.js +1 -1
  66. package/src/parser/src/types.d.ts +2 -6
  67. package/src/types.d.ts +1 -1
  68. package/version.d.ts +1 -1
  69. package/version.js +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adaptabletools/adaptable",
3
- "version": "12.0.2",
3
+ "version": "12.0.5",
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
  "keywords": [
6
6
  "web-components",
@@ -1,2 +1,2 @@
1
- declare const _default: 1656835883968;
1
+ declare const _default: 1657198207277;
2
2
  export default _default;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.default = 1656835883968;
3
+ exports.default = 1657198207277;
@@ -7,28 +7,22 @@ import { GridCell } from '../PredefinedConfig/Selection/GridCell';
7
7
  */
8
8
  export interface EditOptions {
9
9
  /**
10
- * Function to validate on Server Adaptable data edits
11
- *
12
- * @defaultValue undefined
10
+ * Function to validate Adaptable data edits on Server
13
11
  */
14
12
  validateOnServer?: (cellDataChangedInfo: CellDataChangedInfo) => Promise<ValidationResult>;
15
13
  /**
16
- * Displays message after Server Validation
14
+ * Whether to display message after Server Validation runs
17
15
  *
18
16
  * @defaultValue true
19
17
  * @gridInfoItem
20
18
  */
21
19
  displayServerValidationMessages?: boolean;
22
20
  /**
23
- * Function which checks if given Grid Cell is editable
24
- *
25
- * @defaultValue undefined
21
+ * Function which checks if a given Grid Cell is editable
26
22
  */
27
23
  isCellEditable?: (gridCell: GridCell) => boolean;
28
24
  /**
29
25
  * Custom Operations to use in Smart Edit
30
- *
31
- * @defaultValue undefined
32
26
  */
33
27
  smartEditCustomOperations?: SmartEditCustomOperation[];
34
28
  }
@@ -58,6 +52,9 @@ export declare type SmartEditCustomOperation = {
58
52
  */
59
53
  operation: (context: SmartEditOperationContext) => number;
60
54
  };
55
+ /**
56
+ * Operation used by Smart Edit - either System or Custom
57
+ */
61
58
  export declare type SmartEditOperation = SmartEditCustomOperation | MathOperation;
62
59
  /**
63
60
  * Context used in Custom Smart Edit Operations
@@ -72,15 +72,15 @@ export interface CustomReport {
72
72
  */
73
73
  export interface CustomDestination {
74
74
  /**
75
- * Name of Custom Destination
75
+ * Name of Custom Destination (mandatory)
76
76
  */
77
77
  name: string;
78
78
  /**
79
- * Optional Adaptable Form - if provided, it must include Buttons that will execute the export
79
+ * Optional Adaptable Form; if provided, it must include Buttons that will execute the Export
80
80
  */
81
81
  form?: AdaptableForm<ExportFormContext>;
82
82
  /**
83
- * Function invoked when export is applied (used if no form is supplied)
83
+ * Optional Function invoked when Export is applied (used if no form is supplied)
84
84
  */
85
85
  onExport?: (reportContext: ReportContext) => void;
86
86
  }
@@ -101,9 +101,24 @@ export interface ExportFormContext extends FormContext {
101
101
  */
102
102
  customDestination: CustomDestination;
103
103
  }
104
+ /**
105
+ * List of System Export Destinations
106
+ */
104
107
  export declare type SystemExportDestinations = SystemExportDestination[];
108
+ /**
109
+ * Export Destinations provided by AdapTable
110
+ */
105
111
  export declare type SystemExportDestination = 'Excel' | 'CSV' | 'Clipboard' | 'JSON';
112
+ /**
113
+ * Report Context sent when using Custom Export Destinations
114
+ */
106
115
  export interface ReportContext extends BaseContext {
116
+ /**
117
+ * Definition of Report being Run
118
+ */
107
119
  report: Report;
120
+ /**
121
+ * Data being exported in the Report
122
+ */
108
123
  reportData: ReportData;
109
124
  }
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Options for using the Glue42 plugin which provides a mechanism whereby AdapTable can be integreated with multiple widgets
2
+ * Options for using the Glue42 plugin
3
3
  */
4
4
  export interface Glue42PluginOptions {
5
5
  /**
@@ -1,7 +1,5 @@
1
1
  /**
2
- * Options required for when using the ipushpull plugin
3
- *
4
- * ipushpull allows users to collborate and share data in powerful ways and it integrates very closely with AdapTable.
2
+ * Options available in ipushpull plugin; allows users to collborate and share data in powerful ways
5
3
  */
6
4
  export interface IPushPullPluginOptions {
7
5
  /**
@@ -7,7 +7,7 @@ import { ColumnFilter, DataSet } from '../../types';
7
7
  */
8
8
  export interface SearchChangedInfo extends BaseEventInfo {
9
9
  /**
10
- * What search-related change caused the event to fire
10
+ * How Search was changed: 'CurrentQuery', 'Filter', 'DataChange' or 'Sort'
11
11
  */
12
12
  searchChangedTrigger: 'CurrentQuery' | 'Filter' | 'DataChange' | 'Sort';
13
13
  /**
@@ -10,49 +10,49 @@ export interface FinanceApi {
10
10
  */
11
11
  getPluginOptions(): FinancePluginOptions;
12
12
  /**
13
- * Creates Instrument Context
13
+ * Creates FDC3 Instrument Context
14
14
  * @param instrumentColumn Instrument Column to create Context For
15
15
  * @param rowNode Row Node to use for Context Data
16
16
  */
17
17
  createFDC3InstrumentContext(instrumentColumn: InstrumentColumn, rowNode: RowNode): InstrumentContext;
18
18
  /**
19
- * Creates Instrumentlist Context
19
+ * Creates FDC3 Instrumentlist Context
20
20
  * @param instrumentColumn Instrument Column to create Context For
21
21
  * @param rowNode Row Nodes to use for Context Data
22
22
  */
23
23
  createFDC3InstrumentListContext(instrumentColumn: InstrumentColumn, rowNodes: RowNode[]): InstrumentListContext;
24
24
  /**
25
- * Creates Position Context
25
+ * Creates FDC3 Position Context
26
26
  * @param instrumentColumn Position Column to create Context For
27
27
  * @param rowNode Row Node to use for Context Data
28
28
  */
29
29
  createFDC3PositionContext(positionColumn: PositionColumn, rowNode: RowNode): PositionContext;
30
30
  /**
31
- * Creates Portfolio Context
31
+ * Creates FDC3 Portfolio Context
32
32
  * @param instrumentColumn Position Column to create Context For
33
33
  * @param rowNode Row Nodes to use for Context Data
34
34
  */
35
35
  createFDC3PortfolioContext(positionColumn: PositionColumn, rowNodes: RowNode[]): PortfolioContext;
36
36
  /**
37
- * Creates Contact Context
37
+ * Creates FDC3 Contact Context
38
38
  * @param instrumentColumn Contact Column to create Context For
39
39
  * @param rowNode Row Node to use for Context Data
40
40
  */
41
41
  createFDC3ContactContext(contactColumn: ContactColumn, rowNode: RowNode): ContactContext;
42
42
  /**
43
- * Creates Contact List Context
43
+ * Creates FDC3 Contact List Context
44
44
  * @param instrumentColumn Contact Column to create Context For
45
45
  * @param rowNode Row Nodes to use for Context Data
46
46
  */
47
47
  createFDC3ContactListContext(contactColumn: ContactColumn, rowNodes: RowNode[]): ContactListContext;
48
48
  /**
49
- * Creates Organization Context
49
+ * Creates FDC3 Organization Context
50
50
  * @param instrumentColumn Organization Column to create Context For
51
51
  * @param rowNode Row Node to use for Context Data
52
52
  */
53
53
  createFDC3OrganizationContext(organizationColumn: OrganizationColumn, rowNode: RowNode): OrganizationContext;
54
54
  /**
55
- * Creates Country Context
55
+ * Creates FDC3 Country Context
56
56
  * @param instrumentColumn Country Column to create Context For
57
57
  * @param rowNode Row Node to use for Context Data
58
58
  */
@@ -199,4 +199,9 @@ export interface FormatColumnApi {
199
199
  * @param options formatter options
200
200
  */
201
201
  getDateFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
202
+ /**
203
+ * Checks if a Format Column contains a Custom Display Formatter
204
+ * @param formatColumn Format Column
205
+ */
206
+ hasCustomDisplayFormatter(formatColumn: FormatColumn): boolean;
202
207
  }
@@ -48,4 +48,5 @@ export declare class FormatColumnApiImpl extends ApiBase implements FormatColumn
48
48
  getNumberFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
49
49
  getStringFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
50
50
  getDateFormattedValue(value: any, node: RowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
51
+ hasCustomDisplayFormatter(formatColumn: FormatColumn): boolean;
51
52
  }
@@ -293,6 +293,9 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
293
293
  }, customDisplayFormatterContext);
294
294
  }
295
295
  getNumberFormattedValue(value, node, abColumn, options) {
296
+ if (!value) {
297
+ return undefined;
298
+ }
296
299
  const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
297
300
  return FormatHelper_1.default.NumberFormatter(preparedValue, options);
298
301
  }
@@ -301,8 +304,27 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
301
304
  return FormatHelper_1.default.StringFormatter(preparedValue, options);
302
305
  }
303
306
  getDateFormattedValue(value, node, abColumn, options) {
307
+ if (!value) {
308
+ return undefined;
309
+ }
304
310
  const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
305
- return FormatHelper_1.default.DateFormatter(preparedValue, options);
311
+ const dateFormatterOptions = options;
312
+ // only use DateFormatter if we have a pattern
313
+ return dateFormatterOptions.Pattern
314
+ ? FormatHelper_1.default.DateFormatter(preparedValue, options)
315
+ : preparedValue;
316
+ }
317
+ hasCustomDisplayFormatter(formatColumn) {
318
+ var _a;
319
+ if (!formatColumn || !formatColumn.DisplayFormat || !formatColumn.DisplayFormat.Options) {
320
+ return false;
321
+ }
322
+ const options = formatColumn.DisplayFormat.Options;
323
+ const columnCustomFormatters = (_a = options === null || options === void 0 ? void 0 : options.CustomDisplayFormats) !== null && _a !== void 0 ? _a : [];
324
+ if (!(columnCustomFormatters === null || columnCustomFormatters === void 0 ? void 0 : columnCustomFormatters.length)) {
325
+ return false;
326
+ }
327
+ return true;
306
328
  }
307
329
  }
308
330
  exports.FormatColumnApiImpl = FormatColumnApiImpl;
@@ -6,7 +6,6 @@ const PopupRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/Pop
6
6
  const SystemRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/SystemRedux"));
7
7
  const SystemRedux_1 = require("../../Redux/ActionsReducers/SystemRedux");
8
8
  const GridRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/GridRedux"));
9
- const LayoutRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/LayoutRedux"));
10
9
  const AlertRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/AlertRedux"));
11
10
  const DeadRedux = tslib_1.__importStar(require("../../Redux/DeadRedux"));
12
11
  const ApiBase_1 = require("./ApiBase");
@@ -239,7 +238,7 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
239
238
  this.dispatchAction(SystemRedux.SetLastAppliedShortcut(gridCell));
240
239
  }
241
240
  updateCurrentDraftLayout(layout) {
242
- this.dispatchAction(LayoutRedux.LayoutUpdateCurrentDraft(layout));
241
+ this.dispatchAction(GridRedux.LayoutUpdateCurrentDraft(layout));
243
242
  }
244
243
  getPrimaryKey() {
245
244
  return this.adaptable.adaptableOptions.primaryKey;
@@ -14,6 +14,7 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
14
14
  fireLayoutChangedEvent(trigger: string, oldSate: LayoutState, newState: LayoutState): void;
15
15
  getCurrentLayout(): Layout;
16
16
  getCurrentLayoutColumnSort(columnId: string): ColumnSort['SortOrder'] | null;
17
+ areDraftAndCurrentLayoutEqual(): boolean;
17
18
  getCurrentLayoutName(): string;
18
19
  getLayoutByName(layoutName: string): Layout | null;
19
20
  getAllLayout(): Layout[];
@@ -76,6 +76,12 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
76
76
  const currentLayout = this.getCurrentLayout();
77
77
  return ((_d = (_c = (_b = (_a = currentLayout === null || currentLayout === void 0 ? void 0 : currentLayout.ColumnSorts) === null || _a === void 0 ? void 0 : _a.find) === null || _b === void 0 ? void 0 : _b.call(_a, (sort) => sort.ColumnId === columnId)) === null || _c === void 0 ? void 0 : _c.SortOrder) !== null && _d !== void 0 ? _d : null);
78
78
  }
79
+ areDraftAndCurrentLayoutEqual() {
80
+ const state = this.getAdaptableState();
81
+ const currentLayout = this.getLayoutByName(state.Layout.CurrentLayout);
82
+ const draftLayout = state.Grid.CurrentLayout;
83
+ return this.areLayoutsEqual(currentLayout, draftLayout);
84
+ }
79
85
  getCurrentLayoutName() {
80
86
  return this.getAdaptableState().Layout.CurrentLayout;
81
87
  }
@@ -329,7 +335,7 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
329
335
  const layout = this.getLayoutByName(layoutName);
330
336
  if (layout) {
331
337
  if (layout.Columns.includes(columnId)) {
332
- this.dispatchAction(LayoutRedux.LayouRemoveColumn(layoutName, columnId));
338
+ this.dispatchAction(LayoutRedux.LayoutRemoveColumn(layoutName, columnId));
333
339
  this.getAdaptableApi().columnApi.hideColumn(columnId);
334
340
  }
335
341
  }
@@ -198,4 +198,9 @@ export interface LayoutApi {
198
198
  * @param layoutName layout from which to remove Column
199
199
  */
200
200
  removeColumnFromLayout(columnId: string, layoutName: string): void;
201
+ /**
202
+ * Checks if the draft layout and the current layout are the same.
203
+ * Useful when `autoSaveLayouts=true`
204
+ */
205
+ areDraftAndCurrentLayoutEqual(): boolean;
201
206
  }
@@ -1,5 +1,8 @@
1
1
  import { GridOptions } from '@ag-grid-community/all-modules';
2
2
  import { AdaptableStatusBar } from '../PredefinedConfig/StatusBarState';
3
+ /**
4
+ * Methods for managaing the Adaptable Status Bar
5
+ */
3
6
  export interface StatusBarApi {
4
7
  /**
5
8
  * Retrieves the current AG Grid Status Bar Panels
@@ -10,7 +10,7 @@ export interface ChartDefinition {
10
10
  model: ChartModel;
11
11
  }
12
12
  /**
13
- * Predefined Configuration for Quick Search Module
13
+ * Used for persisting AG Grids in Adaptable State
14
14
  */
15
15
  export interface ChartingState extends ConfigState {
16
16
  /**
@@ -14,6 +14,9 @@ export interface CellSummmary {
14
14
  Count: number | undefined;
15
15
  [key: string]: any;
16
16
  }
17
+ /**
18
+ * Defines a Custom Cell Summary operation provided by a user
19
+ */
17
20
  export interface CellSummaryOperation {
18
21
  /**
19
22
  * Name of the Operation - will be displayed in the Cell Summary components
@@ -13,8 +13,17 @@ export interface ColumnFilter extends AdaptableObject {
13
13
  */
14
14
  Predicate: ColumnFilterPredicate;
15
15
  }
16
+ /**
17
+ * A Predicate used in Column Filtering
18
+ */
16
19
  export interface ColumnFilterPredicate extends AdaptablePredicate {
17
20
  PredicateId: TypeHint<string, SystemFilterPredicateId>;
18
21
  }
22
+ /**
23
+ * Array containing all System Filter Predicates
24
+ */
19
25
  export declare type SystemFilterPredicateIds = SystemFilterPredicateId[];
26
+ /**
27
+ * List of all the Filter Predicates shipped by AdapTable
28
+ */
20
29
  export declare type SystemFilterPredicateId = 'Values' | 'ExcludeValues' | 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'InRange' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'True' | 'False' | 'BooleanToggle';
@@ -7,11 +7,14 @@ import { FDC3Intent } from '../../types';
7
7
  * it has a field describing what type it is, and data indicating its identity. Use this as a base
8
8
  * to derive your own with any custom properties or metadata.
9
9
  */
10
+ /**
11
+ * General-purpose context type, as defined by FDC3
12
+ */
10
13
  export interface FDC3Context {
11
14
  /**
12
- * Type of context that uniquely identifies it, e.g. "instrument"; used to refer to the accepted context(s) when declaring intents
15
+ * Type of FDC3Context that uniquely identifies it, e.g. "instrument"; used to refer to the accepted context(s) when declaring intents
13
16
  */
14
- type: ContextType;
17
+ type: FDC3ContextType;
15
18
  /**
16
19
  * Name of the context data (optional) - a text string that describes the data being sent
17
20
  */
@@ -228,7 +231,13 @@ export interface AdaptableFDC3EventInfo extends BaseEventInfo {
228
231
  */
229
232
  context: FDC3Context;
230
233
  }
231
- export declare type ContextType = 'fdc3.instrument' | 'fdc3.instrumentList' | 'fdc3.position' | 'fdc3.portfolio' | 'fdc3.contact' | 'fdc3.contactList' | 'fdc3.organization' | 'fdc3.country';
234
+ /**
235
+ * Defines which FDC3 context is being used
236
+ */
237
+ export declare type FDC3ContextType = 'fdc3.instrument' | 'fdc3.instrumentList' | 'fdc3.position' | 'fdc3.portfolio' | 'fdc3.contact' | 'fdc3.contactList' | 'fdc3.organization' | 'fdc3.country';
238
+ /**
239
+ * Context used when providing Custom FDC3 content
240
+ */
232
241
  export interface CustomFDC3Context extends FDC3Context {
233
242
  type: any;
234
243
  }
@@ -1,6 +1,5 @@
1
1
  /**
2
- * Determines whether Adaptable should re-apply filtering after cell and ticking data edits. *
3
- * If the 'applyFilter' value is 'Throttle' then the 'throttleDelay' property should be additionally set.
2
+ * Whether Adaptable re-applies filtering after data edits; if `applyFilter` value is 'Throttle', `throttleDelay` should be set
4
3
  */
5
4
  export interface FilterActionOnDataChange {
6
5
  /**
@@ -1,6 +1,5 @@
1
1
  "use strict";
2
2
  /**
3
- * Determines whether Adaptable should re-apply filtering after cell and ticking data edits. *
4
- * If the 'applyFilter' value is 'Throttle' then the 'throttleDelay' property should be additionally set.
3
+ * Whether Adaptable re-applies filtering after data edits; if `applyFilter` value is 'Throttle', `throttleDelay` should be set
5
4
  */
6
5
  Object.defineProperty(exports, "__esModule", { value: true });
@@ -75,5 +75,11 @@ export interface ReportData {
75
75
  */
76
76
  rows: Record<string, any>[];
77
77
  }
78
+ /**
79
+ * Names of Reports provided by AdapTable
80
+ */
78
81
  export declare type SystemReportName = 'Visual Data' | 'All Data' | 'Current Data' | 'Selected Cells' | 'Selected Rows';
82
+ /**
83
+ * Array containing all System Report names
84
+ */
79
85
  export declare type SystemReportNames = SystemReportName[];
@@ -142,8 +142,11 @@ export interface ColumnComparison {
142
142
  */
143
143
  Color: string;
144
144
  }
145
+ /**
146
+ * Array of CellTextOption available in Format Columns
147
+ */
145
148
  export declare type CellTextOptions = CellTextOption[];
146
149
  /**
147
- * List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
150
+ * Text optionally to show in a Format Column special style: 'CellValue' or 'PercentageValue'
148
151
  */
149
152
  export declare type CellTextOption = 'CellValue' | 'PercentageValue';
@@ -35,20 +35,31 @@ export interface IPushPullDomain {
35
35
  }
36
36
  /**
37
37
  * An ipushpull report
38
- *
39
- * Contains the name of the Report (which will exist in the Export State), and the ipushpull `Folder` and `Page` to which it will be sent.
40
38
  */
41
39
  export interface IPushPullReport extends AdaptableObject {
40
+ /**
41
+ * Name of the Report
42
+ */
42
43
  ReportName: string;
44
+ /**
45
+ * ipushpull Folder which contains the Page
46
+ */
43
47
  Folder: string;
48
+ /**
49
+ * ipushpull Page which will contain the data
50
+ */
44
51
  Page: string;
45
52
  }
46
53
  /**
47
- * Defines an ipushpull Schedule. Used in the Schedule Module (where the State will be stored).
48
- *
49
- * Properties include the report being exported to Excel (via ipushpull) and whether it is Snapshot or Live Data
54
+ * Defines an ipushpull Schedule
50
55
  */
51
56
  export interface IPushPullSchedule extends BaseSchedule {
57
+ /**
58
+ * The report being exported to Excel (via ipushpull)
59
+ */
52
60
  IPushPullReport: IPushPullReport;
61
+ /**
62
+ * How data is sent: 'Snapshot' or 'Live Data'
63
+ */
53
64
  Transmission: 'Snapshot' | 'Live Data';
54
65
  }
@@ -16,7 +16,7 @@ export interface LayoutState extends ConfigState {
16
16
  Layouts?: Layout[];
17
17
  }
18
18
  /**
19
- * Layout object - contains everything required including Columns, Sorts, Widths, Aggregations, Grouping and Pivoting details
19
+ * Defines a Layout; contains everything required i.e. Columns, Sorts, Widths, Aggregations, Grouping & Pivoting
20
20
  */
21
21
  export interface Layout extends AdaptableObject {
22
22
  /**
@@ -26,7 +26,7 @@ export interface ScheduleState extends ConfigState {
26
26
  */
27
27
  Glue42Schedules?: Glue42Schedule[];
28
28
  /**
29
- * Schedules connected to OpenFin data exports - available if OpenFin plugin is running
29
+ * Schedules connected to OpenFin exports - available if OpenFin plugin is running
30
30
  */
31
31
  OpenFinSchedules?: OpenFinSchedule[];
32
32
  }
@@ -27,7 +27,7 @@ export interface Shortcut extends SuspendableObject {
27
27
  */
28
28
  ShortcutKey: string;
29
29
  /**
30
- * Value which acts as 2nd operand for ShortcutOperation (the first operand being the cell value)
30
+ * Value acting as 2nd operand for ShortcutOperation (1st operand is the cell value)
31
31
  */
32
32
  ShortcutValue: number;
33
33
  /**
@@ -67,11 +67,17 @@ export interface SharedEntity extends AdaptableObject {
67
67
  */
68
68
  Type: SharedEntityType;
69
69
  }
70
+ /**
71
+ * Defines Objects which have been imported into Team Sharing
72
+ */
70
73
  export interface TeamSharingImportInfo<T extends AdaptableObject> {
71
74
  ModuleEntities: T[];
72
75
  AddAction: (entity: T) => any;
73
76
  EditAction: (entity: T) => any;
74
77
  }
78
+ /**
79
+ * Describes an Object which is being Team Shared
80
+ */
75
81
  export interface SharedEntityConfig {
76
82
  description: string;
77
83
  type: SharedEntityType;
@@ -6,7 +6,7 @@ import { SelectedRowInfo } from '../../PredefinedConfig/Selection/SelectedRowInf
6
6
  import { AdaptableMenuItem } from '../../PredefinedConfig/Common/Menu';
7
7
  import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
8
8
  import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
9
- import { CellSummmary } from '../../types';
9
+ import { Layout, CellSummmary, ColumnFilter } from '../../types';
10
10
  import { RowNode } from '@ag-grid-community/all-modules';
11
11
  /**
12
12
  * @ReduxAction Columns have been set in the Grid
@@ -80,6 +80,12 @@ export declare const GRID_SET_TREE_MODE_ON = "GRID_SET_TREE_MODE_ON";
80
80
  * @ReduxAction Grid is taken out of tree mode
81
81
  */
82
82
  export declare const GRID_SET_TREE_MODE_OFF = "GRID_SET_TREE_MODE_OFF";
83
+ export declare const LAYOUT_UPDATE_CURRENT_DRAFT = "LAYOUT_UPDATE_CURRENT_DRAFT";
84
+ export declare const LAYOUT_DRAFT_COLUMN_FILTER_ADD = "LAYOUT_DRAFT_COLUMN_FILTER_ADD";
85
+ export declare const LAYOUT_DRAFT_COLUMN_FILTER_EDIT = "LAYOUT_DRAFT_COLUMN_FILTER_EDIT";
86
+ export declare const LAYOUT_DRAFT_COLUMN_FILTER_SET = "LAYOUT_DRAFT_COLUMN_FILTER_SET";
87
+ export declare const LAYOUT_DRAFT_COLUMN_FILTER_CLEAR_ALL = "LAYOUT_DRAFT_COLUMN_FILTER_CLEAR_ALL";
88
+ export declare const LAYOUT_DRAFT_COLUMN_FILTER_CLEAR = "LAYOUT_DRAFT_COLUMN_FILTER_CLEAR";
83
89
  export interface GridDataChangedAction extends Redux.Action {
84
90
  cellDataChangedInfo: CellDataChangedInfo;
85
91
  }
@@ -151,6 +157,23 @@ export interface SetTreeModeOnAction extends Redux.Action {
151
157
  }
152
158
  export interface SetTreeModeOffAction extends Redux.Action {
153
159
  }
160
+ export interface LayoutUpdateCurrentDraftAction extends Redux.Action {
161
+ layout: Layout;
162
+ }
163
+ export interface LayoutDraftColumnFilterAddAction extends Redux.Action {
164
+ columnFilter: ColumnFilter;
165
+ }
166
+ export interface LayoutDraftColumnFilterEditAction extends Redux.Action {
167
+ columnFilter: ColumnFilter;
168
+ }
169
+ export interface LayoutDraftColumnFilterSetAction extends Redux.Action {
170
+ columnFilter: ColumnFilter;
171
+ }
172
+ export interface LayoutDraftColumnFilterClearAction extends Redux.Action {
173
+ columnFilter: ColumnFilter;
174
+ }
175
+ export interface LayoutDraftColumnFilterClearAllAction extends Redux.Action {
176
+ }
154
177
  export declare const GridSetColumns: (Columns: AdaptableColumn[]) => GridSetColumnsAction;
155
178
  export declare const GridAddColumn: (Column: AdaptableColumn) => GridAddColumnAction;
156
179
  export declare const GridAddColumns: (Columns: AdaptableColumn[]) => GridAddColumnsAction;
@@ -169,4 +192,10 @@ export declare const SetTreeModeOn: () => SetTreeModeOnAction;
169
192
  export declare const SetTreeModeOff: () => SetTreeModeOffAction;
170
193
  export declare const SetSettingPanelModuleMenuItems: (MenuItems: AdaptableMenuItem[]) => SetSettingPanelModuleMenuItemsAction;
171
194
  export declare const SetModuleButtonMenuItems: (MenuItems: AdaptableMenuItem[]) => SetModuleButtonMenuItemsAction;
195
+ export declare const LayoutUpdateCurrentDraft: (layout: Layout) => LayoutUpdateCurrentDraftAction;
196
+ export declare const LayoutDraftColumnFilterAdd: (columnFilter: ColumnFilter) => LayoutDraftColumnFilterAddAction;
197
+ export declare const LayoutDraftColumnFilterEdit: (columnFilter: ColumnFilter) => LayoutDraftColumnFilterEditAction;
198
+ export declare const LayoutDraftColumnFilterSet: (columnFilter: ColumnFilter) => LayoutDraftColumnFilterSetAction;
199
+ export declare const LayoutDraftColumnFilterClear: (columnFilter: ColumnFilter) => LayoutDraftColumnFilterClearAction;
200
+ export declare const LayoutDraftColumnFilterClearAll: () => LayoutDraftColumnFilterClearAllAction;
172
201
  export declare const GridReducer: Redux.Reducer<GridState>;