@genesislcap/grid-pro 14.48.0 → 14.49.1
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/dist/custom-elements.json +141 -5
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +10 -5
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
- package/dist/dts/grid-pro.d.ts +26 -6
- package/dist/dts/grid-pro.d.ts.map +1 -1
- package/dist/dts/utils/array.d.ts +9 -0
- package/dist/dts/utils/array.d.ts.map +1 -0
- package/dist/dts/utils/index.d.ts +1 -0
- package/dist/dts/utils/index.d.ts.map +1 -1
- package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +20 -4
- package/dist/esm/grid-pro.js +81 -43
- package/dist/esm/utils/array.js +27 -0
- package/dist/esm/utils/index.js +1 -0
- package/dist/grid-pro.api.json +293 -7
- package/dist/grid-pro.d.ts +44 -10
- package/docs/api/grid-pro.converttokebabcase.md +13 -0
- package/docs/api/grid-pro.gridpro.agattributes.md +1 -1
- package/docs/api/grid-pro.gridpro.agpropertiesmap.md +1 -1
- package/docs/api/grid-pro.gridpro.applytemplatedefinitions.md +3 -2
- package/docs/api/grid-pro.gridpro.getsavedcolumnstate.md +21 -0
- package/docs/api/grid-pro.gridpro.gridprogenesisdatasource.md +11 -0
- package/docs/api/grid-pro.gridpro.md +5 -3
- package/docs/api/grid-pro.gridprogenesisdatasource.md +2 -0
- package/docs/api/grid-pro.gridprogenesisdatasource.refreshrows.md +17 -0
- package/docs/api/grid-pro.gridprogenesisdatasource.rowdatamapper.md +13 -0
- package/docs/api/grid-pro.md +2 -0
- package/docs/api/grid-pro.mergeanddedupcoldefwithcolumnstate.md +31 -0
- package/docs/api-report.md +15 -3
- package/package.json +7 -7
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Merges two arrays, one of `ColDef` and one of `ColumnState`, and deduplicates them.
|
|
3
|
+
* @remarks ColDef uses `field` and ColumnState uses `colId` to identify columns.
|
|
4
|
+
* @privateRemarks For restoring saved `ColumnState` but also keep custom renderers and other `ColDef` properties.
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export function mergeAndDedupColDefWithColumnState(colDefs, columnStates, arr1Field = 'field', arr2Field = 'colId') {
|
|
8
|
+
const merged = {};
|
|
9
|
+
const deduplicated = [];
|
|
10
|
+
columnStates.forEach((state) => {
|
|
11
|
+
const matchingColDef = colDefs.find((item) => item[arr1Field] === state[arr2Field]);
|
|
12
|
+
if (matchingColDef) {
|
|
13
|
+
const colDefStateMerge = Object.assign(Object.assign({}, matchingColDef), state);
|
|
14
|
+
delete colDefStateMerge[arr2Field];
|
|
15
|
+
merged[matchingColDef[arr1Field]] = colDefStateMerge;
|
|
16
|
+
deduplicated.push(colDefStateMerge);
|
|
17
|
+
}
|
|
18
|
+
});
|
|
19
|
+
colDefs.forEach((def) => {
|
|
20
|
+
if (!merged.hasOwnProperty(def[arr1Field])) {
|
|
21
|
+
const newObj = Object.assign({}, def);
|
|
22
|
+
merged[def[arr1Field]] = newObj;
|
|
23
|
+
deduplicated.push(newObj);
|
|
24
|
+
}
|
|
25
|
+
});
|
|
26
|
+
return deduplicated;
|
|
27
|
+
}
|
package/dist/esm/utils/index.js
CHANGED
package/dist/grid-pro.api.json
CHANGED
|
@@ -3035,6 +3035,29 @@
|
|
|
3035
3035
|
"endIndex": 6
|
|
3036
3036
|
}
|
|
3037
3037
|
},
|
|
3038
|
+
{
|
|
3039
|
+
"kind": "Variable",
|
|
3040
|
+
"canonicalReference": "@genesislcap/grid-pro!convertToKebabCase:var",
|
|
3041
|
+
"docComment": "/**\n * Convert string values from 'camelCase' to 'kebab-case'\n *\n * @param value - The value to convert to Kebab case.\n *\n * @returns The Kebab case result.\n *\n * @public\n */\n",
|
|
3042
|
+
"excerptTokens": [
|
|
3043
|
+
{
|
|
3044
|
+
"kind": "Content",
|
|
3045
|
+
"text": "convertToKebabCase: "
|
|
3046
|
+
},
|
|
3047
|
+
{
|
|
3048
|
+
"kind": "Content",
|
|
3049
|
+
"text": "(value: string) => string"
|
|
3050
|
+
}
|
|
3051
|
+
],
|
|
3052
|
+
"fileUrlPath": "src/grid-pro.ts",
|
|
3053
|
+
"isReadonly": true,
|
|
3054
|
+
"releaseTag": "Public",
|
|
3055
|
+
"name": "convertToKebabCase",
|
|
3056
|
+
"variableTypeTokenRange": {
|
|
3057
|
+
"startIndex": 1,
|
|
3058
|
+
"endIndex": 2
|
|
3059
|
+
}
|
|
3060
|
+
},
|
|
3038
3061
|
{
|
|
3039
3062
|
"kind": "Function",
|
|
3040
3063
|
"canonicalReference": "@genesislcap/grid-pro!dateTimeValueFormatter:function(1)",
|
|
@@ -4848,9 +4871,14 @@
|
|
|
4848
4871
|
"kind": "Content",
|
|
4849
4872
|
"text": "protected agAttributes: "
|
|
4850
4873
|
},
|
|
4874
|
+
{
|
|
4875
|
+
"kind": "Reference",
|
|
4876
|
+
"text": "Record",
|
|
4877
|
+
"canonicalReference": "!Record:type"
|
|
4878
|
+
},
|
|
4851
4879
|
{
|
|
4852
4880
|
"kind": "Content",
|
|
4853
|
-
"text": "
|
|
4881
|
+
"text": "<string, string>"
|
|
4854
4882
|
},
|
|
4855
4883
|
{
|
|
4856
4884
|
"kind": "Content",
|
|
@@ -4863,7 +4891,7 @@
|
|
|
4863
4891
|
"name": "agAttributes",
|
|
4864
4892
|
"propertyTypeTokenRange": {
|
|
4865
4893
|
"startIndex": 1,
|
|
4866
|
-
"endIndex":
|
|
4894
|
+
"endIndex": 3
|
|
4867
4895
|
},
|
|
4868
4896
|
"isStatic": false,
|
|
4869
4897
|
"isProtected": true,
|
|
@@ -4940,9 +4968,14 @@
|
|
|
4940
4968
|
"kind": "Content",
|
|
4941
4969
|
"text": "protected agPropertiesMap: "
|
|
4942
4970
|
},
|
|
4971
|
+
{
|
|
4972
|
+
"kind": "Reference",
|
|
4973
|
+
"text": "Record",
|
|
4974
|
+
"canonicalReference": "!Record:type"
|
|
4975
|
+
},
|
|
4943
4976
|
{
|
|
4944
4977
|
"kind": "Content",
|
|
4945
|
-
"text": "
|
|
4978
|
+
"text": "<string, string>"
|
|
4946
4979
|
},
|
|
4947
4980
|
{
|
|
4948
4981
|
"kind": "Content",
|
|
@@ -4955,7 +4988,7 @@
|
|
|
4955
4988
|
"name": "agPropertiesMap",
|
|
4956
4989
|
"propertyTypeTokenRange": {
|
|
4957
4990
|
"startIndex": 1,
|
|
4958
|
-
"endIndex":
|
|
4991
|
+
"endIndex": 3
|
|
4959
4992
|
},
|
|
4960
4993
|
"isStatic": false,
|
|
4961
4994
|
"isProtected": true,
|
|
@@ -4968,7 +5001,7 @@
|
|
|
4968
5001
|
"excerptTokens": [
|
|
4969
5002
|
{
|
|
4970
5003
|
"kind": "Content",
|
|
4971
|
-
"text": "applyTemplateDefinitions(columnDefs
|
|
5004
|
+
"text": "applyTemplateDefinitions(columnDefs: "
|
|
4972
5005
|
},
|
|
4973
5006
|
{
|
|
4974
5007
|
"kind": "Reference",
|
|
@@ -4979,6 +5012,14 @@
|
|
|
4979
5012
|
"kind": "Content",
|
|
4980
5013
|
"text": "[]"
|
|
4981
5014
|
},
|
|
5015
|
+
{
|
|
5016
|
+
"kind": "Content",
|
|
5017
|
+
"text": ", deferredColumnDefs?: "
|
|
5018
|
+
},
|
|
5019
|
+
{
|
|
5020
|
+
"kind": "Content",
|
|
5021
|
+
"text": "boolean"
|
|
5022
|
+
},
|
|
4982
5023
|
{
|
|
4983
5024
|
"kind": "Content",
|
|
4984
5025
|
"text": "): "
|
|
@@ -4999,8 +5040,8 @@
|
|
|
4999
5040
|
],
|
|
5000
5041
|
"isStatic": false,
|
|
5001
5042
|
"returnTypeTokenRange": {
|
|
5002
|
-
"startIndex":
|
|
5003
|
-
"endIndex":
|
|
5043
|
+
"startIndex": 6,
|
|
5044
|
+
"endIndex": 8
|
|
5004
5045
|
},
|
|
5005
5046
|
"releaseTag": "Public",
|
|
5006
5047
|
"isProtected": false,
|
|
@@ -5012,6 +5053,14 @@
|
|
|
5012
5053
|
"startIndex": 1,
|
|
5013
5054
|
"endIndex": 3
|
|
5014
5055
|
},
|
|
5056
|
+
"isOptional": false
|
|
5057
|
+
},
|
|
5058
|
+
{
|
|
5059
|
+
"parameterName": "deferredColumnDefs",
|
|
5060
|
+
"parameterTypeTokenRange": {
|
|
5061
|
+
"startIndex": 4,
|
|
5062
|
+
"endIndex": 5
|
|
5063
|
+
},
|
|
5015
5064
|
"isOptional": true
|
|
5016
5065
|
}
|
|
5017
5066
|
],
|
|
@@ -5342,6 +5391,42 @@
|
|
|
5342
5391
|
"isProtected": false,
|
|
5343
5392
|
"isAbstract": false
|
|
5344
5393
|
},
|
|
5394
|
+
{
|
|
5395
|
+
"kind": "Method",
|
|
5396
|
+
"canonicalReference": "@genesislcap/grid-pro!GridPro#getSavedColumnState:member(1)",
|
|
5397
|
+
"docComment": "/**\n * Gets the saved grid ColumnState[] from local storage\n *\n * @remarks\n *\n * This is used to restore the grid state when the grid is rehydrated\n *\n * @public\n */\n",
|
|
5398
|
+
"excerptTokens": [
|
|
5399
|
+
{
|
|
5400
|
+
"kind": "Content",
|
|
5401
|
+
"text": "getSavedColumnState(): "
|
|
5402
|
+
},
|
|
5403
|
+
{
|
|
5404
|
+
"kind": "Reference",
|
|
5405
|
+
"text": "ColumnState",
|
|
5406
|
+
"canonicalReference": "@ag-grid-community/core!ColumnState:interface"
|
|
5407
|
+
},
|
|
5408
|
+
{
|
|
5409
|
+
"kind": "Content",
|
|
5410
|
+
"text": "[]"
|
|
5411
|
+
},
|
|
5412
|
+
{
|
|
5413
|
+
"kind": "Content",
|
|
5414
|
+
"text": ";"
|
|
5415
|
+
}
|
|
5416
|
+
],
|
|
5417
|
+
"isStatic": false,
|
|
5418
|
+
"returnTypeTokenRange": {
|
|
5419
|
+
"startIndex": 1,
|
|
5420
|
+
"endIndex": 3
|
|
5421
|
+
},
|
|
5422
|
+
"releaseTag": "Public",
|
|
5423
|
+
"isProtected": false,
|
|
5424
|
+
"overloadIndex": 1,
|
|
5425
|
+
"parameters": [],
|
|
5426
|
+
"isOptional": false,
|
|
5427
|
+
"isAbstract": false,
|
|
5428
|
+
"name": "getSavedColumnState"
|
|
5429
|
+
},
|
|
5345
5430
|
{
|
|
5346
5431
|
"kind": "Method",
|
|
5347
5432
|
"canonicalReference": "@genesislcap/grid-pro!GridPro#globalEventListener:member(1)",
|
|
@@ -5567,6 +5652,37 @@
|
|
|
5567
5652
|
"isProtected": false,
|
|
5568
5653
|
"isAbstract": false
|
|
5569
5654
|
},
|
|
5655
|
+
{
|
|
5656
|
+
"kind": "Property",
|
|
5657
|
+
"canonicalReference": "@genesislcap/grid-pro!GridPro#gridProGenesisDatasource:member",
|
|
5658
|
+
"docComment": "",
|
|
5659
|
+
"excerptTokens": [
|
|
5660
|
+
{
|
|
5661
|
+
"kind": "Content",
|
|
5662
|
+
"text": "get gridProGenesisDatasource(): "
|
|
5663
|
+
},
|
|
5664
|
+
{
|
|
5665
|
+
"kind": "Reference",
|
|
5666
|
+
"text": "GridProGenesisDatasource",
|
|
5667
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource:class"
|
|
5668
|
+
},
|
|
5669
|
+
{
|
|
5670
|
+
"kind": "Content",
|
|
5671
|
+
"text": ";"
|
|
5672
|
+
}
|
|
5673
|
+
],
|
|
5674
|
+
"isReadonly": true,
|
|
5675
|
+
"isOptional": false,
|
|
5676
|
+
"releaseTag": "Public",
|
|
5677
|
+
"name": "gridProGenesisDatasource",
|
|
5678
|
+
"propertyTypeTokenRange": {
|
|
5679
|
+
"startIndex": 1,
|
|
5680
|
+
"endIndex": 2
|
|
5681
|
+
},
|
|
5682
|
+
"isStatic": false,
|
|
5683
|
+
"isProtected": false,
|
|
5684
|
+
"isAbstract": false
|
|
5685
|
+
},
|
|
5570
5686
|
{
|
|
5571
5687
|
"kind": "Property",
|
|
5572
5688
|
"canonicalReference": "@genesislcap/grid-pro!GridPro#gridSlot:member",
|
|
@@ -6969,6 +7085,37 @@
|
|
|
6969
7085
|
"isProtected": false,
|
|
6970
7086
|
"isAbstract": false
|
|
6971
7087
|
},
|
|
7088
|
+
{
|
|
7089
|
+
"kind": "Method",
|
|
7090
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#refreshRows:member(1)",
|
|
7091
|
+
"docComment": "/**\n * Force the grid to redispatch the current rows\n */\n",
|
|
7092
|
+
"excerptTokens": [
|
|
7093
|
+
{
|
|
7094
|
+
"kind": "Content",
|
|
7095
|
+
"text": "refreshRows(): "
|
|
7096
|
+
},
|
|
7097
|
+
{
|
|
7098
|
+
"kind": "Content",
|
|
7099
|
+
"text": "void"
|
|
7100
|
+
},
|
|
7101
|
+
{
|
|
7102
|
+
"kind": "Content",
|
|
7103
|
+
"text": ";"
|
|
7104
|
+
}
|
|
7105
|
+
],
|
|
7106
|
+
"isStatic": false,
|
|
7107
|
+
"returnTypeTokenRange": {
|
|
7108
|
+
"startIndex": 1,
|
|
7109
|
+
"endIndex": 2
|
|
7110
|
+
},
|
|
7111
|
+
"releaseTag": "Public",
|
|
7112
|
+
"isProtected": false,
|
|
7113
|
+
"overloadIndex": 1,
|
|
7114
|
+
"parameters": [],
|
|
7115
|
+
"isOptional": false,
|
|
7116
|
+
"isAbstract": false,
|
|
7117
|
+
"name": "refreshRows"
|
|
7118
|
+
},
|
|
6972
7119
|
{
|
|
6973
7120
|
"kind": "Method",
|
|
6974
7121
|
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#removeFilter:member(1)",
|
|
@@ -7263,6 +7410,37 @@
|
|
|
7263
7410
|
"isProtected": false,
|
|
7264
7411
|
"isAbstract": false
|
|
7265
7412
|
},
|
|
7413
|
+
{
|
|
7414
|
+
"kind": "Property",
|
|
7415
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#rowDataMapper:member",
|
|
7416
|
+
"docComment": "/**\n * Allows grid data updates to be processed via and external function before applying in grid\n */\n",
|
|
7417
|
+
"excerptTokens": [
|
|
7418
|
+
{
|
|
7419
|
+
"kind": "Content",
|
|
7420
|
+
"text": "rowDataMapper: "
|
|
7421
|
+
},
|
|
7422
|
+
{
|
|
7423
|
+
"kind": "Reference",
|
|
7424
|
+
"text": "Function",
|
|
7425
|
+
"canonicalReference": "!Function:interface"
|
|
7426
|
+
},
|
|
7427
|
+
{
|
|
7428
|
+
"kind": "Content",
|
|
7429
|
+
"text": ";"
|
|
7430
|
+
}
|
|
7431
|
+
],
|
|
7432
|
+
"isReadonly": false,
|
|
7433
|
+
"isOptional": false,
|
|
7434
|
+
"releaseTag": "Public",
|
|
7435
|
+
"name": "rowDataMapper",
|
|
7436
|
+
"propertyTypeTokenRange": {
|
|
7437
|
+
"startIndex": 1,
|
|
7438
|
+
"endIndex": 2
|
|
7439
|
+
},
|
|
7440
|
+
"isStatic": false,
|
|
7441
|
+
"isProtected": false,
|
|
7442
|
+
"isAbstract": false
|
|
7443
|
+
},
|
|
7266
7444
|
{
|
|
7267
7445
|
"kind": "Property",
|
|
7268
7446
|
"canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#rowIdAttr:member",
|
|
@@ -7538,6 +7716,114 @@
|
|
|
7538
7716
|
"endIndex": 3
|
|
7539
7717
|
}
|
|
7540
7718
|
},
|
|
7719
|
+
{
|
|
7720
|
+
"kind": "Function",
|
|
7721
|
+
"canonicalReference": "@genesislcap/grid-pro!mergeAndDedupColDefWithColumnState:function(1)",
|
|
7722
|
+
"docComment": "/**\n * Merges two arrays, one of `ColDef` and one of `ColumnState`, and deduplicates them.\n *\n * @remarks\n *\n * ColDef uses `field` and ColumnState uses `colId` to identify columns.\n *\n * @public\n */\n",
|
|
7723
|
+
"excerptTokens": [
|
|
7724
|
+
{
|
|
7725
|
+
"kind": "Content",
|
|
7726
|
+
"text": "export declare function mergeAndDedupColDefWithColumnState(colDefs: "
|
|
7727
|
+
},
|
|
7728
|
+
{
|
|
7729
|
+
"kind": "Reference",
|
|
7730
|
+
"text": "ColDef",
|
|
7731
|
+
"canonicalReference": "@ag-grid-community/core!ColDef:interface"
|
|
7732
|
+
},
|
|
7733
|
+
{
|
|
7734
|
+
"kind": "Content",
|
|
7735
|
+
"text": "[]"
|
|
7736
|
+
},
|
|
7737
|
+
{
|
|
7738
|
+
"kind": "Content",
|
|
7739
|
+
"text": ", columnStates: "
|
|
7740
|
+
},
|
|
7741
|
+
{
|
|
7742
|
+
"kind": "Reference",
|
|
7743
|
+
"text": "ColumnState",
|
|
7744
|
+
"canonicalReference": "@ag-grid-community/core!ColumnState:interface"
|
|
7745
|
+
},
|
|
7746
|
+
{
|
|
7747
|
+
"kind": "Content",
|
|
7748
|
+
"text": "[]"
|
|
7749
|
+
},
|
|
7750
|
+
{
|
|
7751
|
+
"kind": "Content",
|
|
7752
|
+
"text": ", arr1Field?: "
|
|
7753
|
+
},
|
|
7754
|
+
{
|
|
7755
|
+
"kind": "Content",
|
|
7756
|
+
"text": "string"
|
|
7757
|
+
},
|
|
7758
|
+
{
|
|
7759
|
+
"kind": "Content",
|
|
7760
|
+
"text": ", arr2Field?: "
|
|
7761
|
+
},
|
|
7762
|
+
{
|
|
7763
|
+
"kind": "Content",
|
|
7764
|
+
"text": "string"
|
|
7765
|
+
},
|
|
7766
|
+
{
|
|
7767
|
+
"kind": "Content",
|
|
7768
|
+
"text": "): "
|
|
7769
|
+
},
|
|
7770
|
+
{
|
|
7771
|
+
"kind": "Reference",
|
|
7772
|
+
"text": "ColDef",
|
|
7773
|
+
"canonicalReference": "@ag-grid-community/core!ColDef:interface"
|
|
7774
|
+
},
|
|
7775
|
+
{
|
|
7776
|
+
"kind": "Content",
|
|
7777
|
+
"text": "[]"
|
|
7778
|
+
},
|
|
7779
|
+
{
|
|
7780
|
+
"kind": "Content",
|
|
7781
|
+
"text": ";"
|
|
7782
|
+
}
|
|
7783
|
+
],
|
|
7784
|
+
"fileUrlPath": "src/utils/array.ts",
|
|
7785
|
+
"returnTypeTokenRange": {
|
|
7786
|
+
"startIndex": 11,
|
|
7787
|
+
"endIndex": 13
|
|
7788
|
+
},
|
|
7789
|
+
"releaseTag": "Public",
|
|
7790
|
+
"overloadIndex": 1,
|
|
7791
|
+
"parameters": [
|
|
7792
|
+
{
|
|
7793
|
+
"parameterName": "colDefs",
|
|
7794
|
+
"parameterTypeTokenRange": {
|
|
7795
|
+
"startIndex": 1,
|
|
7796
|
+
"endIndex": 3
|
|
7797
|
+
},
|
|
7798
|
+
"isOptional": false
|
|
7799
|
+
},
|
|
7800
|
+
{
|
|
7801
|
+
"parameterName": "columnStates",
|
|
7802
|
+
"parameterTypeTokenRange": {
|
|
7803
|
+
"startIndex": 4,
|
|
7804
|
+
"endIndex": 6
|
|
7805
|
+
},
|
|
7806
|
+
"isOptional": false
|
|
7807
|
+
},
|
|
7808
|
+
{
|
|
7809
|
+
"parameterName": "arr1Field",
|
|
7810
|
+
"parameterTypeTokenRange": {
|
|
7811
|
+
"startIndex": 7,
|
|
7812
|
+
"endIndex": 8
|
|
7813
|
+
},
|
|
7814
|
+
"isOptional": true
|
|
7815
|
+
},
|
|
7816
|
+
{
|
|
7817
|
+
"parameterName": "arr2Field",
|
|
7818
|
+
"parameterTypeTokenRange": {
|
|
7819
|
+
"startIndex": 9,
|
|
7820
|
+
"endIndex": 10
|
|
7821
|
+
},
|
|
7822
|
+
"isOptional": true
|
|
7823
|
+
}
|
|
7824
|
+
],
|
|
7825
|
+
"name": "mergeAndDedupColDefWithColumnState"
|
|
7826
|
+
},
|
|
7541
7827
|
{
|
|
7542
7828
|
"kind": "Class",
|
|
7543
7829
|
"canonicalReference": "@genesislcap/grid-pro!SelectRenderer:class",
|
package/dist/grid-pro.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ import { Binding } from '@microsoft/fast-element';
|
|
|
3
3
|
import { CaptureType } from '@microsoft/fast-element';
|
|
4
4
|
import { ColDef } from '@ag-grid-community/core';
|
|
5
5
|
import { ColumnApi } from '@ag-grid-community/core';
|
|
6
|
+
import { ColumnState } from '@ag-grid-community/core';
|
|
6
7
|
import { Connect } from '@genesislcap/foundation-comms';
|
|
7
8
|
import type { Container } from '@microsoft/fast-foundation';
|
|
8
9
|
import { Controller } from '@microsoft/fast-element';
|
|
@@ -383,6 +384,14 @@ export declare const CellTemplate: ViewTemplate<GridProCell, any>;
|
|
|
383
384
|
*/
|
|
384
385
|
export declare const ColumnTemplate: ViewTemplate<GridColumn, any>;
|
|
385
386
|
|
|
387
|
+
/**
|
|
388
|
+
* Convert string values from 'camelCase' to 'kebab-case'
|
|
389
|
+
* @param value - The value to convert to Kebab case.
|
|
390
|
+
* @returns The Kebab case result.
|
|
391
|
+
* @public
|
|
392
|
+
*/
|
|
393
|
+
export declare const convertToKebabCase: (value: string) => string;
|
|
394
|
+
|
|
386
395
|
/**
|
|
387
396
|
* Returns a formatted date time value from the Grid Pro cell value.
|
|
388
397
|
* @param param - A ValueFormatterParams object.
|
|
@@ -805,8 +814,8 @@ export declare class GridPro extends GridPro_base {
|
|
|
805
814
|
gridComponents: {
|
|
806
815
|
[componentName: string]: any;
|
|
807
816
|
};
|
|
808
|
-
protected agAttributes:
|
|
809
|
-
protected agPropertiesMap:
|
|
817
|
+
protected agAttributes: Record<string, string>;
|
|
818
|
+
protected agPropertiesMap: Record<string, string>;
|
|
810
819
|
protected agGridOptions: GridOptions;
|
|
811
820
|
protected initialised: boolean;
|
|
812
821
|
private rehydrationAttempted;
|
|
@@ -826,15 +835,23 @@ export declare class GridPro extends GridPro_base {
|
|
|
826
835
|
* @internal
|
|
827
836
|
*/
|
|
828
837
|
private removeConfigWidthsToAutosize;
|
|
829
|
-
private
|
|
830
|
-
|
|
838
|
+
private saveColumnState;
|
|
839
|
+
/**
|
|
840
|
+
* Gets the saved grid ColumnState[] from local storage
|
|
841
|
+
* @remarks This is used to restore the grid state when the grid is rehydrated
|
|
842
|
+
* @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering.
|
|
843
|
+
* @public
|
|
844
|
+
*/
|
|
845
|
+
getSavedColumnState(): ColumnState[];
|
|
846
|
+
private restoreColumnState;
|
|
831
847
|
/**
|
|
832
848
|
* @public
|
|
833
849
|
*/
|
|
834
850
|
get gridOptions(): GridOptions;
|
|
851
|
+
get gridProGenesisDatasource(): GridProGenesisDatasource;
|
|
835
852
|
set gridOptions(options: GridOptions);
|
|
836
853
|
private enableFlashingRows;
|
|
837
|
-
applyTemplateDefinitions(columnDefs
|
|
854
|
+
applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefs?: boolean): ColDef<any>[];
|
|
838
855
|
get observedAttributes(): string[];
|
|
839
856
|
agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
|
|
840
857
|
globalEventListener(eventType: any, event: any): void;
|
|
@@ -1088,6 +1105,10 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1088
1105
|
ondragleave: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
1089
1106
|
ondragover: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
1090
1107
|
ondragstart: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
1108
|
+
/**
|
|
1109
|
+
* Grid Pro default configuration.
|
|
1110
|
+
* @public
|
|
1111
|
+
*/
|
|
1091
1112
|
ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
1092
1113
|
ondurationchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1093
1114
|
onemptied: (this: GlobalEventHandlers, ev: Event) => any;
|
|
@@ -1220,6 +1241,10 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
|
|
|
1220
1241
|
*/
|
|
1221
1242
|
rowIdAttr: any;
|
|
1222
1243
|
restartOnReconnection: boolean;
|
|
1244
|
+
/**
|
|
1245
|
+
* Allows grid data updates to be processed via and external function before applying in grid
|
|
1246
|
+
*/
|
|
1247
|
+
rowDataMapper: Function;
|
|
1223
1248
|
private dataSub;
|
|
1224
1249
|
private updateSub;
|
|
1225
1250
|
private connectionSub;
|
|
@@ -1258,6 +1283,10 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
|
|
|
1258
1283
|
* @public
|
|
1259
1284
|
*/
|
|
1260
1285
|
restart(): void;
|
|
1286
|
+
/**
|
|
1287
|
+
* Force the grid to redispatch the current rows
|
|
1288
|
+
*/
|
|
1289
|
+
refreshRows(): void;
|
|
1261
1290
|
/**
|
|
1262
1291
|
* Sends a DATA_LOGOFF when the resource is an active stream
|
|
1263
1292
|
* @remarks Will only happen for streaming DATASERER resources.
|
|
@@ -1272,6 +1301,7 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
|
|
|
1272
1301
|
private handleStreamResult;
|
|
1273
1302
|
private applyRequestServerData;
|
|
1274
1303
|
private applyDataserverData;
|
|
1304
|
+
private mapTransaction;
|
|
1275
1305
|
private handleStreamInserts;
|
|
1276
1306
|
private handleStreamDeletes;
|
|
1277
1307
|
private handleStreamUpdates;
|
|
@@ -1326,11 +1356,7 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
1326
1356
|
readonly classList: DOMTokenList;
|
|
1327
1357
|
className: string;
|
|
1328
1358
|
readonly clientHeight: number;
|
|
1329
|
-
readonly clientLeft: number;
|
|
1330
|
-
* Initializes the datasource.
|
|
1331
|
-
* @public
|
|
1332
|
-
* @remarks This method is called automatically when the element is connected to the DOM.
|
|
1333
|
-
*/
|
|
1359
|
+
readonly clientLeft: number;
|
|
1334
1360
|
readonly clientTop: number;
|
|
1335
1361
|
readonly clientWidth: number;
|
|
1336
1362
|
id: string;
|
|
@@ -1992,6 +2018,14 @@ export declare const gridProTemplate: ViewTemplate;
|
|
|
1992
2018
|
*/
|
|
1993
2019
|
export declare const logger: Logger;
|
|
1994
2020
|
|
|
2021
|
+
/**
|
|
2022
|
+
* Merges two arrays, one of `ColDef` and one of `ColumnState`, and deduplicates them.
|
|
2023
|
+
* @remarks ColDef uses `field` and ColumnState uses `colId` to identify columns.
|
|
2024
|
+
* @privateRemarks For restoring saved `ColumnState` but also keep custom renderers and other `ColDef` properties.
|
|
2025
|
+
* @public
|
|
2026
|
+
*/
|
|
2027
|
+
export declare function mergeAndDedupColDefWithColumnState(colDefs: ColDef[], columnStates: ColumnState[], arr1Field?: string, arr2Field?: string): ColDef[];
|
|
2028
|
+
|
|
1995
2029
|
declare interface SelectCellRendererParams extends ICellRendererParams {
|
|
1996
2030
|
accessor: string;
|
|
1997
2031
|
defaultValue?: string;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [convertToKebabCase](./grid-pro.converttokebabcase.md)
|
|
4
|
+
|
|
5
|
+
## convertToKebabCase variable
|
|
6
|
+
|
|
7
|
+
Convert string values from 'camelCase' to 'kebab-case'
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
convertToKebabCase: (value: string) => string
|
|
13
|
+
```
|
|
@@ -7,14 +7,15 @@
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
applyTemplateDefinitions(columnDefs
|
|
10
|
+
applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefs?: boolean): ColDef<any>[];
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
15
|
| Parameter | Type | Description |
|
|
16
16
|
| --- | --- | --- |
|
|
17
|
-
| columnDefs | ColDef\[\] |
|
|
17
|
+
| columnDefs | ColDef\[\] | |
|
|
18
|
+
| deferredColumnDefs | boolean | _(Optional)_ |
|
|
18
19
|
|
|
19
20
|
**Returns:**
|
|
20
21
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [GridPro](./grid-pro.gridpro.md) > [getSavedColumnState](./grid-pro.gridpro.getsavedcolumnstate.md)
|
|
4
|
+
|
|
5
|
+
## GridPro.getSavedColumnState() method
|
|
6
|
+
|
|
7
|
+
Gets the saved grid ColumnState\[\] from local storage
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getSavedColumnState(): ColumnState[];
|
|
13
|
+
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
ColumnState\[\]
|
|
17
|
+
|
|
18
|
+
## Remarks
|
|
19
|
+
|
|
20
|
+
This is used to restore the grid state when the grid is rehydrated
|
|
21
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [GridPro](./grid-pro.gridpro.md) > [gridProGenesisDatasource](./grid-pro.gridpro.gridprogenesisdatasource.md)
|
|
4
|
+
|
|
5
|
+
## GridPro.gridProGenesisDatasource property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
get gridProGenesisDatasource(): GridProGenesisDatasource;
|
|
11
|
+
```
|
|
@@ -27,10 +27,10 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
|
|
|
27
27
|
|
|
28
28
|
| Property | Modifiers | Type | Description |
|
|
29
29
|
| --- | --- | --- | --- |
|
|
30
|
-
| [agAttributes](./grid-pro.gridpro.agattributes.md) | <code>protected</code> |
|
|
30
|
+
| [agAttributes](./grid-pro.gridpro.agattributes.md) | <code>protected</code> | Record<string, string> | |
|
|
31
31
|
| [agGrid](./grid-pro.gridpro.aggrid.md) | | Grid | |
|
|
32
32
|
| [agGridOptions](./grid-pro.gridpro.aggridoptions.md) | <code>protected</code> | GridOptions | |
|
|
33
|
-
| [agPropertiesMap](./grid-pro.gridpro.agpropertiesmap.md) | <code>protected</code> |
|
|
33
|
+
| [agPropertiesMap](./grid-pro.gridpro.agpropertiesmap.md) | <code>protected</code> | Record<string, string> | |
|
|
34
34
|
| [autoCellRendererByType](./grid-pro.gridpro.autocellrendererbytype.md) | | boolean | |
|
|
35
35
|
| [classNames](./grid-pro.gridpro.classnames.md) | | string | |
|
|
36
36
|
| [columnApi](./grid-pro.gridpro.columnapi.md) | | ColumnApi | |
|
|
@@ -43,6 +43,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
|
|
|
43
43
|
| [gridComponents](./grid-pro.gridpro.gridcomponents.md) | | { \[componentName: string\]: any; } | |
|
|
44
44
|
| [gridFontFace](./grid-pro.gridpro.gridfontface.md) | | string | |
|
|
45
45
|
| [gridOptions](./grid-pro.gridpro.gridoptions.md) | | GridOptions | |
|
|
46
|
+
| [gridProGenesisDatasource](./grid-pro.gridpro.gridprogenesisdatasource.md) | <code>readonly</code> | [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) | |
|
|
46
47
|
| [gridSlot](./grid-pro.gridpro.gridslot.md) | | HTMLSlotElement | |
|
|
47
48
|
| [headerHeight](./grid-pro.gridpro.headerheight.md) | | number | |
|
|
48
49
|
| [initialised](./grid-pro.gridpro.initialised.md) | <code>protected</code> | boolean | |
|
|
@@ -57,10 +58,11 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
|
|
|
57
58
|
| Method | Modifiers | Description |
|
|
58
59
|
| --- | --- | --- |
|
|
59
60
|
| [agAttributeChangedCallback(attName, oldValue, newValue)](./grid-pro.gridpro.agattributechangedcallback.md) | | |
|
|
60
|
-
| [applyTemplateDefinitions(columnDefs)](./grid-pro.gridpro.applytemplatedefinitions.md) | | |
|
|
61
|
+
| [applyTemplateDefinitions(columnDefs, deferredColumnDefs)](./grid-pro.gridpro.applytemplatedefinitions.md) | | |
|
|
61
62
|
| [combineAllGridComponents(gridOptionsComponents)](./grid-pro.gridpro.combineallgridcomponents.md) | | |
|
|
62
63
|
| [connectedCallback()](./grid-pro.gridpro.connectedcallback.md) | | |
|
|
63
64
|
| [disconnectedCallback()](./grid-pro.gridpro.disconnectedcallback.md) | | |
|
|
65
|
+
| [getSavedColumnState()](./grid-pro.gridpro.getsavedcolumnstate.md) | | Gets the saved grid ColumnState\[\] from local storage |
|
|
64
66
|
| [globalEventListener(eventType, event)](./grid-pro.gridpro.globaleventlistener.md) | | |
|
|
65
67
|
| [statePersistanceEnabled()](./grid-pro.gridpro.statepersistanceenabled.md) | | |
|
|
66
68
|
| [themeChanged(oldValue, newValue)](./grid-pro.gridpro.themechanged.md) | | |
|