@genesislcap/grid-pro 14.27.2-alpha-af4c16a.0 → 14.28.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/dist/custom-elements.json +22 -115
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource-next.d.ts +1 -0
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource-next.d.ts.map +1 -1
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
- package/dist/dts/grid-pro.d.ts +6 -22
- package/dist/dts/grid-pro.d.ts.map +1 -1
- package/dist/dts/utils/index.d.ts +0 -1
- package/dist/dts/utils/index.d.ts.map +1 -1
- package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource-next.js +10 -3
- package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +1 -1
- package/dist/esm/grid-pro.js +43 -80
- package/dist/esm/utils/index.js +0 -1
- package/dist/grid-pro.api.json +6 -230
- package/dist/grid-pro.d.ts +6 -30
- 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 +1 -2
- package/docs/api/grid-pro.gridpro.md +3 -5
- package/docs/api/grid-pro.md +0 -2
- package/docs/api-report.md +5 -13
- package/package.json +7 -7
- package/dist/dts/utils/array.d.ts +0 -9
- package/dist/dts/utils/array.d.ts.map +0 -1
- package/dist/esm/utils/array.js +0 -27
- package/docs/api/grid-pro.converttokebabcase.md +0 -13
- package/docs/api/grid-pro.gridpro.getsavedcolumnstate.md +0 -21
- package/docs/api/grid-pro.gridpro.gridprogenesisdatasource.md +0 -11
- package/docs/api/grid-pro.mergeanddedupcoldefwithcolumnstate.md +0 -31
package/dist/grid-pro.api.json
CHANGED
|
@@ -3035,29 +3035,6 @@
|
|
|
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
|
-
},
|
|
3061
3038
|
{
|
|
3062
3039
|
"kind": "Function",
|
|
3063
3040
|
"canonicalReference": "@genesislcap/grid-pro!dateTimeValueFormatter:function(1)",
|
|
@@ -4871,14 +4848,9 @@
|
|
|
4871
4848
|
"kind": "Content",
|
|
4872
4849
|
"text": "protected agAttributes: "
|
|
4873
4850
|
},
|
|
4874
|
-
{
|
|
4875
|
-
"kind": "Reference",
|
|
4876
|
-
"text": "Record",
|
|
4877
|
-
"canonicalReference": "!Record:type"
|
|
4878
|
-
},
|
|
4879
4851
|
{
|
|
4880
4852
|
"kind": "Content",
|
|
4881
|
-
"text": "
|
|
4853
|
+
"text": "any"
|
|
4882
4854
|
},
|
|
4883
4855
|
{
|
|
4884
4856
|
"kind": "Content",
|
|
@@ -4891,7 +4863,7 @@
|
|
|
4891
4863
|
"name": "agAttributes",
|
|
4892
4864
|
"propertyTypeTokenRange": {
|
|
4893
4865
|
"startIndex": 1,
|
|
4894
|
-
"endIndex":
|
|
4866
|
+
"endIndex": 2
|
|
4895
4867
|
},
|
|
4896
4868
|
"isStatic": false,
|
|
4897
4869
|
"isProtected": true,
|
|
@@ -4968,14 +4940,9 @@
|
|
|
4968
4940
|
"kind": "Content",
|
|
4969
4941
|
"text": "protected agPropertiesMap: "
|
|
4970
4942
|
},
|
|
4971
|
-
{
|
|
4972
|
-
"kind": "Reference",
|
|
4973
|
-
"text": "Record",
|
|
4974
|
-
"canonicalReference": "!Record:type"
|
|
4975
|
-
},
|
|
4976
4943
|
{
|
|
4977
4944
|
"kind": "Content",
|
|
4978
|
-
"text": "
|
|
4945
|
+
"text": "any"
|
|
4979
4946
|
},
|
|
4980
4947
|
{
|
|
4981
4948
|
"kind": "Content",
|
|
@@ -4988,7 +4955,7 @@
|
|
|
4988
4955
|
"name": "agPropertiesMap",
|
|
4989
4956
|
"propertyTypeTokenRange": {
|
|
4990
4957
|
"startIndex": 1,
|
|
4991
|
-
"endIndex":
|
|
4958
|
+
"endIndex": 2
|
|
4992
4959
|
},
|
|
4993
4960
|
"isStatic": false,
|
|
4994
4961
|
"isProtected": true,
|
|
@@ -5012,14 +4979,6 @@
|
|
|
5012
4979
|
"kind": "Content",
|
|
5013
4980
|
"text": "[]"
|
|
5014
4981
|
},
|
|
5015
|
-
{
|
|
5016
|
-
"kind": "Content",
|
|
5017
|
-
"text": ", deferredColumnDefs?: "
|
|
5018
|
-
},
|
|
5019
|
-
{
|
|
5020
|
-
"kind": "Content",
|
|
5021
|
-
"text": "boolean"
|
|
5022
|
-
},
|
|
5023
4982
|
{
|
|
5024
4983
|
"kind": "Content",
|
|
5025
4984
|
"text": "): "
|
|
@@ -5040,8 +4999,8 @@
|
|
|
5040
4999
|
],
|
|
5041
5000
|
"isStatic": false,
|
|
5042
5001
|
"returnTypeTokenRange": {
|
|
5043
|
-
"startIndex":
|
|
5044
|
-
"endIndex":
|
|
5002
|
+
"startIndex": 4,
|
|
5003
|
+
"endIndex": 6
|
|
5045
5004
|
},
|
|
5046
5005
|
"releaseTag": "Public",
|
|
5047
5006
|
"isProtected": false,
|
|
@@ -5054,14 +5013,6 @@
|
|
|
5054
5013
|
"endIndex": 3
|
|
5055
5014
|
},
|
|
5056
5015
|
"isOptional": true
|
|
5057
|
-
},
|
|
5058
|
-
{
|
|
5059
|
-
"parameterName": "deferredColumnDefs",
|
|
5060
|
-
"parameterTypeTokenRange": {
|
|
5061
|
-
"startIndex": 4,
|
|
5062
|
-
"endIndex": 5
|
|
5063
|
-
},
|
|
5064
|
-
"isOptional": true
|
|
5065
5016
|
}
|
|
5066
5017
|
],
|
|
5067
5018
|
"isOptional": false,
|
|
@@ -5391,42 +5342,6 @@
|
|
|
5391
5342
|
"isProtected": false,
|
|
5392
5343
|
"isAbstract": false
|
|
5393
5344
|
},
|
|
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
|
-
},
|
|
5430
5345
|
{
|
|
5431
5346
|
"kind": "Method",
|
|
5432
5347
|
"canonicalReference": "@genesislcap/grid-pro!GridPro#globalEventListener:member(1)",
|
|
@@ -5652,37 +5567,6 @@
|
|
|
5652
5567
|
"isProtected": false,
|
|
5653
5568
|
"isAbstract": false
|
|
5654
5569
|
},
|
|
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
|
-
},
|
|
5686
5570
|
{
|
|
5687
5571
|
"kind": "Property",
|
|
5688
5572
|
"canonicalReference": "@genesislcap/grid-pro!GridPro#gridSlot:member",
|
|
@@ -7619,114 +7503,6 @@
|
|
|
7619
7503
|
"endIndex": 3
|
|
7620
7504
|
}
|
|
7621
7505
|
},
|
|
7622
|
-
{
|
|
7623
|
-
"kind": "Function",
|
|
7624
|
-
"canonicalReference": "@genesislcap/grid-pro!mergeAndDedupColDefWithColumnState:function(1)",
|
|
7625
|
-
"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",
|
|
7626
|
-
"excerptTokens": [
|
|
7627
|
-
{
|
|
7628
|
-
"kind": "Content",
|
|
7629
|
-
"text": "export declare function mergeAndDedupColDefWithColumnState(colDefs: "
|
|
7630
|
-
},
|
|
7631
|
-
{
|
|
7632
|
-
"kind": "Reference",
|
|
7633
|
-
"text": "ColDef",
|
|
7634
|
-
"canonicalReference": "@ag-grid-community/core!ColDef:interface"
|
|
7635
|
-
},
|
|
7636
|
-
{
|
|
7637
|
-
"kind": "Content",
|
|
7638
|
-
"text": "[]"
|
|
7639
|
-
},
|
|
7640
|
-
{
|
|
7641
|
-
"kind": "Content",
|
|
7642
|
-
"text": ", columnStates: "
|
|
7643
|
-
},
|
|
7644
|
-
{
|
|
7645
|
-
"kind": "Reference",
|
|
7646
|
-
"text": "ColumnState",
|
|
7647
|
-
"canonicalReference": "@ag-grid-community/core!ColumnState:interface"
|
|
7648
|
-
},
|
|
7649
|
-
{
|
|
7650
|
-
"kind": "Content",
|
|
7651
|
-
"text": "[]"
|
|
7652
|
-
},
|
|
7653
|
-
{
|
|
7654
|
-
"kind": "Content",
|
|
7655
|
-
"text": ", arr1Field?: "
|
|
7656
|
-
},
|
|
7657
|
-
{
|
|
7658
|
-
"kind": "Content",
|
|
7659
|
-
"text": "string"
|
|
7660
|
-
},
|
|
7661
|
-
{
|
|
7662
|
-
"kind": "Content",
|
|
7663
|
-
"text": ", arr2Field?: "
|
|
7664
|
-
},
|
|
7665
|
-
{
|
|
7666
|
-
"kind": "Content",
|
|
7667
|
-
"text": "string"
|
|
7668
|
-
},
|
|
7669
|
-
{
|
|
7670
|
-
"kind": "Content",
|
|
7671
|
-
"text": "): "
|
|
7672
|
-
},
|
|
7673
|
-
{
|
|
7674
|
-
"kind": "Reference",
|
|
7675
|
-
"text": "ColDef",
|
|
7676
|
-
"canonicalReference": "@ag-grid-community/core!ColDef:interface"
|
|
7677
|
-
},
|
|
7678
|
-
{
|
|
7679
|
-
"kind": "Content",
|
|
7680
|
-
"text": "[]"
|
|
7681
|
-
},
|
|
7682
|
-
{
|
|
7683
|
-
"kind": "Content",
|
|
7684
|
-
"text": ";"
|
|
7685
|
-
}
|
|
7686
|
-
],
|
|
7687
|
-
"fileUrlPath": "src/utils/array.ts",
|
|
7688
|
-
"returnTypeTokenRange": {
|
|
7689
|
-
"startIndex": 11,
|
|
7690
|
-
"endIndex": 13
|
|
7691
|
-
},
|
|
7692
|
-
"releaseTag": "Public",
|
|
7693
|
-
"overloadIndex": 1,
|
|
7694
|
-
"parameters": [
|
|
7695
|
-
{
|
|
7696
|
-
"parameterName": "colDefs",
|
|
7697
|
-
"parameterTypeTokenRange": {
|
|
7698
|
-
"startIndex": 1,
|
|
7699
|
-
"endIndex": 3
|
|
7700
|
-
},
|
|
7701
|
-
"isOptional": false
|
|
7702
|
-
},
|
|
7703
|
-
{
|
|
7704
|
-
"parameterName": "columnStates",
|
|
7705
|
-
"parameterTypeTokenRange": {
|
|
7706
|
-
"startIndex": 4,
|
|
7707
|
-
"endIndex": 6
|
|
7708
|
-
},
|
|
7709
|
-
"isOptional": false
|
|
7710
|
-
},
|
|
7711
|
-
{
|
|
7712
|
-
"parameterName": "arr1Field",
|
|
7713
|
-
"parameterTypeTokenRange": {
|
|
7714
|
-
"startIndex": 7,
|
|
7715
|
-
"endIndex": 8
|
|
7716
|
-
},
|
|
7717
|
-
"isOptional": true
|
|
7718
|
-
},
|
|
7719
|
-
{
|
|
7720
|
-
"parameterName": "arr2Field",
|
|
7721
|
-
"parameterTypeTokenRange": {
|
|
7722
|
-
"startIndex": 9,
|
|
7723
|
-
"endIndex": 10
|
|
7724
|
-
},
|
|
7725
|
-
"isOptional": true
|
|
7726
|
-
}
|
|
7727
|
-
],
|
|
7728
|
-
"name": "mergeAndDedupColDefWithColumnState"
|
|
7729
|
-
},
|
|
7730
7506
|
{
|
|
7731
7507
|
"kind": "Class",
|
|
7732
7508
|
"canonicalReference": "@genesislcap/grid-pro!SelectRenderer:class",
|
package/dist/grid-pro.d.ts
CHANGED
|
@@ -9,7 +9,6 @@ import { Binding } from '@microsoft/fast-element';
|
|
|
9
9
|
import { CaptureType } from '@microsoft/fast-element';
|
|
10
10
|
import { ColDef } from '@ag-grid-community/core';
|
|
11
11
|
import { ColumnApi } from '@ag-grid-community/core';
|
|
12
|
-
import { ColumnState } from '@ag-grid-community/core';
|
|
13
12
|
import { Connect } from '@genesislcap/foundation-comms';
|
|
14
13
|
import type { Container } from '@microsoft/fast-foundation';
|
|
15
14
|
import { Controller } from '@microsoft/fast-element';
|
|
@@ -398,14 +397,6 @@ export declare const CellTemplate: ViewTemplate<GridProCell, any>;
|
|
|
398
397
|
*/
|
|
399
398
|
export declare const ColumnTemplate: ViewTemplate<GridColumn, any>;
|
|
400
399
|
|
|
401
|
-
/**
|
|
402
|
-
* Convert string values from 'camelCase' to 'kebab-case'
|
|
403
|
-
* @param value - The value to convert to Kebab case.
|
|
404
|
-
* @returns The Kebab case result.
|
|
405
|
-
* @public
|
|
406
|
-
*/
|
|
407
|
-
export declare const convertToKebabCase: (value: string) => string;
|
|
408
|
-
|
|
409
400
|
/**
|
|
410
401
|
* Returns a formatted date time value from the Grid Pro cell value.
|
|
411
402
|
* @param param - A ValueFormatterParams object.
|
|
@@ -828,8 +819,8 @@ export declare class GridPro extends GridPro_base {
|
|
|
828
819
|
gridComponents: {
|
|
829
820
|
[componentName: string]: any;
|
|
830
821
|
};
|
|
831
|
-
protected agAttributes:
|
|
832
|
-
protected agPropertiesMap:
|
|
822
|
+
protected agAttributes: any;
|
|
823
|
+
protected agPropertiesMap: any;
|
|
833
824
|
protected agGridOptions: GridOptions;
|
|
834
825
|
protected initialised: boolean;
|
|
835
826
|
private rehydrationAttempted;
|
|
@@ -849,23 +840,15 @@ export declare class GridPro extends GridPro_base {
|
|
|
849
840
|
* @internal
|
|
850
841
|
*/
|
|
851
842
|
private removeConfigWidthsToAutosize;
|
|
852
|
-
private
|
|
853
|
-
|
|
854
|
-
* Gets the saved grid ColumnState[] from local storage
|
|
855
|
-
* @remarks This is used to restore the grid state when the grid is rehydrated
|
|
856
|
-
* @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering.
|
|
857
|
-
* @public
|
|
858
|
-
*/
|
|
859
|
-
getSavedColumnState(): ColumnState[];
|
|
860
|
-
private restoreColumnState;
|
|
843
|
+
private serialiseStoreTableConfig;
|
|
844
|
+
private rehydrateTableConfig;
|
|
861
845
|
/**
|
|
862
846
|
* @public
|
|
863
847
|
*/
|
|
864
848
|
get gridOptions(): GridOptions;
|
|
865
|
-
get gridProGenesisDatasource(): GridProGenesisDatasource;
|
|
866
849
|
set gridOptions(options: GridOptions);
|
|
867
850
|
private enableFlashingRows;
|
|
868
|
-
applyTemplateDefinitions(columnDefs?: ColDef[]
|
|
851
|
+
applyTemplateDefinitions(columnDefs?: ColDef[]): ColDef<any>[];
|
|
869
852
|
get observedAttributes(): string[];
|
|
870
853
|
agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
|
|
871
854
|
globalEventListener(eventType: any, event: any): void;
|
|
@@ -1631,6 +1614,7 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
1631
1614
|
export declare class GridProGenesisDatasourceNext extends GridProGenesisDatasourceNext_base {
|
|
1632
1615
|
connect: Connect;
|
|
1633
1616
|
criteria: string;
|
|
1617
|
+
criteriaChanged(oldCriteria: string, newCriteria: string): void;
|
|
1634
1618
|
fields: string;
|
|
1635
1619
|
isSnapshot: boolean;
|
|
1636
1620
|
maxRows: number;
|
|
@@ -2003,14 +1987,6 @@ export declare const gridProTemplate: ViewTemplate;
|
|
|
2003
1987
|
*/
|
|
2004
1988
|
export declare const logger: Logger;
|
|
2005
1989
|
|
|
2006
|
-
/**
|
|
2007
|
-
* Merges two arrays, one of `ColDef` and one of `ColumnState`, and deduplicates them.
|
|
2008
|
-
* @remarks ColDef uses `field` and ColumnState uses `colId` to identify columns.
|
|
2009
|
-
* @privateRemarks For restoring saved `ColumnState` but also keep custom renderers and other `ColDef` properties.
|
|
2010
|
-
* @public
|
|
2011
|
-
*/
|
|
2012
|
-
export declare function mergeAndDedupColDefWithColumnState(colDefs: ColDef[], columnStates: ColumnState[], arr1Field?: string, arr2Field?: string): ColDef[];
|
|
2013
|
-
|
|
2014
1990
|
declare interface SelectCellRendererParams extends ICellRendererParams {
|
|
2015
1991
|
accessor: string;
|
|
2016
1992
|
defaultValue?: string;
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
applyTemplateDefinitions(columnDefs?: ColDef[]
|
|
10
|
+
applyTemplateDefinitions(columnDefs?: ColDef[]): ColDef<any>[];
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
@@ -15,7 +15,6 @@ applyTemplateDefinitions(columnDefs?: ColDef[], deferredColumnDefs?: boolean): C
|
|
|
15
15
|
| Parameter | Type | Description |
|
|
16
16
|
| --- | --- | --- |
|
|
17
17
|
| columnDefs | ColDef\[\] | _(Optional)_ |
|
|
18
|
-
| deferredColumnDefs | boolean | _(Optional)_ |
|
|
19
18
|
|
|
20
19
|
**Returns:**
|
|
21
20
|
|
|
@@ -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> | any | |
|
|
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> | any | |
|
|
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,7 +43,6 @@ 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) | |
|
|
47
46
|
| [gridSlot](./grid-pro.gridpro.gridslot.md) | | HTMLSlotElement | |
|
|
48
47
|
| [headerHeight](./grid-pro.gridpro.headerheight.md) | | number | |
|
|
49
48
|
| [initialised](./grid-pro.gridpro.initialised.md) | <code>protected</code> | boolean | |
|
|
@@ -58,11 +57,10 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
|
|
|
58
57
|
| Method | Modifiers | Description |
|
|
59
58
|
| --- | --- | --- |
|
|
60
59
|
| [agAttributeChangedCallback(attName, oldValue, newValue)](./grid-pro.gridpro.agattributechangedcallback.md) | | |
|
|
61
|
-
| [applyTemplateDefinitions(columnDefs
|
|
60
|
+
| [applyTemplateDefinitions(columnDefs)](./grid-pro.gridpro.applytemplatedefinitions.md) | | |
|
|
62
61
|
| [combineAllGridComponents(gridOptionsComponents)](./grid-pro.gridpro.combineallgridcomponents.md) | | |
|
|
63
62
|
| [connectedCallback()](./grid-pro.gridpro.connectedcallback.md) | | |
|
|
64
63
|
| [disconnectedCallback()](./grid-pro.gridpro.disconnectedcallback.md) | | |
|
|
65
|
-
| [getSavedColumnState()](./grid-pro.gridpro.getsavedcolumnstate.md) | | Gets the saved grid ColumnState\[\] from local storage |
|
|
66
64
|
| [globalEventListener(eventType, event)](./grid-pro.gridpro.globaleventlistener.md) | | |
|
|
67
65
|
| [statePersistanceEnabled()](./grid-pro.gridpro.statepersistanceenabled.md) | | |
|
|
68
66
|
| [themeChanged(oldValue, newValue)](./grid-pro.gridpro.themechanged.md) | | |
|
package/docs/api/grid-pro.md
CHANGED
|
@@ -34,7 +34,6 @@
|
|
|
34
34
|
| [dateTimeValueFormatter({ value })](./grid-pro.datetimevalueformatter.md) | Returns a formatted date time value from the Grid Pro cell value. |
|
|
35
35
|
| [dateValueFormatter({ value })](./grid-pro.datevalueformatter.md) | Returns a formatted date value from the Grid Pro cell value. |
|
|
36
36
|
| [gridProColumns(itemsBinding, includeRenderers)](./grid-pro.gridprocolumns.md) | A directive that renders a set of grid-pro-column elements from a given input binding |
|
|
37
|
-
| [mergeAndDedupColDefWithColumnState(colDefs, columnStates, arr1Field, arr2Field)](./grid-pro.mergeanddedupcoldefwithcolumnstate.md) | Merges two arrays, one of <code>ColDef</code> and one of <code>ColumnState</code>, and deduplicates them. |
|
|
38
37
|
|
|
39
38
|
## Variables
|
|
40
39
|
|
|
@@ -59,7 +58,6 @@
|
|
|
59
58
|
| [agThemeTokenMapCSS](./grid-pro.agthemetokenmapcss.md) | Generates the CSS for a given GridPro theme name and token map |
|
|
60
59
|
| [CellTemplate](./grid-pro.celltemplate.md) | The Grid Pro Cell Template. |
|
|
61
60
|
| [ColumnTemplate](./grid-pro.columntemplate.md) | The Grid Pro Column Template. |
|
|
62
|
-
| [convertToKebabCase](./grid-pro.converttokebabcase.md) | Convert string values from 'camelCase' to 'kebab-case' |
|
|
63
61
|
| [defaultAgGridFontFace](./grid-pro.defaultaggridfontface.md) | The default font face for Grid Pro (agGridAlpine). |
|
|
64
62
|
| [defaultGridProConfig](./grid-pro.defaultgridproconfig.md) | Grid Pro default configuration. |
|
|
65
63
|
| [foundationAgBooleanRenderer](./grid-pro.foundationagbooleanrenderer.md) | A function that returns a Foundation Boolean Renderer registration for configuring the component with a DesignSystem. |
|
package/docs/api-report.md
CHANGED
|
@@ -15,7 +15,6 @@ import { Binding } from '@microsoft/fast-element';
|
|
|
15
15
|
import { CaptureType } from '@microsoft/fast-element';
|
|
16
16
|
import { ColDef } from '@ag-grid-community/core';
|
|
17
17
|
import { ColumnApi } from '@ag-grid-community/core';
|
|
18
|
-
import { ColumnState } from '@ag-grid-community/core';
|
|
19
18
|
import { Connect } from '@genesislcap/foundation-comms';
|
|
20
19
|
import type { Container } from '@microsoft/fast-foundation';
|
|
21
20
|
import { Controller } from '@microsoft/fast-element';
|
|
@@ -321,9 +320,6 @@ export const CellTemplate: ViewTemplate<GridProCell, any>;
|
|
|
321
320
|
// @public
|
|
322
321
|
export const ColumnTemplate: ViewTemplate<GridColumn, any>;
|
|
323
322
|
|
|
324
|
-
// @public
|
|
325
|
-
export const convertToKebabCase: (value: string) => string;
|
|
326
|
-
|
|
327
323
|
// @public
|
|
328
324
|
export function dateTimeValueFormatter({ value }: ValueFormatterParams): any;
|
|
329
325
|
|
|
@@ -549,15 +545,15 @@ export class GridPro extends GridPro_base {
|
|
|
549
545
|
// (undocumented)
|
|
550
546
|
agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
|
|
551
547
|
// (undocumented)
|
|
552
|
-
protected agAttributes:
|
|
548
|
+
protected agAttributes: any;
|
|
553
549
|
// (undocumented)
|
|
554
550
|
agGrid: Grid;
|
|
555
551
|
// (undocumented)
|
|
556
552
|
protected agGridOptions: GridOptions;
|
|
557
553
|
// (undocumented)
|
|
558
|
-
protected agPropertiesMap:
|
|
554
|
+
protected agPropertiesMap: any;
|
|
559
555
|
// (undocumented)
|
|
560
|
-
applyTemplateDefinitions(columnDefs?: ColDef[]
|
|
556
|
+
applyTemplateDefinitions(columnDefs?: ColDef[]): ColDef<any>[];
|
|
561
557
|
// (undocumented)
|
|
562
558
|
autoCellRendererByType: boolean;
|
|
563
559
|
// (undocumented)
|
|
@@ -577,7 +573,6 @@ export class GridPro extends GridPro_base {
|
|
|
577
573
|
enabledRowFlashing: boolean;
|
|
578
574
|
// (undocumented)
|
|
579
575
|
eventsAndCallbacks: any;
|
|
580
|
-
getSavedColumnState(): ColumnState[];
|
|
581
576
|
// (undocumented)
|
|
582
577
|
globalEventListener(eventType: any, event: any): void;
|
|
583
578
|
// (undocumented)
|
|
@@ -593,8 +588,6 @@ export class GridPro extends GridPro_base {
|
|
|
593
588
|
get gridOptions(): GridOptions;
|
|
594
589
|
set gridOptions(options: GridOptions);
|
|
595
590
|
// (undocumented)
|
|
596
|
-
get gridProGenesisDatasource(): GridProGenesisDatasource;
|
|
597
|
-
// (undocumented)
|
|
598
591
|
gridSlot: HTMLSlotElement;
|
|
599
592
|
// (undocumented)
|
|
600
593
|
headerHeight: number;
|
|
@@ -707,6 +700,8 @@ export class GridProGenesisDatasourceNext extends GridProGenesisDatasourceNext_b
|
|
|
707
700
|
// (undocumented)
|
|
708
701
|
criteria: string;
|
|
709
702
|
// (undocumented)
|
|
703
|
+
criteriaChanged(oldCriteria: string, newCriteria: string): void;
|
|
704
|
+
// (undocumented)
|
|
710
705
|
disconnectedCallback(): void;
|
|
711
706
|
// (undocumented)
|
|
712
707
|
fields: string;
|
|
@@ -760,9 +755,6 @@ export const gridProTemplate: ViewTemplate;
|
|
|
760
755
|
// @public
|
|
761
756
|
export const logger: Logger;
|
|
762
757
|
|
|
763
|
-
// @public
|
|
764
|
-
export function mergeAndDedupColDefWithColumnState(colDefs: ColDef[], columnStates: ColumnState[], arr1Field?: string, arr2Field?: string): ColDef[];
|
|
765
|
-
|
|
766
758
|
// @public
|
|
767
759
|
export class SelectRenderer extends FoundationElement implements ICellRendererComp {
|
|
768
760
|
// (undocumented)
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/grid-pro",
|
|
3
3
|
"description": "Genesis Foundation AG Grid",
|
|
4
|
-
"version": "14.
|
|
4
|
+
"version": "14.28.0",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -21,8 +21,8 @@
|
|
|
21
21
|
"serve": "genx serve"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
24
|
-
"@genesislcap/foundation-testing": "14.
|
|
25
|
-
"@genesislcap/genx": "14.
|
|
24
|
+
"@genesislcap/foundation-testing": "^14.28.0",
|
|
25
|
+
"@genesislcap/genx": "^14.28.0",
|
|
26
26
|
"@playwright/test": "^1.18.1",
|
|
27
27
|
"bulma": "^0.9.3",
|
|
28
28
|
"c8": "^7.11.0",
|
|
@@ -38,9 +38,9 @@
|
|
|
38
38
|
"watchlist": "^0.3.1"
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@genesislcap/foundation-comms": "14.
|
|
42
|
-
"@genesislcap/foundation-ui": "14.
|
|
43
|
-
"@genesislcap/foundation-utils": "14.
|
|
41
|
+
"@genesislcap/foundation-comms": "^14.28.0",
|
|
42
|
+
"@genesislcap/foundation-ui": "^14.28.0",
|
|
43
|
+
"@genesislcap/foundation-utils": "^14.28.0",
|
|
44
44
|
"@microsoft/fast-colors": "^5.1.4",
|
|
45
45
|
"@microsoft/fast-components": "^2.21.3",
|
|
46
46
|
"@microsoft/fast-element": "^1.7.0",
|
|
@@ -66,5 +66,5 @@
|
|
|
66
66
|
"access": "public"
|
|
67
67
|
},
|
|
68
68
|
"customElements": "dist/custom-elements.json",
|
|
69
|
-
"gitHead": "
|
|
69
|
+
"gitHead": "fcf71da3c5d4780fc557a01487181de1d0aabad2"
|
|
70
70
|
}
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { ColDef, ColumnState } from '@ag-grid-community/core';
|
|
2
|
-
/**
|
|
3
|
-
* Merges two arrays, one of `ColDef` and one of `ColumnState`, and deduplicates them.
|
|
4
|
-
* @remarks ColDef uses `field` and ColumnState uses `colId` to identify columns.
|
|
5
|
-
* @privateRemarks For restoring saved `ColumnState` but also keep custom renderers and other `ColDef` properties.
|
|
6
|
-
* @public
|
|
7
|
-
*/
|
|
8
|
-
export declare function mergeAndDedupColDefWithColumnState(colDefs: ColDef[], columnStates: ColumnState[], arr1Field?: string, arr2Field?: string): ColDef[];
|
|
9
|
-
//# sourceMappingURL=array.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../../src/utils/array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAE9D;;;;;GAKG;AACH,wBAAgB,kCAAkC,CAChD,OAAO,EAAE,MAAM,EAAE,EACjB,YAAY,EAAE,WAAW,EAAE,EAC3B,SAAS,SAAU,EACnB,SAAS,SAAU,GAClB,MAAM,EAAE,CAuBV"}
|
package/dist/esm/utils/array.js
DELETED
|
@@ -1,27 +0,0 @@
|
|
|
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.colId;
|
|
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
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
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
|
-
```
|
|
@@ -1,21 +0,0 @@
|
|
|
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
|
-
|