@genesislcap/grid-pro 14.167.3-alpha-69ba23f.0 → 14.169.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.
Files changed (47) hide show
  1. package/dist/custom-elements.json +126 -3
  2. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.config.d.ts +9 -0
  3. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.config.d.ts.map +1 -0
  4. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +17 -1
  5. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
  6. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.d.ts +25 -0
  7. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.d.ts.map +1 -0
  8. package/dist/dts/grid-pro-genesis-datasource/index.d.ts +2 -0
  9. package/dist/dts/grid-pro-genesis-datasource/index.d.ts.map +1 -1
  10. package/dist/dts/grid-pro.d.ts +13 -15
  11. package/dist/dts/grid-pro.d.ts.map +1 -1
  12. package/dist/dts/grid-pro.definitions.d.ts +15 -0
  13. package/dist/dts/grid-pro.definitions.d.ts.map +1 -1
  14. package/dist/dts/grid-pro.styles.d.ts.map +1 -1
  15. package/dist/dts/grid-pro.template.d.ts +11 -1
  16. package/dist/dts/grid-pro.template.d.ts.map +1 -1
  17. package/dist/dts/grid-pro.types.d.ts +28 -0
  18. package/dist/dts/grid-pro.types.d.ts.map +1 -1
  19. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.config.js +8 -0
  20. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +15 -2
  21. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.types.js +1 -0
  22. package/dist/esm/grid-pro-genesis-datasource/index.js +2 -0
  23. package/dist/esm/grid-pro.definitions.js +15 -0
  24. package/dist/esm/grid-pro.js +24 -2
  25. package/dist/esm/grid-pro.styles.js +35 -5
  26. package/dist/esm/grid-pro.template.js +41 -2
  27. package/dist/grid-pro.api.json +453 -1
  28. package/dist/grid-pro.d.ts +124 -16
  29. package/docs/api/grid-pro.getgridprotemplate.md +13 -0
  30. package/docs/api/grid-pro.gridpro.griderroritems.md +11 -0
  31. package/docs/api/grid-pro.gridpro.md +1 -0
  32. package/docs/api/grid-pro.gridproerrorevent.md +15 -0
  33. package/docs/api/grid-pro.gridproerroritem.detail.md +11 -0
  34. package/docs/api/grid-pro.gridproerroritem.md +21 -0
  35. package/docs/api/grid-pro.gridproerroritem.type.md +11 -0
  36. package/docs/api/grid-pro.gridproerrornames.md +16 -0
  37. package/docs/api/grid-pro.gridproerrortypes.md +15 -0
  38. package/docs/api/grid-pro.gridproeventnames.md +15 -0
  39. package/docs/api/grid-pro.gridprogenesisdatasourceerrorevent.md +15 -0
  40. package/docs/api/grid-pro.gridprogenesisdatasourceerroreventdetail.md +15 -0
  41. package/docs/api/grid-pro.gridprogenesisdatasourceeventnames.md +16 -0
  42. package/docs/api/grid-pro.gridprogenesisrowdatasetevent.md +15 -0
  43. package/docs/api/grid-pro.gridprogenesisrowdataseteventdetail.md +15 -0
  44. package/docs/api/grid-pro.gridprotemplate.md +5 -2
  45. package/docs/api/grid-pro.md +12 -1
  46. package/docs/api-report.md +61 -1
  47. package/package.json +13 -13
@@ -1070,6 +1070,14 @@ export declare const getDateEditorTemplate: (prefix?: string) => ViewTemplate<Da
1070
1070
  */
1071
1071
  export declare function getFilterByFieldType(type: string): string;
1072
1072
 
1073
+ /**
1074
+ * Get a Design System prefixed The Grid Pro template.
1075
+ * @param prefix - The design system prefix to use. Defaults to 'foundation'.
1076
+ * @returns A grid Pro template prefixed with the correct design system.
1077
+ * @public
1078
+ */
1079
+ export declare const getGridProTemplate: (prefix?: string) => ViewTemplate<GridPro, any>;
1080
+
1073
1081
  /**
1074
1082
  * Get a Design System prefixed Select template.
1075
1083
  * @param designSystem - The design system prefix to use. Defaults to 'foundation'.
@@ -1160,6 +1168,7 @@ export declare const GridOptionsConfig: InterfaceSymbol<GridOptionsConfig>;
1160
1168
  export declare class GridPro extends GridPro_base {
1161
1169
  columnApi: ColumnApi;
1162
1170
  gridApi: GridApi;
1171
+ gridErrorItems: GridProErrorItem<GridProErrorEvent['detail']>[];
1163
1172
  statePersistence: StatePersistence;
1164
1173
  /**
1165
1174
  * Timeout function used to debounce resize calls
@@ -1239,6 +1248,7 @@ export declare class GridPro extends GridPro_base {
1239
1248
  protected agGridOptions: GridOptions;
1240
1249
  protected initialised: boolean;
1241
1250
  private rehydrationAttempted;
1251
+ private rootEventsListeners;
1242
1252
  private gridEventsQueue;
1243
1253
  private _filterConfig;
1244
1254
  getfilterModel(): Promise<{
@@ -1265,6 +1275,8 @@ export declare class GridPro extends GridPro_base {
1265
1275
  constructor();
1266
1276
  addEventListener(type: any, listener: any, options?: boolean | AddEventListenerOptions): void;
1267
1277
  private addGridEventListener;
1278
+ private handleError;
1279
+ private hideDatasourceError;
1268
1280
  connectedCallback(): void;
1269
1281
  disconnectedCallback(): void;
1270
1282
  combineAllGridComponents(gridOptionsComponents: GridComponents): GridComponents;
@@ -1336,6 +1348,9 @@ declare const GridPro_base: (new (...args: any[]) => {
1336
1348
  readonly shouldRunConnect: boolean;
1337
1349
  "__#1@#_blockLifecycleDueToTokenChange"(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
1338
1350
  "__#1@#_tryFindContainingLayout"(e: Element): FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
1351
+ /**
1352
+ * @deprecated - use `enableRowFlashing` instead.
1353
+ */
1339
1354
  connectedCallback(): void;
1340
1355
  readonly $fastController: Controller;
1341
1356
  $emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
@@ -1384,20 +1399,7 @@ declare const GridPro_base: (new (...args: any[]) => {
1384
1399
  readonly scrollHeight: number;
1385
1400
  scrollLeft: number;
1386
1401
  scrollTop: number;
1387
- readonly scrollWidth: number; /**
1388
- * Injectable config that allows to change grid options on an app level basis
1389
- * To modify options, register instance of the config in DOM container that is
1390
- * above the grid or on the top level of the application, so it applies to all grids.
1391
- *
1392
- * @example
1393
- * ```
1394
- * DI.getOrCreateDOMContainer().register([
1395
- * Registration.instance<GridOptionsConfig>(GridOptionsConfig, {
1396
- * headerHeight: 50,
1397
- * }),
1398
- * ]);
1399
- * ```
1400
- */
1402
+ readonly scrollWidth: number;
1401
1403
  readonly shadowRoot: ShadowRoot;
1402
1404
  slot: string;
1403
1405
  readonly tagName: string;
@@ -1487,6 +1489,10 @@ declare const GridPro_base: (new (...args: any[]) => {
1487
1489
  readonly DOCUMENT_POSITION_PRECEDING: number;
1488
1490
  readonly DOCUMENT_TYPE_NODE: number;
1489
1491
  readonly ELEMENT_NODE: number;
1492
+ /**
1493
+ * If {@link @genesislcap/grid-pro#GridPro.gridAutosizingEnabled} is true, will remove the widths from the column states.
1494
+ * @internal
1495
+ */
1490
1496
  readonly ENTITY_NODE: number;
1491
1497
  readonly ENTITY_REFERENCE_NODE: number;
1492
1498
  readonly NOTATION_NODE: number;
@@ -2076,6 +2082,53 @@ declare const GridProColumn_base: (new (...args: any[]) => {
2076
2082
  */
2077
2083
  export declare function gridProColumns<TSource = any>(itemsBinding: Binding<TSource, readonly ColDef[]> | readonly ColDef[], includeRenderers?: boolean): CaptureType<TSource>;
2078
2084
 
2085
+ /**
2086
+ * Grid Pro possible error events
2087
+ * @public
2088
+ */
2089
+ export declare type GridProErrorEvent = GridProGenesisDatasourceErrorEvent | CustomEvent<GridProErrorItem<any>>;
2090
+
2091
+ /**
2092
+ * Grid Pro Error Item
2093
+ * @public
2094
+ */
2095
+ export declare interface GridProErrorItem<GridProErrorItemDetailType> {
2096
+ detail: GridProErrorItemDetailType;
2097
+ type: GridProErrorTypes;
2098
+ }
2099
+
2100
+ /**
2101
+ * The error names for the Grid Pro component.
2102
+ * @public
2103
+ */
2104
+ export declare const gridProErrorNames: {
2105
+ readonly datasource: "datasource";
2106
+ readonly unknown: "unknown";
2107
+ };
2108
+
2109
+ /**
2110
+ * Grid Pro Error Types
2111
+ * @public
2112
+ */
2113
+ export declare type GridProErrorTypes = keyof typeof gridProErrorNames;
2114
+
2115
+ /**
2116
+ * The event names for the Grid Pro component.
2117
+ * @public
2118
+ */
2119
+ export declare const gridProEventNames: {
2120
+ datasourceErrorClose: string;
2121
+ };
2122
+
2123
+ /**
2124
+ * Grid Pro Event Listeners
2125
+ * @internal
2126
+ */
2127
+ export declare type GridProEventsListeners = {
2128
+ key: string;
2129
+ action: (event: Event) => void;
2130
+ }[];
2131
+
2079
2132
  /**
2080
2133
  * The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element.
2081
2134
  * @remarks Only supports Client-Side Row Model.
@@ -2201,6 +2254,13 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
2201
2254
  readonly accessKeyLabel: string;
2202
2255
  autocapitalize: string;
2203
2256
  dir: string;
2257
+ /**
2258
+ * Initializes the datasource.
2259
+ * @public
2260
+ * @param columnDefinitions - Optionally set the `gridOptions` up with column definitions
2261
+ * @param columnStates - Optionally set the grid up with column state
2262
+ * @remarks This method is called automatically when the element is connected to the DOM.
2263
+ */
2204
2264
  draggable: boolean;
2205
2265
  hidden: boolean;
2206
2266
  inert: boolean;
@@ -2264,7 +2324,9 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
2264
2324
  getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
2265
2325
  hasAttribute(qualifiedName: string): boolean;
2266
2326
  hasAttributeNS(namespace: string, localName: string): boolean;
2267
- hasAttributes(): boolean;
2327
+ hasAttributes(): boolean; /**
2328
+ * Force the grid to redispatch the current rows
2329
+ */
2268
2330
  hasPointerCapture(pointerId: number): boolean;
2269
2331
  insertAdjacentElement(where: InsertPosition, element: Element): Element;
2270
2332
  insertAdjacentHTML(position: InsertPosition, text: string): void;
@@ -2333,6 +2395,13 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
2333
2395
  readonly ENTITY_NODE: number;
2334
2396
  readonly ENTITY_REFERENCE_NODE: number;
2335
2397
  readonly NOTATION_NODE: number;
2398
+ /**
2399
+ * Initializes the datasource and loads the data for the grid.
2400
+ * Handles both snapshot and stream data (for both REQUEST_SERVER and DATASERVER resource types).
2401
+ *
2402
+ * @param withFullInit - if true, will call datasource.init() with requiresMetadataFetch = true, fetching fresh metadata
2403
+ * @internal
2404
+ */
2336
2405
  readonly PROCESSING_INSTRUCTION_NODE: number;
2337
2406
  readonly TEXT_NODE: number;
2338
2407
  dispatchEvent(event: Event): boolean;
@@ -2506,6 +2575,43 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
2506
2575
  focus(options?: FocusOptions): void;
2507
2576
  }) & typeof GridProBaseDatasource;
2508
2577
 
2578
+ /**
2579
+ * The error event grid pro genesis datasource.
2580
+ * @public
2581
+ */
2582
+ export declare type GridProGenesisDatasourceErrorEvent = CustomEvent<GridProGenesisDatasourceErrorEventDetail>;
2583
+
2584
+ /**
2585
+ * The event detail for the grid pro genesis datasource `error` event.
2586
+ * @public
2587
+ */
2588
+ export declare type GridProGenesisDatasourceErrorEventDetail = {
2589
+ message: string;
2590
+ };
2591
+
2592
+ /**
2593
+ * The Genesis Datasource events names.
2594
+ * @public
2595
+ */
2596
+ export declare const gridProGenesisDatasourceEventNames: {
2597
+ error: string;
2598
+ rowDataSet: string;
2599
+ };
2600
+
2601
+ /**
2602
+ * The rowDataSet event grid pro genesis datasource.
2603
+ * @public
2604
+ */
2605
+ export declare type GridProGenesisRowDataSetEvent = CustomEvent<GridProGenesisRowDataSetEventDetail>;
2606
+
2607
+ /**
2608
+ * The event detail for the grid pro genesis datasource `rowDataSet` event.
2609
+ * @public
2610
+ */
2611
+ export declare type GridProGenesisRowDataSetEventDetail = {
2612
+ data: any[];
2613
+ };
2614
+
2509
2615
  /**
2510
2616
  * The available Grid Pro Renderer Types
2511
2617
  * @public
@@ -2893,8 +2999,10 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
2893
2999
  }) & typeof GridProBaseDatasource;
2894
3000
 
2895
3001
  /**
2896
- * The Grid Pro Template.
3002
+ *
2897
3003
  * @public
3004
+ * @remarks
3005
+ * HTML Element: \<foundation-grid-pro\>
2898
3006
  */
2899
3007
  export declare const gridProTemplate: ViewTemplate;
2900
3008
 
@@ -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; [getGridProTemplate](./grid-pro.getgridprotemplate.md)
4
+
5
+ ## getGridProTemplate variable
6
+
7
+ Get a Design System prefixed The Grid Pro template.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getGridProTemplate: (prefix?: string) => ViewTemplate<GridPro, any>
13
+ ```
@@ -0,0 +1,11 @@
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; [GridPro](./grid-pro.gridpro.md) &gt; [gridErrorItems](./grid-pro.gridpro.griderroritems.md)
4
+
5
+ ## GridPro.gridErrorItems property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ gridErrorItems: GridProErrorItem<GridProErrorEvent['detail']>[];
11
+ ```
@@ -46,6 +46,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
46
46
  | [gridApi](./grid-pro.gridpro.gridapi.md) | | GridApi | |
47
47
  | [gridAutosizingEnabled](./grid-pro.gridpro.gridautosizingenabled.md) | | boolean | Boolean attribute to control whether the grid autosizes the columns upon interaction. This will disable the column widths from being manually set, and doesn't save the widths in local storage if you are using <code>persist-column-state-key</code>. |
48
48
  | [gridComponents](./grid-pro.gridpro.gridcomponents.md) | | { \[componentName: string\]: any; } | |
49
+ | [gridErrorItems](./grid-pro.gridpro.griderroritems.md) | | [GridProErrorItem](./grid-pro.gridproerroritem.md)<!-- -->&lt;[GridProErrorEvent](./grid-pro.gridproerrorevent.md)<!-- -->\['detail'\]&gt;\[\] | |
49
50
  | [gridFontFace](./grid-pro.gridpro.gridfontface.md) | | string | |
50
51
  | [gridOptions](./grid-pro.gridpro.gridoptions.md) | | GridOptions | |
51
52
  | [gridOptionsConfig](./grid-pro.gridpro.gridoptionsconfig.md) | | [GridOptionsConfig](./grid-pro.gridoptionsconfig.md) | Injectable config that allows to change grid options on an app level basis To modify options, register instance of the config in DOM container that is above the grid or on the top level of the application, so it applies to all grids. |
@@ -0,0 +1,15 @@
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; [GridProErrorEvent](./grid-pro.gridproerrorevent.md)
4
+
5
+ ## GridProErrorEvent type
6
+
7
+ Grid Pro possible error events
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type GridProErrorEvent = GridProGenesisDatasourceErrorEvent | CustomEvent<GridProErrorItem<any>>;
13
+ ```
14
+ **References:** [GridProGenesisDatasourceErrorEvent](./grid-pro.gridprogenesisdatasourceerrorevent.md)<!-- -->, [GridProErrorItem](./grid-pro.gridproerroritem.md)
15
+
@@ -0,0 +1,11 @@
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; [GridProErrorItem](./grid-pro.gridproerroritem.md) &gt; [detail](./grid-pro.gridproerroritem.detail.md)
4
+
5
+ ## GridProErrorItem.detail property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ detail: GridProErrorItemDetailType;
11
+ ```
@@ -0,0 +1,21 @@
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; [GridProErrorItem](./grid-pro.gridproerroritem.md)
4
+
5
+ ## GridProErrorItem interface
6
+
7
+ Grid Pro Error Item
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface GridProErrorItem<GridProErrorItemDetailType>
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ | Property | Modifiers | Type | Description |
18
+ | --- | --- | --- | --- |
19
+ | [detail](./grid-pro.gridproerroritem.detail.md) | | GridProErrorItemDetailType | |
20
+ | [type](./grid-pro.gridproerroritem.type.md) | | [GridProErrorTypes](./grid-pro.gridproerrortypes.md) | |
21
+
@@ -0,0 +1,11 @@
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; [GridProErrorItem](./grid-pro.gridproerroritem.md) &gt; [type](./grid-pro.gridproerroritem.type.md)
4
+
5
+ ## GridProErrorItem.type property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ type: GridProErrorTypes;
11
+ ```
@@ -0,0 +1,16 @@
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; [gridProErrorNames](./grid-pro.gridproerrornames.md)
4
+
5
+ ## gridProErrorNames variable
6
+
7
+ The error names for the Grid Pro component.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ gridProErrorNames: {
13
+ readonly datasource: "datasource";
14
+ readonly unknown: "unknown";
15
+ }
16
+ ```
@@ -0,0 +1,15 @@
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; [GridProErrorTypes](./grid-pro.gridproerrortypes.md)
4
+
5
+ ## GridProErrorTypes type
6
+
7
+ Grid Pro Error Types
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type GridProErrorTypes = keyof typeof gridProErrorNames;
13
+ ```
14
+ **References:** [gridProErrorNames](./grid-pro.gridproerrornames.md)
15
+
@@ -0,0 +1,15 @@
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; [gridProEventNames](./grid-pro.gridproeventnames.md)
4
+
5
+ ## gridProEventNames variable
6
+
7
+ The event names for the Grid Pro component.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ gridProEventNames: {
13
+ datasourceErrorClose: string;
14
+ }
15
+ ```
@@ -0,0 +1,15 @@
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; [GridProGenesisDatasourceErrorEvent](./grid-pro.gridprogenesisdatasourceerrorevent.md)
4
+
5
+ ## GridProGenesisDatasourceErrorEvent type
6
+
7
+ The error event grid pro genesis datasource.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type GridProGenesisDatasourceErrorEvent = CustomEvent<GridProGenesisDatasourceErrorEventDetail>;
13
+ ```
14
+ **References:** [GridProGenesisDatasourceErrorEventDetail](./grid-pro.gridprogenesisdatasourceerroreventdetail.md)
15
+
@@ -0,0 +1,15 @@
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; [GridProGenesisDatasourceErrorEventDetail](./grid-pro.gridprogenesisdatasourceerroreventdetail.md)
4
+
5
+ ## GridProGenesisDatasourceErrorEventDetail type
6
+
7
+ The event detail for the grid pro genesis datasource `error` event.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type GridProGenesisDatasourceErrorEventDetail = {
13
+ message: string;
14
+ };
15
+ ```
@@ -0,0 +1,16 @@
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; [gridProGenesisDatasourceEventNames](./grid-pro.gridprogenesisdatasourceeventnames.md)
4
+
5
+ ## gridProGenesisDatasourceEventNames variable
6
+
7
+ The Genesis Datasource events names.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ gridProGenesisDatasourceEventNames: {
13
+ error: string;
14
+ rowDataSet: string;
15
+ }
16
+ ```
@@ -0,0 +1,15 @@
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; [GridProGenesisRowDataSetEvent](./grid-pro.gridprogenesisrowdatasetevent.md)
4
+
5
+ ## GridProGenesisRowDataSetEvent type
6
+
7
+ The rowDataSet event grid pro genesis datasource.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type GridProGenesisRowDataSetEvent = CustomEvent<GridProGenesisRowDataSetEventDetail>;
13
+ ```
14
+ **References:** [GridProGenesisRowDataSetEventDetail](./grid-pro.gridprogenesisrowdataseteventdetail.md)
15
+
@@ -0,0 +1,15 @@
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; [GridProGenesisRowDataSetEventDetail](./grid-pro.gridprogenesisrowdataseteventdetail.md)
4
+
5
+ ## GridProGenesisRowDataSetEventDetail type
6
+
7
+ The event detail for the grid pro genesis datasource `rowDataSet` event.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type GridProGenesisRowDataSetEventDetail = {
13
+ data: any[];
14
+ };
15
+ ```
@@ -4,10 +4,13 @@
4
4
 
5
5
  ## gridProTemplate variable
6
6
 
7
- The Grid Pro Template.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  gridProTemplate: ViewTemplate
13
11
  ```
12
+
13
+ ## Remarks
14
+
15
+ HTML Element: &lt;<!-- -->foundation-grid-pro<!-- -->&gt;
16
+
@@ -54,6 +54,7 @@
54
54
  | --- | --- |
55
55
  | [DateEditorParams](./grid-pro.dateeditorparams.md) | Parameters used to configure [SelectEditor](./grid-pro.selecteditor.md) |
56
56
  | [GridOptionsConfig](./grid-pro.gridoptionsconfig.md) | Grid options config used to configure grids across the application |
57
+ | [GridProErrorItem](./grid-pro.gridproerroritem.md) | Grid Pro Error Item |
57
58
  | [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) | Parameters used to configure [MultiselectEditor](./grid-pro.multiselecteditor.md) |
58
59
  | [NumberEditorParams](./grid-pro.numbereditorparams.md) | Parameters used to configure [NumberEditor](./grid-pro.numbereditor.md) |
59
60
  | [SelectEditorParams](./grid-pro.selecteditorparams.md) | Parameters used to configure [SelectEditor](./grid-pro.selecteditor.md) |
@@ -116,6 +117,7 @@
116
117
  | [getAgBooleanRendererTemplate](./grid-pro.getagbooleanrenderertemplate.md) | Get a Design System prefixed Checkbox template. |
117
118
  | [getAgEditableRendererTemplate](./grid-pro.getageditablerenderertemplate.md) | Get a Design System prefixed Checkbox template. |
118
119
  | [getDateEditorTemplate](./grid-pro.getdateeditortemplate.md) | Get a Design System prefixed Select template. |
120
+ | [getGridProTemplate](./grid-pro.getgridprotemplate.md) | Get a Design System prefixed The Grid Pro template. |
119
121
  | [getMultiselectEditorTemplate](./grid-pro.getmultiselecteditortemplate.md) | Get a Design System prefixed Select template. |
120
122
  | [getNumberEditorTemplate](./grid-pro.getnumbereditortemplate.md) | Get a Design System prefixed Select template. |
121
123
  | [getSelectEditorTemplate](./grid-pro.getselecteditortemplate.md) | Get a Design System prefixed Select template. |
@@ -124,7 +126,10 @@
124
126
  | [getTextFieldRendererTemplate](./grid-pro.gettextfieldrenderertemplate.md) | Get a Design System prefixed Text Field template. |
125
127
  | [getTextRendererTemplate](./grid-pro.gettextrenderertemplate.md) | |
126
128
  | [GRID\_READY\_EVENT](./grid-pro.grid_ready_event.md) | Event fired when grid is ready |
127
- | [gridProTemplate](./grid-pro.gridprotemplate.md) | The Grid Pro Template. |
129
+ | [gridProErrorNames](./grid-pro.gridproerrornames.md) | The error names for the Grid Pro component. |
130
+ | [gridProEventNames](./grid-pro.gridproeventnames.md) | The event names for the Grid Pro component. |
131
+ | [gridProGenesisDatasourceEventNames](./grid-pro.gridprogenesisdatasourceeventnames.md) | The Genesis Datasource events names. |
132
+ | [gridProTemplate](./grid-pro.gridprotemplate.md) | |
128
133
  | [logger](./grid-pro.logger.md) | Logger for the grid-pro package |
129
134
  | [textFieldRendererStyles](./grid-pro.textfieldrendererstyles.md) | The AG Text Field Renderer Styles. |
130
135
  | [textRendererStyles](./grid-pro.textrendererstyles.md) | |
@@ -136,4 +141,10 @@
136
141
  | [ActionRendererParams](./grid-pro.actionrendererparams.md) | Parameters for the [GridPro](./grid-pro.gridpro.md) action renderer. |
137
142
  | [AgThemeFontFaceMap](./grid-pro.agthemefontfacemap.md) | Type for mapping of a [AgGridTheme](./grid-pro.aggridtheme.md) to a font face. |
138
143
  | [GridComponents](./grid-pro.gridcomponents.md) | Grid Pro Components type, used to define the custom components that will be registered in the grid |
144
+ | [GridProErrorEvent](./grid-pro.gridproerrorevent.md) | Grid Pro possible error events |
145
+ | [GridProErrorTypes](./grid-pro.gridproerrortypes.md) | Grid Pro Error Types |
146
+ | [GridProGenesisDatasourceErrorEvent](./grid-pro.gridprogenesisdatasourceerrorevent.md) | The error event grid pro genesis datasource. |
147
+ | [GridProGenesisDatasourceErrorEventDetail](./grid-pro.gridprogenesisdatasourceerroreventdetail.md) | The event detail for the grid pro genesis datasource <code>error</code> event. |
148
+ | [GridProGenesisRowDataSetEvent](./grid-pro.gridprogenesisrowdatasetevent.md) | The rowDataSet event grid pro genesis datasource. |
149
+ | [GridProGenesisRowDataSetEventDetail](./grid-pro.gridprogenesisrowdataseteventdetail.md) | The event detail for the grid pro genesis datasource <code>rowDataSet</code> event. |
139
150
 
@@ -741,6 +741,9 @@ export const getDateEditorTemplate: (prefix?: string) => ViewTemplate<DateEditor
741
741
  // @alpha
742
742
  export function getFilterByFieldType(type: string): string;
743
743
 
744
+ // @public
745
+ export const getGridProTemplate: (prefix?: string) => ViewTemplate<GridPro, any>;
746
+
744
747
  // @public
745
748
  export const getMultiselectEditorTemplate: (designSystem?: string) => ViewTemplate<MultiselectEditor, any>;
746
749
 
@@ -837,6 +840,8 @@ export class GridPro extends GridPro_base {
837
840
  [componentName: string]: any;
838
841
  };
839
842
  // (undocumented)
843
+ gridErrorItems: GridProErrorItem<GridProErrorEvent['detail']>[];
844
+ // (undocumented)
840
845
  gridFontFace: string;
841
846
  // (undocumented)
842
847
  get gridOptions(): GridOptions;
@@ -945,6 +950,39 @@ export class GridProColumn extends GridProColumn_base {
945
950
  // @public
946
951
  export function gridProColumns<TSource = any>(itemsBinding: Binding<TSource, readonly ColDef[]> | readonly ColDef[], includeRenderers?: boolean): CaptureType<TSource>;
947
952
 
953
+ // @public
954
+ export type GridProErrorEvent = GridProGenesisDatasourceErrorEvent | CustomEvent<GridProErrorItem<any>>;
955
+
956
+ // @public
957
+ export interface GridProErrorItem<GridProErrorItemDetailType> {
958
+ // (undocumented)
959
+ detail: GridProErrorItemDetailType;
960
+ // (undocumented)
961
+ type: GridProErrorTypes;
962
+ }
963
+
964
+ // @public
965
+ export const gridProErrorNames: {
966
+ readonly datasource: "datasource";
967
+ readonly unknown: "unknown";
968
+ };
969
+
970
+ // @public
971
+ export type GridProErrorTypes = keyof typeof gridProErrorNames;
972
+
973
+ // @public
974
+ export const gridProEventNames: {
975
+ datasourceErrorClose: string;
976
+ };
977
+
978
+ // Warning: (ae-internal-missing-underscore) The name "GridProEventsListeners" should be prefixed with an underscore because the declaration is marked as @internal
979
+ //
980
+ // @internal
981
+ export type GridProEventsListeners = {
982
+ key: string;
983
+ action: (event: Event) => void;
984
+ }[];
985
+
948
986
  // Warning: (ae-forgotten-export) The symbol "GridProGenesisDatasource_base" needs to be exported by the entry point index.d.ts
949
987
  //
950
988
  // @public
@@ -995,6 +1033,28 @@ export class GridProGenesisDatasource extends GridProGenesisDatasource_base {
995
1033
  setFilter(fieldName: string, newFilter: string): void;
996
1034
  }
997
1035
 
1036
+ // @public
1037
+ export type GridProGenesisDatasourceErrorEvent = CustomEvent<GridProGenesisDatasourceErrorEventDetail>;
1038
+
1039
+ // @public
1040
+ export type GridProGenesisDatasourceErrorEventDetail = {
1041
+ message: string;
1042
+ };
1043
+
1044
+ // @public
1045
+ export const gridProGenesisDatasourceEventNames: {
1046
+ error: string;
1047
+ rowDataSet: string;
1048
+ };
1049
+
1050
+ // @public
1051
+ export type GridProGenesisRowDataSetEvent = CustomEvent<GridProGenesisRowDataSetEventDetail>;
1052
+
1053
+ // @public
1054
+ export type GridProGenesisRowDataSetEventDetail = {
1055
+ data: any[];
1056
+ };
1057
+
998
1058
  // @public
999
1059
  export enum GridProRendererTypes {
1000
1060
  // (undocumented)
@@ -1057,7 +1117,7 @@ export class GridProServerSideDatasource extends GridProServerSideDatasource_bas
1057
1117
  get rowModel(): IServerSideRowModel;
1058
1118
  }
1059
1119
 
1060
- // @public
1120
+ // @public (undocumented)
1061
1121
  export const gridProTemplate: ViewTemplate;
1062
1122
 
1063
1123
  // @public
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.167.3-alpha-69ba23f.0",
4
+ "version": "14.169.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -30,20 +30,20 @@
30
30
  "test:debug": "genx test --debug"
31
31
  },
32
32
  "devDependencies": {
33
- "@genesislcap/foundation-testing": "14.167.3-alpha-69ba23f.0",
34
- "@genesislcap/genx": "14.167.3-alpha-69ba23f.0",
35
- "@genesislcap/rollup-builder": "14.167.3-alpha-69ba23f.0",
36
- "@genesislcap/ts-builder": "14.167.3-alpha-69ba23f.0",
37
- "@genesislcap/uvu-playwright-builder": "14.167.3-alpha-69ba23f.0",
38
- "@genesislcap/vite-builder": "14.167.3-alpha-69ba23f.0",
39
- "@genesislcap/webpack-builder": "14.167.3-alpha-69ba23f.0",
33
+ "@genesislcap/foundation-testing": "14.169.0",
34
+ "@genesislcap/genx": "14.169.0",
35
+ "@genesislcap/rollup-builder": "14.169.0",
36
+ "@genesislcap/ts-builder": "14.169.0",
37
+ "@genesislcap/uvu-playwright-builder": "14.169.0",
38
+ "@genesislcap/vite-builder": "14.169.0",
39
+ "@genesislcap/webpack-builder": "14.169.0",
40
40
  "rimraf": "^3.0.2"
41
41
  },
42
42
  "dependencies": {
43
- "@genesislcap/foundation-comms": "14.167.3-alpha-69ba23f.0",
44
- "@genesislcap/foundation-logger": "14.167.3-alpha-69ba23f.0",
45
- "@genesislcap/foundation-ui": "14.167.3-alpha-69ba23f.0",
46
- "@genesislcap/foundation-utils": "14.167.3-alpha-69ba23f.0",
43
+ "@genesislcap/foundation-comms": "14.169.0",
44
+ "@genesislcap/foundation-logger": "14.169.0",
45
+ "@genesislcap/foundation-ui": "14.169.0",
46
+ "@genesislcap/foundation-utils": "14.169.0",
47
47
  "@microsoft/fast-colors": "^5.3.1",
48
48
  "@microsoft/fast-components": "^2.30.6",
49
49
  "@microsoft/fast-element": "^1.12.0",
@@ -69,5 +69,5 @@
69
69
  "access": "public"
70
70
  },
71
71
  "customElements": "dist/custom-elements.json",
72
- "gitHead": "181f6eb8a074dea1a432c628141688c39163fbfd"
72
+ "gitHead": "59695045bb3be9f8f42679be27fc88cd911e5136"
73
73
  }