@genesislcap/grid-pro 15.97.0 → 15.98.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/custom-elements.json +4345 -2867
- package/dist/dts/datasource/cube.block-loads.d.ts +29 -0
- package/dist/dts/datasource/cube.block-loads.d.ts.map +1 -0
- package/dist/dts/datasource/cube.client.d.ts +50 -0
- package/dist/dts/datasource/cube.client.d.ts.map +1 -0
- package/dist/dts/datasource/cube.request.d.ts +99 -0
- package/dist/dts/datasource/cube.request.d.ts.map +1 -0
- package/dist/dts/datasource/cube.source.d.ts +43 -0
- package/dist/dts/datasource/cube.source.d.ts.map +1 -0
- package/dist/dts/datasource/infinite.datasource.d.ts +39 -3
- package/dist/dts/datasource/infinite.datasource.d.ts.map +1 -1
- package/dist/dts/datasource/infinite.resource-cube.d.ts +22 -0
- package/dist/dts/datasource/infinite.resource-cube.d.ts.map +1 -0
- package/dist/dts/datasource/server-side.datasource.d.ts +49 -1
- package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
- package/dist/dts/datasource/server-side.resource-cube.d.ts +21 -0
- package/dist/dts/datasource/server-side.resource-cube.d.ts.map +1 -0
- package/dist/dts/grid-pro-genesis-datasource/datasource-events.types.d.ts +2 -1
- package/dist/dts/grid-pro-genesis-datasource/datasource-events.types.d.ts.map +1 -1
- package/dist/dts/react.d.ts +9 -9
- package/dist/esm/datasource/cube.block-loads.js +48 -0
- package/dist/esm/datasource/cube.client.js +144 -0
- package/dist/esm/datasource/cube.request.js +165 -0
- package/dist/esm/datasource/cube.source.js +73 -0
- package/dist/esm/datasource/infinite.datasource.js +157 -24
- package/dist/esm/datasource/infinite.resource-cube.js +56 -0
- package/dist/esm/datasource/server-side.datasource.js +197 -23
- package/dist/esm/datasource/server-side.resource-cube.js +58 -0
- package/dist/grid-pro.api.json +510 -3
- package/dist/grid-pro.d.ts +139 -3
- package/dist/react.cjs +6 -6
- package/dist/react.mjs +5 -5
- package/package.json +12 -12
package/dist/grid-pro.api.json
CHANGED
|
@@ -23184,7 +23184,7 @@
|
|
|
23184
23184
|
{
|
|
23185
23185
|
"kind": "Class",
|
|
23186
23186
|
"canonicalReference": "@genesislcap/grid-pro!GridProInfiniteDatasource:class",
|
|
23187
|
-
"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-loading-finished - Fired when the first block comes back with rows\n *\n * @fires\n *\n * datasource-no-data-available - Fired when the first block comes back empty\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",
|
|
23187
|
+
"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 * **Genesis Spring data cubes**: with `cube-url` set, `resource-name` names a cube resource read over HTTP from that URL: its `query` endpoint as flat rows, or the named `cube-operation`. Filtering, sorting (on several columns) and paging run on the cube; `criteria` restricts every request and `order-by` takes a cube sort such as `-price,name` for a grid that is not sorted. Rows are read on demand, and re-read on a commit ACK for an event in `pollTriggerEvents`. The Genesis stream attributes (`is-snapshot`, `max-view`, `reverse`, `request`) do not apply. Rows that carry no id - a resource that is not `addressable`, or a named operation whose rows have no `ROW_REF`, with no `row-id` set - are identified by position and raise no `datasource-data-changed`.\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-loading-finished - Fired when the first block comes back with rows\n *\n * @fires\n *\n * datasource-no-data-available - Fired when the first block comes back empty\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",
|
|
23188
23188
|
"excerptTokens": [
|
|
23189
23189
|
{
|
|
23190
23190
|
"kind": "Content",
|
|
@@ -23363,6 +23363,194 @@
|
|
|
23363
23363
|
"isAbstract": false,
|
|
23364
23364
|
"name": "criteriaChanged"
|
|
23365
23365
|
},
|
|
23366
|
+
{
|
|
23367
|
+
"kind": "Property",
|
|
23368
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProInfiniteDatasource#cubeOperation:member",
|
|
23369
|
+
"docComment": "/**\n * A named cube operation to read instead of the cube resource's `query` endpoint.\n *\n * @remarks\n *\n * Only applies with `cube-url`. Its columns offer no filters, because its schema does not say which columns it accepts filters on; `criteria` still applies.\n */\n",
|
|
23370
|
+
"excerptTokens": [
|
|
23371
|
+
{
|
|
23372
|
+
"kind": "Content",
|
|
23373
|
+
"text": "cubeOperation: "
|
|
23374
|
+
},
|
|
23375
|
+
{
|
|
23376
|
+
"kind": "Content",
|
|
23377
|
+
"text": "string"
|
|
23378
|
+
},
|
|
23379
|
+
{
|
|
23380
|
+
"kind": "Content",
|
|
23381
|
+
"text": ";"
|
|
23382
|
+
}
|
|
23383
|
+
],
|
|
23384
|
+
"isReadonly": false,
|
|
23385
|
+
"isOptional": false,
|
|
23386
|
+
"releaseTag": "Beta",
|
|
23387
|
+
"name": "cubeOperation",
|
|
23388
|
+
"propertyTypeTokenRange": {
|
|
23389
|
+
"startIndex": 1,
|
|
23390
|
+
"endIndex": 2
|
|
23391
|
+
},
|
|
23392
|
+
"isStatic": false,
|
|
23393
|
+
"isProtected": false,
|
|
23394
|
+
"isAbstract": false
|
|
23395
|
+
},
|
|
23396
|
+
{
|
|
23397
|
+
"kind": "Method",
|
|
23398
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProInfiniteDatasource#cubeOperationChanged:member(1)",
|
|
23399
|
+
"docComment": "",
|
|
23400
|
+
"excerptTokens": [
|
|
23401
|
+
{
|
|
23402
|
+
"kind": "Content",
|
|
23403
|
+
"text": "cubeOperationChanged(oldValue: "
|
|
23404
|
+
},
|
|
23405
|
+
{
|
|
23406
|
+
"kind": "Content",
|
|
23407
|
+
"text": "string"
|
|
23408
|
+
},
|
|
23409
|
+
{
|
|
23410
|
+
"kind": "Content",
|
|
23411
|
+
"text": ", newValue: "
|
|
23412
|
+
},
|
|
23413
|
+
{
|
|
23414
|
+
"kind": "Content",
|
|
23415
|
+
"text": "string"
|
|
23416
|
+
},
|
|
23417
|
+
{
|
|
23418
|
+
"kind": "Content",
|
|
23419
|
+
"text": "): "
|
|
23420
|
+
},
|
|
23421
|
+
{
|
|
23422
|
+
"kind": "Content",
|
|
23423
|
+
"text": "void"
|
|
23424
|
+
},
|
|
23425
|
+
{
|
|
23426
|
+
"kind": "Content",
|
|
23427
|
+
"text": ";"
|
|
23428
|
+
}
|
|
23429
|
+
],
|
|
23430
|
+
"isStatic": false,
|
|
23431
|
+
"returnTypeTokenRange": {
|
|
23432
|
+
"startIndex": 5,
|
|
23433
|
+
"endIndex": 6
|
|
23434
|
+
},
|
|
23435
|
+
"releaseTag": "Beta",
|
|
23436
|
+
"isProtected": false,
|
|
23437
|
+
"overloadIndex": 1,
|
|
23438
|
+
"parameters": [
|
|
23439
|
+
{
|
|
23440
|
+
"parameterName": "oldValue",
|
|
23441
|
+
"parameterTypeTokenRange": {
|
|
23442
|
+
"startIndex": 1,
|
|
23443
|
+
"endIndex": 2
|
|
23444
|
+
},
|
|
23445
|
+
"isOptional": false
|
|
23446
|
+
},
|
|
23447
|
+
{
|
|
23448
|
+
"parameterName": "newValue",
|
|
23449
|
+
"parameterTypeTokenRange": {
|
|
23450
|
+
"startIndex": 3,
|
|
23451
|
+
"endIndex": 4
|
|
23452
|
+
},
|
|
23453
|
+
"isOptional": false
|
|
23454
|
+
}
|
|
23455
|
+
],
|
|
23456
|
+
"isOptional": false,
|
|
23457
|
+
"isAbstract": false,
|
|
23458
|
+
"name": "cubeOperationChanged"
|
|
23459
|
+
},
|
|
23460
|
+
{
|
|
23461
|
+
"kind": "Property",
|
|
23462
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProInfiniteDatasource#cubeUrl:member",
|
|
23463
|
+
"docComment": "/**\n * The base URL of a Genesis Spring data cube API, such as `/gwf/my-spring-app/api/v1/cubes`.\n *\n * @remarks\n *\n * When set, `resource-name` names a cube resource on it rather than a Genesis resource.\n */\n",
|
|
23464
|
+
"excerptTokens": [
|
|
23465
|
+
{
|
|
23466
|
+
"kind": "Content",
|
|
23467
|
+
"text": "cubeUrl: "
|
|
23468
|
+
},
|
|
23469
|
+
{
|
|
23470
|
+
"kind": "Content",
|
|
23471
|
+
"text": "string"
|
|
23472
|
+
},
|
|
23473
|
+
{
|
|
23474
|
+
"kind": "Content",
|
|
23475
|
+
"text": ";"
|
|
23476
|
+
}
|
|
23477
|
+
],
|
|
23478
|
+
"isReadonly": false,
|
|
23479
|
+
"isOptional": false,
|
|
23480
|
+
"releaseTag": "Beta",
|
|
23481
|
+
"name": "cubeUrl",
|
|
23482
|
+
"propertyTypeTokenRange": {
|
|
23483
|
+
"startIndex": 1,
|
|
23484
|
+
"endIndex": 2
|
|
23485
|
+
},
|
|
23486
|
+
"isStatic": false,
|
|
23487
|
+
"isProtected": false,
|
|
23488
|
+
"isAbstract": false
|
|
23489
|
+
},
|
|
23490
|
+
{
|
|
23491
|
+
"kind": "Method",
|
|
23492
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProInfiniteDatasource#cubeUrlChanged:member(1)",
|
|
23493
|
+
"docComment": "",
|
|
23494
|
+
"excerptTokens": [
|
|
23495
|
+
{
|
|
23496
|
+
"kind": "Content",
|
|
23497
|
+
"text": "cubeUrlChanged(oldValue: "
|
|
23498
|
+
},
|
|
23499
|
+
{
|
|
23500
|
+
"kind": "Content",
|
|
23501
|
+
"text": "string"
|
|
23502
|
+
},
|
|
23503
|
+
{
|
|
23504
|
+
"kind": "Content",
|
|
23505
|
+
"text": ", newValue: "
|
|
23506
|
+
},
|
|
23507
|
+
{
|
|
23508
|
+
"kind": "Content",
|
|
23509
|
+
"text": "string"
|
|
23510
|
+
},
|
|
23511
|
+
{
|
|
23512
|
+
"kind": "Content",
|
|
23513
|
+
"text": "): "
|
|
23514
|
+
},
|
|
23515
|
+
{
|
|
23516
|
+
"kind": "Content",
|
|
23517
|
+
"text": "void"
|
|
23518
|
+
},
|
|
23519
|
+
{
|
|
23520
|
+
"kind": "Content",
|
|
23521
|
+
"text": ";"
|
|
23522
|
+
}
|
|
23523
|
+
],
|
|
23524
|
+
"isStatic": false,
|
|
23525
|
+
"returnTypeTokenRange": {
|
|
23526
|
+
"startIndex": 5,
|
|
23527
|
+
"endIndex": 6
|
|
23528
|
+
},
|
|
23529
|
+
"releaseTag": "Beta",
|
|
23530
|
+
"isProtected": false,
|
|
23531
|
+
"overloadIndex": 1,
|
|
23532
|
+
"parameters": [
|
|
23533
|
+
{
|
|
23534
|
+
"parameterName": "oldValue",
|
|
23535
|
+
"parameterTypeTokenRange": {
|
|
23536
|
+
"startIndex": 1,
|
|
23537
|
+
"endIndex": 2
|
|
23538
|
+
},
|
|
23539
|
+
"isOptional": false
|
|
23540
|
+
},
|
|
23541
|
+
{
|
|
23542
|
+
"parameterName": "newValue",
|
|
23543
|
+
"parameterTypeTokenRange": {
|
|
23544
|
+
"startIndex": 3,
|
|
23545
|
+
"endIndex": 4
|
|
23546
|
+
},
|
|
23547
|
+
"isOptional": false
|
|
23548
|
+
}
|
|
23549
|
+
],
|
|
23550
|
+
"isOptional": false,
|
|
23551
|
+
"isAbstract": false,
|
|
23552
|
+
"name": "cubeUrlChanged"
|
|
23553
|
+
},
|
|
23366
23554
|
{
|
|
23367
23555
|
"kind": "Property",
|
|
23368
23556
|
"canonicalReference": "@genesislcap/grid-pro!GridProInfiniteDatasource#datasource:member",
|
|
@@ -23493,6 +23681,37 @@
|
|
|
23493
23681
|
"isAbstract": false,
|
|
23494
23682
|
"name": "disconnectedCallback"
|
|
23495
23683
|
},
|
|
23684
|
+
{
|
|
23685
|
+
"kind": "Property",
|
|
23686
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProInfiniteDatasource#http:member",
|
|
23687
|
+
"docComment": "",
|
|
23688
|
+
"excerptTokens": [
|
|
23689
|
+
{
|
|
23690
|
+
"kind": "Content",
|
|
23691
|
+
"text": "http: "
|
|
23692
|
+
},
|
|
23693
|
+
{
|
|
23694
|
+
"kind": "Reference",
|
|
23695
|
+
"text": "Http",
|
|
23696
|
+
"canonicalReference": "@genesislcap/foundation-comms!Http:interface"
|
|
23697
|
+
},
|
|
23698
|
+
{
|
|
23699
|
+
"kind": "Content",
|
|
23700
|
+
"text": ";"
|
|
23701
|
+
}
|
|
23702
|
+
],
|
|
23703
|
+
"isReadonly": false,
|
|
23704
|
+
"isOptional": false,
|
|
23705
|
+
"releaseTag": "Beta",
|
|
23706
|
+
"name": "http",
|
|
23707
|
+
"propertyTypeTokenRange": {
|
|
23708
|
+
"startIndex": 1,
|
|
23709
|
+
"endIndex": 2
|
|
23710
|
+
},
|
|
23711
|
+
"isStatic": false,
|
|
23712
|
+
"isProtected": false,
|
|
23713
|
+
"isAbstract": false
|
|
23714
|
+
},
|
|
23496
23715
|
{
|
|
23497
23716
|
"kind": "Method",
|
|
23498
23717
|
"canonicalReference": "@genesislcap/grid-pro!GridProInfiniteDatasource#init:member(1)",
|
|
@@ -23725,6 +23944,36 @@
|
|
|
23725
23944
|
"isOptional": false,
|
|
23726
23945
|
"isAbstract": false,
|
|
23727
23946
|
"name": "restart"
|
|
23947
|
+
},
|
|
23948
|
+
{
|
|
23949
|
+
"kind": "Property",
|
|
23950
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProInfiniteDatasource#rowId:member",
|
|
23951
|
+
"docComment": "",
|
|
23952
|
+
"excerptTokens": [
|
|
23953
|
+
{
|
|
23954
|
+
"kind": "Content",
|
|
23955
|
+
"text": "protected get rowId(): "
|
|
23956
|
+
},
|
|
23957
|
+
{
|
|
23958
|
+
"kind": "Content",
|
|
23959
|
+
"text": "string"
|
|
23960
|
+
},
|
|
23961
|
+
{
|
|
23962
|
+
"kind": "Content",
|
|
23963
|
+
"text": ";"
|
|
23964
|
+
}
|
|
23965
|
+
],
|
|
23966
|
+
"isReadonly": true,
|
|
23967
|
+
"isOptional": false,
|
|
23968
|
+
"releaseTag": "Beta",
|
|
23969
|
+
"name": "rowId",
|
|
23970
|
+
"propertyTypeTokenRange": {
|
|
23971
|
+
"startIndex": 1,
|
|
23972
|
+
"endIndex": 2
|
|
23973
|
+
},
|
|
23974
|
+
"isStatic": false,
|
|
23975
|
+
"isProtected": true,
|
|
23976
|
+
"isAbstract": false
|
|
23728
23977
|
}
|
|
23729
23978
|
],
|
|
23730
23979
|
"extendsTokenRange": {
|
|
@@ -26679,7 +26928,7 @@
|
|
|
26679
26928
|
{
|
|
26680
26929
|
"kind": "Class",
|
|
26681
26930
|
"canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource:class",
|
|
26682
|
-
"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",
|
|
26931
|
+
"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 * **Genesis Spring data cubes**: with `cube-url` set, `resource-name` names a cube resource read over HTTP from that URL: its `query` endpoint, or the named `cube-operation`. Filtering, sorting and paging run on the cube, and on the `query` endpoint row grouping and value aggregation do too; `criteria` restricts every request. The Genesis stream attributes (`live-updates`, polling, `is-snapshot`, `order-by`, `request`) do not apply. Row grouping also requires the AG Grid Enterprise `RowGroupingModule`, and is not offered on date and datetime columns: a request that groups by one is refused and reported as a datasource error. Rows that carry no id - a resource that is not `addressable`, or a named operation whose rows have no `ROW_REF`, with no `row-id` set - get AG Grid's own row ids and raise no `datasource-data-changed`.\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",
|
|
26683
26932
|
"excerptTokens": [
|
|
26684
26933
|
{
|
|
26685
26934
|
"kind": "Content",
|
|
@@ -26796,6 +27045,194 @@
|
|
|
26796
27045
|
"isAbstract": false,
|
|
26797
27046
|
"name": "criteriaChanged"
|
|
26798
27047
|
},
|
|
27048
|
+
{
|
|
27049
|
+
"kind": "Property",
|
|
27050
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource#cubeOperation:member",
|
|
27051
|
+
"docComment": "/**\n * A named cube operation to read instead of the cube resource's `query` endpoint.\n *\n * @remarks\n *\n * Only applies with `cube-url`. A named operation returns rows it has already aggregated, so row grouping is not available on it. Its columns offer no filters, because its schema does not say which columns it accepts filters on; `criteria` still applies.\n */\n",
|
|
27052
|
+
"excerptTokens": [
|
|
27053
|
+
{
|
|
27054
|
+
"kind": "Content",
|
|
27055
|
+
"text": "cubeOperation: "
|
|
27056
|
+
},
|
|
27057
|
+
{
|
|
27058
|
+
"kind": "Content",
|
|
27059
|
+
"text": "string"
|
|
27060
|
+
},
|
|
27061
|
+
{
|
|
27062
|
+
"kind": "Content",
|
|
27063
|
+
"text": ";"
|
|
27064
|
+
}
|
|
27065
|
+
],
|
|
27066
|
+
"isReadonly": false,
|
|
27067
|
+
"isOptional": false,
|
|
27068
|
+
"releaseTag": "Beta",
|
|
27069
|
+
"name": "cubeOperation",
|
|
27070
|
+
"propertyTypeTokenRange": {
|
|
27071
|
+
"startIndex": 1,
|
|
27072
|
+
"endIndex": 2
|
|
27073
|
+
},
|
|
27074
|
+
"isStatic": false,
|
|
27075
|
+
"isProtected": false,
|
|
27076
|
+
"isAbstract": false
|
|
27077
|
+
},
|
|
27078
|
+
{
|
|
27079
|
+
"kind": "Method",
|
|
27080
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource#cubeOperationChanged:member(1)",
|
|
27081
|
+
"docComment": "",
|
|
27082
|
+
"excerptTokens": [
|
|
27083
|
+
{
|
|
27084
|
+
"kind": "Content",
|
|
27085
|
+
"text": "cubeOperationChanged(oldValue: "
|
|
27086
|
+
},
|
|
27087
|
+
{
|
|
27088
|
+
"kind": "Content",
|
|
27089
|
+
"text": "string"
|
|
27090
|
+
},
|
|
27091
|
+
{
|
|
27092
|
+
"kind": "Content",
|
|
27093
|
+
"text": ", newValue: "
|
|
27094
|
+
},
|
|
27095
|
+
{
|
|
27096
|
+
"kind": "Content",
|
|
27097
|
+
"text": "string"
|
|
27098
|
+
},
|
|
27099
|
+
{
|
|
27100
|
+
"kind": "Content",
|
|
27101
|
+
"text": "): "
|
|
27102
|
+
},
|
|
27103
|
+
{
|
|
27104
|
+
"kind": "Content",
|
|
27105
|
+
"text": "void"
|
|
27106
|
+
},
|
|
27107
|
+
{
|
|
27108
|
+
"kind": "Content",
|
|
27109
|
+
"text": ";"
|
|
27110
|
+
}
|
|
27111
|
+
],
|
|
27112
|
+
"isStatic": false,
|
|
27113
|
+
"returnTypeTokenRange": {
|
|
27114
|
+
"startIndex": 5,
|
|
27115
|
+
"endIndex": 6
|
|
27116
|
+
},
|
|
27117
|
+
"releaseTag": "Beta",
|
|
27118
|
+
"isProtected": false,
|
|
27119
|
+
"overloadIndex": 1,
|
|
27120
|
+
"parameters": [
|
|
27121
|
+
{
|
|
27122
|
+
"parameterName": "oldValue",
|
|
27123
|
+
"parameterTypeTokenRange": {
|
|
27124
|
+
"startIndex": 1,
|
|
27125
|
+
"endIndex": 2
|
|
27126
|
+
},
|
|
27127
|
+
"isOptional": false
|
|
27128
|
+
},
|
|
27129
|
+
{
|
|
27130
|
+
"parameterName": "newValue",
|
|
27131
|
+
"parameterTypeTokenRange": {
|
|
27132
|
+
"startIndex": 3,
|
|
27133
|
+
"endIndex": 4
|
|
27134
|
+
},
|
|
27135
|
+
"isOptional": false
|
|
27136
|
+
}
|
|
27137
|
+
],
|
|
27138
|
+
"isOptional": false,
|
|
27139
|
+
"isAbstract": false,
|
|
27140
|
+
"name": "cubeOperationChanged"
|
|
27141
|
+
},
|
|
27142
|
+
{
|
|
27143
|
+
"kind": "Property",
|
|
27144
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource#cubeUrl:member",
|
|
27145
|
+
"docComment": "/**\n * The base URL of a Genesis Spring data cube API, such as `/gwf/my-spring-app/api/v1/cubes`.\n *\n * @remarks\n *\n * When set, `resource-name` names a cube resource on it rather than a Genesis resource.\n */\n",
|
|
27146
|
+
"excerptTokens": [
|
|
27147
|
+
{
|
|
27148
|
+
"kind": "Content",
|
|
27149
|
+
"text": "cubeUrl: "
|
|
27150
|
+
},
|
|
27151
|
+
{
|
|
27152
|
+
"kind": "Content",
|
|
27153
|
+
"text": "string"
|
|
27154
|
+
},
|
|
27155
|
+
{
|
|
27156
|
+
"kind": "Content",
|
|
27157
|
+
"text": ";"
|
|
27158
|
+
}
|
|
27159
|
+
],
|
|
27160
|
+
"isReadonly": false,
|
|
27161
|
+
"isOptional": false,
|
|
27162
|
+
"releaseTag": "Beta",
|
|
27163
|
+
"name": "cubeUrl",
|
|
27164
|
+
"propertyTypeTokenRange": {
|
|
27165
|
+
"startIndex": 1,
|
|
27166
|
+
"endIndex": 2
|
|
27167
|
+
},
|
|
27168
|
+
"isStatic": false,
|
|
27169
|
+
"isProtected": false,
|
|
27170
|
+
"isAbstract": false
|
|
27171
|
+
},
|
|
27172
|
+
{
|
|
27173
|
+
"kind": "Method",
|
|
27174
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource#cubeUrlChanged:member(1)",
|
|
27175
|
+
"docComment": "",
|
|
27176
|
+
"excerptTokens": [
|
|
27177
|
+
{
|
|
27178
|
+
"kind": "Content",
|
|
27179
|
+
"text": "cubeUrlChanged(oldValue: "
|
|
27180
|
+
},
|
|
27181
|
+
{
|
|
27182
|
+
"kind": "Content",
|
|
27183
|
+
"text": "string"
|
|
27184
|
+
},
|
|
27185
|
+
{
|
|
27186
|
+
"kind": "Content",
|
|
27187
|
+
"text": ", newValue: "
|
|
27188
|
+
},
|
|
27189
|
+
{
|
|
27190
|
+
"kind": "Content",
|
|
27191
|
+
"text": "string"
|
|
27192
|
+
},
|
|
27193
|
+
{
|
|
27194
|
+
"kind": "Content",
|
|
27195
|
+
"text": "): "
|
|
27196
|
+
},
|
|
27197
|
+
{
|
|
27198
|
+
"kind": "Content",
|
|
27199
|
+
"text": "void"
|
|
27200
|
+
},
|
|
27201
|
+
{
|
|
27202
|
+
"kind": "Content",
|
|
27203
|
+
"text": ";"
|
|
27204
|
+
}
|
|
27205
|
+
],
|
|
27206
|
+
"isStatic": false,
|
|
27207
|
+
"returnTypeTokenRange": {
|
|
27208
|
+
"startIndex": 5,
|
|
27209
|
+
"endIndex": 6
|
|
27210
|
+
},
|
|
27211
|
+
"releaseTag": "Beta",
|
|
27212
|
+
"isProtected": false,
|
|
27213
|
+
"overloadIndex": 1,
|
|
27214
|
+
"parameters": [
|
|
27215
|
+
{
|
|
27216
|
+
"parameterName": "oldValue",
|
|
27217
|
+
"parameterTypeTokenRange": {
|
|
27218
|
+
"startIndex": 1,
|
|
27219
|
+
"endIndex": 2
|
|
27220
|
+
},
|
|
27221
|
+
"isOptional": false
|
|
27222
|
+
},
|
|
27223
|
+
{
|
|
27224
|
+
"parameterName": "newValue",
|
|
27225
|
+
"parameterTypeTokenRange": {
|
|
27226
|
+
"startIndex": 3,
|
|
27227
|
+
"endIndex": 4
|
|
27228
|
+
},
|
|
27229
|
+
"isOptional": false
|
|
27230
|
+
}
|
|
27231
|
+
],
|
|
27232
|
+
"isOptional": false,
|
|
27233
|
+
"isAbstract": false,
|
|
27234
|
+
"name": "cubeUrlChanged"
|
|
27235
|
+
},
|
|
26799
27236
|
{
|
|
26800
27237
|
"kind": "Method",
|
|
26801
27238
|
"canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource#deepClone:member(1)",
|
|
@@ -26895,6 +27332,37 @@
|
|
|
26895
27332
|
"isAbstract": false,
|
|
26896
27333
|
"name": "disconnectedCallback"
|
|
26897
27334
|
},
|
|
27335
|
+
{
|
|
27336
|
+
"kind": "Property",
|
|
27337
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource#http:member",
|
|
27338
|
+
"docComment": "",
|
|
27339
|
+
"excerptTokens": [
|
|
27340
|
+
{
|
|
27341
|
+
"kind": "Content",
|
|
27342
|
+
"text": "http: "
|
|
27343
|
+
},
|
|
27344
|
+
{
|
|
27345
|
+
"kind": "Reference",
|
|
27346
|
+
"text": "Http",
|
|
27347
|
+
"canonicalReference": "@genesislcap/foundation-comms!Http:interface"
|
|
27348
|
+
},
|
|
27349
|
+
{
|
|
27350
|
+
"kind": "Content",
|
|
27351
|
+
"text": ";"
|
|
27352
|
+
}
|
|
27353
|
+
],
|
|
27354
|
+
"isReadonly": false,
|
|
27355
|
+
"isOptional": false,
|
|
27356
|
+
"releaseTag": "Beta",
|
|
27357
|
+
"name": "http",
|
|
27358
|
+
"propertyTypeTokenRange": {
|
|
27359
|
+
"startIndex": 1,
|
|
27360
|
+
"endIndex": 2
|
|
27361
|
+
},
|
|
27362
|
+
"isStatic": false,
|
|
27363
|
+
"isProtected": false,
|
|
27364
|
+
"isAbstract": false
|
|
27365
|
+
},
|
|
26898
27366
|
{
|
|
26899
27367
|
"kind": "Method",
|
|
26900
27368
|
"canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource#init:member(1)",
|
|
@@ -27206,6 +27674,36 @@
|
|
|
27206
27674
|
"isOptional": false,
|
|
27207
27675
|
"isAbstract": false,
|
|
27208
27676
|
"name": "restart"
|
|
27677
|
+
},
|
|
27678
|
+
{
|
|
27679
|
+
"kind": "Property",
|
|
27680
|
+
"canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource#rowId:member",
|
|
27681
|
+
"docComment": "",
|
|
27682
|
+
"excerptTokens": [
|
|
27683
|
+
{
|
|
27684
|
+
"kind": "Content",
|
|
27685
|
+
"text": "protected get rowId(): "
|
|
27686
|
+
},
|
|
27687
|
+
{
|
|
27688
|
+
"kind": "Content",
|
|
27689
|
+
"text": "string"
|
|
27690
|
+
},
|
|
27691
|
+
{
|
|
27692
|
+
"kind": "Content",
|
|
27693
|
+
"text": ";"
|
|
27694
|
+
}
|
|
27695
|
+
],
|
|
27696
|
+
"isReadonly": true,
|
|
27697
|
+
"isOptional": false,
|
|
27698
|
+
"releaseTag": "Beta",
|
|
27699
|
+
"name": "rowId",
|
|
27700
|
+
"propertyTypeTokenRange": {
|
|
27701
|
+
"startIndex": 1,
|
|
27702
|
+
"endIndex": 2
|
|
27703
|
+
},
|
|
27704
|
+
"isStatic": false,
|
|
27705
|
+
"isProtected": true,
|
|
27706
|
+
"isAbstract": false
|
|
27209
27707
|
}
|
|
27210
27708
|
],
|
|
27211
27709
|
"extendsTokenRange": {
|
|
@@ -37403,6 +37901,15 @@
|
|
|
37403
37901
|
"text": "GenesisInfiniteDatasource",
|
|
37404
37902
|
"canonicalReference": "@genesislcap/grid-pro!~GenesisInfiniteDatasource:class"
|
|
37405
37903
|
},
|
|
37904
|
+
{
|
|
37905
|
+
"kind": "Content",
|
|
37906
|
+
"text": " | "
|
|
37907
|
+
},
|
|
37908
|
+
{
|
|
37909
|
+
"kind": "Reference",
|
|
37910
|
+
"text": "CubeInfiniteDatasource",
|
|
37911
|
+
"canonicalReference": "@genesislcap/grid-pro!~CubeInfiniteDatasource:class"
|
|
37912
|
+
},
|
|
37406
37913
|
{
|
|
37407
37914
|
"kind": "Content",
|
|
37408
37915
|
"text": " | null"
|
|
@@ -37418,7 +37925,7 @@
|
|
|
37418
37925
|
"name": "datasource",
|
|
37419
37926
|
"propertyTypeTokenRange": {
|
|
37420
37927
|
"startIndex": 1,
|
|
37421
|
-
"endIndex":
|
|
37928
|
+
"endIndex": 5
|
|
37422
37929
|
}
|
|
37423
37930
|
}
|
|
37424
37931
|
],
|