@adaptabletools/adaptable 11.2.4-canary.0 → 12.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.
- package/base.css +22 -4
- package/bundle.cjs.js +111 -111
- package/index.css +26 -4
- package/package.json +1 -1
- package/publishTimestamp.d.ts +1 -1
- package/publishTimestamp.js +1 -1
- package/src/AdaptableInterfaces/IAdaptable.d.ts +6 -1
- package/src/AdaptableOptions/ActionOptions.d.ts +1 -0
- package/src/AdaptableOptions/{MasterDetailAgGridPluginOptions.js → ActionOptions.js} +0 -0
- package/src/AdaptableOptions/AdaptableFrameworkComponent.d.ts +5 -0
- package/src/AdaptableOptions/AdaptableOptions.d.ts +3 -3
- package/src/AdaptableOptions/AdaptableQLOptions.d.ts +5 -0
- package/src/AdaptableOptions/AlertOptions.d.ts +14 -1
- package/src/AdaptableOptions/ColumnOptions.d.ts +49 -0
- package/src/AdaptableOptions/{SmartEdit.js → ColumnOptions.js} +0 -0
- package/src/AdaptableOptions/DashboardOptions.d.ts +2 -7
- package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts +19 -0
- package/src/AdaptableOptions/EditOptions.d.ts +92 -4
- package/src/AdaptableOptions/EntitlementOptions.d.ts +7 -1
- package/src/AdaptableOptions/ExportOptions.d.ts +5 -1
- package/src/AdaptableOptions/FilterOptions.d.ts +6 -1
- package/src/AdaptableOptions/FinancePluginOptions.d.ts +33 -3
- package/src/AdaptableOptions/GeneralOptions.d.ts +22 -23
- package/src/AdaptableOptions/{MasterDetailAgGridPluginOptions.d.ts → MasterDetailPluginOptions.d.ts} +2 -4
- package/src/{Api/DataSourceApi.js → AdaptableOptions/MasterDetailPluginOptions.js} +0 -0
- package/src/AdaptableOptions/SettingsPanelOptions.d.ts +3 -6
- package/src/AdaptableOptions/ToolPanelOptions.d.ts +2 -49
- package/src/AdaptableOptions/UserInterfaceOptions.d.ts +81 -54
- package/src/Api/AdaptableApi.d.ts +6 -3
- package/src/Api/ColumnApi.d.ts +6 -3
- package/src/Api/ConditionalStyleApi.d.ts +10 -0
- package/src/Api/ConfigApi.d.ts +0 -12
- package/src/Api/DashboardApi.d.ts +6 -19
- package/src/Api/DataSetApi.d.ts +40 -0
- package/src/{PredefinedConfig/DataSourceState.js → Api/DataSetApi.js} +0 -0
- package/src/Api/EventApi.d.ts +18 -1
- package/src/Api/Events/DataSetChanged.d.ts +5 -0
- package/src/{PredefinedConfig/FilterState.js → Api/Events/DataSetChanged.js} +0 -0
- package/src/Api/Events/RowFormSubmitted.d.ts +19 -0
- package/src/Api/Events/RowFormSubmitted.js +2 -0
- package/src/Api/Events/SearchChanged.d.ts +3 -4
- package/src/Api/FilterApi.d.ts +1 -77
- package/src/Api/FinanceApi.d.ts +3 -2
- package/src/Api/FormatColumnApi.d.ts +28 -1
- package/src/Api/GridApi.d.ts +15 -1
- package/src/Api/Implementation/AdaptableApiImpl.d.ts +2 -2
- package/src/Api/Implementation/AdaptableApiImpl.js +3 -3
- package/src/Api/Implementation/AlertApiImpl.js +5 -1
- package/src/Api/Implementation/ApiBase.d.ts +3 -0
- package/src/Api/Implementation/ApiBase.js +6 -0
- package/src/Api/Implementation/ColumnApiImpl.d.ts +2 -2
- package/src/Api/Implementation/ColumnApiImpl.js +6 -3
- package/src/Api/Implementation/ConditionalStyleApiImpl.d.ts +2 -0
- package/src/Api/Implementation/ConditionalStyleApiImpl.js +8 -0
- package/src/Api/Implementation/ConfigApiImpl.d.ts +0 -4
- package/src/Api/Implementation/ConfigApiImpl.js +2 -24
- package/src/Api/Implementation/DashboardApiImpl.d.ts +3 -6
- package/src/Api/Implementation/DashboardApiImpl.js +5 -29
- package/src/Api/Implementation/DataSetApiImpl.d.ts +12 -0
- package/src/Api/Implementation/DataSetApiImpl.js +42 -0
- package/src/Api/Implementation/EventApiImpl.js +1 -0
- package/src/Api/Implementation/FilterApiImpl.d.ts +1 -16
- package/src/Api/Implementation/FilterApiImpl.js +5 -164
- package/src/Api/Implementation/FormatColumnApiImpl.d.ts +6 -0
- package/src/Api/Implementation/FormatColumnApiImpl.js +34 -0
- package/src/Api/Implementation/GridApiImpl.d.ts +4 -1
- package/src/Api/Implementation/GridApiImpl.js +41 -1
- package/src/Api/Implementation/InternalApiImpl.d.ts +7 -2
- package/src/Api/Implementation/InternalApiImpl.js +51 -10
- package/src/Api/Implementation/LayoutApiImpl.d.ts +18 -1
- package/src/Api/Implementation/LayoutApiImpl.js +172 -0
- package/src/Api/Implementation/PredicateApiImpl.js +1 -1
- package/src/Api/Implementation/SmartEditApiImpl.d.ts +5 -2
- package/src/Api/Implementation/SmartEditApiImpl.js +9 -0
- package/src/Api/Implementation/TeamSharingApiImpl.d.ts +5 -3
- package/src/Api/Implementation/TeamSharingApiImpl.js +28 -10
- package/src/Api/Implementation/UserInterfaceApiImpl.d.ts +1 -1
- package/src/Api/Implementation/UserInterfaceApiImpl.js +7 -25
- package/src/Api/InternalApi.d.ts +6 -2
- package/src/Api/LayoutApi.d.ts +88 -1
- package/src/Api/SmartEditApi.d.ts +14 -3
- package/src/Api/TeamSharingApi.d.ts +18 -5
- package/src/Api/UserInterfaceApi.d.ts +4 -4
- package/src/PredefinedConfig/AdaptableState.d.ts +0 -4
- package/src/PredefinedConfig/CalculatedColumnState.d.ts +5 -0
- package/src/PredefinedConfig/Common/AdaptableButton.d.ts +3 -3
- package/src/PredefinedConfig/Common/AdaptableColumn.d.ts +5 -1
- package/src/PredefinedConfig/Common/AdaptableForm.d.ts +3 -2
- package/src/PredefinedConfig/Common/AdaptableFormat.d.ts +6 -3
- package/src/PredefinedConfig/Common/AdaptableObject.d.ts +2 -11
- package/src/PredefinedConfig/Common/AdaptablePredicate.js +35 -2
- package/src/PredefinedConfig/Common/BaseContext.d.ts +1 -1
- package/src/PredefinedConfig/{FilterState.d.ts → Common/ColumnFilter.d.ts} +2 -33
- package/src/PredefinedConfig/Common/ColumnFilter.js +2 -0
- package/src/PredefinedConfig/Common/Enums.d.ts +2 -2
- package/src/PredefinedConfig/Common/Enums.js +1 -1
- package/src/PredefinedConfig/Common/FDC3Context.d.ts +5 -1
- package/src/PredefinedConfig/Common/Types.d.ts +6 -5
- package/src/PredefinedConfig/Common/Types.js +2 -3
- package/src/PredefinedConfig/LayoutState.d.ts +5 -0
- package/src/PredefinedConfig/PredefinedConfig.d.ts +0 -10
- package/src/PredefinedConfig/StatusBarState.d.ts +1 -2
- package/src/PredefinedConfig/SystemState.d.ts +4 -2
- package/src/Redux/ActionsReducers/LayoutRedux.d.ts +47 -0
- package/src/Redux/ActionsReducers/LayoutRedux.js +135 -1
- package/src/Redux/ActionsReducers/SystemRedux.d.ts +23 -1
- package/src/Redux/ActionsReducers/SystemRedux.js +39 -1
- package/src/Redux/Store/AdaptableStore.js +37 -39
- package/src/Strategy/AlertModule.d.ts +11 -0
- package/src/Strategy/AlertModule.js +14 -0
- package/src/Strategy/CellSummaryModule.d.ts +3 -0
- package/src/Strategy/CellSummaryModule.js +28 -14
- package/src/Strategy/DataSetModule.d.ts +25 -0
- package/src/Strategy/DataSetModule.js +65 -0
- package/src/Strategy/ExportModule.js +6 -1
- package/src/Strategy/FilterModule.d.ts +7 -11
- package/src/Strategy/FilterModule.js +24 -15
- package/src/Strategy/FlashingCellModule.d.ts +1 -1
- package/src/Strategy/FlashingCellModule.js +2 -2
- package/src/Strategy/FormatColumnModule.js +1 -1
- package/src/Strategy/Interface/IModule.d.ts +3 -1
- package/src/Strategy/LayoutModule.js +24 -2
- package/src/Strategy/SmartEditModule.d.ts +1 -1
- package/src/Strategy/SmartEditModule.js +5 -6
- package/src/Strategy/StatusBarModule.js +1 -3
- package/src/Strategy/TeamSharingModule.js +1 -1
- package/src/Strategy/ToolPanelModule.js +1 -4
- package/src/Utilities/Constants/GeneralConstants.d.ts +6 -2
- package/src/Utilities/Constants/GeneralConstants.js +6 -2
- package/src/Utilities/Constants/ModuleConstants.d.ts +1 -1
- package/src/Utilities/Constants/ModuleConstants.js +2 -2
- package/src/Utilities/Defaults/DefaultAdaptableOptions.js +22 -13
- package/src/Utilities/Defaults/DefaultSettingsPanel.js +1 -1
- package/src/Utilities/ExpressionFunctions/booleanExpressionFunctions.js +2 -4
- package/src/Utilities/Helpers/AdaptableHelper.js +4 -1
- package/src/Utilities/ObjectFactory.d.ts +3 -6
- package/src/Utilities/ObjectFactory.js +3 -7
- package/src/Utilities/Services/EntitlementService.js +7 -1
- package/src/Utilities/Services/Interface/IRowEditService.d.ts +8 -0
- package/src/Utilities/Services/Interface/IRowEditService.js +2 -0
- package/src/Utilities/Services/ModuleService.js +1 -1
- package/src/Utilities/Services/ReportService.js +2 -3
- package/src/Utilities/Services/RowEditService.d.ts +25 -0
- package/src/Utilities/Services/RowEditService.js +165 -0
- package/src/Utilities/Services/TeamSharingService.js +4 -4
- package/src/View/AdaptablePopover/index.d.ts +1 -0
- package/src/View/AdaptablePopover/index.js +5 -6
- package/src/View/AdaptableView.js +1 -1
- package/src/View/AdaptableViewFactory.js +2 -2
- package/src/View/Alert/ActiveAlertsPanel.d.ts +2 -0
- package/src/View/Alert/ActiveAlertsPanel.js +15 -0
- package/src/View/Alert/AlertStatusSubPanel.js +3 -8
- package/src/View/Alert/AlertViewPanel.js +2 -2
- package/src/View/Alert/Wizard/AlertDisplayWizardSection.js +1 -1
- package/src/View/BulkUpdate/BulkUpdateViewPanel.js +1 -1
- package/src/View/CalculatedColumn/Wizard/CalculatedColumnExpressionWizardSection.js +1 -1
- package/src/View/CalculatedColumn/Wizard/CalculatedColumnSettingsWizardSection.js +9 -2
- package/src/View/CellSummary/CellSummaryDetails.js +2 -2
- package/src/View/CellSummary/CellSummaryPopover.d.ts +2 -4
- package/src/View/CellSummary/CellSummaryPopover.js +3 -6
- package/src/View/CellSummary/CellSummaryPopup.js +8 -0
- package/src/View/CellSummary/CellSummaryStatusBarSubPanelPopover.js +1 -1
- package/src/View/CellSummary/CellSummaryStatusPanel.js +2 -2
- package/src/View/CellSummary/CellSummaryViewPanel.js +1 -1
- package/src/View/Components/AdaptableObjectList/AdaptableObjectCompactList.js +18 -8
- package/src/View/Components/AdaptableObjectList/AdaptableObjectList.js +1 -2
- package/src/View/Components/ExternalRenderer.d.ts +3 -6
- package/src/View/Components/ExternalRenderer.js +5 -5
- package/src/View/Components/FilterForm/FilterForm.d.ts +5 -2
- package/src/View/Components/FilterForm/FilterForm.js +9 -7
- package/src/View/Components/FilterForm/ListBoxFilterForm.d.ts +4 -1
- package/src/View/Components/FilterForm/ListBoxFilterForm.js +7 -7
- package/src/View/Components/FilterForm/QuickFilterForm.d.ts +1 -1
- package/src/View/Components/FilterForm/QuickFilterForm.js +21 -7
- package/src/View/Components/FilterForm/getDefaultColumnFilterPredicate.d.ts +1 -1
- package/src/View/Components/Popups/AdaptablePopup/AdaptablePopupDialog.js +2 -0
- package/src/View/Components/Popups/AdaptablePopupAlert.d.ts +0 -2
- package/src/View/Components/Popups/AdaptablePopupAlert.js +13 -11
- package/src/View/Components/Popups/AdaptableToaster.js +29 -9
- package/src/View/Components/Popups/FormPopups/FormPopups.js +2 -2
- package/src/View/Components/ToolPanel/AdaptableToolPanel.js +3 -2
- package/src/View/Components/ToolPanel/CustomToolPanelContent.js +11 -9
- package/src/View/Dashboard/CustomDashboardButton.d.ts +11 -0
- package/src/View/Dashboard/CustomDashboardButton.js +47 -0
- package/src/View/Dashboard/CustomToolbarWrapper.d.ts +1 -0
- package/src/View/Dashboard/CustomToolbarWrapper.js +30 -11
- package/src/View/Dashboard/Dashboard.d.ts +1 -0
- package/src/View/Dashboard/Dashboard.js +8 -34
- package/src/View/DataChangeHistory/DataChangeHistoryGrid.js +19 -36
- package/src/View/DataChangeHistory/buildActionColumnButton.d.ts +3 -0
- package/src/View/DataChangeHistory/buildActionColumnButton.js +70 -0
- package/src/View/DataSet/DataSetSelector.d.ts +7 -0
- package/src/View/DataSet/DataSetSelector.js +18 -0
- package/src/View/DataSet/DataSetStatusPanelPopover.d.ts +2 -0
- package/src/View/DataSet/DataSetStatusPanelPopover.js +19 -0
- package/src/View/DataSet/DataSetViewPanel.d.ts +19 -0
- package/src/View/DataSet/DataSetViewPanel.js +58 -0
- package/src/View/Filter/ActiveFiltersPanel.js +1 -1
- package/src/View/Filter/FilterSummary.d.ts +5 -5
- package/src/View/Filter/FilterSummary.js +6 -5
- package/src/View/Filter/FilterViewPanel.d.ts +4 -4
- package/src/View/Filter/FilterViewPanel.js +11 -14
- package/src/View/FormatColumn/Wizard/FormatColumnFormatWizardSection.d.ts +3 -2
- package/src/View/FormatColumn/Wizard/FormatColumnFormatWizardSection.js +51 -22
- package/src/View/FormatColumn/Wizard/FormatColumnWizard.js +1 -1
- package/src/View/GridInfo/GridInfoPopup.js +1 -1
- package/src/View/Layout/LayoutStatusBarSubPanelPopover.js +6 -24
- package/src/View/Layout/Wizard/LayoutEditor/index.js +1 -1
- package/src/View/Layout/Wizard/LayoutEditorWizard.d.ts +2 -1
- package/src/View/SmartEdit/SmartEditPopup.d.ts +1 -1
- package/src/View/SmartEdit/SmartEditPopup.js +3 -4
- package/src/View/SmartEdit/SmartEditViewPanel.d.ts +1 -1
- package/src/View/SmartEdit/SmartEditViewPanel.js +3 -4
- package/src/View/SpecialColumnSettingsWizardStep.js +1 -1
- package/src/View/StatusBar/AdaptableStatusBar.js +1 -1
- package/src/View/StatusBar/StatusBarPanel.d.ts +1 -0
- package/src/View/StatusBar/StatusBarPanel.js +5 -4
- package/src/View/Theme/ThemeStatusPanelPopover.js +5 -25
- package/src/View/UIHelper.d.ts +4 -4
- package/src/View/UIHelper.js +4 -4
- package/src/agGrid/ActionColumnRenderer.d.ts +6 -1
- package/src/agGrid/ActionColumnRenderer.js +9 -6
- package/src/agGrid/Adaptable.d.ts +7 -2
- package/src/agGrid/Adaptable.js +217 -87
- package/src/agGrid/FilterWrapper.js +1 -1
- package/src/agGrid/agGridHelper.d.ts +6 -6
- package/src/agGrid/agGridHelper.js +34 -56
- package/src/agGrid/agGridMenuHelper.js +4 -1
- package/src/agGrid/rowEditIcons.d.ts +4 -0
- package/src/agGrid/rowEditIcons.js +9 -0
- package/src/components/AdaptableFormComponent/AdaptableFormComponent.js +9 -18
- package/src/components/Dashboard/DashboardToolbar.js +2 -2
- package/src/components/Datepicker/index.js +19 -18
- package/src/components/SelectList.d.ts +10 -0
- package/src/components/SelectList.js +9 -0
- package/src/components/WindowModal/WindowModal.d.ts +2 -0
- package/src/components/WindowModal/WindowModal.js +1 -1
- package/src/components/icons/{data-source.d.ts → data-set.d.ts} +0 -0
- package/src/components/icons/{data-source.js → data-set.js} +0 -0
- package/src/components/icons/index.js +2 -2
- package/src/metamodel/adaptable.metamodel.d.ts +242 -70
- package/src/metamodel/adaptable.metamodel.js +620 -376
- package/src/types.d.ts +19 -15
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/src/AdaptableOptions/SmartEdit.d.ts +0 -34
- package/src/Api/DataSourceApi.d.ts +0 -58
- package/src/Api/Implementation/DataSourceApiImpl.d.ts +0 -15
- package/src/Api/Implementation/DataSourceApiImpl.js +0 -51
- package/src/PredefinedConfig/DataSourceState.d.ts +0 -34
- package/src/Redux/ActionsReducers/DataSourceRedux.d.ts +0 -42
- package/src/Redux/ActionsReducers/DataSourceRedux.js +0 -76
- package/src/Redux/ActionsReducers/FilterRedux.d.ts +0 -70
- package/src/Redux/ActionsReducers/FilterRedux.js +0 -126
- package/src/Strategy/DataSourceModule.d.ts +0 -20
- package/src/Strategy/DataSourceModule.js +0 -56
- package/src/View/Components/Forms/AdaptableForm.d.ts +0 -6
- package/src/View/Components/Forms/AdaptableForm.js +0 -21
- package/src/View/DataSource/DataSourceViewPanel.d.ts +0 -19
- package/src/View/DataSource/DataSourceViewPanel.js +0 -69
- package/src/View/DataSource/Wizard/DataSourceSettingsSummary.d.ts +0 -2
- package/src/View/DataSource/Wizard/DataSourceSettingsSummary.js +0 -17
- package/src/View/DataSource/Wizard/DataSourceSettingsWizard.d.ts +0 -8
- package/src/View/DataSource/Wizard/DataSourceSettingsWizard.js +0 -42
- package/src/View/DataSource/Wizard/DataSourceWizard.d.ts +0 -8
- package/src/View/DataSource/Wizard/DataSourceWizard.js +0 -53
|
@@ -1,55 +1,12 @@
|
|
|
1
1
|
import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
|
|
2
|
-
import { AdaptableApi } from '../Api/AdaptableApi';
|
|
3
2
|
import { AdaptableFrameworkComponent } from './AdaptableFrameworkComponent';
|
|
4
3
|
import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
|
|
5
4
|
import { ToolPanelState } from '../PredefinedConfig/ToolPanelState';
|
|
6
|
-
import { BaseContext } from '../types';
|
|
5
|
+
import { BaseContext, CustomRenderContext } from '../types';
|
|
7
6
|
/**
|
|
8
7
|
* Options related to managing the AdapTable ToolPanel Component
|
|
9
8
|
*/
|
|
10
9
|
export interface ToolPanelOptions {
|
|
11
|
-
/**
|
|
12
|
-
* Displays Adaptable ToolPanel Component (only if AG Grid Sidebar is provided)
|
|
13
|
-
*
|
|
14
|
-
* @defaultValue true
|
|
15
|
-
* @gridInfoItem
|
|
16
|
-
*/
|
|
17
|
-
showAdaptableToolPanel?: boolean;
|
|
18
|
-
/**
|
|
19
|
-
* Title for AdapTable ToolPanel Component - appears vertically at side
|
|
20
|
-
*
|
|
21
|
-
* @defaultValue 'AdapTable'
|
|
22
|
-
* @gridInfoItem
|
|
23
|
-
*/
|
|
24
|
-
adaptableToolPanelTitle?: string;
|
|
25
|
-
/**
|
|
26
|
-
* Key of icon to be used (beside the label) for Adaptable ToolPanel Component
|
|
27
|
-
*
|
|
28
|
-
* @defaultValue 'menu'
|
|
29
|
-
* @gridInfoItem
|
|
30
|
-
*/
|
|
31
|
-
iconKey?: string;
|
|
32
|
-
/**
|
|
33
|
-
* The initial width of AdapTable ToolPanel
|
|
34
|
-
* @defaultValue var(--ab-cmp-toolpanel__width)
|
|
35
|
-
*/
|
|
36
|
-
width?: number;
|
|
37
|
-
/**
|
|
38
|
-
* The min width of AdapTable ToolPanel
|
|
39
|
-
* @defaultValue var(--ab-cmp-toolpanel__width)
|
|
40
|
-
*/
|
|
41
|
-
minWidth?: number;
|
|
42
|
-
/**
|
|
43
|
-
* The max width of AdapTable ToolPanel
|
|
44
|
-
* @defaultValue undefined
|
|
45
|
-
*/
|
|
46
|
-
maxWidth?: number;
|
|
47
|
-
/**
|
|
48
|
-
* Order of displayed ToolPanels in Sidebar
|
|
49
|
-
*
|
|
50
|
-
* @defaultValue ['filters', 'columns', 'adaptable']
|
|
51
|
-
*/
|
|
52
|
-
toolPanelOrder?: ('adaptable' | 'columns' | 'filters')[];
|
|
53
10
|
/**
|
|
54
11
|
* Display the Tool Panels dropdown
|
|
55
12
|
*
|
|
@@ -85,11 +42,7 @@ export interface CustomToolPanel extends AdaptableObject {
|
|
|
85
42
|
/**
|
|
86
43
|
* Function to provide bespoke content when NOT using a Framework wrapper
|
|
87
44
|
*/
|
|
88
|
-
render?: (
|
|
89
|
-
visible: boolean;
|
|
90
|
-
node: HTMLDivElement;
|
|
91
|
-
adaptableApi: AdaptableApi;
|
|
92
|
-
}) => string | null;
|
|
45
|
+
render?: (customRenderContext: CustomRenderContext) => string | null;
|
|
93
46
|
/**
|
|
94
47
|
* Framework-specific (Angular or React) component to be rendered
|
|
95
48
|
*/
|
|
@@ -2,11 +2,10 @@ import { AdaptableIcon } from '../PredefinedConfig/Common/AdaptableIcon';
|
|
|
2
2
|
import { DateInputOptions } from './DateInputOptions';
|
|
3
3
|
import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
|
|
4
4
|
import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
|
|
5
|
-
import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
|
|
6
|
-
import { RowNode } from '@ag-grid-community/all-modules';
|
|
7
5
|
import { AdaptableObject, AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
|
|
8
6
|
import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
|
|
9
|
-
import {
|
|
7
|
+
import { AdaptableButton, BaseContext, GridCell } from '../../types';
|
|
8
|
+
import { RowNode } from '@ag-grid-community/all-modules';
|
|
10
9
|
/**
|
|
11
10
|
* Options for managing the User Interface of AdapTable
|
|
12
11
|
*/
|
|
@@ -52,10 +51,6 @@ export interface UserInterfaceOptions {
|
|
|
52
51
|
* Colours to display in Colour Picker (in place of AdapTable's default set); can be hardcoded list or function
|
|
53
52
|
*/
|
|
54
53
|
colorPalette?: string[] | ((currentTheme: string) => string[]);
|
|
55
|
-
/**
|
|
56
|
-
* Columns which contain an AdapTable Button - used for performing Actions
|
|
57
|
-
*/
|
|
58
|
-
actionColumns?: ActionColumn[];
|
|
59
54
|
/**
|
|
60
55
|
* Style to set for editable cells
|
|
61
56
|
*/
|
|
@@ -73,12 +68,7 @@ export interface UserInterfaceOptions {
|
|
|
73
68
|
/**
|
|
74
69
|
* Optional list of AdaptableObjectTags that can be associated with AdaptableObjects
|
|
75
70
|
*/
|
|
76
|
-
objectTags?: AdaptableObjectTag[] | ((
|
|
77
|
-
/**
|
|
78
|
-
* Optional list of Column Types - used primarily for special columns
|
|
79
|
-
*
|
|
80
|
-
*/
|
|
81
|
-
columnTypes?: string[];
|
|
71
|
+
objectTags?: AdaptableObjectTag[] | ((context: ObjectTagsContext) => AdaptableObjectTag[]);
|
|
82
72
|
/**
|
|
83
73
|
* Provide links to AdapTable documentation (in Module popups and Expression Editor)
|
|
84
74
|
*
|
|
@@ -99,56 +89,36 @@ export interface UserInterfaceOptions {
|
|
|
99
89
|
* @gridInfoItem
|
|
100
90
|
*/
|
|
101
91
|
showAdapTableVersion?: boolean;
|
|
102
|
-
}
|
|
103
|
-
export interface BasePermittedValues {
|
|
104
92
|
/**
|
|
105
|
-
*
|
|
93
|
+
* Custom Formatters to use in the Format Column Module
|
|
106
94
|
*/
|
|
107
|
-
|
|
108
|
-
}
|
|
109
|
-
/**
|
|
110
|
-
* Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)
|
|
111
|
-
*/
|
|
112
|
-
export interface PermittedValues extends BasePermittedValues {
|
|
95
|
+
customDisplayFormatters?: CustomDisplayFormatter[];
|
|
113
96
|
/**
|
|
114
|
-
*
|
|
97
|
+
* Options for creating Action Columns and Buttons
|
|
115
98
|
*/
|
|
116
|
-
|
|
99
|
+
actionOptions?: ActionOptions;
|
|
117
100
|
}
|
|
118
101
|
/**
|
|
119
|
-
*
|
|
120
|
-
*/
|
|
121
|
-
export interface EditLookUpPermittedValues extends BasePermittedValues {
|
|
122
|
-
values?: any[] | ((context: EditLookUpContext) => any[]);
|
|
123
|
-
}
|
|
124
|
-
/**
|
|
125
|
-
* Used to define values inside the floating filter and floating filter (quick filter)
|
|
102
|
+
* Options related to Action Columns and Buttons in Adaptable.
|
|
126
103
|
*/
|
|
127
|
-
export interface
|
|
104
|
+
export interface ActionOptions {
|
|
128
105
|
/**
|
|
129
|
-
*
|
|
130
|
-
* @defaultValue false
|
|
106
|
+
* Columns which contain an AdapTable Button - used for performing Actions
|
|
131
107
|
*/
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
values: (context: BulkUpdatePermittedValuesContext) => any[] | Promise<any[]>;
|
|
108
|
+
actionColumns?: ActionColumn[];
|
|
109
|
+
/**
|
|
110
|
+
* Action buttons to display for each row.
|
|
111
|
+
*
|
|
112
|
+
* @defaultValue undefined
|
|
113
|
+
*/
|
|
114
|
+
actionRowButtons?: ('clone' | 'edit' | 'delete')[];
|
|
115
|
+
/**
|
|
116
|
+
* Position of supplied Action Buttons
|
|
117
|
+
*
|
|
118
|
+
* @defaultValue 'pinnedLeft'
|
|
119
|
+
*/
|
|
120
|
+
actionRowButtonsPosition?: 'pinnedLeft' | 'pinnedRight';
|
|
146
121
|
}
|
|
147
|
-
/**
|
|
148
|
-
* Use PermittedValues instead
|
|
149
|
-
* @deprecated use PermittedValues instead
|
|
150
|
-
*/
|
|
151
|
-
export declare type CellValuesList = PermittedValues;
|
|
152
122
|
/**
|
|
153
123
|
* A Special Column that wraps an AdapTable Button
|
|
154
124
|
*/
|
|
@@ -215,6 +185,55 @@ export interface ActionColumnSettings {
|
|
|
215
185
|
*/
|
|
216
186
|
suppressMovable?: boolean;
|
|
217
187
|
}
|
|
188
|
+
export interface BasePermittedValues {
|
|
189
|
+
/**
|
|
190
|
+
* Scope where Values will appear (Mandatory property)
|
|
191
|
+
*/
|
|
192
|
+
scope: AdaptableScope;
|
|
193
|
+
}
|
|
194
|
+
/**
|
|
195
|
+
* Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)
|
|
196
|
+
*/
|
|
197
|
+
export interface PermittedValues extends BasePermittedValues {
|
|
198
|
+
/**
|
|
199
|
+
* Values to display: either hardcoded list or a function
|
|
200
|
+
*/
|
|
201
|
+
values?: any[] | ((context: PermittedValuesContext) => any[]);
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* Used to define permitted values for inline column editor
|
|
205
|
+
*/
|
|
206
|
+
export interface EditLookUpPermittedValues extends BasePermittedValues {
|
|
207
|
+
values?: any[] | ((context: EditLookUpContext) => any[]);
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* Used to define values inside the floating filter and floating filter (quick filter)
|
|
211
|
+
*/
|
|
212
|
+
export interface FilterPermittedValues extends BasePermittedValues {
|
|
213
|
+
/**
|
|
214
|
+
* Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed
|
|
215
|
+
* @defaultValue false
|
|
216
|
+
*/
|
|
217
|
+
suppressFilterSearchBar?: boolean;
|
|
218
|
+
values: (context: FilterPermittedValuesContext) => any[] | Promise<any[]>;
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* Custom column values for custom sort.
|
|
222
|
+
*/
|
|
223
|
+
export interface CustomSortPermittedValues extends BasePermittedValues {
|
|
224
|
+
values: (context: PermittedValuesContext) => any[] | Promise<any[]>;
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
* User to define permitted values when updating cells via bulk update
|
|
228
|
+
*/
|
|
229
|
+
export interface BulkUpdatePermittedValues extends BasePermittedValues {
|
|
230
|
+
values: (context: BulkUpdatePermittedValuesContext) => any[] | Promise<any[]>;
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* Use PermittedValues instead
|
|
234
|
+
* @deprecated use PermittedValues instead
|
|
235
|
+
*/
|
|
236
|
+
export declare type CellValuesList = PermittedValues;
|
|
218
237
|
export interface EditLookUpContext extends BaseContext {
|
|
219
238
|
/**
|
|
220
239
|
* Column displaying the Edit LookUp
|
|
@@ -223,7 +242,7 @@ export interface EditLookUpContext extends BaseContext {
|
|
|
223
242
|
/**
|
|
224
243
|
* Cell being edited
|
|
225
244
|
*/
|
|
226
|
-
gridCell
|
|
245
|
+
gridCell?: GridCell;
|
|
227
246
|
}
|
|
228
247
|
export interface PermittedValuesContext extends BaseContext {
|
|
229
248
|
/**
|
|
@@ -253,3 +272,11 @@ export interface BulkUpdatePermittedValuesContext extends BaseContext {
|
|
|
253
272
|
}
|
|
254
273
|
export declare type GridInfoSections = GridInfoSection[];
|
|
255
274
|
export declare type GridInfoSection = 'GridSummary' | 'AdaptableOptions' | 'ColumnInfo' | 'AdaptableObjectsSummary';
|
|
275
|
+
export interface ObjectTagsContext extends BaseContext {
|
|
276
|
+
}
|
|
277
|
+
export declare type CustomDisplayFormatter = {
|
|
278
|
+
id: string;
|
|
279
|
+
label?: string;
|
|
280
|
+
handler: (value: any) => any;
|
|
281
|
+
scope: AdaptableScope;
|
|
282
|
+
};
|
|
@@ -8,7 +8,7 @@ import { ConditionalStyleApi } from './ConditionalStyleApi';
|
|
|
8
8
|
import { CustomSortApi } from './CustomSortApi';
|
|
9
9
|
import { DashboardApi } from './DashboardApi';
|
|
10
10
|
import { ToolPanelApi } from './ToolPanelApi';
|
|
11
|
-
import {
|
|
11
|
+
import { DataSetApi } from './DataSetApi';
|
|
12
12
|
import { EventApi } from './EventApi';
|
|
13
13
|
import { ExportApi } from './ExportApi';
|
|
14
14
|
import { FormatColumnApi } from './FormatColumnApi';
|
|
@@ -89,9 +89,9 @@ export interface AdaptableApi {
|
|
|
89
89
|
**/
|
|
90
90
|
dataChangeHistoryApi: DataChangeHistoryApi;
|
|
91
91
|
/**
|
|
92
|
-
* Provides access to
|
|
92
|
+
* Provides access to Data Sets
|
|
93
93
|
*/
|
|
94
|
-
|
|
94
|
+
dataSetApi: DataSetApi;
|
|
95
95
|
/**
|
|
96
96
|
* Used for listenning / subscribing to the various Events published by AdapTable
|
|
97
97
|
*/
|
|
@@ -209,6 +209,9 @@ export interface AdaptableApi {
|
|
|
209
209
|
unmount: boolean;
|
|
210
210
|
destroyApi?: boolean;
|
|
211
211
|
}) => void;
|
|
212
|
+
/**
|
|
213
|
+
* Whether the Adaptable instance has been destroyed
|
|
214
|
+
*/
|
|
212
215
|
isDestroyed: () => boolean;
|
|
213
216
|
/**
|
|
214
217
|
* Cleanup method that only cleans up this api instance (clears event listeners and sets every property to null), but does not destroy the Adaptable instance.
|
package/src/Api/ColumnApi.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
|
|
1
|
+
import { AdaptableColumn, AdaptableColumnDataType } from '../PredefinedConfig/Common/AdaptableColumn';
|
|
2
2
|
import { DataType } from '../PredefinedConfig/Common/Enums';
|
|
3
3
|
import { Column, RowNode } from '@ag-grid-community/all-modules';
|
|
4
4
|
import { GridCell } from '../../types';
|
|
@@ -157,7 +157,7 @@ export interface ColumnApi {
|
|
|
157
157
|
* Returns Data Type for a Column
|
|
158
158
|
* @param columnId Column to check
|
|
159
159
|
*/
|
|
160
|
-
getColumnDataTypeFromColumnId(columnId: string):
|
|
160
|
+
getColumnDataTypeFromColumnId(columnId: string): AdaptableColumnDataType | undefined;
|
|
161
161
|
/**
|
|
162
162
|
* Retrieves Friendly Name for a given Column
|
|
163
163
|
* @param columnId ColumnId to check
|
|
@@ -227,7 +227,10 @@ export interface ColumnApi {
|
|
|
227
227
|
* @param columnFilter Current applied filter
|
|
228
228
|
*/
|
|
229
229
|
getDistinctFilterDisplayValuesForColumn(columnId: string, filter: string): Promise<{
|
|
230
|
-
values:
|
|
230
|
+
values: {
|
|
231
|
+
value: any;
|
|
232
|
+
label: string;
|
|
233
|
+
}[];
|
|
231
234
|
suppressClientSideFilter: boolean;
|
|
232
235
|
}>;
|
|
233
236
|
/**
|
|
@@ -77,6 +77,16 @@ export interface ConditionalStyleApi {
|
|
|
77
77
|
* @returns conditional styles
|
|
78
78
|
*/
|
|
79
79
|
editConditionalStyles(conditionalStyles: ConditionalStyle[]): ConditionalStyle[];
|
|
80
|
+
/**
|
|
81
|
+
* Deletes a Conditional Style
|
|
82
|
+
* @param conditionalStyle Conditional Style to delete
|
|
83
|
+
*/
|
|
84
|
+
deleteConditionalStyle(conditionalStyle: ConditionalStyle): void;
|
|
85
|
+
/**
|
|
86
|
+
* Deletes Conditional Styles
|
|
87
|
+
* @param conditionalStyles Conditional Styles to delete
|
|
88
|
+
*/
|
|
89
|
+
deleteConditionalStyles(conditionalStyles: ConditionalStyle[]): void;
|
|
80
90
|
/**
|
|
81
91
|
* Adds new Conditional Style to State
|
|
82
92
|
* @param conditionalStyle Conditional Style to add
|
package/src/Api/ConfigApi.d.ts
CHANGED
|
@@ -4,7 +4,6 @@ import { QuickSearchState } from '../PredefinedConfig/QuickSearchState';
|
|
|
4
4
|
import { LayoutState } from '../PredefinedConfig/LayoutState';
|
|
5
5
|
import { FormatColumnState } from '../PredefinedConfig/FormatColumnState';
|
|
6
6
|
import { ExportState } from '../PredefinedConfig/ExportState';
|
|
7
|
-
import { DataSourceState } from '../PredefinedConfig/DataSourceState';
|
|
8
7
|
import { DashboardState } from '../PredefinedConfig/DashboardState';
|
|
9
8
|
import { CustomSortState } from '../PredefinedConfig/CustomSortState';
|
|
10
9
|
import { ConditionalStyleState } from '../PredefinedConfig/ConditionalStyleState';
|
|
@@ -15,7 +14,6 @@ import { PlusMinusState } from '../PredefinedConfig/PlusMinusState';
|
|
|
15
14
|
import { ApplicationState } from '../PredefinedConfig/ApplicationState';
|
|
16
15
|
import { AdaptablePersistentState, AdaptableState } from '../PredefinedConfig/AdaptableState';
|
|
17
16
|
import { FreeTextColumnState } from '../PredefinedConfig/FreeTextColumnState';
|
|
18
|
-
import { FilterState } from '../PredefinedConfig/FilterState';
|
|
19
17
|
import { ToolPanelState } from '../PredefinedConfig/ToolPanelState';
|
|
20
18
|
import { AdaptableStateKey, AdaptableModule } from '../PredefinedConfig/Common/Types';
|
|
21
19
|
import { AdaptableSearchState, PredefinedConfig, ScheduleState } from '../types';
|
|
@@ -133,21 +131,11 @@ export interface ConfigApi {
|
|
|
133
131
|
* @param returnJson return as JSON rather than object
|
|
134
132
|
*/
|
|
135
133
|
getDashboardState(returnJson: boolean): DashboardState;
|
|
136
|
-
/**
|
|
137
|
-
* Returns Data Source section of Adaptable State
|
|
138
|
-
* @param returnJson return as JSON rather than object
|
|
139
|
-
*/
|
|
140
|
-
getDataSourceState(returnJson: boolean): DataSourceState;
|
|
141
134
|
/**
|
|
142
135
|
* Returns Export section of Adaptable State
|
|
143
136
|
* @param returnJson return as JSON rather than object
|
|
144
137
|
*/
|
|
145
138
|
getExportState(returnJson: boolean): ExportState;
|
|
146
|
-
/**
|
|
147
|
-
* Returns Filter section of Adaptable State
|
|
148
|
-
* @param returnJson return as JSON rather than object
|
|
149
|
-
*/
|
|
150
|
-
getFilterState(returnJson: boolean): FilterState;
|
|
151
139
|
/**
|
|
152
140
|
* Returns Formt Column section of Adaptable State
|
|
153
141
|
* @param returnJson return as JSON rather than object
|
|
@@ -2,7 +2,7 @@ import { DashboardState, DashboardTab } from '../PredefinedConfig/DashboardState
|
|
|
2
2
|
import { AdaptableModuleButtons, AdaptableDashboardToolbars, AdaptableDashboardToolbar } from '../PredefinedConfig/Common/Types';
|
|
3
3
|
import { DashboardChangedInfo } from './Events/DashboardChanged';
|
|
4
4
|
import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
|
|
5
|
-
import { CustomToolbar,
|
|
5
|
+
import { CustomToolbar, DashboardButtonContext } from '../AdaptableOptions/DashboardOptions';
|
|
6
6
|
/**
|
|
7
7
|
* Functions relating to the AdapTable Dashboard.
|
|
8
8
|
*/
|
|
@@ -18,7 +18,7 @@ export interface DashboardApi {
|
|
|
18
18
|
/**
|
|
19
19
|
* Retrieves all Custom Buttons
|
|
20
20
|
*/
|
|
21
|
-
getCustomDashboardButtons(): AdaptableButton<DashboardButtonContext>[]
|
|
21
|
+
getCustomDashboardButtons(): AdaptableButton<DashboardButtonContext>[];
|
|
22
22
|
/**
|
|
23
23
|
* Retrieves first Custom Button with given Label
|
|
24
24
|
* @param buttonLabel the label of the Custom Button to retrieve
|
|
@@ -49,23 +49,6 @@ export interface DashboardApi {
|
|
|
49
49
|
* @param customToolbarName the name of the Custom Toolbar
|
|
50
50
|
*/
|
|
51
51
|
getCustomToolbarByName(customToolbarName: string): CustomToolbar;
|
|
52
|
-
/**
|
|
53
|
-
* Replaces Toolbar Buttons in Custom Toolbar with the new set
|
|
54
|
-
* @param customToolbarName name of the Custom Toolbar
|
|
55
|
-
* @param buttons Toolbar Buttons to add
|
|
56
|
-
*/
|
|
57
|
-
setCustomToolbarButtons(customToolbarName: string, buttons: AdaptableButton<CustomToolbarButtonContext>[]): void;
|
|
58
|
-
/**
|
|
59
|
-
* Adds Toolbar Buttons to current collection in Custom Toolbar
|
|
60
|
-
* @param customToolbarName name of the Custom Toolbar
|
|
61
|
-
* @param buttons Toolbar Buttons to add
|
|
62
|
-
*/
|
|
63
|
-
addCustomToolbarButtons(customToolbarName: string, buttons: AdaptableButton<CustomToolbarButtonContext>[]): void;
|
|
64
|
-
/**
|
|
65
|
-
* Clears all Toolbar Buttons from Custom Toolbar
|
|
66
|
-
* @param customToolbarName the name of the Custom Toolbar
|
|
67
|
-
*/
|
|
68
|
-
clearCustomToolbarButtons(customToolbarName: string): void;
|
|
69
52
|
/**
|
|
70
53
|
* Collapses Dashboard so only Dashboard Header is visible (and not Toolbars' contents)
|
|
71
54
|
*/
|
|
@@ -74,6 +57,10 @@ export interface DashboardApi {
|
|
|
74
57
|
* Expands Dashboard so Toolbars in Active Tab are fully visible
|
|
75
58
|
*/
|
|
76
59
|
expandDashboard(): void;
|
|
60
|
+
/**
|
|
61
|
+
* Refreshes the entire Dashboard section, including Toolbars and Buttons; this is particularly relevant for AdapTable built-in elements, as framework components are dependent on the framework specific change detection mechanisms
|
|
62
|
+
*/
|
|
63
|
+
refreshDashboard(): void;
|
|
77
64
|
/**
|
|
78
65
|
* Floats Dashboard so only Dashboard Header is visible (in reduced size); can be dragged to a new location
|
|
79
66
|
*/
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { DataSet } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* Provides run-time access to Data Sets
|
|
4
|
+
*/
|
|
5
|
+
export interface DataSetApi {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves the Data Sets from General Options
|
|
8
|
+
* @returns data Sets
|
|
9
|
+
*/
|
|
10
|
+
getAllDataSets(): DataSet[];
|
|
11
|
+
/**
|
|
12
|
+
* Retrieves the currently applied Data Set
|
|
13
|
+
* @returns data Set
|
|
14
|
+
*/
|
|
15
|
+
getCurrentDataSet(): DataSet | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* Retreives Data Set from State with given name
|
|
18
|
+
* @param dataSetName name of Data Set to retrieve
|
|
19
|
+
* @returns data Set
|
|
20
|
+
*/
|
|
21
|
+
getDataSetByName(dataSetName: string): DataSet;
|
|
22
|
+
/**
|
|
23
|
+
* Makes given Data Set current
|
|
24
|
+
* @param dataSetName Name of Data Set to apply
|
|
25
|
+
*/
|
|
26
|
+
setDataSet(dataSetName: string): void;
|
|
27
|
+
/**
|
|
28
|
+
* Clears currently selected Data Set
|
|
29
|
+
*/
|
|
30
|
+
clearCurrentDataSet(): void;
|
|
31
|
+
/**
|
|
32
|
+
* Opens Settings Panel with Data Set section selected and visible
|
|
33
|
+
*/
|
|
34
|
+
showDataSetPopup(): void;
|
|
35
|
+
/**
|
|
36
|
+
* Fire the DataSet Changed Event
|
|
37
|
+
* @param dataSet Data Set which has changed
|
|
38
|
+
*/
|
|
39
|
+
fireDataSetChangeEvent(dataSet: DataSet): void;
|
|
40
|
+
}
|
|
File without changes
|
package/src/Api/EventApi.d.ts
CHANGED
|
@@ -14,6 +14,8 @@ import { AdaptableStateChangedInfo } from './Events/AdaptableStateChanged';
|
|
|
14
14
|
import { FlashingCellDisplayedInfo } from './Events/FlashingCellDisplayed';
|
|
15
15
|
import { GridDataChangedInfo } from './Events/GridDataChanged';
|
|
16
16
|
import { TeamSharingEntityChangedInfo } from './Events/TeamSharingEntityChanged';
|
|
17
|
+
import { RowFormSubmittedInfo } from './Events/RowFormSubmitted';
|
|
18
|
+
import { DataSetChangedInfo } from './Events/DataSetChanged';
|
|
17
19
|
/**
|
|
18
20
|
* Responsible for publishing the many Events that AdapTable fires
|
|
19
21
|
*/
|
|
@@ -193,6 +195,21 @@ export interface EventApi {
|
|
|
193
195
|
* Unsubscribe from LiveDataChanged
|
|
194
196
|
*/
|
|
195
197
|
off(eventName: 'LiveDataChanged', callback: (liveDataChangedInfo: LiveDataChangedInfo) => void): void;
|
|
198
|
+
on(eventName: 'RowFormSubmitted', callback: (rowEditedFormInfo: RowFormSubmittedInfo) => void): () => void;
|
|
199
|
+
off(eventName: 'RowFormSubmitted', callback: (rowEditedFormInfo: RowFormSubmittedInfo) => void): void;
|
|
200
|
+
/**
|
|
201
|
+
* Event fired when a DataSet is changed
|
|
202
|
+
*
|
|
203
|
+
* @param eventName DataSetChanged
|
|
204
|
+
* @param callback DataSetChangedInfo
|
|
205
|
+
*/
|
|
206
|
+
on(eventName: 'DataSetChanged', callback: (dataSetChangedInfo: DataSetChangedInfo) => void): () => void;
|
|
207
|
+
/**
|
|
208
|
+
* Unsubscribe from DataSetChanged
|
|
209
|
+
* @param eventName DataSetChanged
|
|
210
|
+
* @param callback
|
|
211
|
+
*/
|
|
212
|
+
off(eventName: 'DataSetChanged', callback: (dataSetChangedInfo: DataSetChangedInfo) => void): void;
|
|
196
213
|
/**
|
|
197
214
|
* Fired when Adaptable is up and running - has no arguments.
|
|
198
215
|
* @param eventName - AdaptableReady
|
|
@@ -224,6 +241,6 @@ export interface EventApi {
|
|
|
224
241
|
emitSync(eventName: 'DashboardChanged', data?: any): any[];
|
|
225
242
|
emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
|
|
226
243
|
emitSync(eventName: 'AdaptableDestroy'): any[];
|
|
227
|
-
emit(eventName: 'AdaptableReady' | 'AlertFired' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'AdaptableStateChanged' | 'DashboardChanged' | 'CellChanged' | 'GridDataChanged' | 'LayoutChanged' | 'LiveDataChanged' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'FDC3MessageSent', data?: any): Promise<any>;
|
|
244
|
+
emit(eventName: 'AdaptableReady' | 'AlertFired' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'AdaptableStateChanged' | 'DashboardChanged' | 'CellChanged' | 'GridDataChanged' | 'LayoutChanged' | 'LiveDataChanged' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'FDC3MessageSent' | 'RowFormSubmitted' | 'DataSetChanged', data?: any): Promise<any>;
|
|
228
245
|
destroy(): void;
|
|
229
246
|
}
|
|
File without changes
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { BaseEventInfo } from './BaseEventInfo';
|
|
2
|
+
import { AdaptableFormData } from '../../PredefinedConfig/Common/AdaptableForm';
|
|
3
|
+
import { RowNode } from '@ag-grid-community/all-modules';
|
|
4
|
+
export declare type RowFormSubmittedInfo = CreatedRowFormInfo | EditedRowFormInfo | DeletedRowFormInfo;
|
|
5
|
+
export declare type RowFormType = 'rowCreated' | 'rowEdited' | 'rowDeleted';
|
|
6
|
+
export interface CreatedRowFormInfo extends BaseEventInfo {
|
|
7
|
+
type: 'rowCreated';
|
|
8
|
+
formData: AdaptableFormData;
|
|
9
|
+
clonedRowNode?: RowNode;
|
|
10
|
+
}
|
|
11
|
+
export interface EditedRowFormInfo extends BaseEventInfo {
|
|
12
|
+
type: 'rowEdited';
|
|
13
|
+
formData: AdaptableFormData;
|
|
14
|
+
rowNode: RowNode;
|
|
15
|
+
}
|
|
16
|
+
export interface DeletedRowFormInfo extends BaseEventInfo {
|
|
17
|
+
type: 'rowDeleted';
|
|
18
|
+
rowNode: RowNode;
|
|
19
|
+
}
|
|
@@ -1,8 +1,7 @@
|
|
|
1
|
-
import { DataSource } from '../../PredefinedConfig/DataSourceState';
|
|
2
1
|
import { CustomSort } from '../../PredefinedConfig/CustomSortState';
|
|
3
2
|
import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
|
|
4
|
-
import { ColumnFilter } from '../../PredefinedConfig/FilterState';
|
|
5
3
|
import { BaseEventInfo } from './BaseEventInfo';
|
|
4
|
+
import { ColumnFilter, DataSet } from '../../types';
|
|
6
5
|
/**
|
|
7
6
|
* EventInfo returned by SearchChanged event; includes full AdapTable search and sort info plus the event's trigger
|
|
8
7
|
*/
|
|
@@ -10,7 +9,7 @@ export interface SearchChangedInfo extends BaseEventInfo {
|
|
|
10
9
|
/**
|
|
11
10
|
* What search-related change caused the event to fire
|
|
12
11
|
*/
|
|
13
|
-
searchChangedTrigger: '
|
|
12
|
+
searchChangedTrigger: 'CurrentQuery' | 'Filter' | 'DataChange' | 'Sort';
|
|
14
13
|
/**
|
|
15
14
|
* Current searches and filters in the Grid
|
|
16
15
|
*/
|
|
@@ -27,7 +26,7 @@ export interface AdaptableSearchState {
|
|
|
27
26
|
/**
|
|
28
27
|
* Current Data Source (if one selected)
|
|
29
28
|
*/
|
|
30
|
-
|
|
29
|
+
dataSet: DataSet | undefined;
|
|
31
30
|
/**
|
|
32
31
|
* Current Query
|
|
33
32
|
*/
|
package/src/Api/FilterApi.d.ts
CHANGED
|
@@ -1,15 +1,9 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { AdaptableColumn } from '../types';
|
|
1
|
+
import { AdaptableColumn, SystemFilterPredicateIds } from '../types';
|
|
3
2
|
import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
|
|
4
|
-
import { RowNode } from '@ag-grid-community/all-modules';
|
|
5
3
|
/**
|
|
6
4
|
* Provides run-time access to Filter section of Adaptable State.
|
|
7
5
|
*/
|
|
8
6
|
export interface FilterApi {
|
|
9
|
-
/**
|
|
10
|
-
* Retrieves Filter section from Adaptable State
|
|
11
|
-
*/
|
|
12
|
-
getFilterState(): FilterState;
|
|
13
7
|
/**
|
|
14
8
|
* Returns Predicate Definition for given Column and Quick Filter shortcut
|
|
15
9
|
* @param shortcut Quick Filter shortcut to lookup
|
|
@@ -30,76 +24,6 @@ export interface FilterApi {
|
|
|
30
24
|
* Retrieves Ids for all System Filters
|
|
31
25
|
*/
|
|
32
26
|
getAllSystemFilterIds(): SystemFilterPredicateIds;
|
|
33
|
-
/**
|
|
34
|
-
* Retrieves all the Column Filters in the Column Filter State (of Predefined Config)
|
|
35
|
-
* @returns column filters
|
|
36
|
-
*/
|
|
37
|
-
getAllColumnFilter(): ColumnFilter[];
|
|
38
|
-
/**
|
|
39
|
-
* Retrieves ColumnFilter by Id
|
|
40
|
-
* @param id column filter id
|
|
41
|
-
* @returns column filter
|
|
42
|
-
*/
|
|
43
|
-
getColumnFilterById(id: ColumnFilter['Uuid']): ColumnFilter;
|
|
44
|
-
/**
|
|
45
|
-
* Sets Column Filters - will replace filters for existing column and leave other column filters in place
|
|
46
|
-
* @param columnFilters Column Filters to set
|
|
47
|
-
* @returns column filters
|
|
48
|
-
*/
|
|
49
|
-
setColumnFilter(columnFilters: ColumnFilter[]): ColumnFilter[] | null;
|
|
50
|
-
/**
|
|
51
|
-
* Clears given Column Filter
|
|
52
|
-
* @param columnFilter Column Filter to clear
|
|
53
|
-
*/
|
|
54
|
-
clearColumnFilter(columnFilter: ColumnFilter): void;
|
|
55
|
-
/**
|
|
56
|
-
* Clears Column Filter for given Column
|
|
57
|
-
* @param columnId Column for which Column Filter should be cleared
|
|
58
|
-
*/
|
|
59
|
-
clearColumnFilterByColumn(columnId: string): void;
|
|
60
|
-
/**
|
|
61
|
-
* Clears Column Filters for given set of Columns
|
|
62
|
-
* @param columns Columns for which Column Filte should be cleared
|
|
63
|
-
*/
|
|
64
|
-
clearColumnFilterByColumns(columns: string[]): void;
|
|
65
|
-
/**
|
|
66
|
-
* Clears all Column Filters in State
|
|
67
|
-
*/
|
|
68
|
-
clearAllColumnFilter(): void;
|
|
69
|
-
/**
|
|
70
|
-
* Clears existing Column Filters and then sets the new ones
|
|
71
|
-
* @param columnFilters Column Filters to set
|
|
72
|
-
*/
|
|
73
|
-
clearAndSetColumnFilter(columnFilters: ColumnFilter[]): void;
|
|
74
|
-
/**
|
|
75
|
-
* Retrieves all Column Filters for given Column
|
|
76
|
-
* @param columnId column to retrieve Column Filters for
|
|
77
|
-
* @returns column filters
|
|
78
|
-
*/
|
|
79
|
-
getAllColumnFilterForColumn(columnId: string): ColumnFilter[];
|
|
80
|
-
/**
|
|
81
|
-
* Creates new Column Filter on given Column using Primary Key values
|
|
82
|
-
* @param columnId ColumnId to use
|
|
83
|
-
* @param primarykeyValues Primary Key Values to use
|
|
84
|
-
* @returns column filter
|
|
85
|
-
*/
|
|
86
|
-
createColumnFilterForCell(columnId: string, primarykeyValues: any[]): ColumnFilter | null;
|
|
87
|
-
/**
|
|
88
|
-
* Retrieves description of given Column Filter
|
|
89
|
-
* @param columnFilter Column Filter to use
|
|
90
|
-
*/
|
|
91
|
-
columnFilterToString(columnFilter: ColumnFilter): string;
|
|
92
|
-
/**
|
|
93
|
-
* Retrieves descriptions of given Column Filters
|
|
94
|
-
* @param columnFilters Column Filters to use
|
|
95
|
-
*/
|
|
96
|
-
columnFiltersToString(columnFilters: ColumnFilter[]): string;
|
|
97
|
-
/**
|
|
98
|
-
* Calls AdapTableQL to evaluate Filter for given Row
|
|
99
|
-
* @param columnFilter Column Filter to use
|
|
100
|
-
* @param node Row Node to evaluate
|
|
101
|
-
*/
|
|
102
|
-
evaluateColumnFilter(columnFilter: ColumnFilter, node: RowNode): boolean;
|
|
103
27
|
/**
|
|
104
28
|
* Makes Quick Filter Bar appear
|
|
105
29
|
*/
|