@genesislcap/grid-pro 15.24.2 → 15.25.0-FUI-2611.2
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 +549 -44
- package/dist/dts/datasource/base.datasource.d.ts +70 -7
- package/dist/dts/datasource/base.datasource.d.ts.map +1 -1
- package/dist/dts/datasource/base.types.d.ts +27 -0
- package/dist/dts/datasource/base.types.d.ts.map +1 -1
- package/dist/dts/datasource/delivered-block.ledger.d.ts +32 -0
- package/dist/dts/datasource/delivered-block.ledger.d.ts.map +1 -0
- package/dist/dts/datasource/infinite.datasource.d.ts +33 -1
- package/dist/dts/datasource/infinite.datasource.d.ts.map +1 -1
- package/dist/dts/datasource/infinite.resource.d.ts +75 -6
- package/dist/dts/datasource/infinite.resource.d.ts.map +1 -1
- package/dist/dts/datasource/server-side.datasource.d.ts +14 -4
- package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
- package/dist/dts/datasource/server-side.resource-base.d.ts +24 -0
- package/dist/dts/datasource/server-side.resource-base.d.ts.map +1 -1
- package/dist/dts/datasource/server-side.resource-dataserver.d.ts +26 -0
- package/dist/dts/datasource/server-side.resource-dataserver.d.ts.map +1 -1
- package/dist/dts/datasource/server-side.resource-reqrep.d.ts.map +1 -1
- package/dist/dts/grid-pro-beta.d.ts +6 -0
- package/dist/dts/grid-pro-beta.d.ts.map +1 -1
- package/dist/dts/grid-pro-genesis-datasource/datasource-events.types.d.ts +4 -0
- package/dist/dts/grid-pro-genesis-datasource/datasource-events.types.d.ts.map +1 -1
- package/dist/dts/grid-pro.d.ts.map +1 -1
- package/dist/dts/react.d.ts +1 -1
- package/dist/esm/datasource/base.datasource.js +177 -23
- package/dist/esm/datasource/delivered-block.ledger.js +59 -0
- package/dist/esm/datasource/infinite.datasource.js +61 -17
- package/dist/esm/datasource/infinite.resource.js +81 -10
- package/dist/esm/datasource/server-side.datasource.js +73 -25
- package/dist/esm/datasource/server-side.resource-base.js +43 -0
- package/dist/esm/datasource/server-side.resource-dataserver.js +77 -17
- package/dist/esm/datasource/server-side.resource-reqrep.js +12 -0
- package/dist/esm/grid-pro-beta.js +20 -2
- package/dist/esm/grid-pro.js +4 -1
- package/dist/grid-pro.api.json +35 -35
- package/dist/grid-pro.d.ts +228 -17
- package/dist/react.cjs +6 -6
- package/dist/react.mjs +6 -6
- package/package.json +13 -13
|
@@ -39,6 +39,9 @@ export class ReqRepServerSideDatasource extends BaseServerSideDatasource {
|
|
|
39
39
|
}
|
|
40
40
|
getRows(params) {
|
|
41
41
|
return __awaiter(this, void 0, void 0, function* () {
|
|
42
|
+
// Taken before the first await: a reload that lands anywhere between here and the reply
|
|
43
|
+
// means the block cache this request was read for is gone.
|
|
44
|
+
const generation = this.loadGeneration;
|
|
42
45
|
if (yield this.setupFiltering(params)) {
|
|
43
46
|
params.fail();
|
|
44
47
|
return;
|
|
@@ -54,6 +57,14 @@ export class ReqRepServerSideDatasource extends BaseServerSideDatasource {
|
|
|
54
57
|
DETAILS: this.buildRequestDetails(),
|
|
55
58
|
};
|
|
56
59
|
const requestResult = yield this.createReqRepRequestFunc(requestParams);
|
|
60
|
+
// The cache this block was read for was dropped while the request was in flight (a filter,
|
|
61
|
+
// sort or criteria change): the reply must not be handed to the host as rows the grid holds.
|
|
62
|
+
// fail() still frees AG Grid's concurrent-request slot; the purge already dropped the block.
|
|
63
|
+
if (generation !== this.loadGeneration) {
|
|
64
|
+
logger.debug('SSRM req/rep reply discarded: the block cache was reset while it was in flight');
|
|
65
|
+
params.fail();
|
|
66
|
+
return;
|
|
67
|
+
}
|
|
57
68
|
// Apply the result to the grid
|
|
58
69
|
this.applyServerSideData(params, requestResult);
|
|
59
70
|
// If polling enabled, schedule stream creation after user stops scrolling
|
|
@@ -117,6 +128,7 @@ export class ReqRepServerSideDatasource extends BaseServerSideDatasource {
|
|
|
117
128
|
successRowData.rowCount = this.getCorrectRowCount(params);
|
|
118
129
|
this.lastSuccessRowData = successRowData;
|
|
119
130
|
params.success(successRowData);
|
|
131
|
+
this.deliverRows(params.request.startRow, successRowData.rowData);
|
|
120
132
|
this.notifyNoDataAvailableIfEmpty(params, successRowData);
|
|
121
133
|
}
|
|
122
134
|
getCorrectRowCount(params) {
|
|
@@ -461,11 +461,25 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
|
|
|
461
461
|
*/
|
|
462
462
|
handleDataChanged(event) {
|
|
463
463
|
const { changes } = event.detail;
|
|
464
|
-
|
|
464
|
+
// Every datasource emits this for consumers, but only the client-side row model takes row
|
|
465
|
+
// transactions: the infinite and server-side datasources drive the grid through
|
|
466
|
+
// refresh-infinite-cache / apply-server-side-transaction, and applyTransaction on those
|
|
467
|
+
// models is a no-op that logs an AG Grid warning per event.
|
|
468
|
+
if (!this.gridApi || !this.isClientSideRowModel)
|
|
465
469
|
return;
|
|
466
470
|
const result = this.gridApi.applyTransaction(changes);
|
|
467
471
|
this.flashAddedCells(result === null || result === void 0 ? void 0 : result.add);
|
|
468
472
|
}
|
|
473
|
+
/**
|
|
474
|
+
* Whether the live grid runs AG Grid's client-side row model (the default when the datasource
|
|
475
|
+
* set no `rowModelType`).
|
|
476
|
+
* @internal
|
|
477
|
+
*/
|
|
478
|
+
get isClientSideRowModel() {
|
|
479
|
+
var _a, _b, _c;
|
|
480
|
+
const rowModelType = (_c = (_b = (_a = this.gridApi) === null || _a === void 0 ? void 0 : _a.getGridOption) === null || _b === void 0 ? void 0 : _b.call(_a, 'rowModelType')) !== null && _c !== void 0 ? _c : 'clientSide';
|
|
481
|
+
return rowModelType === 'clientSide';
|
|
482
|
+
}
|
|
469
483
|
flashAddedCells(rowNodes) {
|
|
470
484
|
if (this.enableRowFlashing && (rowNodes === null || rowNodes === void 0 ? void 0 : rowNodes.length)) {
|
|
471
485
|
this.gridApi.flashCells({ rowNodes });
|
|
@@ -578,7 +592,11 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
|
|
|
578
592
|
if (includeSchema) {
|
|
579
593
|
this.gridApi.setGridOption('columnDefs', []);
|
|
580
594
|
}
|
|
581
|
-
|
|
595
|
+
// rowData belongs to the client-side row model; the infinite and server-side caches are
|
|
596
|
+
// cleared by their own refresh / transaction events.
|
|
597
|
+
if (this.isClientSideRowModel) {
|
|
598
|
+
this.gridApi.setGridOption('rowData', []);
|
|
599
|
+
}
|
|
582
600
|
this.gridApi.refreshCells({ force: true });
|
|
583
601
|
}
|
|
584
602
|
/**
|
package/dist/esm/grid-pro.js
CHANGED
|
@@ -414,7 +414,10 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
|
|
|
414
414
|
handleDataChanged(event) {
|
|
415
415
|
var _a, _b, _c;
|
|
416
416
|
const { changes } = event.detail;
|
|
417
|
-
|
|
417
|
+
// Every datasource emits this for consumers, but row transactions are a client-side row
|
|
418
|
+
// model API: the server-side datasource drives the grid through apply-server-side-transaction,
|
|
419
|
+
// and applyTransaction on that model is a no-op that logs an AG Grid warning per event.
|
|
420
|
+
if (!this.gridApi || this.isServerSide)
|
|
418
421
|
return;
|
|
419
422
|
if (((_a = changes.add) === null || _a === void 0 ? void 0 : _a.length) > 0) {
|
|
420
423
|
if (this.asyncAdd) {
|
package/dist/grid-pro.api.json
CHANGED
|
@@ -4497,7 +4497,7 @@
|
|
|
4497
4497
|
},
|
|
4498
4498
|
{
|
|
4499
4499
|
"kind": "Content",
|
|
4500
|
-
"text": "{\n add?: any[];\n remove?: any[];\n update?: any[];\n insertIndex?: number;\n }"
|
|
4500
|
+
"text": "{\n add?: any[];\n remove?: any[];\n update?: any[];\n addIndex?: number;\n insertIndex?: number;\n }"
|
|
4501
4501
|
},
|
|
4502
4502
|
{
|
|
4503
4503
|
"kind": "Content",
|
|
@@ -17160,6 +17160,37 @@
|
|
|
17160
17160
|
"isProtected": false,
|
|
17161
17161
|
"isAbstract": false
|
|
17162
17162
|
},
|
|
17163
|
+
{
|
|
17164
|
+
"kind": "Property",
|
|
17165
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProBaseDatasource#serializer:member",
|
|
17166
|
+
"docComment": "",
|
|
17167
|
+
"excerptTokens": [
|
|
17168
|
+
{
|
|
17169
|
+
"kind": "Content",
|
|
17170
|
+
"text": "serializer: "
|
|
17171
|
+
},
|
|
17172
|
+
{
|
|
17173
|
+
"kind": "Reference",
|
|
17174
|
+
"text": "JSONSerializer",
|
|
17175
|
+
"canonicalReference": "@genesislcap/foundation-utils!JSONSerializer:interface"
|
|
17176
|
+
},
|
|
17177
|
+
{
|
|
17178
|
+
"kind": "Content",
|
|
17179
|
+
"text": ";"
|
|
17180
|
+
}
|
|
17181
|
+
],
|
|
17182
|
+
"isReadonly": false,
|
|
17183
|
+
"isOptional": false,
|
|
17184
|
+
"releaseTag": "Public",
|
|
17185
|
+
"name": "serializer",
|
|
17186
|
+
"propertyTypeTokenRange": {
|
|
17187
|
+
"startIndex": 1,
|
|
17188
|
+
"endIndex": 2
|
|
17189
|
+
},
|
|
17190
|
+
"isStatic": false,
|
|
17191
|
+
"isProtected": false,
|
|
17192
|
+
"isAbstract": false
|
|
17193
|
+
},
|
|
17163
17194
|
{
|
|
17164
17195
|
"kind": "Method",
|
|
17165
17196
|
"canonicalReference": "@genesislcap/grid-pro!GridProBaseDatasource#setDisconnected:member(1)",
|
|
@@ -22864,7 +22895,7 @@
|
|
|
22864
22895
|
{
|
|
22865
22896
|
"kind": "Class",
|
|
22866
22897
|
"canonicalReference": "@genesislcap/grid-pro!GridProInfiniteDatasource:class",
|
|
22867
|
-
"docComment": "/**\n * A Genesis Datasource element for AG Grid's Infinite Row Model.\n *\n * @remarks\n *\n * The Infinite Row Model is part of AG Grid Community (free) and provides: - Lazy loading of data as user scrolls - Server-side sorting and filtering - Simple infinite scroll without grouping/aggregation - Live updates for DATASERVER resources: the DATA_LOGON stream the grid pages over pushes every change, so no flag or second subscription is needed\n *\n * REQUEST_SERVER resources are read on demand only - a change on the server shows up when the grid re-reads (scroll, filter/sort change, or an explicit refresh), not live. The exception is a write made through this session: a commit ACK for an event listed in `pollTriggerEvents` re-reads the loaded blocks, so entity-management CRUD is reflected immediately.\n *\n * Like the other datasources, consumer options passed as `deferredGridOptions` (including via entity-management's `gridOptions` with `datasource-type=\"infinite\"`) are merged over this element's defaults in `init()`.\n *\n * Use this instead of Server-Side Row Model when you don't need Enterprise features like row grouping, aggregation, or pivoting.\n *\n * @fires\n *\n * base-datasource-error - Fired when a datasource error is reported. detail: `BaseDatasourceErrorEventDetail`\n *\n * @fires\n *\n * datasource-error - Fired when a datasource error occurs (for grid integration). detail: `DatasourceErrorEventDetail`\n *\n * @fires\n *\n * base-datasource-connected - Fired when error state is cleared after connection succeeds\n *\n * @fires\n *\n * datasource-initialize - Fired to hand off infinite row model grid options. detail: `InitializeEventDetail`\n *\n * @fires\n *\n * datasource-init - Fired when the infinite grid model should initialize data\n *\n * @fires\n *\n * datasource-schema-updated - Fired when column metadata or defs are updated. detail: `SchemaUpdatedEventDetail`\n *\n * @fires\n *\n * set-infinite-datasource - Fired to attach or clear the infinite row model datasource. detail: `SetInfiniteDatasourceEventDetail`\n *\n * @fires\n *\n * refresh-infinite-cache - Fired to request an infinite row model refresh; `purge` drops the block cache and re-reads. detail: `RefreshInfiniteCacheEventDetail`\n *\n * @fires\n *\n * add-grid-css-class - Fired to add a CSS class on the grid host (hover sort indicators). detail: `GridCssClassEventDetail`\n *\n * @fires\n *\n * remove-grid-css-class - Fired to remove that CSS class from the grid host. detail: `GridCssClassEventDetail`\n *\n * @fires\n *\n * cache-filter-config - Fired to persist filter configuration for the grid\n *\n * @fires\n *\n * datasource-data-cleared - Fired when
|
|
22898
|
+
"docComment": "/**\n * A Genesis Datasource element for AG Grid's Infinite Row Model.\n *\n * @remarks\n *\n * The Infinite Row Model is part of AG Grid Community (free) and provides: - Lazy loading of data as user scrolls - Server-side sorting and filtering - Simple infinite scroll without grouping/aggregation - Live updates for DATASERVER resources: the DATA_LOGON stream the grid pages over pushes every change, so no flag or second subscription is needed\n *\n * REQUEST_SERVER resources are read on demand only - a change on the server shows up when the grid re-reads (scroll, filter/sort change, or an explicit refresh), not live. The exception is a write made through this session: a commit ACK for an event listed in `pollTriggerEvents` re-reads the loaded blocks, so entity-management CRUD is reflected immediately.\n *\n * Like the other datasources, consumer options passed as `deferredGridOptions` (including via entity-management's `gridOptions` with `datasource-type=\"infinite\"`) are merged over this element's defaults in `init()`.\n *\n * Use this instead of Server-Side Row Model when you don't need Enterprise features like row grouping, aggregation, or pivoting.\n *\n * @fires\n *\n * base-datasource-error - Fired when a datasource error is reported. detail: `BaseDatasourceErrorEventDetail`\n *\n * @fires\n *\n * datasource-error - Fired when a datasource error occurs (for grid integration). detail: `DatasourceErrorEventDetail`\n *\n * @fires\n *\n * base-datasource-connected - Fired when error state is cleared after connection succeeds\n *\n * @fires\n *\n * datasource-initialize - Fired to hand off infinite row model grid options. detail: `InitializeEventDetail`\n *\n * @fires\n *\n * datasource-init - Fired when the infinite grid model should initialize data\n *\n * @fires\n *\n * datasource-schema-updated - Fired when column metadata or defs are updated. detail: `SchemaUpdatedEventDetail`\n *\n * @fires\n *\n * datasource-data-changed - Fired when rows are delivered to the grid, a DATASERVER push changes them, or a re-read no longer returns them; `add` are rows the grid did not hold before, `update` are held rows whose content changed, `remove` carries the row id. detail: `DataChangedEventDetail`\n *\n * @fires\n *\n * set-infinite-datasource - Fired to attach or clear the infinite row model datasource. detail: `SetInfiniteDatasourceEventDetail`\n *\n * @fires\n *\n * refresh-infinite-cache - Fired to request an infinite row model refresh; `purge` drops the block cache and re-reads. detail: `RefreshInfiniteCacheEventDetail`\n *\n * @fires\n *\n * add-grid-css-class - Fired to add a CSS class on the grid host (hover sort indicators). detail: `GridCssClassEventDetail`\n *\n * @fires\n *\n * remove-grid-css-class - Fired to remove that CSS class from the grid host. detail: `GridCssClassEventDetail`\n *\n * @fires\n *\n * cache-filter-config - Fired to persist filter configuration for the grid\n *\n * @fires\n *\n * datasource-data-cleared - Fired when the grid drops every row it held (reload, filter or sort change, destroy); `includeSchema` says whether the columns went too. detail: `DataClearedEventDetail`\n *\n * @fires\n *\n * datasource-filters-restored - Fired when persisted filters are reapplied\n *\n * @see\n *\n * https://www.ag-grid.com/javascript-data-grid/infinite-scrolling/\n *\n * @beta\n */\n",
|
|
22868
22899
|
"excerptTokens": [
|
|
22869
22900
|
{
|
|
22870
22901
|
"kind": "Content",
|
|
@@ -23706,7 +23737,7 @@
|
|
|
23706
23737
|
{
|
|
23707
23738
|
"kind": "Class",
|
|
23708
23739
|
"canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource:class",
|
|
23709
|
-
"docComment": "/**\n * A Genesis Datasource element, for server-side | SSRM-compatible data fetching and used exclusively by the GridPro element.\n *\n * @remarks\n *\n * Only supports Server-Side Row Model. Requires `@ag-grid-enterprise/server-side-row-model` setup and valid AG Grid Enterprise license.\n *\n * **Supported resources**: DATASERVER resources, and REQUEST_SERVER (req/rep) resources that declare `criteriaOnlyRequest`. A req/rep resource without it reports a `resource-type` error and no datasource is attached to the grid.\n *\n * **Custom Sort Indicators**: This datasource automatically applies custom sort indicators that are always visible (instead of only on hover). Sortable columns will show a subtle sort icon even when not sorted, and active sort indicators will be more prominent. The custom styling uses AG Grid's native icon font for consistency with the grid theme.\n *\n * @fires\n *\n * base-datasource-error - Fired when a datasource error is reported. detail: `BaseDatasourceErrorEventDetail`\n *\n * @fires\n *\n * datasource-error - Fired when a datasource error occurs (for grid integration). detail: `DatasourceErrorEventDetail`\n *\n * @fires\n *\n * base-datasource-connected - Fired when error state is cleared after connection succeeds\n *\n * @fires\n *\n * datasource-loading-finished - Fired when pending stream transactions are flushed with no row changes\n *\n * @fires\n *\n * datasource-no-data-available - Fired when loading finishes with an empty row set\n *\n * @fires\n *\n * datasource-data-changed - Fired when
|
|
23740
|
+
"docComment": "/**\n * A Genesis Datasource element, for server-side | SSRM-compatible data fetching and used exclusively by the GridPro element.\n *\n * @remarks\n *\n * Only supports Server-Side Row Model. Requires `@ag-grid-enterprise/server-side-row-model` setup and valid AG Grid Enterprise license.\n *\n * **Supported resources**: DATASERVER resources, and REQUEST_SERVER (req/rep) resources that declare `criteriaOnlyRequest`. A req/rep resource without it reports a `resource-type` error and no datasource is attached to the grid.\n *\n * **Custom Sort Indicators**: This datasource automatically applies custom sort indicators that are always visible (instead of only on hover). Sortable columns will show a subtle sort icon even when not sorted, and active sort indicators will be more prominent. The custom styling uses AG Grid's native icon font for consistency with the grid theme.\n *\n * @fires\n *\n * base-datasource-error - Fired when a datasource error is reported. detail: `BaseDatasourceErrorEventDetail`\n *\n * @fires\n *\n * datasource-error - Fired when a datasource error occurs (for grid integration). detail: `DatasourceErrorEventDetail`\n *\n * @fires\n *\n * base-datasource-connected - Fired when error state is cleared after connection succeeds\n *\n * @fires\n *\n * datasource-loading-finished - Fired when pending stream transactions are flushed with no row changes\n *\n * @fires\n *\n * datasource-no-data-available - Fired when loading finishes with an empty row set\n *\n * @fires\n *\n * datasource-data-changed - Fired when rows are delivered to the grid, a live stream pushes a change, a poll detects one, or a re-read no longer returns a row; `add` are rows the grid did not hold before, `update` are held rows whose content changed, `remove` carries the row id. detail: `DataChangedEventDetail`\n *\n * @fires\n *\n * cache-filter-config - Fired to persist filter configuration for the grid\n *\n * @fires\n *\n * refresh-server-side - Fired to request a server-side refresh. detail: `RefreshServerSideEventDetail`\n *\n * @fires\n *\n * set-server-side-datasource - Fired to attach or clear the server-side row model datasource\n *\n * @fires\n *\n * datasource-loading-started - Fired when a server-side load cycle starts\n *\n * @fires\n *\n * add-grid-css-class - Fired to add a CSS class on the grid host (e.g. server-side styling). detail: `GridCssClassEventDetail`\n *\n * @fires\n *\n * remove-grid-css-class - Fired to remove a CSS class from the grid host. detail: `GridCssClassEventDetail`\n *\n * @fires\n *\n * datasource-initialize - Fired to hand off server-side grid options. detail: `InitializeEventDetail`\n *\n * @fires\n *\n * datasource-init - Fired when the server-side grid model should initialize data\n *\n * @fires\n *\n * datasource-schema-updated - Fired when column metadata or defs are updated. detail: `SchemaUpdatedEventDetail`\n *\n * @fires\n *\n * datasource-filters-restored - Fired when persisted filters are reapplied\n *\n * @fires\n *\n * datasource-data-cleared - Fired when the grid drops every row it held (reload, filter or sort change, destroy); `includeSchema` says whether the columns went too. detail: `DataClearedEventDetail`\n *\n * @fires\n *\n * apply-server-side-transaction - Fired to apply a server-side row transaction\n *\n * @fires\n *\n * datasource-ready - Fired when the host grid is ready to start loading data\n *\n * @beta\n */\n",
|
|
23710
23741
|
"excerptTokens": [
|
|
23711
23742
|
{
|
|
23712
23743
|
"kind": "Content",
|
|
@@ -24233,37 +24264,6 @@
|
|
|
24233
24264
|
"isOptional": false,
|
|
24234
24265
|
"isAbstract": false,
|
|
24235
24266
|
"name": "restart"
|
|
24236
|
-
},
|
|
24237
|
-
{
|
|
24238
|
-
"kind": "Property",
|
|
24239
|
-
"canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource#serializer:member",
|
|
24240
|
-
"docComment": "",
|
|
24241
|
-
"excerptTokens": [
|
|
24242
|
-
{
|
|
24243
|
-
"kind": "Content",
|
|
24244
|
-
"text": "serializer: "
|
|
24245
|
-
},
|
|
24246
|
-
{
|
|
24247
|
-
"kind": "Reference",
|
|
24248
|
-
"text": "JSONSerializer",
|
|
24249
|
-
"canonicalReference": "@genesislcap/foundation-utils!JSONSerializer:interface"
|
|
24250
|
-
},
|
|
24251
|
-
{
|
|
24252
|
-
"kind": "Content",
|
|
24253
|
-
"text": ";"
|
|
24254
|
-
}
|
|
24255
|
-
],
|
|
24256
|
-
"isReadonly": false,
|
|
24257
|
-
"isOptional": false,
|
|
24258
|
-
"releaseTag": "Beta",
|
|
24259
|
-
"name": "serializer",
|
|
24260
|
-
"propertyTypeTokenRange": {
|
|
24261
|
-
"startIndex": 1,
|
|
24262
|
-
"endIndex": 2
|
|
24263
|
-
},
|
|
24264
|
-
"isStatic": false,
|
|
24265
|
-
"isProtected": false,
|
|
24266
|
-
"isAbstract": false
|
|
24267
24267
|
}
|
|
24268
24268
|
],
|
|
24269
24269
|
"extendsTokenRange": {
|
|
@@ -33344,7 +33344,7 @@
|
|
|
33344
33344
|
},
|
|
33345
33345
|
{
|
|
33346
33346
|
"kind": "Content",
|
|
33347
|
-
"text": "<void>;\n errorHandlerFunc?: (message: string, type: string) => void;\n onNoDataAvailableFunc?: () => void;\n onDataAvailableFunc?: () => void;\n resourceName: string;\n resourceParams?: "
|
|
33347
|
+
"text": "<void>;\n errorHandlerFunc?: (message: string, type: string) => void;\n onNoDataAvailableFunc?: () => void;\n onDataAvailableFunc?: () => void;\n onRowsDeliveredFunc?: (rows: any[]) => void;\n onRowsWithdrawnFunc?: (rowIds: string[]) => void;\n onRowsEvictedFunc?: (rowIds: string[]) => void;\n maxBlocksInCache?: number;\n gridReceivesLiveUpdates?: boolean;\n resourceName: string;\n resourceParams?: "
|
|
33348
33348
|
},
|
|
33349
33349
|
{
|
|
33350
33350
|
"kind": "Reference",
|
package/dist/grid-pro.d.ts
CHANGED
|
@@ -825,8 +825,12 @@ export declare const csvExportParams: CsvExportParams;
|
|
|
825
825
|
export declare interface DataChangedEventDetail {
|
|
826
826
|
changes: {
|
|
827
827
|
add?: any[];
|
|
828
|
+
/** Row-id-only objects (`{ [rowId]: id }`) for the rows that left the grid. */
|
|
828
829
|
remove?: any[];
|
|
829
830
|
update?: any[];
|
|
831
|
+
/** Where `add` rows were inserted, as AG Grid's `RowDataTransaction.addIndex`. */
|
|
832
|
+
addIndex?: number;
|
|
833
|
+
/** @deprecated Never populated; the emitted field is `addIndex`. */
|
|
830
834
|
insertIndex?: number;
|
|
831
835
|
};
|
|
832
836
|
}
|
|
@@ -2001,12 +2005,7 @@ declare const GenesisGridDatasourceElement_base: new () => {
|
|
|
2001
2005
|
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
2002
2006
|
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
2003
2007
|
removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
2004
|
-
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options
|
|
2005
|
-
/**
|
|
2006
|
-
* 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.
|
|
2007
|
-
* @remarks DATASERVER only.
|
|
2008
|
-
*/
|
|
2009
|
-
?: boolean | EventListenerOptions): void;
|
|
2008
|
+
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
2010
2009
|
readonly attributes: NamedNodeMap;
|
|
2011
2010
|
get classList(): DOMTokenList;
|
|
2012
2011
|
set classList(value: string): any;
|
|
@@ -2071,7 +2070,15 @@ declare const GenesisGridDatasourceElement_base: new () => {
|
|
|
2071
2070
|
removeAttribute(qualifiedName: string): void;
|
|
2072
2071
|
removeAttributeNS(namespace: string | null, localName: string): void;
|
|
2073
2072
|
removeAttributeNode(attr: Attr): Attr;
|
|
2074
|
-
requestFullscreen(options
|
|
2073
|
+
requestFullscreen(options
|
|
2074
|
+
/**
|
|
2075
|
+
* Returns whether the `row-id` attribute is the default one, depending on the resource type.
|
|
2076
|
+
* @internal
|
|
2077
|
+
*/
|
|
2078
|
+
? /**
|
|
2079
|
+
* Returns whether the `row-id` attribute is the default one, depending on the resource type.
|
|
2080
|
+
* @internal
|
|
2081
|
+
*/: FullscreenOptions): Promise<void>;
|
|
2075
2082
|
requestPointerLock(options?: PointerLockOptions): Promise<void>;
|
|
2076
2083
|
scroll(options?: ScrollToOptions): void;
|
|
2077
2084
|
scroll(x: number, y: number): void;
|
|
@@ -2352,17 +2359,57 @@ declare class GenesisInfiniteDatasource implements IDatasource {
|
|
|
2352
2359
|
* Called when an unsolicited batch changes which rows exist or their order (an INSERT or a
|
|
2353
2360
|
* DELETE). The cache cannot be patched in place for those - a created row arrives at the end
|
|
2354
2361
|
* rather than in sort position, and a delete below the delivered watermark is skipped to keep
|
|
2355
|
-
* slice offsets stable - so the rows have to be re-read.
|
|
2362
|
+
* slice offsets stable - so the rows have to be re-read. Receives the pushed change so the
|
|
2363
|
+
* host can report it before the re-read.
|
|
2356
2364
|
* @internal
|
|
2357
2365
|
*/
|
|
2358
2366
|
private onRowsInvalidatedFunc?;
|
|
2359
2367
|
/**
|
|
2360
2368
|
* Called when an unsolicited batch only modified rows already held. The cache is patched in
|
|
2361
|
-
* place, so the grid just needs to re-render its blocks.
|
|
2369
|
+
* place, so the grid just needs to re-render its blocks. Receives the pushed change so the
|
|
2370
|
+
* host can report it.
|
|
2362
2371
|
* @internal
|
|
2363
2372
|
*/
|
|
2364
2373
|
private onRowsUpdatedFunc?;
|
|
2374
|
+
/**
|
|
2375
|
+
* Called with the rows just handed to AG Grid for a block, on either transport. This is the
|
|
2376
|
+
* only point at which rows leave the datasource, so it is where the host learns which rows
|
|
2377
|
+
* the grid holds (a re-read after a refresh delivers the same rows again).
|
|
2378
|
+
* @internal
|
|
2379
|
+
*/
|
|
2380
|
+
private onRowsDeliveredFunc?;
|
|
2381
|
+
/**
|
|
2382
|
+
* Called with the ids of rows a re-read of a block no longer returned: they left the grid
|
|
2383
|
+
* (deleted on the server, or moved into a block that reports them again).
|
|
2384
|
+
* @internal
|
|
2385
|
+
*/
|
|
2386
|
+
private onRowsWithdrawnFunc?;
|
|
2387
|
+
/**
|
|
2388
|
+
* Called with the ids of rows whose block the grid evicted from its cache (`maxBlocksInCache`),
|
|
2389
|
+
* so the host stops treating them as held.
|
|
2390
|
+
* @internal
|
|
2391
|
+
*/
|
|
2392
|
+
private onRowsEvictedFunc?;
|
|
2393
|
+
/**
|
|
2394
|
+
* Called when a filter or sort change drops every row the grid held, on either transport, so
|
|
2395
|
+
* the host forgets them too. AG Grid purges its own cache on those changes.
|
|
2396
|
+
* @internal
|
|
2397
|
+
*/
|
|
2398
|
+
private onRowCacheResetFunc?;
|
|
2365
2399
|
private errorHandlerFunc;
|
|
2400
|
+
/** Which rows each delivered block carried, for withdrawal and eviction reporting. @internal */
|
|
2401
|
+
private ledger;
|
|
2402
|
+
/**
|
|
2403
|
+
* Bumped whenever the rows this datasource was reading for are dropped (a teardown, or a
|
|
2404
|
+
* filter/sort change). A REQUEST_SERVER reply that resolves for an earlier generation was read
|
|
2405
|
+
* for a cache the grid no longer has.
|
|
2406
|
+
* @remarks Deliberately a generation rather than a "destroyed" flag: AG Grid calls `destroy()`
|
|
2407
|
+
* on the datasource bean it then keeps using (`InfiniteRowModel.start()` re-applies the
|
|
2408
|
+
* `datasource` grid option, and `setDatasource` destroys the previous one first), so a sticky
|
|
2409
|
+
* flag would disable the instance the grid is still driving.
|
|
2410
|
+
* @internal
|
|
2411
|
+
*/
|
|
2412
|
+
private loadGeneration;
|
|
2366
2413
|
/**
|
|
2367
2414
|
* Max time a DATASERVER block may stay pending before the safety valve resolves it with the
|
|
2368
2415
|
* rows accumulated so far.
|
|
@@ -2385,8 +2432,10 @@ declare class GenesisInfiniteDatasource implements IDatasource {
|
|
|
2385
2432
|
private dataserverStreamSubscription;
|
|
2386
2433
|
private sourceRef;
|
|
2387
2434
|
/**
|
|
2388
|
-
* Identifies the CRITERIA_MATCH/ORDER_BY the current
|
|
2389
|
-
*
|
|
2435
|
+
* Identifies the CRITERIA_MATCH/ORDER_BY the current rows were read with. A change means AG
|
|
2436
|
+
* Grid has dropped every block (it purges on filter/sort changes): on DATASERVER the
|
|
2437
|
+
* subscription has to be re-opened, as those are DATA_LOGON parameters, and on both transports
|
|
2438
|
+
* the host is told its held rows are gone.
|
|
2390
2439
|
* @internal
|
|
2391
2440
|
*/
|
|
2392
2441
|
private subscriptionKey;
|
|
@@ -2424,14 +2473,20 @@ declare class GenesisInfiniteDatasource implements IDatasource {
|
|
|
2424
2473
|
createSnapshotFunc: (params?: any) => Promise<RequestServerResult | FilteredDataServerResult>;
|
|
2425
2474
|
createDataserverStreamFunc?: (params?: any) => SocketObservable<FilteredDataServerResult>;
|
|
2426
2475
|
getMoreRowsFunc?: (sourceRef: string) => Promise<unknown>;
|
|
2427
|
-
onRowsInvalidatedFunc?: () => void;
|
|
2428
|
-
onRowsUpdatedFunc?: () => void;
|
|
2476
|
+
onRowsInvalidatedFunc?: (change: FilteredDataServerResult) => void;
|
|
2477
|
+
onRowsUpdatedFunc?: (change: FilteredDataServerResult) => void;
|
|
2478
|
+
onRowsDeliveredFunc?: (rows: any[]) => void;
|
|
2479
|
+
onRowsWithdrawnFunc?: (rowIds: string[]) => void;
|
|
2480
|
+
onRowsEvictedFunc?: (rowIds: string[]) => void;
|
|
2481
|
+
onRowCacheResetFunc?: () => void;
|
|
2429
2482
|
errorHandlerFunc: (message: string, type: string) => void;
|
|
2430
2483
|
resourceName: string;
|
|
2431
2484
|
resourceParams: any;
|
|
2432
2485
|
resourceIndexes: Map<string, string[]>;
|
|
2433
2486
|
resourceColDefs: MetadataDetail[];
|
|
2434
2487
|
maxRows: number;
|
|
2488
|
+
/** AG Grid's `maxBlocksInCache`, so eviction can be mirrored; unset keeps every block. */
|
|
2489
|
+
maxBlocksInCache?: number;
|
|
2435
2490
|
rowId: string;
|
|
2436
2491
|
baseCriteria?: string;
|
|
2437
2492
|
isRequestServer: boolean;
|
|
@@ -2468,6 +2523,14 @@ declare class GenesisInfiniteDatasource implements IDatasource {
|
|
|
2468
2523
|
* outstanding at once, and each settles as soon as the cache covers its range.
|
|
2469
2524
|
* @internal
|
|
2470
2525
|
*/
|
|
2526
|
+
/**
|
|
2527
|
+
* Notes the CRITERIA_MATCH/ORDER_BY a block is being read with. A change means AG Grid has
|
|
2528
|
+
* purged its cache and restarted from block 0: on DATASERVER the subscription is re-opened
|
|
2529
|
+
* (those are DATA_LOGON parameters), and on both transports the host is told the rows it held
|
|
2530
|
+
* are gone, so the rows read under the new filter or sort are reported as new.
|
|
2531
|
+
* @internal
|
|
2532
|
+
*/
|
|
2533
|
+
private noteRequestKey;
|
|
2471
2534
|
private getDataserverRows;
|
|
2472
2535
|
/**
|
|
2473
2536
|
* Keeps pulling batches while blocks are still waiting.
|
|
@@ -2516,6 +2579,12 @@ declare class GenesisInfiniteDatasource implements IDatasource {
|
|
|
2516
2579
|
* @internal
|
|
2517
2580
|
*/
|
|
2518
2581
|
private settleBlock;
|
|
2582
|
+
/**
|
|
2583
|
+
* Reports rows handed to the grid for a block, then the rows a re-read of that block no longer
|
|
2584
|
+
* carries and the rows whose block the grid evicted.
|
|
2585
|
+
* @internal
|
|
2586
|
+
*/
|
|
2587
|
+
private deliverRows;
|
|
2519
2588
|
/**
|
|
2520
2589
|
* Warns when the view filled up before the data ran out.
|
|
2521
2590
|
* @remarks The server stops sending at MAX_VIEW rows and reports MORE_ROWS false, which is
|
|
@@ -2541,6 +2610,13 @@ declare class GenesisInfiniteDatasource implements IDatasource {
|
|
|
2541
2610
|
* @internal
|
|
2542
2611
|
*/
|
|
2543
2612
|
private teardownDataserverSubscription;
|
|
2613
|
+
/**
|
|
2614
|
+
* Drops the subscription and the cached rows.
|
|
2615
|
+
* @remarks AG Grid calls this on the bean it then keeps using (`InfiniteRowModel.start()`
|
|
2616
|
+
* re-applies the `datasource` grid option, and `setDatasource` destroys the previous one
|
|
2617
|
+
* first), and it can land while a block request is in flight. So it must leave the datasource
|
|
2618
|
+
* able to serve that reply and the next `getRows`: it drops the subscription, not the instance.
|
|
2619
|
+
*/
|
|
2544
2620
|
destroy?(): void;
|
|
2545
2621
|
}
|
|
2546
2622
|
|
|
@@ -3606,19 +3682,78 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
3606
3682
|
}) & typeof FoundationElement;
|
|
3607
3683
|
|
|
3608
3684
|
export declare class GridProBaseDatasource extends GenesisGridDatasourceElement {
|
|
3685
|
+
serializer: JSONSerializer;
|
|
3609
3686
|
protected dataSubWasLoggedOff: boolean;
|
|
3610
3687
|
keepColDefsOnClearRowData: boolean;
|
|
3611
3688
|
rowData: Map<string, any>;
|
|
3612
3689
|
protected transactionData: TransactionData;
|
|
3690
|
+
/** So rows without a row id are warned about once per element, not once per block. @internal */
|
|
3691
|
+
private missingRowIdWarned;
|
|
3613
3692
|
protected connectionSub: Subscription | undefined;
|
|
3614
3693
|
protected subscribeToConnection(): void;
|
|
3615
3694
|
protected unsubscribeFromConnection(): void;
|
|
3616
3695
|
protected generateColumnDefsFromMetadata(fieldsMetadata: FieldMetadata[], getFilterParamsByFieldType: (field: FieldMetadata) => ColDef['filterParams'] | any, getFilterByFieldType: (type: FieldTypeEnum) => string): ColDef[];
|
|
3617
3696
|
protected handleStreamInserts(insertedRows: any[], addIndex?: number): void;
|
|
3697
|
+
/**
|
|
3698
|
+
* Resolves the id of the held row a stream row refers to.
|
|
3699
|
+
* @remarks Under a custom `row-id` a DATASERVER push may carry only the default id
|
|
3700
|
+
* (`ROW_REF`), so the held row with that default id supplies the custom one. Returns
|
|
3701
|
+
* `undefined` when neither id is present - callers skip the row rather than matching
|
|
3702
|
+
* `undefined === undefined` against the first held row.
|
|
3703
|
+
* @internal
|
|
3704
|
+
*/
|
|
3705
|
+
protected resolveRowId(row: any): string | undefined;
|
|
3618
3706
|
protected handleStreamDeletes(deletedRows: any[]): void;
|
|
3619
3707
|
protected handleStreamUpdates(updatedRows: any[]): void;
|
|
3620
3708
|
protected applyAllTransactions(): void;
|
|
3621
3709
|
private applyMappedTransaction;
|
|
3710
|
+
/**
|
|
3711
|
+
* Reports rows a block-based row model (server-side, infinite) has just handed to the grid.
|
|
3712
|
+
* Rows not held before are reported as `add`; rows already held (a block re-read after a
|
|
3713
|
+
* refresh, or a req/rep re-read after a commit or poll) are reported as `update` only when
|
|
3714
|
+
* their content changed, so a plain re-read is silent.
|
|
3715
|
+
* @remarks `rowData` mirrors the rows the grid holds: the resource reports rows a re-read no
|
|
3716
|
+
* longer returned (`reportWithdrawnRows`) and blocks the grid evicted from its cache
|
|
3717
|
+
* (`forgetRows`), and `clearRowData` empties it when the grid drops its cache.
|
|
3718
|
+
* @internal
|
|
3719
|
+
*/
|
|
3720
|
+
protected reportDeliveredRows(rows: any[]): void;
|
|
3721
|
+
/**
|
|
3722
|
+
* Reports rows a block re-read no longer returned: they left the grid (deleted on the server,
|
|
3723
|
+
* or moved into a block that reports them again). Rows already reported removed - a DATASERVER
|
|
3724
|
+
* push, say - are skipped.
|
|
3725
|
+
* @internal
|
|
3726
|
+
*/
|
|
3727
|
+
protected reportWithdrawnRows(rowIds: string[]): void;
|
|
3728
|
+
/**
|
|
3729
|
+
* Forgets rows the grid evicted from its block cache. They still exist on the server, so
|
|
3730
|
+
* nothing is emitted; a later re-read reports them as `add`, as the grid did not hold them.
|
|
3731
|
+
* @internal
|
|
3732
|
+
*/
|
|
3733
|
+
protected forgetRows(rowIds: string[]): void;
|
|
3734
|
+
/**
|
|
3735
|
+
* Starts a fresh transaction and returns it, so a caller can keep working on the object it
|
|
3736
|
+
* built even if a consumer's `datasource-data-changed` handler resets the element meanwhile.
|
|
3737
|
+
* @internal
|
|
3738
|
+
*/
|
|
3739
|
+
protected resetTransaction(): TransactionData & {
|
|
3740
|
+
add: any[];
|
|
3741
|
+
remove: any[];
|
|
3742
|
+
update: any[];
|
|
3743
|
+
};
|
|
3744
|
+
/**
|
|
3745
|
+
* Whether two versions of a row differ in content. Identity and a key-order-insensitive
|
|
3746
|
+
* field comparison come first, so a re-read of unchanged rows costs no serialization; nested
|
|
3747
|
+
* values fall back to the serializer.
|
|
3748
|
+
* @internal
|
|
3749
|
+
*/
|
|
3750
|
+
protected hasRowContentChanged(known: any, row: any): boolean;
|
|
3751
|
+
/** Emits `datasource-data-changed` for `transaction` when it is non-empty. @internal */
|
|
3752
|
+
protected emitTransaction(transaction: TransactionData | undefined): void;
|
|
3753
|
+
/** Emits `datasource-data-changed` for the current transaction when it is non-empty. @internal */
|
|
3754
|
+
protected emitPendingTransaction(): void;
|
|
3755
|
+
/** @internal */
|
|
3756
|
+
private warnMissingRowIdOnce;
|
|
3622
3757
|
/**
|
|
3623
3758
|
* Builds the index map used for server-side sorting from the resource's metadata.
|
|
3624
3759
|
* @remarks Real DATASERVER indexes keep their names; when the resource also (or only) reports
|
|
@@ -3863,6 +3998,12 @@ export declare class GridProBeta extends GridProBeta_base {
|
|
|
3863
3998
|
* @internal
|
|
3864
3999
|
*/
|
|
3865
4000
|
private handleDataChanged;
|
|
4001
|
+
/**
|
|
4002
|
+
* Whether the live grid runs AG Grid's client-side row model (the default when the datasource
|
|
4003
|
+
* set no `rowModelType`).
|
|
4004
|
+
* @internal
|
|
4005
|
+
*/
|
|
4006
|
+
private get isClientSideRowModel();
|
|
3866
4007
|
private flashAddedCells;
|
|
3867
4008
|
/**
|
|
3868
4009
|
* Handles schema updates from datasource
|
|
@@ -5746,12 +5887,13 @@ export declare const gridProGenesisDatasourceEventNames: {
|
|
|
5746
5887
|
* @fires datasource-initialize - Fired to hand off infinite row model grid options. detail: `InitializeEventDetail`
|
|
5747
5888
|
* @fires datasource-init - Fired when the infinite grid model should initialize data
|
|
5748
5889
|
* @fires datasource-schema-updated - Fired when column metadata or defs are updated. detail: `SchemaUpdatedEventDetail`
|
|
5890
|
+
* @fires datasource-data-changed - Fired when rows are delivered to the grid, a DATASERVER push changes them, or a re-read no longer returns them; `add` are rows the grid did not hold before, `update` are held rows whose content changed, `remove` carries the row id. detail: `DataChangedEventDetail`
|
|
5749
5891
|
* @fires set-infinite-datasource - Fired to attach or clear the infinite row model datasource. detail: `SetInfiniteDatasourceEventDetail`
|
|
5750
5892
|
* @fires refresh-infinite-cache - Fired to request an infinite row model refresh; `purge` drops the block cache and re-reads. detail: `RefreshInfiniteCacheEventDetail`
|
|
5751
5893
|
* @fires add-grid-css-class - Fired to add a CSS class on the grid host (hover sort indicators). detail: `GridCssClassEventDetail`
|
|
5752
5894
|
* @fires remove-grid-css-class - Fired to remove that CSS class from the grid host. detail: `GridCssClassEventDetail`
|
|
5753
5895
|
* @fires cache-filter-config - Fired to persist filter configuration for the grid
|
|
5754
|
-
* @fires datasource-data-cleared - Fired when
|
|
5896
|
+
* @fires datasource-data-cleared - Fired when the grid drops every row it held (reload, filter or sort change, destroy); `includeSchema` says whether the columns went too. detail: `DataClearedEventDetail`
|
|
5755
5897
|
* @fires datasource-filters-restored - Fired when persisted filters are reapplied
|
|
5756
5898
|
*/
|
|
5757
5899
|
export declare class GridProInfiniteDatasource extends GridProInfiniteDatasource_base {
|
|
@@ -5763,6 +5905,8 @@ export declare class GridProInfiniteDatasource extends GridProInfiniteDatasource
|
|
|
5763
5905
|
private infiniteDatasource;
|
|
5764
5906
|
/** Unsubscribes the commit-response listener behind `pollTriggerEvents`. @internal */
|
|
5765
5907
|
private commitResponseUnsubscribe?;
|
|
5908
|
+
/** The `maxBlocksInCache` the grid was initialised with, so eviction can be mirrored. @internal */
|
|
5909
|
+
private maxBlocksInCache?;
|
|
5766
5910
|
resourceNameChanged(oldValue: string, newValue: string): void;
|
|
5767
5911
|
criteriaChanged(oldCriteria: string, newCriteria: string): void;
|
|
5768
5912
|
connectedCallback(): void;
|
|
@@ -5779,8 +5923,37 @@ export declare class GridProInfiniteDatasource extends GridProInfiniteDatasource
|
|
|
5779
5923
|
private clearReadyListener;
|
|
5780
5924
|
/** @internal */
|
|
5781
5925
|
private onDatasourceReady;
|
|
5926
|
+
/**
|
|
5927
|
+
* A pushed INSERT/DELETE changes which rows exist or their order, so the change is reported
|
|
5928
|
+
* and then the rows are re-read (purge).
|
|
5929
|
+
* @internal
|
|
5930
|
+
*/
|
|
5931
|
+
private handleLiveRowsInvalidated;
|
|
5932
|
+
/**
|
|
5933
|
+
* A pushed MODIFY is already patched into the paging cache, so the change is reported and the
|
|
5934
|
+
* grid only needs to re-render its blocks.
|
|
5935
|
+
* @internal
|
|
5936
|
+
*/
|
|
5937
|
+
private handleLiveRowsUpdated;
|
|
5938
|
+
/**
|
|
5939
|
+
* Turns a DATASERVER push into the same transaction the client-side datasource reports:
|
|
5940
|
+
* inserts of held rows become updates, partial MODIFY rows are merged into the held row, and
|
|
5941
|
+
* a remove carries just the row id.
|
|
5942
|
+
* @remarks Unlike the client-side model, a pushed row need not be held here - it may sit
|
|
5943
|
+
* beyond the loaded blocks. A MODIFY for such a row is not reported (the block that delivers
|
|
5944
|
+
* it reports it as `add`); a DELETE is reported by the id it carries, and one that cannot be
|
|
5945
|
+
* resolved to an id is skipped with a warning rather than matched against the wrong row.
|
|
5946
|
+
* @internal
|
|
5947
|
+
*/
|
|
5948
|
+
private reportLiveChange;
|
|
5782
5949
|
destroy(): Promise<void>;
|
|
5783
5950
|
restart(): Promise<void>;
|
|
5951
|
+
/**
|
|
5952
|
+
* Forgets every held row and tells consumers, as the client-side datasource does: the grid is
|
|
5953
|
+
* dropping its rows (a reload, a filter or sort change, or teardown). `withColumnDefs` also
|
|
5954
|
+
* clears the column definitions.
|
|
5955
|
+
* @internal
|
|
5956
|
+
*/
|
|
5784
5957
|
private clearRowData;
|
|
5785
5958
|
/**
|
|
5786
5959
|
* Honours `pollTriggerEvents` without polling: a commit ACK for one of the listed events
|
|
@@ -6217,7 +6390,7 @@ export declare enum GridProRendererTypes {
|
|
|
6217
6390
|
* @fires base-datasource-connected - Fired when error state is cleared after connection succeeds
|
|
6218
6391
|
* @fires datasource-loading-finished - Fired when pending stream transactions are flushed with no row changes
|
|
6219
6392
|
* @fires datasource-no-data-available - Fired when loading finishes with an empty row set
|
|
6220
|
-
* @fires datasource-data-changed - Fired when
|
|
6393
|
+
* @fires datasource-data-changed - Fired when rows are delivered to the grid, a live stream pushes a change, a poll detects one, or a re-read no longer returns a row; `add` are rows the grid did not hold before, `update` are held rows whose content changed, `remove` carries the row id. detail: `DataChangedEventDetail`
|
|
6221
6394
|
* @fires cache-filter-config - Fired to persist filter configuration for the grid
|
|
6222
6395
|
* @fires refresh-server-side - Fired to request a server-side refresh. detail: `RefreshServerSideEventDetail`
|
|
6223
6396
|
* @fires set-server-side-datasource - Fired to attach or clear the server-side row model datasource
|
|
@@ -6228,13 +6401,18 @@ export declare enum GridProRendererTypes {
|
|
|
6228
6401
|
* @fires datasource-init - Fired when the server-side grid model should initialize data
|
|
6229
6402
|
* @fires datasource-schema-updated - Fired when column metadata or defs are updated. detail: `SchemaUpdatedEventDetail`
|
|
6230
6403
|
* @fires datasource-filters-restored - Fired when persisted filters are reapplied
|
|
6231
|
-
* @fires datasource-data-cleared - Fired when
|
|
6404
|
+
* @fires datasource-data-cleared - Fired when the grid drops every row it held (reload, filter or sort change, destroy); `includeSchema` says whether the columns went too. detail: `DataClearedEventDetail`
|
|
6232
6405
|
* @fires apply-server-side-transaction - Fired to apply a server-side row transaction
|
|
6233
6406
|
* @fires datasource-ready - Fired when the host grid is ready to start loading data
|
|
6234
6407
|
*/
|
|
6235
6408
|
export declare class GridProServerSideDatasource extends GridProServerSideDatasource_base {
|
|
6236
|
-
serializer: JSONSerializer;
|
|
6237
6409
|
pollingDatasource: Datasource;
|
|
6410
|
+
/**
|
|
6411
|
+
* The `maxBlocksInCache` the consumer gave the grid, if any, so block eviction can be mirrored
|
|
6412
|
+
* in the held-row bookkeeping. The server-side defaults set none, so AG Grid keeps every block.
|
|
6413
|
+
* @internal
|
|
6414
|
+
*/
|
|
6415
|
+
private get gridMaxBlocksInCache();
|
|
6238
6416
|
/**
|
|
6239
6417
|
* Enable live updates for the grid.
|
|
6240
6418
|
* @remarks Only works with DATASERVER resources (StreamDatasource) right now.
|
|
@@ -6270,6 +6448,12 @@ export declare class GridProServerSideDatasource extends GridProServerSideDataso
|
|
|
6270
6448
|
private onDatasourceReady;
|
|
6271
6449
|
destroy(): Promise<void>;
|
|
6272
6450
|
restart(): Promise<void>;
|
|
6451
|
+
/**
|
|
6452
|
+
* Forgets every held row and tells consumers, as the client-side datasource does: the grid is
|
|
6453
|
+
* dropping its rows (a reload, a filter or sort change, or teardown). `withColumnDefs` also
|
|
6454
|
+
* clears the column definitions.
|
|
6455
|
+
* @internal
|
|
6456
|
+
*/
|
|
6273
6457
|
private clearRowData;
|
|
6274
6458
|
/**
|
|
6275
6459
|
* Checks whether the resolved resource can be served through the Server-Side Row Model.
|
|
@@ -8148,6 +8332,33 @@ export declare type ServerSideDatasourceOptions = {
|
|
|
8148
8332
|
onNoDataAvailableFunc?: () => void;
|
|
8149
8333
|
/** Called when a server-side load finishes with one or more rows. */
|
|
8150
8334
|
onDataAvailableFunc?: () => void;
|
|
8335
|
+
/**
|
|
8336
|
+
* Called with the rows just handed to AG Grid for a block. This is the only point at which
|
|
8337
|
+
* rows leave the datasource, so it is where the host learns which rows the grid holds.
|
|
8338
|
+
*/
|
|
8339
|
+
onRowsDeliveredFunc?: (rows: any[]) => void;
|
|
8340
|
+
/**
|
|
8341
|
+
* Called with the ids of rows a re-read of a block no longer returned - they left the grid
|
|
8342
|
+
* (deleted on the server, or moved to a block that reports them again).
|
|
8343
|
+
*/
|
|
8344
|
+
onRowsWithdrawnFunc?: (rowIds: string[]) => void;
|
|
8345
|
+
/**
|
|
8346
|
+
* Called with the ids of rows whose block AG Grid evicted from its cache (`maxBlocksInCache`),
|
|
8347
|
+
* so the host stops treating them as held. Nothing changed on the server.
|
|
8348
|
+
*/
|
|
8349
|
+
onRowsEvictedFunc?: (rowIds: string[]) => void;
|
|
8350
|
+
/**
|
|
8351
|
+
* AG Grid's `maxBlocksInCache`, when the consumer set one, so the datasource can mirror the
|
|
8352
|
+
* grid's block eviction. Unset means the grid keeps every block.
|
|
8353
|
+
*/
|
|
8354
|
+
maxBlocksInCache?: number;
|
|
8355
|
+
/**
|
|
8356
|
+
* Whether the host applies pushed INSERTs and DELETEs to the grid as transactions
|
|
8357
|
+
* (`live-updates`). The paging subscription receives every push either way; this decides
|
|
8358
|
+
* whether the row cache mirrors the grid's re-indexing or treats the grid as a snapshot that
|
|
8359
|
+
* only a refresh brings up to date.
|
|
8360
|
+
*/
|
|
8361
|
+
gridReceivesLiveUpdates?: boolean;
|
|
8151
8362
|
resourceName: string;
|
|
8152
8363
|
resourceParams?: DataserverParams | RequestParams;
|
|
8153
8364
|
resourceIndexes?: Map<string, string[]>;
|