@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.
Files changed (29) hide show
  1. package/dist/custom-elements.json +141 -5
  2. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +10 -5
  3. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
  4. package/dist/dts/grid-pro.d.ts +26 -6
  5. package/dist/dts/grid-pro.d.ts.map +1 -1
  6. package/dist/dts/utils/array.d.ts +9 -0
  7. package/dist/dts/utils/array.d.ts.map +1 -0
  8. package/dist/dts/utils/index.d.ts +1 -0
  9. package/dist/dts/utils/index.d.ts.map +1 -1
  10. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +20 -4
  11. package/dist/esm/grid-pro.js +81 -43
  12. package/dist/esm/utils/array.js +27 -0
  13. package/dist/esm/utils/index.js +1 -0
  14. package/dist/grid-pro.api.json +293 -7
  15. package/dist/grid-pro.d.ts +44 -10
  16. package/docs/api/grid-pro.converttokebabcase.md +13 -0
  17. package/docs/api/grid-pro.gridpro.agattributes.md +1 -1
  18. package/docs/api/grid-pro.gridpro.agpropertiesmap.md +1 -1
  19. package/docs/api/grid-pro.gridpro.applytemplatedefinitions.md +3 -2
  20. package/docs/api/grid-pro.gridpro.getsavedcolumnstate.md +21 -0
  21. package/docs/api/grid-pro.gridpro.gridprogenesisdatasource.md +11 -0
  22. package/docs/api/grid-pro.gridpro.md +5 -3
  23. package/docs/api/grid-pro.gridprogenesisdatasource.md +2 -0
  24. package/docs/api/grid-pro.gridprogenesisdatasource.refreshrows.md +17 -0
  25. package/docs/api/grid-pro.gridprogenesisdatasource.rowdatamapper.md +13 -0
  26. package/docs/api/grid-pro.md +2 -0
  27. package/docs/api/grid-pro.mergeanddedupcoldefwithcolumnstate.md +31 -0
  28. package/docs/api-report.md +15 -3
  29. package/package.json +7 -7
@@ -36,6 +36,7 @@ Only supports Client-Side Row Model.
36
36
  | [resourceName](./grid-pro.gridprogenesisdatasource.resourcename.md) | | string | |
37
37
  | [restartOnReconnection](./grid-pro.gridprogenesisdatasource.restartonreconnection.md) | | boolean | |
38
38
  | [reverse](./grid-pro.gridprogenesisdatasource.reverse.md) | | boolean | |
39
+ | [rowDataMapper](./grid-pro.gridprogenesisdatasource.rowdatamapper.md) | | Function | Allows grid data updates to be processed via and external function before applying in grid |
39
40
  | [rowIdAttr](./grid-pro.gridprogenesisdatasource.rowidattr.md) | | any | <p>Attribute to set an unique identifier for the row.</p><p>Defaults to <code>ROW_REF</code> or <code>RECORD_ID</code> depending on the resource type.</p> |
40
41
 
41
42
  ## Methods
@@ -48,6 +49,7 @@ Only supports Client-Side Row Model.
48
49
  | [deinit()](./grid-pro.gridprogenesisdatasource.deinit.md) | | Deinitialises the datasource, resetting it to its initial state. |
49
50
  | [disconnectedCallback()](./grid-pro.gridprogenesisdatasource.disconnectedcallback.md) | | |
50
51
  | [init()](./grid-pro.gridprogenesisdatasource.init.md) | | Initializes the datasource. |
52
+ | [refreshRows()](./grid-pro.gridprogenesisdatasource.refreshrows.md) | | Force the grid to redispatch the current rows |
51
53
  | [removeFilter(fieldName)](./grid-pro.gridprogenesisdatasource.removefilter.md) | | |
52
54
  | [reset()](./grid-pro.gridprogenesisdatasource.reset.md) | | Resets the datasource to its initial state. |
53
55
  | [resourceNameChanged(oldValue, newValue)](./grid-pro.gridprogenesisdatasource.resourcenamechanged.md) | | |
@@ -0,0 +1,17 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [refreshRows](./grid-pro.gridprogenesisdatasource.refreshrows.md)
4
+
5
+ ## GridProGenesisDatasource.refreshRows() method
6
+
7
+ Force the grid to redispatch the current rows
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ refreshRows(): void;
13
+ ```
14
+ **Returns:**
15
+
16
+ void
17
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [rowDataMapper](./grid-pro.gridprogenesisdatasource.rowdatamapper.md)
4
+
5
+ ## GridProGenesisDatasource.rowDataMapper property
6
+
7
+ Allows grid data updates to be processed via and external function before applying in grid
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ rowDataMapper: Function;
13
+ ```
@@ -34,6 +34,7 @@
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. |
37
38
 
38
39
  ## Variables
39
40
 
@@ -58,6 +59,7 @@
58
59
  | [agThemeTokenMapCSS](./grid-pro.agthemetokenmapcss.md) | Generates the CSS for a given GridPro theme name and token map |
59
60
  | [CellTemplate](./grid-pro.celltemplate.md) | The Grid Pro Cell Template. |
60
61
  | [ColumnTemplate](./grid-pro.columntemplate.md) | The Grid Pro Column Template. |
62
+ | [convertToKebabCase](./grid-pro.converttokebabcase.md) | Convert string values from 'camelCase' to 'kebab-case' |
61
63
  | [defaultAgGridFontFace](./grid-pro.defaultaggridfontface.md) | The default font face for Grid Pro (agGridAlpine). |
62
64
  | [defaultGridProConfig](./grid-pro.defaultgridproconfig.md) | Grid Pro default configuration. |
63
65
  | [foundationAgBooleanRenderer](./grid-pro.foundationagbooleanrenderer.md) | A function that returns a Foundation Boolean Renderer registration for configuring the component with a DesignSystem. |
@@ -0,0 +1,31 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [mergeAndDedupColDefWithColumnState](./grid-pro.mergeanddedupcoldefwithcolumnstate.md)
4
+
5
+ ## mergeAndDedupColDefWithColumnState() function
6
+
7
+ Merges two arrays, one of `ColDef` and one of `ColumnState`<!-- -->, and deduplicates them.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function mergeAndDedupColDefWithColumnState(colDefs: ColDef[], columnStates: ColumnState[], arr1Field?: string, arr2Field?: string): ColDef[];
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | colDefs | ColDef\[\] | |
20
+ | columnStates | ColumnState\[\] | |
21
+ | arr1Field | string | _(Optional)_ |
22
+ | arr2Field | string | _(Optional)_ |
23
+
24
+ **Returns:**
25
+
26
+ ColDef\[\]
27
+
28
+ ## Remarks
29
+
30
+ ColDef uses `field` and ColumnState uses `colId` to identify columns.
31
+
@@ -9,6 +9,7 @@ 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';
12
13
  import { Connect } from '@genesislcap/foundation-comms';
13
14
  import type { Container } from '@microsoft/fast-foundation';
14
15
  import { Controller } from '@microsoft/fast-element';
@@ -303,6 +304,9 @@ export const CellTemplate: ViewTemplate<GridProCell, any>;
303
304
  // @public
304
305
  export const ColumnTemplate: ViewTemplate<GridColumn, any>;
305
306
 
307
+ // @public
308
+ export const convertToKebabCase: (value: string) => string;
309
+
306
310
  // @public
307
311
  export function dateTimeValueFormatter({ value }: ValueFormatterParams): any;
308
312
 
@@ -528,15 +532,15 @@ export class GridPro extends GridPro_base {
528
532
  // (undocumented)
529
533
  agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
530
534
  // (undocumented)
531
- protected agAttributes: any;
535
+ protected agAttributes: Record<string, string>;
532
536
  // (undocumented)
533
537
  agGrid: Grid;
534
538
  // (undocumented)
535
539
  protected agGridOptions: GridOptions;
536
540
  // (undocumented)
537
- protected agPropertiesMap: any;
541
+ protected agPropertiesMap: Record<string, string>;
538
542
  // (undocumented)
539
- applyTemplateDefinitions(columnDefs?: ColDef[]): ColDef<any>[];
543
+ applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefs?: boolean): ColDef<any>[];
540
544
  // (undocumented)
541
545
  autoCellRendererByType: boolean;
542
546
  // (undocumented)
@@ -556,6 +560,7 @@ export class GridPro extends GridPro_base {
556
560
  enabledRowFlashing: boolean;
557
561
  // (undocumented)
558
562
  eventsAndCallbacks: any;
563
+ getSavedColumnState(): ColumnState[];
559
564
  // (undocumented)
560
565
  globalEventListener(eventType: any, event: any): void;
561
566
  // (undocumented)
@@ -571,6 +576,8 @@ export class GridPro extends GridPro_base {
571
576
  get gridOptions(): GridOptions;
572
577
  set gridOptions(options: GridOptions);
573
578
  // (undocumented)
579
+ get gridProGenesisDatasource(): GridProGenesisDatasource;
580
+ // (undocumented)
574
581
  gridSlot: HTMLSlotElement;
575
582
  // (undocumented)
576
583
  headerHeight: number;
@@ -653,6 +660,7 @@ export class GridProGenesisDatasource extends GridProGenesisDatasource_base {
653
660
  orderBy: string;
654
661
  // (undocumented)
655
662
  pollingInterval: number;
663
+ refreshRows(): void;
656
664
  // (undocumented)
657
665
  removeFilter(fieldName: string): void;
658
666
  // (undocumented)
@@ -668,6 +676,7 @@ export class GridProGenesisDatasource extends GridProGenesisDatasource_base {
668
676
  restartOnReconnection: boolean;
669
677
  // (undocumented)
670
678
  reverse: boolean;
679
+ rowDataMapper: Function;
671
680
  rowIdAttr: any;
672
681
  // (undocumented)
673
682
  setFilter(fieldName: string, newFilter: string): void;
@@ -739,6 +748,9 @@ export const gridProTemplate: ViewTemplate;
739
748
  // @public
740
749
  export const logger: Logger;
741
750
 
751
+ // @public
752
+ export function mergeAndDedupColDefWithColumnState(colDefs: ColDef[], columnStates: ColumnState[], arr1Field?: string, arr2Field?: string): ColDef[];
753
+
742
754
  // @public
743
755
  export class SelectRenderer extends FoundationElement implements ICellRendererComp {
744
756
  // (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.48.0",
4
+ "version": "14.49.1",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -21,14 +21,14 @@
21
21
  "serve": "genx serve"
22
22
  },
23
23
  "devDependencies": {
24
- "@genesislcap/foundation-testing": "^14.48.0",
25
- "@genesislcap/genx": "^14.48.0",
24
+ "@genesislcap/foundation-testing": "^14.49.1",
25
+ "@genesislcap/genx": "^14.49.1",
26
26
  "bulma": "^0.9.3"
27
27
  },
28
28
  "dependencies": {
29
- "@genesislcap/foundation-comms": "^14.48.0",
30
- "@genesislcap/foundation-ui": "^14.48.0",
31
- "@genesislcap/foundation-utils": "^14.48.0",
29
+ "@genesislcap/foundation-comms": "^14.49.1",
30
+ "@genesislcap/foundation-ui": "^14.49.1",
31
+ "@genesislcap/foundation-utils": "^14.49.1",
32
32
  "@microsoft/fast-colors": "^5.1.4",
33
33
  "@microsoft/fast-components": "^2.21.3",
34
34
  "@microsoft/fast-element": "^1.7.0",
@@ -51,5 +51,5 @@
51
51
  "access": "public"
52
52
  },
53
53
  "customElements": "dist/custom-elements.json",
54
- "gitHead": "6ca7b92f4966b3913bce518f695e4bdc8e77e73d"
54
+ "gitHead": "e101668934ff8e856aecc40ef160c48a77d34b79"
55
55
  }