@genesislcap/grid-pro 14.320.2-alpha-e69dcb3.0 → 14.321.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 (31) hide show
  1. package/dist/custom-elements.json +249 -535
  2. package/dist/dts/datasource/base.datasource.d.ts +4 -63
  3. package/dist/dts/datasource/base.datasource.d.ts.map +1 -1
  4. package/dist/dts/datasource/server-side.resource-reqrep.d.ts.map +1 -1
  5. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +0 -2
  6. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
  7. package/dist/dts/status-bar-components/pagination.status-bar.d.ts.map +1 -1
  8. package/dist/esm/datasource/base.datasource.js +14 -56
  9. package/dist/esm/datasource/server-side.resource-reqrep.js +6 -19
  10. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +2 -33
  11. package/dist/esm/status-bar-components/pagination.status-bar.js +4 -29
  12. package/dist/grid-pro.api.json +14 -44
  13. package/dist/grid-pro.d.ts +4 -65
  14. package/docs/api/grid-pro.genesisgriddatasourceelement.criteria.md +0 -2
  15. package/docs/api/grid-pro.genesisgriddatasourceelement.disablepolling.md +0 -7
  16. package/docs/api/grid-pro.genesisgriddatasourceelement.fields.md +0 -7
  17. package/docs/api/grid-pro.genesisgriddatasourceelement.issnapshot.md +0 -7
  18. package/docs/api/grid-pro.genesisgriddatasourceelement.maxrows.md +0 -7
  19. package/docs/api/grid-pro.genesisgriddatasourceelement.maxview.md +0 -7
  20. package/docs/api/grid-pro.genesisgriddatasourceelement.md +0 -47
  21. package/docs/api/grid-pro.genesisgriddatasourceelement.movingview.md +0 -7
  22. package/docs/api/grid-pro.genesisgriddatasourceelement.orderby.md +0 -7
  23. package/docs/api/grid-pro.genesisgriddatasourceelement.pollinginterval.md +0 -7
  24. package/docs/api/grid-pro.genesisgriddatasourceelement.polltriggerevents.md +0 -7
  25. package/docs/api/grid-pro.genesisgriddatasourceelement.request.md +0 -7
  26. package/docs/api/grid-pro.genesisgriddatasourceelement.resourcename.md +0 -7
  27. package/docs/api/grid-pro.genesisgriddatasourceelement.reverse.md +0 -7
  28. package/docs/api/grid-pro.genesisgriddatasourceelement.viewnumber.md +0 -2
  29. package/docs/api-report.md.api.md +14 -1
  30. package/package.json +13 -13
  31. package/docs/api/grid-pro.genesisgriddatasourceelement.offset.md +0 -18
@@ -1065,78 +1065,19 @@ export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceE
1065
1065
  * Allows grid data updates to be processed via and external function before applying in grid
1066
1066
  */
1067
1067
  rowDataMapper: Function;
1068
- /**
1069
- * Groovy expression to perform filters on the query server; these remain active for the life of the subscription.
1070
- */
1071
1068
  criteria: string;
1072
- /**
1073
- * Request a snapshot from the server.
1074
- * @remarks Defaults to false.
1075
- */
1069
+ fields: string;
1076
1070
  isSnapshot: boolean;
1077
- /**
1078
- * Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.
1079
- * @remarks This will not affect the number of rows displayed. Defaults to 250.
1080
- */
1081
1071
  maxRows: number;
1082
- /**
1083
- * The name of the target Data Server query or Request Server requestReply.
1084
- * @remarks Required attribute.
1085
- */
1086
- resourceName: string;
1087
- /**
1088
- * The desired view/page you want data from.
1089
- */
1090
- viewNumber: number;
1091
- /**
1092
- * Optional parameter that allows you to select a subset of fields from the query if the client is not interested in receiving all of them.
1093
- * @remarks DATASERVER only.
1094
- */
1095
- fields: string;
1096
- /**
1097
- * Maximum number of rows to track as part of a client "view".
1098
- * @remarks DATASERVER only. Defaults to 1000.
1099
- */
1100
1072
  maxView: number;
1101
- /**
1102
- * If true, when the maximum number of rows defined in max-view is reached, the Data Server will start discarding the oldest rows (in terms of timestamp) and sending newer rows.
1103
- * @remarks DATASERVER only. If false, the updates in the server will be sent to the front end regardless of order. Note that this will only update the UI; no changes will be performed in the database. Defaults to false.
1104
- */
1105
1073
  movingView: boolean;
1106
- /**
1107
- * Option to select a Data Server index (defined in the Data Server query), which is especially useful if you want the data to be sorted in a specific way.
1108
- * @remarks DATASERVER only. By default, Data Server rows are returned in order of creation (from oldest database record to newest).
1109
- */
1110
1074
  orderBy: string;
1111
- /**
1112
- * Option that changes the Data Server index iteration.
1113
- * @remarks DATASERVER only. For example, if you are using the default index, the query will return rows in order from the newest database records to the oldest. Defaults to false.
1114
- */
1075
+ resourceName: string;
1115
1076
  reverse: boolean;
1116
- /**
1117
- * Disables polling if set to true (data updates for the grid will not be fetched automatically).
1118
- * @remarks REQUEST_SERVER only. Defaults to false.
1119
- */
1120
- disablePolling: boolean;
1121
- /**
1122
- * The offset for pagination in REQUEST_SERVER scenarios.
1123
- * @remarks REQUEST_SERVER only.
1124
- */
1125
- offset: number;
1126
- /**
1127
- * Custom polling frequency (in milliseconds) for a Request Server resource.
1128
- * @remarks REQUEST_SERVER only. Note that this option only works with Request Server resources; if your resource is a Data Server query, your grid is updated in real time. Defaults to 5000ms.
1129
- */
1077
+ viewNumber: number;
1130
1078
  pollingInterval: number;
1131
- /**
1132
- * Array of event names that will trigger a poll when received as commit responses.
1133
- * @remarks REQUEST_SERVER only.
1134
- */
1135
1079
  pollTriggerEvents: string[];
1136
- /**
1137
- * Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.
1138
- * @remarks REQUEST_SERVER only.
1139
- */
1080
+ disablePolling: boolean;
1140
1081
  request: any;
1141
1082
  /**
1142
1083
  * Attribute to set whether the REQUEST object should be automatically set up.
@@ -2964,8 +2905,6 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
2964
2905
  private _lastMoreRows;
2965
2906
  private _isMoreRowsResult;
2966
2907
  private _sourceRef;
2967
- private _nextOffset;
2968
- private _loadMoreCount;
2969
2908
  connectedCallback(): void;
2970
2909
  disconnectedCallback(): void;
2971
2910
  deepClone(): Node;
@@ -4,8 +4,6 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.criteria property
6
6
 
7
- Groovy expression to perform filters on the query server; these remain active for the life of the subscription.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
@@ -4,15 +4,8 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.disablePolling property
6
6
 
7
- Disables polling if set to true (data updates for the grid will not be fetched automatically).
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  disablePolling: boolean;
13
11
  ```
14
-
15
- ## Remarks
16
-
17
- REQUEST\_SERVER only. Defaults to false.
18
-
@@ -4,15 +4,8 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.fields property
6
6
 
7
- Optional parameter that allows you to select a subset of fields from the query if the client is not interested in receiving all of them.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  fields: string;
13
11
  ```
14
-
15
- ## Remarks
16
-
17
- DATASERVER only.
18
-
@@ -4,15 +4,8 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.isSnapshot property
6
6
 
7
- Request a snapshot from the server.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  isSnapshot: boolean;
13
11
  ```
14
-
15
- ## Remarks
16
-
17
- Defaults to false.
18
-
@@ -4,15 +4,8 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.maxRows property
6
6
 
7
- Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE\_ROWS messages.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  maxRows: number;
13
11
  ```
14
-
15
- ## Remarks
16
-
17
- This will not affect the number of rows displayed. Defaults to 250.
18
-
@@ -4,15 +4,8 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.maxView property
6
6
 
7
- Maximum number of rows to track as part of a client "view".
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  maxView: number;
13
11
  ```
14
-
15
- ## Remarks
16
-
17
- DATASERVER only. Defaults to 1000.
18
-
@@ -89,8 +89,6 @@ string
89
89
 
90
90
  </td><td>
91
91
 
92
- Groovy expression to perform filters on the query server; these remain active for the life of the subscription.
93
-
94
92
 
95
93
  </td></tr>
96
94
  <tr><td>
@@ -199,8 +197,6 @@ boolean
199
197
 
200
198
  </td><td>
201
199
 
202
- Disables polling if set to true (data updates for the grid will not be fetched automatically).
203
-
204
200
 
205
201
  </td></tr>
206
202
  <tr><td>
@@ -218,8 +214,6 @@ string
218
214
 
219
215
  </td><td>
220
216
 
221
- Optional parameter that allows you to select a subset of fields from the query if the client is not interested in receiving all of them.
222
-
223
217
 
224
218
  </td></tr>
225
219
  <tr><td>
@@ -256,8 +250,6 @@ boolean
256
250
 
257
251
  </td><td>
258
252
 
259
- Request a snapshot from the server.
260
-
261
253
 
262
254
  </td></tr>
263
255
  <tr><td>
@@ -275,8 +267,6 @@ number
275
267
 
276
268
  </td><td>
277
269
 
278
- Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE\_ROWS messages.
279
-
280
270
 
281
271
  </td></tr>
282
272
  <tr><td>
@@ -294,8 +284,6 @@ number
294
284
 
295
285
  </td><td>
296
286
 
297
- Maximum number of rows to track as part of a client "view".
298
-
299
287
 
300
288
  </td></tr>
301
289
  <tr><td>
@@ -313,27 +301,6 @@ boolean
313
301
 
314
302
  </td><td>
315
303
 
316
- If true, when the maximum number of rows defined in max-view is reached, the Data Server will start discarding the oldest rows (in terms of timestamp) and sending newer rows.
317
-
318
-
319
- </td></tr>
320
- <tr><td>
321
-
322
- [offset](./grid-pro.genesisgriddatasourceelement.offset.md)
323
-
324
-
325
- </td><td>
326
-
327
-
328
- </td><td>
329
-
330
- number
331
-
332
-
333
- </td><td>
334
-
335
- The offset for pagination in REQUEST\_SERVER scenarios.
336
-
337
304
 
338
305
  </td></tr>
339
306
  <tr><td>
@@ -351,8 +318,6 @@ string
351
318
 
352
319
  </td><td>
353
320
 
354
- Option to select a Data Server index (defined in the Data Server query), which is especially useful if you want the data to be sorted in a specific way.
355
-
356
321
 
357
322
  </td></tr>
358
323
  <tr><td>
@@ -370,8 +335,6 @@ number
370
335
 
371
336
  </td><td>
372
337
 
373
- Custom polling frequency (in milliseconds) for a Request Server resource.
374
-
375
338
 
376
339
  </td></tr>
377
340
  <tr><td>
@@ -389,8 +352,6 @@ string\[\]
389
352
 
390
353
  </td><td>
391
354
 
392
- Array of event names that will trigger a poll when received as commit responses.
393
-
394
355
 
395
356
  </td></tr>
396
357
  <tr><td>
@@ -408,8 +369,6 @@ any
408
369
 
409
370
  </td><td>
410
371
 
411
- Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.
412
-
413
372
 
414
373
  </td></tr>
415
374
  <tr><td>
@@ -446,8 +405,6 @@ string
446
405
 
447
406
  </td><td>
448
407
 
449
- The name of the target Data Server query or Request Server requestReply.
450
-
451
408
 
452
409
  </td></tr>
453
410
  <tr><td>
@@ -484,8 +441,6 @@ boolean
484
441
 
485
442
  </td><td>
486
443
 
487
- Option that changes the Data Server index iteration.
488
-
489
444
 
490
445
  </td></tr>
491
446
  <tr><td>
@@ -562,8 +517,6 @@ number
562
517
 
563
518
  </td><td>
564
519
 
565
- The desired view/page you want data from.
566
-
567
520
 
568
521
  </td></tr>
569
522
  </tbody></table>
@@ -4,15 +4,8 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.movingView property
6
6
 
7
- If true, when the maximum number of rows defined in max-view is reached, the Data Server will start discarding the oldest rows (in terms of timestamp) and sending newer rows.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  movingView: boolean;
13
11
  ```
14
-
15
- ## Remarks
16
-
17
- DATASERVER only. If false, the updates in the server will be sent to the front end regardless of order. Note that this will only update the UI; no changes will be performed in the database. Defaults to false.
18
-
@@ -4,15 +4,8 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.orderBy property
6
6
 
7
- Option to select a Data Server index (defined in the Data Server query), which is especially useful if you want the data to be sorted in a specific way.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  orderBy: string;
13
11
  ```
14
-
15
- ## Remarks
16
-
17
- DATASERVER only. By default, Data Server rows are returned in order of creation (from oldest database record to newest).
18
-
@@ -4,15 +4,8 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.pollingInterval property
6
6
 
7
- Custom polling frequency (in milliseconds) for a Request Server resource.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  pollingInterval: number;
13
11
  ```
14
-
15
- ## Remarks
16
-
17
- REQUEST\_SERVER only. Note that this option only works with Request Server resources; if your resource is a Data Server query, your grid is updated in real time. Defaults to 5000ms.
18
-
@@ -4,15 +4,8 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.pollTriggerEvents property
6
6
 
7
- Array of event names that will trigger a poll when received as commit responses.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  pollTriggerEvents: string[];
13
11
  ```
14
-
15
- ## Remarks
16
-
17
- REQUEST\_SERVER only.
18
-
@@ -4,15 +4,8 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.request property
6
6
 
7
- Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  request: any;
13
11
  ```
14
-
15
- ## Remarks
16
-
17
- REQUEST\_SERVER only.
18
-
@@ -4,15 +4,8 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.resourceName property
6
6
 
7
- The name of the target Data Server query or Request Server requestReply.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  resourceName: string;
13
11
  ```
14
-
15
- ## Remarks
16
-
17
- Required attribute.
18
-
@@ -4,15 +4,8 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.reverse property
6
6
 
7
- Option that changes the Data Server index iteration.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
10
  reverse: boolean;
13
11
  ```
14
-
15
- ## Remarks
16
-
17
- DATASERVER only. For example, if you are using the default index, the query will return rows in order from the newest database records to the oldest. Defaults to false.
18
-
@@ -4,8 +4,6 @@
4
4
 
5
5
  ## GenesisGridDatasourceElement.viewNumber property
6
6
 
7
- The desired view/page you want data from.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
@@ -787,6 +787,7 @@ export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_b
787
787
  clearErrors(): void;
788
788
  // (undocumented)
789
789
  connect: Connect;
790
+ // (undocumented)
790
791
  criteria: string;
791
792
  // (undocumented)
792
793
  protected criteriaFromFilters: Map<string, string>;
@@ -802,7 +803,9 @@ export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_b
802
803
  deferredColumnStates: ColumnState[];
803
804
  // (undocumented)
804
805
  deferredGridOptions: GridOptions;
806
+ // (undocumented)
805
807
  disablePolling: boolean;
808
+ // (undocumented)
806
809
  fields: string;
807
810
  // Warning: (ae-forgotten-export) The symbol "BaseDatasourceErrorEventDetail" needs to be exported by the entry point index.d.ts
808
811
  handleErrors(errors: string | any[], type?: BaseDatasourceErrorEventDetail['type']): void;
@@ -812,20 +815,29 @@ export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_b
812
815
  protected initializeDatasource(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
813
816
  // (undocumented)
814
817
  get isRequestServer(): boolean;
818
+ // (undocumented)
815
819
  isSnapshot: boolean;
820
+ // (undocumented)
816
821
  maxRows: number;
822
+ // (undocumented)
817
823
  maxView: number;
824
+ // (undocumented)
818
825
  movingView: boolean;
819
- offset: number;
826
+ // (undocumented)
820
827
  orderBy: string;
828
+ // (undocumented)
821
829
  pollingInterval: number;
830
+ // (undocumented)
822
831
  pollTriggerEvents: string[];
823
832
  // (undocumented)
824
833
  removeFilter(fieldName: string): void;
834
+ // (undocumented)
825
835
  request: any;
826
836
  requestAutoSetup: boolean;
837
+ // (undocumented)
827
838
  resourceName: string;
828
839
  restartOnReconnection: boolean;
840
+ // (undocumented)
829
841
  reverse: boolean;
830
842
  rowDataMapper: Function;
831
843
  // @internal
@@ -835,6 +847,7 @@ export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_b
835
847
  setFilter(fieldName: string, newFilter: string): void;
836
848
  // (undocumented)
837
849
  protected update: BehaviorSubject<Map<string, string>>;
850
+ // (undocumented)
838
851
  viewNumber: number;
839
852
  }
840
853
 
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.320.2-alpha-e69dcb3.0",
4
+ "version": "14.321.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -38,19 +38,19 @@
38
38
  }
39
39
  },
40
40
  "devDependencies": {
41
- "@genesislcap/foundation-testing": "14.320.2-alpha-e69dcb3.0",
42
- "@genesislcap/genx": "14.320.2-alpha-e69dcb3.0",
43
- "@genesislcap/rollup-builder": "14.320.2-alpha-e69dcb3.0",
44
- "@genesislcap/ts-builder": "14.320.2-alpha-e69dcb3.0",
45
- "@genesislcap/uvu-playwright-builder": "14.320.2-alpha-e69dcb3.0",
46
- "@genesislcap/vite-builder": "14.320.2-alpha-e69dcb3.0",
47
- "@genesislcap/webpack-builder": "14.320.2-alpha-e69dcb3.0"
41
+ "@genesislcap/foundation-testing": "14.321.0",
42
+ "@genesislcap/genx": "14.321.0",
43
+ "@genesislcap/rollup-builder": "14.321.0",
44
+ "@genesislcap/ts-builder": "14.321.0",
45
+ "@genesislcap/uvu-playwright-builder": "14.321.0",
46
+ "@genesislcap/vite-builder": "14.321.0",
47
+ "@genesislcap/webpack-builder": "14.321.0"
48
48
  },
49
49
  "dependencies": {
50
- "@genesislcap/foundation-comms": "14.320.2-alpha-e69dcb3.0",
51
- "@genesislcap/foundation-logger": "14.320.2-alpha-e69dcb3.0",
52
- "@genesislcap/foundation-ui": "14.320.2-alpha-e69dcb3.0",
53
- "@genesislcap/foundation-utils": "14.320.2-alpha-e69dcb3.0",
50
+ "@genesislcap/foundation-comms": "14.321.0",
51
+ "@genesislcap/foundation-logger": "14.321.0",
52
+ "@genesislcap/foundation-ui": "14.321.0",
53
+ "@genesislcap/foundation-utils": "14.321.0",
54
54
  "@microsoft/fast-colors": "5.3.1",
55
55
  "@microsoft/fast-components": "2.30.6",
56
56
  "@microsoft/fast-element": "1.14.0",
@@ -75,5 +75,5 @@
75
75
  "access": "public"
76
76
  },
77
77
  "customElements": "dist/custom-elements.json",
78
- "gitHead": "6591156f074df6da6bf79baf7cf78539db372e1d"
78
+ "gitHead": "06cb4926f9dda754d5d4d8c4acb3b0553453dd20"
79
79
  }
@@ -1,18 +0,0 @@
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [offset](./grid-pro.genesisgriddatasourceelement.offset.md)
4
-
5
- ## GenesisGridDatasourceElement.offset property
6
-
7
- The offset for pagination in REQUEST\_SERVER scenarios.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- offset: number;
13
- ```
14
-
15
- ## Remarks
16
-
17
- REQUEST\_SERVER only.
18
-