@adaptabletools/adaptable 22.0.0-canary.5 → 22.0.0-canary.6
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/package.json +1 -1
- package/src/AdaptableOptions/CustomSortOptions.d.ts +1 -2
- package/src/AdaptableState/AlertState.d.ts +6 -2
- package/src/AdaptableState/ChartingState.d.ts +5 -5
- package/src/AdaptableState/Common/AdaptableObject.d.ts +0 -9
- package/src/AdaptableState/Common/ColumnHighlightInfo.d.ts +18 -0
- package/src/AdaptableState/Common/ColumnHighlightInfo.js +1 -0
- package/src/AdaptableState/Common/Schedule.d.ts +6 -2
- package/src/AdaptableState/CustomSortState.d.ts +6 -2
- package/src/AdaptableState/DashboardState.d.ts +3 -3
- package/src/AdaptableState/ExportState.d.ts +3 -3
- package/src/AdaptableState/FlashingCellState.d.ts +6 -2
- package/src/AdaptableState/FormatColumnState.d.ts +6 -2
- package/src/AdaptableState/InternalState.d.ts +2 -0
- package/src/AdaptableState/LayoutState.d.ts +3 -3
- package/src/AdaptableState/NamedQueryState.d.ts +3 -3
- package/src/AdaptableState/PlusMinusState.d.ts +6 -2
- package/src/AdaptableState/ShortcutState.d.ts +6 -2
- package/src/AdaptableState/ThemeState.d.ts +3 -3
- package/src/Api/GridApi.d.ts +18 -3
- package/src/Api/Implementation/GridApiImpl.d.ts +4 -0
- package/src/Api/Implementation/GridApiImpl.js +15 -1
- package/src/Redux/ActionsReducers/InternalRedux.d.ts +15 -0
- package/src/Redux/ActionsReducers/InternalRedux.js +36 -0
- package/src/Redux/Store/AdaptableStore.js +21 -0
- package/src/View/Alert/Utilities/getDefaultAlertDefinition.d.ts +2 -2
- package/src/View/Components/ColumnFilter/FloatingFilter.js +41 -3
- package/src/View/Components/ColumnFilter/components/ColumnFilterMenu.js +54 -2
- package/src/agGrid/AdaptableAgGrid.js +9 -0
- package/src/agGrid/AgGridColumnAdapter.d.ts +1 -0
- package/src/agGrid/AgGridColumnAdapter.js +14 -3
- package/src/components/Select/Select.js +78 -15
- package/src/env.js +2 -2
- package/src/metamodel/adaptable.metamodel.d.ts +25 -18
- package/src/metamodel/adaptable.metamodel.js +1 -1
- package/src/types.d.ts +2 -2
- package/tsconfig.esm.tsbuildinfo +1 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@adaptabletools/adaptable",
|
|
3
|
-
"version": "22.0.0-canary.
|
|
3
|
+
"version": "22.0.0-canary.6",
|
|
4
4
|
"description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"web-components",
|
|
@@ -15,9 +15,8 @@ export interface CustomSortOptions<TData = any> {
|
|
|
15
15
|
export interface ColumnValuesComparer<TData = any> {
|
|
16
16
|
/**
|
|
17
17
|
* Name of the CustomSort Comparer
|
|
18
|
-
* FIXME AFL - switch to mandatory
|
|
19
18
|
*/
|
|
20
|
-
name
|
|
19
|
+
name: string;
|
|
21
20
|
/**
|
|
22
21
|
* Column for which to compare values
|
|
23
22
|
*/
|
|
@@ -10,7 +10,7 @@ import { XOR } from '../Utilities/Extensions/TypeExtensions';
|
|
|
10
10
|
import { AdaptableAggregatedBooleanQuery, AdaptableBooleanQuery, AdaptableObservableQuery } from './Common/AdaptableQuery';
|
|
11
11
|
import { ButtonStyle } from './Common/ButtonStyle';
|
|
12
12
|
import { AlertFormContext, BaseContext, NotificationsOptions } from '../types';
|
|
13
|
-
import {
|
|
13
|
+
import { SuspendableObject } from './Common/AdaptableObject';
|
|
14
14
|
/**
|
|
15
15
|
* Adaptable State section for Alert Module
|
|
16
16
|
*/
|
|
@@ -23,7 +23,11 @@ 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
|
|
26
|
+
export interface AlertDefinition extends SuspendableObject {
|
|
27
|
+
/**
|
|
28
|
+
* Name of the Alert Definition
|
|
29
|
+
*/
|
|
30
|
+
Name: string;
|
|
27
31
|
/**
|
|
28
32
|
* Where Alert can be triggered: one, some or all columns or DataTypes
|
|
29
33
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ChartModel } from 'ag-grid-enterprise';
|
|
2
|
-
import {
|
|
2
|
+
import { AdaptableObject } 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,9 +7,9 @@ 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
|
|
10
|
+
export interface ExternalChartDefinition<T = unknown> extends AdaptableObject {
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* Name of the external chart
|
|
13
13
|
*/
|
|
14
14
|
Name: string;
|
|
15
15
|
/**
|
|
@@ -25,9 +25,9 @@ export interface ExternalChartDefinition<T = unknown> extends NamedObject {
|
|
|
25
25
|
/**
|
|
26
26
|
* Wraps an AG Grid Chart Model
|
|
27
27
|
*/
|
|
28
|
-
export interface ChartDefinition extends
|
|
28
|
+
export interface ChartDefinition extends AdaptableObject {
|
|
29
29
|
/**
|
|
30
|
-
* Name of the
|
|
30
|
+
* Name of the chart definition
|
|
31
31
|
*/
|
|
32
32
|
Name: string;
|
|
33
33
|
/**
|
|
@@ -71,12 +71,3 @@ export interface SuspendableObject extends AdaptableObject {
|
|
|
71
71
|
*/
|
|
72
72
|
IsSuspended?: boolean;
|
|
73
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
|
-
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { AdaptableStyle } from '../../../types';
|
|
2
|
+
/**
|
|
3
|
+
* Defines how a given Column in AdapTable should be highlighted
|
|
4
|
+
*/
|
|
5
|
+
export interface ColumnHighlightInfo {
|
|
6
|
+
/**
|
|
7
|
+
* Id of Column being highlighted
|
|
8
|
+
*/
|
|
9
|
+
columnId: string;
|
|
10
|
+
/**
|
|
11
|
+
* Time after which Column should be unhighlighted
|
|
12
|
+
*/
|
|
13
|
+
timeout?: number;
|
|
14
|
+
/**
|
|
15
|
+
* Adaptable Style to use in the Column Highlight
|
|
16
|
+
*/
|
|
17
|
+
highlightStyle: AdaptableStyle;
|
|
18
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { AdaptableObject, SuspendableObject } from './AdaptableObject';
|
|
2
2
|
/**
|
|
3
3
|
* Defines when an action will be run - either one-off or recurring
|
|
4
4
|
*/
|
|
@@ -23,7 +23,11 @@ export interface Schedule {
|
|
|
23
23
|
/**
|
|
24
24
|
* Base Schedule object - typically overriden by Functions
|
|
25
25
|
*/
|
|
26
|
-
export interface BaseSchedule extends
|
|
26
|
+
export interface BaseSchedule extends AdaptableObject, SuspendableObject {
|
|
27
|
+
/**
|
|
28
|
+
* Name of the Schedule
|
|
29
|
+
*/
|
|
30
|
+
Name: string;
|
|
27
31
|
/**
|
|
28
32
|
* The Schedule to run
|
|
29
33
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { BaseState } from './BaseState';
|
|
2
|
-
import {
|
|
2
|
+
import { SuspendableObject } from './Common/AdaptableObject';
|
|
3
3
|
/**
|
|
4
4
|
* Adaptable State Section for Custom Sort Module
|
|
5
5
|
*/
|
|
@@ -12,7 +12,11 @@ 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 {
|
|
16
|
+
/**
|
|
17
|
+
* Name of the Custom Sort definition
|
|
18
|
+
*/
|
|
19
|
+
Name: string;
|
|
16
20
|
/**
|
|
17
21
|
* Id of Column on which Custom Sort will be applied
|
|
18
22
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BaseState } from './BaseState';
|
|
2
2
|
import { AdaptableDashboardToolbars, AdaptableModuleButtons } from './Common/Types';
|
|
3
|
-
import { AdaptableObject
|
|
3
|
+
import { AdaptableObject } from './Common/AdaptableObject';
|
|
4
4
|
/**
|
|
5
5
|
* Adaptable State Section for the AdapTable Dashboard
|
|
6
6
|
*/
|
|
@@ -56,9 +56,9 @@ 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
|
|
59
|
+
export interface DashboardTab extends AdaptableObject {
|
|
60
60
|
/**
|
|
61
|
-
* Name of the
|
|
61
|
+
* Name of the Dashboard Tab as it appears in the Dashboard header
|
|
62
62
|
*/
|
|
63
63
|
Name: string;
|
|
64
64
|
/**
|
|
@@ -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 {
|
|
5
|
+
import { AdaptableObject } 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,9 +26,9 @@ export interface ExportState extends BaseState {
|
|
|
26
26
|
/**
|
|
27
27
|
* A Report which can export data from AdapTable
|
|
28
28
|
*/
|
|
29
|
-
export interface Report extends
|
|
29
|
+
export interface Report extends AdaptableObject {
|
|
30
30
|
/**
|
|
31
|
-
* Name of Report
|
|
31
|
+
* Name of the Report as displayed in the Export toolbar and tool panel
|
|
32
32
|
*/
|
|
33
33
|
Name: ReportNameType;
|
|
34
34
|
/**
|
|
@@ -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 {
|
|
7
|
+
import { AdaptableObject, SuspendableObject } from '../../types';
|
|
8
8
|
/**
|
|
9
9
|
* Adaptable State Section for Flashing Cell module
|
|
10
10
|
*/
|
|
@@ -33,7 +33,11 @@ export type FlashTargetTypes = 'row' | 'cell' | 'aggFuncCell';
|
|
|
33
33
|
/**
|
|
34
34
|
* The Flashing Cell Definition
|
|
35
35
|
*/
|
|
36
|
-
export interface FlashingCellDefinition extends
|
|
36
|
+
export interface FlashingCellDefinition extends AdaptableObject, SuspendableObject {
|
|
37
|
+
/**
|
|
38
|
+
* Name of the Flashing Cell Definition
|
|
39
|
+
*/
|
|
40
|
+
Name: string;
|
|
37
41
|
/**
|
|
38
42
|
* Which Columns, DataTypes or Column Types can Flash
|
|
39
43
|
*/
|
|
@@ -7,7 +7,7 @@ import { XOR } from '../Utilities/Extensions/TypeExtensions';
|
|
|
7
7
|
import { TypeHint } from './Common/Types';
|
|
8
8
|
import { AdaptableBooleanQuery, LayoutExtendedConfig } from '../types';
|
|
9
9
|
import { AdaptableColumnPredicate } from './Common/AdaptablePredicate';
|
|
10
|
-
import {
|
|
10
|
+
import { SuspendableObject } from './Common/AdaptableObject';
|
|
11
11
|
/**
|
|
12
12
|
* Adaptable State Section for Format Column Module
|
|
13
13
|
*/
|
|
@@ -20,7 +20,11 @@ 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 {
|
|
24
|
+
/**
|
|
25
|
+
* Name of the Format Column definition
|
|
26
|
+
*/
|
|
27
|
+
Name: string;
|
|
24
28
|
/**
|
|
25
29
|
* Where Format will be applied: whole Row, some Columns, or Columns of DataType
|
|
26
30
|
*/
|
|
@@ -15,6 +15,7 @@ import { SelectedCellInfo } from './Selection/SelectedCellInfo';
|
|
|
15
15
|
import { SelectedRowInfo } from './Selection/SelectedRowInfo';
|
|
16
16
|
import { AdaptableMenuItem } from './Common/Menu';
|
|
17
17
|
import { CellHighlightInfo } from './Common/CellHighlightInfo';
|
|
18
|
+
import { ColumnHighlightInfo } from './Common/ColumnHighlightInfo';
|
|
18
19
|
import { RowHighlightInfo } from './Common/RowHighlightInfo';
|
|
19
20
|
export type { IPushPullReport, IPushPullDomain };
|
|
20
21
|
export type { OpenFinReport };
|
|
@@ -31,6 +32,7 @@ export interface InternalState extends IPushPullState, OpenFinState {
|
|
|
31
32
|
SelectedCellInfo: SelectedCellInfo;
|
|
32
33
|
SelectedRowInfo: SelectedRowInfo;
|
|
33
34
|
CellHighlightInfo: CellHighlightInfo[];
|
|
35
|
+
ColumnHighlightInfo: ColumnHighlightInfo[];
|
|
34
36
|
RowHighlightInfo: RowHighlightInfo[];
|
|
35
37
|
SettingsPanelModuleEntries: AdaptableMenuItem[];
|
|
36
38
|
AdaptableAlerts: AdaptableAlert[];
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { BaseState } from './BaseState';
|
|
2
|
-
import { AdaptableObject
|
|
2
|
+
import { AdaptableObject } from './Common/AdaptableObject';
|
|
3
3
|
import { ColumnSort } from './Common/ColumnSort';
|
|
4
4
|
import { ColumnFilter, GridFilter } from '../types';
|
|
5
5
|
import { PivotAggregationColumns, TableAggregationColumns } from './Common/AggregationColumns';
|
|
@@ -30,9 +30,9 @@ export interface LayoutState extends BaseState {
|
|
|
30
30
|
/**
|
|
31
31
|
* Base object for both Table and Pivot Layouts
|
|
32
32
|
*/
|
|
33
|
-
export interface LayoutBase extends
|
|
33
|
+
export interface LayoutBase extends AdaptableObject {
|
|
34
34
|
/**
|
|
35
|
-
* Name of Layout as
|
|
35
|
+
* Name of the Layout as it appears in the Layout toolbar and tool panel
|
|
36
36
|
*/
|
|
37
37
|
Name: string;
|
|
38
38
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BaseState } from './BaseState';
|
|
2
2
|
import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
|
|
3
|
-
import {
|
|
3
|
+
import { AdaptableObject } from './Common/AdaptableObject';
|
|
4
4
|
/**
|
|
5
5
|
* Adaptable State Section for Named Query Module
|
|
6
6
|
*/
|
|
@@ -13,9 +13,9 @@ 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,
|
|
16
|
+
export interface NamedQuery extends AdaptableBooleanQuery, AdaptableObject {
|
|
17
17
|
/**
|
|
18
|
-
* Name of the Query
|
|
18
|
+
* Name of the Query, used to reference it in AdaptableQL Expressions
|
|
19
19
|
*/
|
|
20
20
|
Name: string;
|
|
21
21
|
}
|
|
@@ -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 {
|
|
4
|
+
import { SuspendableObject } from './Common/AdaptableObject';
|
|
5
5
|
/**
|
|
6
6
|
* Adaptable State Section for Plus Minus Module
|
|
7
7
|
*/
|
|
@@ -14,7 +14,11 @@ 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
|
|
17
|
+
export interface PlusMinusNudge extends SuspendableObject {
|
|
18
|
+
/**
|
|
19
|
+
* Name of the Plus Minus Nudge rule
|
|
20
|
+
*/
|
|
21
|
+
Name: string;
|
|
18
22
|
/**
|
|
19
23
|
* Where Rule is applied
|
|
20
24
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BaseState } from './BaseState';
|
|
2
2
|
import { ColumnScope } from './Common/ColumnScope';
|
|
3
|
-
import {
|
|
3
|
+
import { SuspendableObject } from './Common/AdaptableObject';
|
|
4
4
|
/**
|
|
5
5
|
* Adaptable State Section for Shortcut Module
|
|
6
6
|
*/
|
|
@@ -17,7 +17,11 @@ 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
|
|
20
|
+
export interface Shortcut extends SuspendableObject {
|
|
21
|
+
/**
|
|
22
|
+
* Name of the Shortcut
|
|
23
|
+
*/
|
|
24
|
+
Name: string;
|
|
21
25
|
/**
|
|
22
26
|
* Numeric Columns where Shortcut is applied
|
|
23
27
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { BaseState } from './BaseState';
|
|
2
|
-
import {
|
|
2
|
+
import { AdaptableObject } from './Common/AdaptableObject';
|
|
3
3
|
import { TypeHint } from './Common/Types';
|
|
4
4
|
/**
|
|
5
5
|
* Theme section of Adaptable State
|
|
@@ -21,9 +21,9 @@ export interface ThemeState extends BaseState {
|
|
|
21
21
|
/**
|
|
22
22
|
* Used for creating User (i.e. Custom) Themes
|
|
23
23
|
*/
|
|
24
|
-
export interface AdaptableTheme extends
|
|
24
|
+
export interface AdaptableTheme extends AdaptableObject {
|
|
25
25
|
/**
|
|
26
|
-
* Name of the Theme
|
|
26
|
+
* Name of the Theme as it appears in the Theme toolbar and tool panel
|
|
27
27
|
*/
|
|
28
28
|
Name: string;
|
|
29
29
|
/**
|
package/src/Api/GridApi.d.ts
CHANGED
|
@@ -13,6 +13,7 @@ import { RowsHighlightInfo } from '../AdaptableState/Common/RowsHighlightInfo';
|
|
|
13
13
|
import { TransposeConfig } from '../AdaptableState/Common/TransposeConfig';
|
|
14
14
|
import { AdaptableVariant } from '../AdaptableInterfaces/IAdaptable';
|
|
15
15
|
import { InternalState } from '../AdaptableState/InternalState';
|
|
16
|
+
import { ColumnHighlightInfo } from '../AdaptableState/Common/ColumnHighlightInfo';
|
|
16
17
|
/**
|
|
17
18
|
* Provides access to important properties and functionalities of AdapTable e.g. sorting, selected cells etc.
|
|
18
19
|
*/
|
|
@@ -442,14 +443,28 @@ export interface GridApi {
|
|
|
442
443
|
highlightCell(cellHighlightInfo: CellHighlightInfo): void;
|
|
443
444
|
/**
|
|
444
445
|
* Unhighlights a Cell in AdapTable
|
|
445
|
-
* @param
|
|
446
|
+
* @param primaryKeyValue pkvalue of cell to unhilight
|
|
447
|
+
* @param columnId column id of cell to unhilight
|
|
446
448
|
*/
|
|
447
|
-
unHighlightCell(primaryKeyValue:
|
|
449
|
+
unHighlightCell(primaryKeyValue: any, columnId: string): void;
|
|
448
450
|
/**
|
|
449
451
|
* Unhighlights all highlighted Cells in AdapTable
|
|
450
|
-
* @param cellHighlightInfo cell to highlight
|
|
451
452
|
*/
|
|
452
453
|
unHighlightAllCells(): void;
|
|
454
|
+
/**
|
|
455
|
+
* Highlights a Column in AdapTable
|
|
456
|
+
* @param columnHighlightInfo column to highlight
|
|
457
|
+
*/
|
|
458
|
+
highlightColumn(columnHighlightInfo: ColumnHighlightInfo): void;
|
|
459
|
+
/**
|
|
460
|
+
* Unhighlights a Column in AdapTable
|
|
461
|
+
* @param columnId column to unhighlight
|
|
462
|
+
*/
|
|
463
|
+
unHighlightColumn(columnId: string): void;
|
|
464
|
+
/**
|
|
465
|
+
* Unhighlights all highlighted Columns in AdapTable
|
|
466
|
+
*/
|
|
467
|
+
unHighlightAllColumns(): void;
|
|
453
468
|
/**
|
|
454
469
|
* Highlight a row using an adaptable style
|
|
455
470
|
* @param rowHighlightInfo highlight instructions
|
|
@@ -16,6 +16,7 @@ import { GridInternalApi } from '../Internal/GridInternalApi';
|
|
|
16
16
|
import { TransposeConfig } from '../../AdaptableState/Common/TransposeConfig';
|
|
17
17
|
import { CellSummmaryInfo } from '../../types';
|
|
18
18
|
import { InternalState } from '../../AdaptableState/InternalState';
|
|
19
|
+
import { ColumnHighlightInfo } from '../../AdaptableState/Common/ColumnHighlightInfo';
|
|
19
20
|
export declare class GridApiImpl extends ApiBase implements GridApi {
|
|
20
21
|
internalApi: GridInternalApi;
|
|
21
22
|
constructor(_adaptable: IAdaptable);
|
|
@@ -122,6 +123,9 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
|
|
|
122
123
|
highlightCell(cellHighlightInfo: CellHighlightInfo): void;
|
|
123
124
|
unHighlightCell(primaryKeyValue: CellHighlightInfo['primaryKeyValue'], columnId: CellHighlightInfo['columnId']): void;
|
|
124
125
|
unHighlightAllCells(): void;
|
|
126
|
+
highlightColumn(columnHighlightInfo: ColumnHighlightInfo): void;
|
|
127
|
+
unHighlightColumn(columnId: string): void;
|
|
128
|
+
unHighlightAllColumns(): void;
|
|
125
129
|
highlightRow(rowHighlightInfo: RowHighlightInfo): void;
|
|
126
130
|
highlightRows(rowHighlightInfos: RowsHighlightInfo): void;
|
|
127
131
|
unHighlightRow(primaryKeyValue: RowHighlightInfo['primaryKeyValue']): void;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ApiBase } from './ApiBase';
|
|
2
|
-
import { HighlightCellAdd, HighlightCellDelete, HighlightCellDeleteAll, HighlightRowAdd, HighlightRowDelete, GridHighlightRowDeleteAll, HighlightRowsAdd, GridHighlightRowsDelete, } from '../../Redux/ActionsReducers/InternalRedux';
|
|
2
|
+
import { HighlightCellAdd, HighlightCellDelete, HighlightCellDeleteAll, HighlightColumnAdd, HighlightColumnDelete, HighlightColumnDeleteAll, HighlightRowAdd, HighlightRowDelete, GridHighlightRowDeleteAll, HighlightRowsAdd, GridHighlightRowsDelete, } from '../../Redux/ActionsReducers/InternalRedux';
|
|
3
3
|
import * as ModuleConstants from '../../Utilities/Constants/ModuleConstants';
|
|
4
4
|
import { GridInternalApi } from '../Internal/GridInternalApi';
|
|
5
5
|
import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
|
|
@@ -470,6 +470,20 @@ export class GridApiImpl extends ApiBase {
|
|
|
470
470
|
unHighlightAllCells() {
|
|
471
471
|
this.dispatchAction(HighlightCellDeleteAll());
|
|
472
472
|
}
|
|
473
|
+
highlightColumn(columnHighlightInfo) {
|
|
474
|
+
this.dispatchAction(HighlightColumnAdd(columnHighlightInfo));
|
|
475
|
+
if (columnHighlightInfo.timeout) {
|
|
476
|
+
setTimeout(() => {
|
|
477
|
+
this.unHighlightColumn(columnHighlightInfo.columnId);
|
|
478
|
+
}, columnHighlightInfo.timeout);
|
|
479
|
+
}
|
|
480
|
+
}
|
|
481
|
+
unHighlightColumn(columnId) {
|
|
482
|
+
this.dispatchAction(HighlightColumnDelete(columnId));
|
|
483
|
+
}
|
|
484
|
+
unHighlightAllColumns() {
|
|
485
|
+
this.dispatchAction(HighlightColumnDeleteAll());
|
|
486
|
+
}
|
|
473
487
|
highlightRow(rowHighlightInfo) {
|
|
474
488
|
this.dispatchAction(HighlightRowAdd(rowHighlightInfo));
|
|
475
489
|
if (rowHighlightInfo.timeout) {
|
|
@@ -15,6 +15,7 @@ import { SelectedCellInfo } from '../../AdaptableState/Selection/SelectedCellInf
|
|
|
15
15
|
import { SelectedRowInfo } from '../../AdaptableState/Selection/SelectedRowInfo';
|
|
16
16
|
import { CellHighlightInfo, RowHighlightInfo, RowsHighlightInfo } from '../../types';
|
|
17
17
|
import { IRowNode } from 'ag-grid-enterprise';
|
|
18
|
+
import { ColumnHighlightInfo } from '../../AdaptableState/Common/ColumnHighlightInfo';
|
|
18
19
|
export declare const SET_COLUMNS = "SET_COLUMNS";
|
|
19
20
|
export declare const SET_SELECTED_CELLS = "SET_SELECTED_CELLS";
|
|
20
21
|
export declare const SET_SELECTED_ROWS = "SET_SELECTED_ROWS";
|
|
@@ -23,6 +24,9 @@ export declare const SET_DASHBOARD_MODULE_BUTTONS = "SET_DASHBOARD_MODULE_BUTTON
|
|
|
23
24
|
export declare const HIGHLIGHT_CELL_ADD = "HIGHLIGHT_CELL_ADD";
|
|
24
25
|
export declare const HIGHLIGHT_CELL_DELETE = "HIGHLIGHT_CELL_DELETE";
|
|
25
26
|
export declare const HIGHLIGHT_CELL_DELETE_ALL = "HIGHLIGHT_CELL_DELETE_ALL";
|
|
27
|
+
export declare const HIGHLIGHT_COLUMN_ADD = "HIGHLIGHT_COLUMN_ADD";
|
|
28
|
+
export declare const HIGHLIGHT_COLUMN_DELETE = "HIGHLIGHT_COLUMN_DELETE";
|
|
29
|
+
export declare const HIGHLIGHT_COLUMN_DELETE_ALL = "HIGHLIGHT_COLUMN_DELETE_ALL";
|
|
26
30
|
export declare const HIGHLIGHT_ROW_ADD = "HIGHLIGHT_ROW_ADD";
|
|
27
31
|
export declare const HIGHLIGHT_ROWS_ADD = "HIGHLIGHT_ROWS_ADD";
|
|
28
32
|
export declare const HIGHLIGHT_ROW_DELETE = "HIGHLIGHT_ROW_DELETE";
|
|
@@ -93,6 +97,14 @@ export interface HighlightCellDeleteAction extends Redux.Action {
|
|
|
93
97
|
}
|
|
94
98
|
export interface HighlightCellDeleteAllAction extends Redux.Action {
|
|
95
99
|
}
|
|
100
|
+
export interface HighlightColumnAddAction extends Redux.Action {
|
|
101
|
+
columnHighlightInfo: ColumnHighlightInfo;
|
|
102
|
+
}
|
|
103
|
+
export interface HighlightColumnDeleteAction extends Redux.Action {
|
|
104
|
+
columnId: ColumnHighlightInfo['columnId'];
|
|
105
|
+
}
|
|
106
|
+
export interface HighlightColumnDeleteAllAction extends Redux.Action {
|
|
107
|
+
}
|
|
96
108
|
export interface HighlightRowAddAction extends Redux.Action {
|
|
97
109
|
rowHighlightInfo: RowHighlightInfo;
|
|
98
110
|
}
|
|
@@ -121,6 +133,9 @@ export interface SystemExportEndAction extends Redux.Action {
|
|
|
121
133
|
export declare const HighlightCellAdd: (cellHighlightInfo: CellHighlightInfo) => HighlightCellAddAction;
|
|
122
134
|
export declare const HighlightCellDelete: (primaryKeyValue: CellHighlightInfo["primaryKeyValue"], columnId: CellHighlightInfo["columnId"]) => HighlightCellDeleteAction;
|
|
123
135
|
export declare const HighlightCellDeleteAll: () => HighlightCellDeleteAllAction;
|
|
136
|
+
export declare const HighlightColumnAdd: (columnHighlightInfo: ColumnHighlightInfo) => HighlightColumnAddAction;
|
|
137
|
+
export declare const HighlightColumnDelete: (columnId: ColumnHighlightInfo["columnId"]) => HighlightColumnDeleteAction;
|
|
138
|
+
export declare const HighlightColumnDeleteAll: () => HighlightColumnDeleteAllAction;
|
|
124
139
|
export declare const HighlightRowAdd: (rowHighlightInfo: RowHighlightInfo) => HighlightRowAddAction;
|
|
125
140
|
export declare const HighlightRowsAdd: (rowsHighlightInfo: RowsHighlightInfo) => HighlightRowsAddAction;
|
|
126
141
|
export declare const HighlightRowDelete: (primaryKeyValue: RowHighlightInfo["primaryKeyValue"]) => HighlightRowDeleteAction;
|
|
@@ -22,6 +22,10 @@ export const SET_DASHBOARD_MODULE_BUTTONS = 'SET_DASHBOARD_MODULE_BUTTONS';
|
|
|
22
22
|
export const HIGHLIGHT_CELL_ADD = 'HIGHLIGHT_CELL_ADD';
|
|
23
23
|
export const HIGHLIGHT_CELL_DELETE = 'HIGHLIGHT_CELL_DELETE';
|
|
24
24
|
export const HIGHLIGHT_CELL_DELETE_ALL = 'HIGHLIGHT_CELL_DELETE_ALL';
|
|
25
|
+
// Column Highlight
|
|
26
|
+
export const HIGHLIGHT_COLUMN_ADD = 'HIGHLIGHT_COLUMN_ADD';
|
|
27
|
+
export const HIGHLIGHT_COLUMN_DELETE = 'HIGHLIGHT_COLUMN_DELETE';
|
|
28
|
+
export const HIGHLIGHT_COLUMN_DELETE_ALL = 'HIGHLIGHT_COLUMN_DELETE_ALL';
|
|
25
29
|
// Row Highlight
|
|
26
30
|
export const HIGHLIGHT_ROW_ADD = 'HIGHLIGHT_ROW_ADD';
|
|
27
31
|
export const HIGHLIGHT_ROWS_ADD = 'HIGHLIGHT_ROWS_ADD';
|
|
@@ -106,6 +110,17 @@ export const HighlightCellDelete = (primaryKeyValue, columnId) => ({
|
|
|
106
110
|
export const HighlightCellDeleteAll = () => ({
|
|
107
111
|
type: HIGHLIGHT_CELL_DELETE_ALL,
|
|
108
112
|
});
|
|
113
|
+
export const HighlightColumnAdd = (columnHighlightInfo) => ({
|
|
114
|
+
type: HIGHLIGHT_COLUMN_ADD,
|
|
115
|
+
columnHighlightInfo: columnHighlightInfo,
|
|
116
|
+
});
|
|
117
|
+
export const HighlightColumnDelete = (columnId) => ({
|
|
118
|
+
type: HIGHLIGHT_COLUMN_DELETE,
|
|
119
|
+
columnId,
|
|
120
|
+
});
|
|
121
|
+
export const HighlightColumnDeleteAll = () => ({
|
|
122
|
+
type: HIGHLIGHT_COLUMN_DELETE_ALL,
|
|
123
|
+
});
|
|
109
124
|
export const HighlightRowAdd = (rowHighlightInfo) => ({
|
|
110
125
|
type: HIGHLIGHT_ROW_ADD,
|
|
111
126
|
rowHighlightInfo: rowHighlightInfo,
|
|
@@ -349,6 +364,7 @@ const initialState = {
|
|
|
349
364
|
SelectedCellInfo: null,
|
|
350
365
|
SelectedRowInfo: null,
|
|
351
366
|
CellHighlightInfo: EMPTY_ARRAY,
|
|
367
|
+
ColumnHighlightInfo: EMPTY_ARRAY,
|
|
352
368
|
RowHighlightInfo: EMPTY_ARRAY,
|
|
353
369
|
SettingsPanelModuleEntries: EMPTY_ARRAY,
|
|
354
370
|
AdaptableAlerts: EMPTY_ARRAY,
|
|
@@ -448,6 +464,26 @@ export const InternalReducer = (state = initialState, action) => {
|
|
|
448
464
|
CellHighlightInfo: [],
|
|
449
465
|
});
|
|
450
466
|
}
|
|
467
|
+
case HIGHLIGHT_COLUMN_ADD: {
|
|
468
|
+
const actionTypedAdd = action;
|
|
469
|
+
return Object.assign({}, state, {
|
|
470
|
+
ColumnHighlightInfo: [...state.ColumnHighlightInfo, actionTypedAdd.columnHighlightInfo],
|
|
471
|
+
});
|
|
472
|
+
}
|
|
473
|
+
case HIGHLIGHT_COLUMN_DELETE: {
|
|
474
|
+
const actionTypedDelete = action;
|
|
475
|
+
const actionId = actionTypedDelete.columnId;
|
|
476
|
+
return Object.assign({}, state, {
|
|
477
|
+
ColumnHighlightInfo: state.ColumnHighlightInfo.filter((columnHighlightInfo) => {
|
|
478
|
+
return columnHighlightInfo.columnId !== actionId;
|
|
479
|
+
}),
|
|
480
|
+
});
|
|
481
|
+
}
|
|
482
|
+
case HIGHLIGHT_COLUMN_DELETE_ALL: {
|
|
483
|
+
return Object.assign({}, state, {
|
|
484
|
+
ColumnHighlightInfo: [],
|
|
485
|
+
});
|
|
486
|
+
}
|
|
451
487
|
case HIGHLIGHT_ROW_ADD: {
|
|
452
488
|
const actionTypedAdd = action;
|
|
453
489
|
return Object.assign({}, state, {
|
|
@@ -745,6 +745,27 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
|
|
|
745
745
|
});
|
|
746
746
|
return ret;
|
|
747
747
|
}
|
|
748
|
+
case InternalRedux.HIGHLIGHT_COLUMN_ADD: {
|
|
749
|
+
const actionTyped = action;
|
|
750
|
+
const ret = next(action);
|
|
751
|
+
const columnHighlightInfo = actionTyped.columnHighlightInfo;
|
|
752
|
+
adaptable.api.gridApi.refreshColumn(columnHighlightInfo.columnId);
|
|
753
|
+
return ret;
|
|
754
|
+
}
|
|
755
|
+
case InternalRedux.HIGHLIGHT_COLUMN_DELETE: {
|
|
756
|
+
const actionTyped = action;
|
|
757
|
+
const ret = next(action);
|
|
758
|
+
adaptable.api.gridApi.refreshColumn(actionTyped.columnId);
|
|
759
|
+
return ret;
|
|
760
|
+
}
|
|
761
|
+
case InternalRedux.HIGHLIGHT_COLUMN_DELETE_ALL: {
|
|
762
|
+
const columnHighlightInfos = middlewareAPI.getState().Internal.ColumnHighlightInfo;
|
|
763
|
+
const ret = next(action);
|
|
764
|
+
columnHighlightInfos.forEach((columnHighlightInfo) => {
|
|
765
|
+
adaptable.api.gridApi.refreshColumn(columnHighlightInfo.columnId);
|
|
766
|
+
});
|
|
767
|
+
return ret;
|
|
768
|
+
}
|
|
748
769
|
case InternalRedux.HIGHLIGHT_ROW_ADD: {
|
|
749
770
|
const actionTyped = action;
|
|
750
771
|
const ret = next(action);
|
|
@@ -6,6 +6,7 @@ import { AlertType } from './getAlertType';
|
|
|
6
6
|
*/
|
|
7
7
|
export declare const getDefaultAlertDefinition: (alertDefinition: AlertDefinition, type: AlertType) => {
|
|
8
8
|
Uuid: string;
|
|
9
|
+
Name: string;
|
|
9
10
|
Scope: import("../../../types").ColumnScope;
|
|
10
11
|
Rule: import("../../../types").AlertRule;
|
|
11
12
|
MessageType: import("../../../types").AdaptableMessageType;
|
|
@@ -13,11 +14,10 @@ export declare const getDefaultAlertDefinition: (alertDefinition: AlertDefinitio
|
|
|
13
14
|
MessageText?: string;
|
|
14
15
|
AlertProperties?: import("../../../types").AlertProperties;
|
|
15
16
|
AlertForm?: string | import("../../../types").AlertButtonForm;
|
|
16
|
-
|
|
17
|
+
IsSuspended?: boolean;
|
|
17
18
|
Source?: "InitialState" | "User";
|
|
18
19
|
AdaptableVersion?: import("../../../types").AdaptableVersion;
|
|
19
20
|
IsReadOnly?: boolean;
|
|
20
21
|
Tags?: import("../../../types").AdaptableObjectTag[];
|
|
21
22
|
Metadata?: any;
|
|
22
|
-
IsSuspended?: boolean;
|
|
23
23
|
};
|