@genesislcap/grid-pro 14.208.2 → 14.208.3
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 +10 -5
- package/dist/dts/grid-pro.d.ts +16 -20
- package/dist/dts/grid-pro.d.ts.map +1 -1
- package/dist/dts/grid-pro.types.d.ts +3 -0
- package/dist/dts/grid-pro.types.d.ts.map +1 -1
- package/dist/esm/grid-pro.js +18 -8
- package/dist/esm/grid-pro.types.js +3 -0
- package/dist/grid-pro.api.json +2 -2
- package/dist/grid-pro.d.ts +19 -20
- package/docs/api/grid-pro.grid_ready_event.md +5 -0
- package/docs/api/grid-pro.gridpro.addeventlistener.md +5 -3
- package/docs/api/grid-pro.gridpro.md +1 -1
- package/docs/api-report.md +1 -2
- package/package.json +13 -13
|
@@ -670,19 +670,23 @@
|
|
|
670
670
|
"name": "eventType",
|
|
671
671
|
"type": {
|
|
672
672
|
"text": "string"
|
|
673
|
-
}
|
|
673
|
+
},
|
|
674
|
+
"description": "The event type to listen for. Recommened to use the `Events` from AG Grid."
|
|
674
675
|
},
|
|
675
676
|
{
|
|
676
|
-
"name": "listener"
|
|
677
|
+
"name": "listener",
|
|
678
|
+
"description": "The event listener to call when the event is fired."
|
|
677
679
|
},
|
|
678
680
|
{
|
|
679
681
|
"name": "options",
|
|
680
682
|
"optional": true,
|
|
681
683
|
"type": {
|
|
682
684
|
"text": "boolean | AddEventListenerOptions"
|
|
683
|
-
}
|
|
685
|
+
},
|
|
686
|
+
"description": "An options object that specifies characteristics about the event listener."
|
|
684
687
|
}
|
|
685
|
-
]
|
|
688
|
+
],
|
|
689
|
+
"description": "Adds an event listener to the grid element."
|
|
686
690
|
},
|
|
687
691
|
{
|
|
688
692
|
"kind": "method",
|
|
@@ -1437,7 +1441,8 @@
|
|
|
1437
1441
|
},
|
|
1438
1442
|
"default": "'onGridReady'",
|
|
1439
1443
|
"description": "Event fired when grid is ready",
|
|
1440
|
-
"privacy": "public"
|
|
1444
|
+
"privacy": "public",
|
|
1445
|
+
"deprecated": "- Use `Events.EVENT_GRID_READY` from `@ag-grid-community/core` instead"
|
|
1441
1446
|
},
|
|
1442
1447
|
{
|
|
1443
1448
|
"kind": "variable",
|
package/dist/dts/grid-pro.d.ts
CHANGED
|
@@ -20,11 +20,6 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
20
20
|
"__#1@#_shouldForceLifecycle": boolean;
|
|
21
21
|
cloneNode(deep?: boolean): Node;
|
|
22
22
|
deepClone(): Node;
|
|
23
|
-
/**
|
|
24
|
-
* Boolean attribute to control whether the grid autosizes the columns upon interaction.
|
|
25
|
-
* This will disable the column widths from being manually set, and doesn't save the widths
|
|
26
|
-
* in local storage if you are using `persist-column-state-key`.
|
|
27
|
-
*/
|
|
28
23
|
readonly shouldRunDisconnect: boolean;
|
|
29
24
|
readonly shouldRunConnect: boolean;
|
|
30
25
|
"__#1@#_blockLifecycleDueToTokenChange"(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
|
|
@@ -38,6 +33,9 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
38
33
|
readonly accessKeyLabel: string;
|
|
39
34
|
autocapitalize: string;
|
|
40
35
|
dir: string;
|
|
36
|
+
/**
|
|
37
|
+
* If true, will enable row flashing for all rows for `add` async transactions
|
|
38
|
+
*/
|
|
41
39
|
draggable: boolean;
|
|
42
40
|
hidden: boolean;
|
|
43
41
|
inert: boolean;
|
|
@@ -201,6 +199,10 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
201
199
|
ariaReadOnly: string;
|
|
202
200
|
ariaRequired: string;
|
|
203
201
|
ariaRoleDescription: string;
|
|
202
|
+
/**
|
|
203
|
+
* If {@link @genesislcap/grid-pro#GridPro.gridAutosizingEnabled} is true, will remove the widths from the column states.
|
|
204
|
+
* @internal
|
|
205
|
+
*/
|
|
204
206
|
ariaRowCount: string;
|
|
205
207
|
ariaRowIndex: string;
|
|
206
208
|
ariaRowIndexText: string;
|
|
@@ -213,12 +215,7 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
213
215
|
ariaValueNow: string;
|
|
214
216
|
ariaValueText: string;
|
|
215
217
|
role: string;
|
|
216
|
-
animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
|
|
217
|
-
* Gets the saved grid ColumnState[] from storage
|
|
218
|
-
* @remarks This is used to restore the grid state when the grid is rehydrated
|
|
219
|
-
* @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering.
|
|
220
|
-
* @public
|
|
221
|
-
*/
|
|
218
|
+
animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
|
|
222
219
|
getAnimations(options?: GetAnimationsOptions): Animation[];
|
|
223
220
|
after(...nodes: (string | Node)[]): void;
|
|
224
221
|
before(...nodes: (string | Node)[]): void;
|
|
@@ -311,15 +308,6 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
311
308
|
onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
|
|
312
309
|
onratechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
313
310
|
onreset: (this: GlobalEventHandlers, ev: Event) => any;
|
|
314
|
-
/**
|
|
315
|
-
* Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`.
|
|
316
|
-
* @public
|
|
317
|
-
* @remarks This will favor the column state from the browser's local storage over the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element.
|
|
318
|
-
* @param columnDefs - The column definitions to apply to the grid.
|
|
319
|
-
* @param deferredColumnDefsOrState - If true, will merge the column definitions with the saved column state or the `deferredColumnStates` property
|
|
320
|
-
* on the `grid-pro-genesis-datasource` element. Defaults to false but `grid-pro-genesis-datasource` will set this to true.
|
|
321
|
-
* @returns The merged column definitions.
|
|
322
|
-
*/
|
|
323
311
|
onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
|
324
312
|
onscroll: (this: GlobalEventHandlers, ev: Event) => any;
|
|
325
313
|
onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
|
|
@@ -477,6 +465,14 @@ export declare class GridPro extends GridPro_base {
|
|
|
477
465
|
*/
|
|
478
466
|
gridOptionsConfig: GridOptionsConfig;
|
|
479
467
|
constructor();
|
|
468
|
+
/**
|
|
469
|
+
* Adds an event listener to the grid element.
|
|
470
|
+
* @param eventType - The event type to listen for. Recommened to use the `Events` from AG Grid.
|
|
471
|
+
* @param listener - The event listener to call when the event is fired.
|
|
472
|
+
* @param options - An options object that specifies characteristics about the event listener.
|
|
473
|
+
* @privateRemarks
|
|
474
|
+
* This will change once we do the AG Upgrade and `eventType` will be correctly typed.
|
|
475
|
+
*/
|
|
480
476
|
addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void;
|
|
481
477
|
private addGridEventListener;
|
|
482
478
|
private handleError;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"grid-pro.d.ts","sourceRoot":"","sources":["../../src/grid-pro.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,
|
|
1
|
+
{"version":3,"file":"grid-pro.d.ts","sourceRoot":"","sources":["../../src/grid-pro.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAyB,IAAI,EAAkB,MAAM,yBAAyB,CAAC;AACnG,OAAO,KAAK,EACV,MAAM,EACN,SAAS,EAET,OAAO,EACP,WAAW,EACX,UAAU,EAEX,MAAM,yBAAyB,CAAC;AAQjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAoB/D,OAAO,EAAE,2BAA2B,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAExF,OAAO,EACL,wBAAwB,EAEzB,MAAM,+BAA+B,CAAC;AAQvC,OAAO,EAML,iBAAiB,EAGlB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EAEf,gBAAgB,EAChB,iBAAiB,EAEjB,yBAAyB,EAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAcvD;;;;GAIG;AACH,eAAO,MAAM,aAAa,szRAA8D,CAAC;;;;;;;;;;;;;;;;;;;;;;IAoEvF;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA0PH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAjUL;;;;;GAKG;AACH,qBAAa,OAAQ,SAAQ,YAAiC;IAChD,SAAS,EAAG,SAAS,CAAC;IACtB,OAAO,EAAG,OAAO,CAAC;IAClB,cAAc,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAM;IAC/D,gBAAgB,EAAE,gBAAgB,CAAC;IAErD;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAwB;IAG2B,sBAAsB,UAClF;IACwD,mBAAmB,UAAS;IAI5F;;;;OAIG;IACsD,qBAAqB,UAAS;IAEvF;;OAEG;IAC+B,QAAQ,SAAK;IAE/C;;;OAGG;IACgD,QAAQ,UAAS;IAEpE;;;OAGG;IACmD,WAAW,UAAS;IAE1E;;;OAGG;IACmD,WAAW,UAAQ;IAEzE;;;OAGG;IAC2D,kBAAkB,UAAS;IAEzF;;OAEG;IAC2D,kBAAkB,UAAS;IAEzF;;OAEG;IAC0D,iBAAiB,UAAS;IAEvF;;OAEG;IAC8C,qBAAqB,EAAE,MAAM,CAAC;IAE/E;;OAEG;IAC8C,qBAAqB,EAAE,MAAM,CAAC;IAE/E;;;;OAIG;IACsC,cAAc,EAAE,eAAe,CAAC;IAEzE;;;;OAIG;IACS,OAAO,EAAE,GAAG,EAAE,CAAC;IAC3B,cAAc,CAAC,CAAC,KAAA,EAAE,OAAO,KAAA;IAMb,YAAY,SAAyB;IAC3C,mBAAmB,SAAqB;IAClC,kBAAkB,EAAE,yBAAyB,CAAC;IACpD,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAsB;IACzC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAYnC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,IAAI,CAAC;IACb,QAAQ,EAAE,eAAe,CAAC;IAC1B,cAAc,EAAE;QAAE,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAE7D,OAAO,CAAC,WAAW,CAAgB;IACnC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/C,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClD,SAAS,CAAC,aAAa,EAAE,WAAW,CAAC;IACrC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC;IAE/B,OAAO,CAAC,oBAAoB,CAAS;IAErC,OAAO,CAAC,mBAAmB,CAA8B;IACzD,OAAO,CAAC,eAAe,CAAgB;IAEvC,OAAO,CAAC,aAAa,CAAiD;IAEhE,cAAc,IAAI,OAAO,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IASjD,cAAc,CAAC,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IASlE;;;;;;;;;;;;;OAaG;IACgB,iBAAiB,EAAE,iBAAiB,CAAC;;IAwBxD;;;;;;;OAOG;IACH,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,KAAA,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB;IAYzF,OAAO,CAAC,oBAAoB;IAM5B,OAAO,CAAC,WAAW;IAInB,mBAAmB;IAMnB,iBAAiB,IAAI,IAAI;IA8BzB,oBAAoB,IAAI,IAAI;IAiB5B,wBAAwB,CAAC,qBAAqB,EAAE,cAAc,GAAG,cAAc;IAoB/E,uBAAuB,IAAI,OAAO;IAOlC;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAW/B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;YAItB,eAAe;IAc7B;;;;;OAKG;IACG,mBAAmB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YAUrC,kBAAkB;IAYhC,OAAO,CAAC,iBAAiB;IAInB,yBAAyB,IAAI,OAAO,CAAC,IAAI,CAAC;IAShD;;OAEG;IACH,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,UAAU,CAI3B;IAED;;;;OAIG;IACH,IAAI,iBAAiB,IACjB,wBAAwB,GACxB,2BAA2B,GAC3B,2BAA2B,CAM9B;IAED,IAAI,WAAW,CAAC,OAAO,EAAE,WAAW,EAiGnC;IAED,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,QAAQ;IAehB;;;;;;OAMG;IACH,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,yBAAyB,UAAQ;IAKhF;;;;;;;;OAQG;IACG,2BAA2B,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,yBAAyB,UAAQ;IAuFzF,IAAI,kBAAkB,aAWrB;IAED,0BAA0B,CAAC,OAAO,KAAA,EAAE,QAAQ,KAAA,EAAE,QAAQ,KAAA;IAqBtD,mBAAmB,CAAC,SAAS,KAAA,EAAE,KAAK,KAAA;IAiBpC,OAAO,CAAC,eAAe,CAAa;IAEpC,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,eAAe;CAMxB;AAED;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B,EAAE,cAA0B,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,oBAAoB;;CAEhC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;kBAM5B,CAAC"}
|
|
@@ -139,6 +139,9 @@ export declare enum GridProRendererTypes {
|
|
|
139
139
|
/**
|
|
140
140
|
* Event fired when grid is ready
|
|
141
141
|
* @public
|
|
142
|
+
* @deprecated - Use `Events.EVENT_GRID_READY` from `@ag-grid-community/core` instead
|
|
143
|
+
* @privateRemarks
|
|
144
|
+
* This will be removed when we do the AG Upgrade.
|
|
142
145
|
*/
|
|
143
146
|
export declare const GRID_READY_EVENT = "onGridReady";
|
|
144
147
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"grid-pro.types.d.ts","sourceRoot":"","sources":["../../src/grid-pro.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAsB,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAGhF,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,iEAAiE,CAAC;AAC1H,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D;;;GAGG;AACH,oBAAY,aAAa;IACvB,eAAe,0BAA0B;IACzC,SAAS,oBAAoB;IAC7B,wBAAwB,oCAAoC;IAC5D,qBAAqB,iCAAiC;IACtD,uBAAuB,mCAAmC;IAC1D,eAAe,0BAA0B;IACzC,qBAAqB,iCAAiC;IACtD,wBAAwB,oCAAoC;IAC5D,+BAA+B,4CAA4C;IAC3E,2BAA2B,wCAAwC;IACnE,0BAA0B,uCAAuC;IACjE,qBAAqB,kCAAkC;IACvD,aAAa,yBAAyB;IACtC,yBAAyB,sCAAsC;IAC/D,6BAA6B,0CAA0C;IACvE,yBAAyB,sCAAsC;IAC/D,0CAA0C,yDAAyD;IACnG,kCAAkC,gDAAgD;IAClF,8BAA8B,4CAA4C;IAC1E,+BAA+B,6CAA6C;IAC5E,mBAAmB,+BAA+B;IAClD,WAAW,sBAAsB;IACjC,oBAAoB,gCAAgC;IACpD,cAAc,0BAA0B;IACxC,0BAA0B,uCAAuC;IACjE,6BAA6B,2CAA2C;IACxE,gBAAgB,4BAA4B;IAC5C,wBAAwB,qCAAqC;IAC7D,4BAA4B,yCAAyC;IACrE,uBAAuB,mCAAmC;IAC1D,oBAAoB,gCAAgC;IACpD,sBAAsB,kCAAkC;IACxD,0BAA0B,sCAAsC;IAChE,0BAA0B,wCAAwC;IAClE,8BAA8B,4CAA4C;IAC1E,yBAAyB,uCAAuC;IAChE,6BAA6B,2CAA2C;IACxE,iCAAiC,+CAA+C;IAChF,6BAA6B,2CAA2C;IACxE,2BAA2B,wCAAwC;IACnE,0BAA0B,uCAAuC;IACjE,2BAA2B,wCAAwC;IACnE,mBAAmB,gCAAgC;IACnD,qBAAqB,kCAAkC;CACxD;AAED;;;GAGG;AACH,oBAAY,WAAW;IACrB,MAAM,oBAAoB;IAC1B,UAAU,yBAAyB;IACnC,MAAM,oBAAoB;IAC1B,UAAU,yBAAyB;IACnC,QAAQ,sBAAsB;CAC/B;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,cAAe,MAAM,WAA6B,CAAC;AAExF;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,cAAe,MAAM,WAAyB,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,kBAAkB,cAAe,MAAM,YAAY,eAAe,GAAG,CAAC,oDAIlF,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAE9D;;;GAGG;AACH,oBAAY,oBAAoB;IAC9B,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,YAAY,iBAAiB;IAC7B,YAAY,iBAAiB;IAC7B,YAAY,iBAAiB;IAC7B,iBAAiB,sBAAsB;CACxC;AAED
|
|
1
|
+
{"version":3,"file":"grid-pro.types.d.ts","sourceRoot":"","sources":["../../src/grid-pro.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAsB,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAGhF,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,iEAAiE,CAAC;AAC1H,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D;;;GAGG;AACH,oBAAY,aAAa;IACvB,eAAe,0BAA0B;IACzC,SAAS,oBAAoB;IAC7B,wBAAwB,oCAAoC;IAC5D,qBAAqB,iCAAiC;IACtD,uBAAuB,mCAAmC;IAC1D,eAAe,0BAA0B;IACzC,qBAAqB,iCAAiC;IACtD,wBAAwB,oCAAoC;IAC5D,+BAA+B,4CAA4C;IAC3E,2BAA2B,wCAAwC;IACnE,0BAA0B,uCAAuC;IACjE,qBAAqB,kCAAkC;IACvD,aAAa,yBAAyB;IACtC,yBAAyB,sCAAsC;IAC/D,6BAA6B,0CAA0C;IACvE,yBAAyB,sCAAsC;IAC/D,0CAA0C,yDAAyD;IACnG,kCAAkC,gDAAgD;IAClF,8BAA8B,4CAA4C;IAC1E,+BAA+B,6CAA6C;IAC5E,mBAAmB,+BAA+B;IAClD,WAAW,sBAAsB;IACjC,oBAAoB,gCAAgC;IACpD,cAAc,0BAA0B;IACxC,0BAA0B,uCAAuC;IACjE,6BAA6B,2CAA2C;IACxE,gBAAgB,4BAA4B;IAC5C,wBAAwB,qCAAqC;IAC7D,4BAA4B,yCAAyC;IACrE,uBAAuB,mCAAmC;IAC1D,oBAAoB,gCAAgC;IACpD,sBAAsB,kCAAkC;IACxD,0BAA0B,sCAAsC;IAChE,0BAA0B,wCAAwC;IAClE,8BAA8B,4CAA4C;IAC1E,yBAAyB,uCAAuC;IAChE,6BAA6B,2CAA2C;IACxE,iCAAiC,+CAA+C;IAChF,6BAA6B,2CAA2C;IACxE,2BAA2B,wCAAwC;IACnE,0BAA0B,uCAAuC;IACjE,2BAA2B,wCAAwC;IACnE,mBAAmB,gCAAgC;IACnD,qBAAqB,kCAAkC;CACxD;AAED;;;GAGG;AACH,oBAAY,WAAW;IACrB,MAAM,oBAAoB;IAC1B,UAAU,yBAAyB;IACnC,MAAM,oBAAoB;IAC1B,UAAU,yBAAyB;IACnC,QAAQ,sBAAsB;CAC/B;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,cAAe,MAAM,WAA6B,CAAC;AAExF;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,cAAe,MAAM,WAAyB,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,kBAAkB,cAAe,MAAM,YAAY,eAAe,GAAG,CAAC,oDAIlF,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAE9D;;;GAGG;AACH,oBAAY,oBAAoB;IAC9B,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,UAAU,eAAe;IACzB,YAAY,iBAAiB;IAC7B,YAAY,iBAAiB;IAC7B,YAAY,iBAAiB;IAC7B,iBAAiB,sBAAsB;CACxC;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,gBAAgB,CAAC;AAE9C;;;GAGG;AACH,eAAO,MAAM,mBAAmB,mBAAmB,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;CAAG;AAEzD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,iBAAsB,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,yEAE7B,CAAC;AAEF;;;GAGG;AACH,oBAAY,eAAe;IACzB,SAAS,cAAc;IACvB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;IAC7B,SAAS,cAAc;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;CAAE,EAAE,CAAC;AAEvF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,iBAAiB,CAAC;AAE/D;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAAC,0BAA0B;IAC1D,MAAM,EAAE,0BAA0B,CAAC;IACnC,IAAI,EAAE,iBAAiB,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GACzB,kCAAkC,GAClC,WAAW,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;AAEvC;;;GAGG;AACH,KAAK,kBAAkB,CAAC,CAAC,IAAI;KAC1B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CACpE,CAAC;AAEF;;;GAGG;AACH,KAAK,aAAa,CAAC,CAAC,IAAI;KACrB,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACvD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC"}
|
package/dist/esm/grid-pro.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { __awaiter, __decorate, __rest } from "tslib";
|
|
2
2
|
import { ClientSideRowModelModule } from '@ag-grid-community/client-side-row-model';
|
|
3
|
-
import { ComponentUtil, Grid, ModuleRegistry } from '@ag-grid-community/core';
|
|
3
|
+
import { ComponentUtil, Events, Grid, ModuleRegistry } from '@ag-grid-community/core';
|
|
4
4
|
import { CsvExportModule } from '@ag-grid-community/csv-export';
|
|
5
5
|
import { insertDocumentCSSRule, LifecycleMixin, respondToVisibility, } from '@genesislcap/foundation-utils';
|
|
6
6
|
import { attr, DOM, observable } from '@microsoft/fast-element';
|
|
@@ -138,17 +138,22 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
|
|
|
138
138
|
action: this.handleError.bind(this, gridProErrorNames.datasource),
|
|
139
139
|
});
|
|
140
140
|
}
|
|
141
|
+
/**
|
|
142
|
+
* Adds an event listener to the grid element.
|
|
143
|
+
* @param eventType - The event type to listen for. Recommened to use the `Events` from AG Grid.
|
|
144
|
+
* @param listener - The event listener to call when the event is fired.
|
|
145
|
+
* @param options - An options object that specifies characteristics about the event listener.
|
|
146
|
+
* @privateRemarks
|
|
147
|
+
* This will change once we do the AG Upgrade and `eventType` will be correctly typed.
|
|
148
|
+
*/
|
|
141
149
|
addEventListener(eventType, listener, options) {
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
: `on${eventType.charAt(0).toUpperCase() + eventType.slice(1)}`;
|
|
145
|
-
super.addEventListener(type, listener, options);
|
|
146
|
-
if (ComponentUtil.PUBLIC_EVENTS.includes(type)) {
|
|
150
|
+
super.addEventListener(eventType, listener, options);
|
|
151
|
+
if (ComponentUtil.PUBLIC_EVENTS.includes(eventType)) {
|
|
147
152
|
if (this.gridApi) {
|
|
148
|
-
this.addGridEventListener(
|
|
153
|
+
this.addGridEventListener(eventType);
|
|
149
154
|
}
|
|
150
155
|
else {
|
|
151
|
-
this.gridEventsQueue.push(
|
|
156
|
+
this.gridEventsQueue.push(eventType);
|
|
152
157
|
}
|
|
153
158
|
}
|
|
154
159
|
}
|
|
@@ -355,6 +360,11 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
|
|
|
355
360
|
if (onGridReady) {
|
|
356
361
|
onGridReady(event);
|
|
357
362
|
}
|
|
363
|
+
this.$emit(Events.EVENT_GRID_READY, {
|
|
364
|
+
event,
|
|
365
|
+
gridId: this.id,
|
|
366
|
+
});
|
|
367
|
+
// TODO: Remove this event when we do the AG Upgrade
|
|
358
368
|
this.$emit(GRID_READY_EVENT, {
|
|
359
369
|
event,
|
|
360
370
|
gridId: this.id,
|
|
@@ -138,6 +138,9 @@ export var GridProRendererTypes;
|
|
|
138
138
|
/**
|
|
139
139
|
* Event fired when grid is ready
|
|
140
140
|
* @public
|
|
141
|
+
* @deprecated - Use `Events.EVENT_GRID_READY` from `@ag-grid-community/core` instead
|
|
142
|
+
* @privateRemarks
|
|
143
|
+
* This will be removed when we do the AG Upgrade.
|
|
141
144
|
*/
|
|
142
145
|
export const GRID_READY_EVENT = 'onGridReady';
|
|
143
146
|
/**
|
package/dist/grid-pro.api.json
CHANGED
|
@@ -7499,7 +7499,7 @@
|
|
|
7499
7499
|
{
|
|
7500
7500
|
"kind": "Variable",
|
|
7501
7501
|
"canonicalReference": "@genesislcap/grid-pro!GRID_READY_EVENT:var",
|
|
7502
|
-
"docComment": "/**\n * Event fired when grid is ready\n *\n * @public\n */\n",
|
|
7502
|
+
"docComment": "/**\n * Event fired when grid is ready\n *\n * @deprecated\n *\n * - Use `Events.EVENT_GRID_READY` from `@ag-grid-community/core` instead\n *\n * @public\n */\n",
|
|
7503
7503
|
"excerptTokens": [
|
|
7504
7504
|
{
|
|
7505
7505
|
"kind": "Content",
|
|
@@ -7623,7 +7623,7 @@
|
|
|
7623
7623
|
{
|
|
7624
7624
|
"kind": "Method",
|
|
7625
7625
|
"canonicalReference": "@genesislcap/grid-pro!GridPro#addEventListener:member(1)",
|
|
7626
|
-
"docComment": "",
|
|
7626
|
+
"docComment": "/**\n * Adds an event listener to the grid element.\n *\n * @param eventType - The event type to listen for. Recommened to use the `Events` from AG Grid.\n *\n * @param listener - The event listener to call when the event is fired.\n *\n * @param options - An options object that specifies characteristics about the event listener.\n */\n",
|
|
7627
7627
|
"excerptTokens": [
|
|
7628
7628
|
{
|
|
7629
7629
|
"kind": "Content",
|
package/dist/grid-pro.d.ts
CHANGED
|
@@ -1504,6 +1504,9 @@ export declare const getTextRendererTemplate: (designSystem?: string) => ViewTem
|
|
|
1504
1504
|
/**
|
|
1505
1505
|
* Event fired when grid is ready
|
|
1506
1506
|
* @public
|
|
1507
|
+
* @deprecated - Use `Events.EVENT_GRID_READY` from `@ag-grid-community/core` instead
|
|
1508
|
+
* @privateRemarks
|
|
1509
|
+
* This will be removed when we do the AG Upgrade.
|
|
1507
1510
|
*/
|
|
1508
1511
|
export declare const GRID_READY_EVENT = "onGridReady";
|
|
1509
1512
|
|
|
@@ -1649,6 +1652,14 @@ export declare class GridPro extends GridPro_base {
|
|
|
1649
1652
|
*/
|
|
1650
1653
|
gridOptionsConfig: GridOptionsConfig;
|
|
1651
1654
|
constructor();
|
|
1655
|
+
/**
|
|
1656
|
+
* Adds an event listener to the grid element.
|
|
1657
|
+
* @param eventType - The event type to listen for. Recommened to use the `Events` from AG Grid.
|
|
1658
|
+
* @param listener - The event listener to call when the event is fired.
|
|
1659
|
+
* @param options - An options object that specifies characteristics about the event listener.
|
|
1660
|
+
* @privateRemarks
|
|
1661
|
+
* This will change once we do the AG Upgrade and `eventType` will be correctly typed.
|
|
1662
|
+
*/
|
|
1652
1663
|
addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void;
|
|
1653
1664
|
private addGridEventListener;
|
|
1654
1665
|
private handleError;
|
|
@@ -1730,11 +1741,6 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1730
1741
|
"__#1@#_shouldForceLifecycle": boolean;
|
|
1731
1742
|
cloneNode(deep?: boolean): Node;
|
|
1732
1743
|
deepClone(): Node;
|
|
1733
|
-
/**
|
|
1734
|
-
* Boolean attribute to control whether the grid autosizes the columns upon interaction.
|
|
1735
|
-
* This will disable the column widths from being manually set, and doesn't save the widths
|
|
1736
|
-
* in local storage if you are using `persist-column-state-key`.
|
|
1737
|
-
*/
|
|
1738
1744
|
readonly shouldRunDisconnect: boolean;
|
|
1739
1745
|
readonly shouldRunConnect: boolean;
|
|
1740
1746
|
"__#1@#_blockLifecycleDueToTokenChange"(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
|
|
@@ -1748,6 +1754,9 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1748
1754
|
readonly accessKeyLabel: string;
|
|
1749
1755
|
autocapitalize: string;
|
|
1750
1756
|
dir: string;
|
|
1757
|
+
/**
|
|
1758
|
+
* If true, will enable row flashing for all rows for `add` async transactions
|
|
1759
|
+
*/
|
|
1751
1760
|
draggable: boolean;
|
|
1752
1761
|
hidden: boolean;
|
|
1753
1762
|
inert: boolean;
|
|
@@ -1911,6 +1920,10 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1911
1920
|
ariaReadOnly: string;
|
|
1912
1921
|
ariaRequired: string;
|
|
1913
1922
|
ariaRoleDescription: string;
|
|
1923
|
+
/**
|
|
1924
|
+
* If {@link @genesislcap/grid-pro#GridPro.gridAutosizingEnabled} is true, will remove the widths from the column states.
|
|
1925
|
+
* @internal
|
|
1926
|
+
*/
|
|
1914
1927
|
ariaRowCount: string;
|
|
1915
1928
|
ariaRowIndex: string;
|
|
1916
1929
|
ariaRowIndexText: string;
|
|
@@ -1923,12 +1936,7 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1923
1936
|
ariaValueNow: string;
|
|
1924
1937
|
ariaValueText: string;
|
|
1925
1938
|
role: string;
|
|
1926
|
-
animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
|
|
1927
|
-
* Gets the saved grid ColumnState[] from storage
|
|
1928
|
-
* @remarks This is used to restore the grid state when the grid is rehydrated
|
|
1929
|
-
* @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering.
|
|
1930
|
-
* @public
|
|
1931
|
-
*/
|
|
1939
|
+
animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
|
|
1932
1940
|
getAnimations(options?: GetAnimationsOptions): Animation[];
|
|
1933
1941
|
after(...nodes: (string | Node)[]): void;
|
|
1934
1942
|
before(...nodes: (string | Node)[]): void;
|
|
@@ -2021,15 +2029,6 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
2021
2029
|
onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
|
|
2022
2030
|
onratechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
2023
2031
|
onreset: (this: GlobalEventHandlers, ev: Event) => any;
|
|
2024
|
-
/**
|
|
2025
|
-
* Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`.
|
|
2026
|
-
* @public
|
|
2027
|
-
* @remarks This will favor the column state from the browser's local storage over the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element.
|
|
2028
|
-
* @param columnDefs - The column definitions to apply to the grid.
|
|
2029
|
-
* @param deferredColumnDefsOrState - If true, will merge the column definitions with the saved column state or the `deferredColumnStates` property
|
|
2030
|
-
* on the `grid-pro-genesis-datasource` element. Defaults to false but `grid-pro-genesis-datasource` will set this to true.
|
|
2031
|
-
* @returns The merged column definitions.
|
|
2032
|
-
*/
|
|
2033
2032
|
onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
|
2034
2033
|
onscroll: (this: GlobalEventHandlers, ev: Event) => any;
|
|
2035
2034
|
onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
|
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
## GridPro.addEventListener() method
|
|
6
6
|
|
|
7
|
+
Adds an event listener to the grid element.
|
|
8
|
+
|
|
7
9
|
**Signature:**
|
|
8
10
|
|
|
9
11
|
```typescript
|
|
@@ -14,9 +16,9 @@ addEventListener(eventType: string, listener: any, options?: boolean | AddEventL
|
|
|
14
16
|
|
|
15
17
|
| Parameter | Type | Description |
|
|
16
18
|
| --- | --- | --- |
|
|
17
|
-
| eventType | string |
|
|
18
|
-
| listener | any |
|
|
19
|
-
| options | boolean \| AddEventListenerOptions | _(Optional)_ |
|
|
19
|
+
| eventType | string | The event type to listen for. Recommened to use the <code>Events</code> from AG Grid. |
|
|
20
|
+
| listener | any | The event listener to call when the event is fired. |
|
|
21
|
+
| options | boolean \| AddEventListenerOptions | _(Optional)_ An options object that specifies characteristics about the event listener. |
|
|
20
22
|
|
|
21
23
|
**Returns:**
|
|
22
24
|
|
|
@@ -69,7 +69,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
|
|
|
69
69
|
|
|
70
70
|
| Method | Modifiers | Description |
|
|
71
71
|
| --- | --- | --- |
|
|
72
|
-
| [addEventListener(eventType, listener, options)](./grid-pro.gridpro.addeventlistener.md) | |
|
|
72
|
+
| [addEventListener(eventType, listener, options)](./grid-pro.gridpro.addeventlistener.md) | | Adds an event listener to the grid element. |
|
|
73
73
|
| [agAttributeChangedCallback(attName, oldValue, newValue)](./grid-pro.gridpro.agattributechangedcallback.md) | | |
|
|
74
74
|
| [applyTemplateDefinitions(columnDefs, deferredColumnDefsOrState)](./grid-pro.gridpro.applytemplatedefinitions.md) | | Will merge templated column definitions with <code>columnDefs</code> plus localStorage's column state or <code>deferredColumnStates</code>. |
|
|
75
75
|
| [combineAllGridComponents(gridOptionsComponents)](./grid-pro.gridpro.combineallgridcomponents.md) | | |
|
package/docs/api-report.md
CHANGED
|
@@ -781,7 +781,7 @@ export const getTextFieldRendererTemplate: (designSystem?: string) => ViewTempla
|
|
|
781
781
|
// @public @deprecated (undocumented)
|
|
782
782
|
export const getTextRendererTemplate: (designSystem?: string) => ViewTemplate<AgTextFieldRenderer, any>;
|
|
783
783
|
|
|
784
|
-
// @public
|
|
784
|
+
// @public @deprecated
|
|
785
785
|
export const GRID_READY_EVENT = "onGridReady";
|
|
786
786
|
|
|
787
787
|
// @public
|
|
@@ -803,7 +803,6 @@ export const GridOptionsConfig: InterfaceSymbol<GridOptionsConfig>;
|
|
|
803
803
|
// @public
|
|
804
804
|
export class GridPro extends GridPro_base {
|
|
805
805
|
constructor();
|
|
806
|
-
// (undocumented)
|
|
807
806
|
addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void;
|
|
808
807
|
addIndex: number;
|
|
809
808
|
// (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.208.
|
|
4
|
+
"version": "14.208.3",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -38,20 +38,20 @@
|
|
|
38
38
|
}
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
|
-
"@genesislcap/foundation-testing": "14.208.
|
|
42
|
-
"@genesislcap/genx": "14.208.
|
|
43
|
-
"@genesislcap/rollup-builder": "14.208.
|
|
44
|
-
"@genesislcap/ts-builder": "14.208.
|
|
45
|
-
"@genesislcap/uvu-playwright-builder": "14.208.
|
|
46
|
-
"@genesislcap/vite-builder": "14.208.
|
|
47
|
-
"@genesislcap/webpack-builder": "14.208.
|
|
41
|
+
"@genesislcap/foundation-testing": "14.208.3",
|
|
42
|
+
"@genesislcap/genx": "14.208.3",
|
|
43
|
+
"@genesislcap/rollup-builder": "14.208.3",
|
|
44
|
+
"@genesislcap/ts-builder": "14.208.3",
|
|
45
|
+
"@genesislcap/uvu-playwright-builder": "14.208.3",
|
|
46
|
+
"@genesislcap/vite-builder": "14.208.3",
|
|
47
|
+
"@genesislcap/webpack-builder": "14.208.3",
|
|
48
48
|
"rimraf": "^5.0.0"
|
|
49
49
|
},
|
|
50
50
|
"dependencies": {
|
|
51
|
-
"@genesislcap/foundation-comms": "14.208.
|
|
52
|
-
"@genesislcap/foundation-logger": "14.208.
|
|
53
|
-
"@genesislcap/foundation-ui": "14.208.
|
|
54
|
-
"@genesislcap/foundation-utils": "14.208.
|
|
51
|
+
"@genesislcap/foundation-comms": "14.208.3",
|
|
52
|
+
"@genesislcap/foundation-logger": "14.208.3",
|
|
53
|
+
"@genesislcap/foundation-ui": "14.208.3",
|
|
54
|
+
"@genesislcap/foundation-utils": "14.208.3",
|
|
55
55
|
"@microsoft/fast-colors": "^5.3.1",
|
|
56
56
|
"@microsoft/fast-components": "^2.30.6",
|
|
57
57
|
"@microsoft/fast-element": "^1.12.0",
|
|
@@ -77,5 +77,5 @@
|
|
|
77
77
|
"access": "public"
|
|
78
78
|
},
|
|
79
79
|
"customElements": "dist/custom-elements.json",
|
|
80
|
-
"gitHead": "
|
|
80
|
+
"gitHead": "9a3b2919d34357d89791809bcf7ac11e4f23b75b"
|
|
81
81
|
}
|