@genesislcap/grid-pro 15.20.2-grid-pro-datasource-fix.1 → 15.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/dist/custom-elements.json +2147 -169
  2. package/dist/dts/datasource/base.datasource.d.ts +17 -3
  3. package/dist/dts/datasource/base.datasource.d.ts.map +1 -1
  4. package/dist/dts/datasource/base.types.d.ts +1 -1
  5. package/dist/dts/datasource/base.types.d.ts.map +1 -1
  6. package/dist/dts/datasource/datasource.types.d.ts +5 -2
  7. package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
  8. package/dist/dts/datasource/filter.utils.d.ts +40 -0
  9. package/dist/dts/datasource/filter.utils.d.ts.map +1 -0
  10. package/dist/dts/datasource/index.d.ts +2 -0
  11. package/dist/dts/datasource/index.d.ts.map +1 -1
  12. package/dist/dts/datasource/infinite.datasource.d.ts +464 -0
  13. package/dist/dts/datasource/infinite.datasource.d.ts.map +1 -0
  14. package/dist/dts/datasource/infinite.resource.d.ts +231 -0
  15. package/dist/dts/datasource/infinite.resource.d.ts.map +1 -0
  16. package/dist/dts/datasource/server-side.datasource.d.ts +0 -2
  17. package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
  18. package/dist/dts/datasource/server-side.resource-base.d.ts +1 -1
  19. package/dist/dts/datasource/server-side.resource-base.d.ts.map +1 -1
  20. package/dist/dts/grid-pro-beta.d.ts +37 -8
  21. package/dist/dts/grid-pro-beta.d.ts.map +1 -1
  22. package/dist/dts/grid-pro-genesis-datasource/datasource-events.types.d.ts +20 -1
  23. package/dist/dts/grid-pro-genesis-datasource/datasource-events.types.d.ts.map +1 -1
  24. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +0 -1
  25. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
  26. package/dist/dts/grid-pro.d.ts +6 -6
  27. package/dist/dts/grid-pro.d.ts.map +1 -1
  28. package/dist/dts/react.d.ts +25 -1
  29. package/dist/dts/utils/map.d.ts +2 -2
  30. package/dist/dts/utils/map.d.ts.map +1 -1
  31. package/dist/esm/datasource/base.datasource.js +39 -2
  32. package/dist/esm/datasource/filter.utils.js +241 -0
  33. package/dist/esm/datasource/index.js +2 -0
  34. package/dist/esm/datasource/infinite.datasource.js +373 -0
  35. package/dist/esm/datasource/infinite.resource.js +581 -0
  36. package/dist/esm/datasource/server-side.datasource.js +0 -38
  37. package/dist/esm/datasource/server-side.grid-definitions.js +1 -1
  38. package/dist/esm/datasource/server-side.resource-base.js +7 -105
  39. package/dist/esm/grid-pro-beta.js +73 -24
  40. package/dist/esm/grid-pro-genesis-datasource/datasource-events.types.js +3 -0
  41. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +0 -3
  42. package/dist/esm/grid-pro.js +12 -19
  43. package/dist/grid-pro.api.json +1355 -477
  44. package/dist/grid-pro.d.ts +958 -173
  45. package/dist/react.cjs +84 -0
  46. package/dist/react.mjs +83 -0
  47. package/package.json +13 -13
@@ -348,16 +348,6 @@
348
348
  "privacy": "private",
349
349
  "description": "A schemaUpdated that arrived before `gridApi` existed; replayed in onGridReady."
350
350
  },
351
- {
352
- "kind": "field",
353
- "name": "hasEmittedDatasourceReady",
354
- "type": {
355
- "text": "boolean"
356
- },
357
- "privacy": "private",
358
- "default": "false",
359
- "description": "Whether `onGridReady` has ever fired `datasourceEventNames.ready` at least once. A datasource\nthat connects (or restarts) after that point would otherwise miss the one-shot event entirely\n— see `handleInitialize`, which replays it directly to any datasource that inits late."
360
- },
361
351
  {
362
352
  "kind": "field",
363
353
  "name": "rootEventsListeners",
@@ -374,7 +364,7 @@
374
364
  "text": "Array<[string, EventListener]>"
375
365
  },
376
366
  "privacy": "private",
377
- "default": "[\n [datasourceEventNames.initialize, this.handleInitialize.bind(this) as EventListener],\n [datasourceEventNames.dataLoaded, this.handleDataLoaded.bind(this) as EventListener],\n [datasourceEventNames.dataChanged, this.handleDataChanged.bind(this) as EventListener],\n [datasourceEventNames.schemaUpdated, this.handleSchemaUpdated.bind(this) as EventListener],\n [datasourceEventNames.dataCleared, this.handleDataCleared.bind(this) as EventListener],\n [datasourceEventNames.loadingStarted, this.handleLoadingStarted.bind(this) as EventListener],\n [\n datasourceEventNames.loadingFinished,\n this.handleLoadingFinished.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.noDataAvailable,\n this.handleNoDataAvailable.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.filtersRestored,\n this.handleFiltersRestored.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.moreDataAvailable,\n this.handleMoreDataAvailable.bind(this) as EventListener,\n ],\n [datasourceEventNames.error, this.handleDatasourceError.bind(this) as EventListener],\n [datasourceEventNames.destroy, this.handleDatasourceDestroy.bind(this) as EventListener],\n [datasourceEventNames.cacheFilterConfig, this.cacheFilterConfig.bind(this) as EventListener],\n [\n datasourceEventNames.refreshServerSide,\n this.handleRefreshServerSide.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.setServerSideDatasource,\n this.handleSetServerSideDatasource.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.addGridCssClass,\n this.handleAddGridCssClass.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.removeGridCssClass,\n this.handleRemoveGridCssClass.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.applyServerSideTransaction,\n this.handleApplyServerSideTransaction.bind(this) as EventListener,\n ],\n ]"
367
+ "default": "[\n [datasourceEventNames.initialize, this.handleInitialize.bind(this) as EventListener],\n [datasourceEventNames.dataLoaded, this.handleDataLoaded.bind(this) as EventListener],\n [datasourceEventNames.dataChanged, this.handleDataChanged.bind(this) as EventListener],\n [datasourceEventNames.schemaUpdated, this.handleSchemaUpdated.bind(this) as EventListener],\n [datasourceEventNames.dataCleared, this.handleDataCleared.bind(this) as EventListener],\n [datasourceEventNames.loadingStarted, this.handleLoadingStarted.bind(this) as EventListener],\n [\n datasourceEventNames.loadingFinished,\n this.handleLoadingFinished.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.noDataAvailable,\n this.handleNoDataAvailable.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.filtersRestored,\n this.handleFiltersRestored.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.moreDataAvailable,\n this.handleMoreDataAvailable.bind(this) as EventListener,\n ],\n [datasourceEventNames.error, this.handleDatasourceError.bind(this) as EventListener],\n [datasourceEventNames.destroy, this.handleDatasourceDestroy.bind(this) as EventListener],\n [datasourceEventNames.cacheFilterConfig, this.cacheFilterConfig.bind(this) as EventListener],\n [\n datasourceEventNames.refreshServerSide,\n this.handleRefreshServerSide.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.setServerSideDatasource,\n this.handleSetServerSideDatasource.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.addGridCssClass,\n this.handleAddGridCssClass.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.removeGridCssClass,\n this.handleRemoveGridCssClass.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.applyServerSideTransaction,\n this.handleApplyServerSideTransaction.bind(this) as EventListener,\n ],\n // Infinite Row Model specific events\n [\n datasourceEventNames.setInfiniteDatasource,\n this.handleSetInfiniteDatasource.bind(this) as EventListener,\n ],\n [\n datasourceEventNames.refreshInfiniteCache,\n this.handleRefreshInfiniteCache.bind(this) as EventListener,\n ],\n ]"
378
368
  },
379
369
  {
380
370
  "kind": "field",
@@ -745,6 +735,15 @@
745
735
  "privacy": "public",
746
736
  "readonly": true
747
737
  },
738
+ {
739
+ "kind": "field",
740
+ "name": "isInfiniteRowModel",
741
+ "type": {
742
+ "text": "boolean"
743
+ },
744
+ "privacy": "public",
745
+ "readonly": true
746
+ },
748
747
  {
749
748
  "kind": "method",
750
749
  "name": "setLocalGridOptions",
@@ -2071,16 +2070,6 @@
2071
2070
  "privacy": "private",
2072
2071
  "readonly": true
2073
2072
  },
2074
- {
2075
- "kind": "field",
2076
- "name": "hasEmittedDatasourceReady",
2077
- "type": {
2078
- "text": "boolean"
2079
- },
2080
- "privacy": "private",
2081
- "default": "false",
2082
- "description": "Whether `onGridReady` has ever fired `datasourceEventNames.ready` at least once. A datasource\nthat connects (or restarts) after that point would otherwise miss the one-shot event entirely\n— see `handleInitialize`, which replays it directly to any datasource that inits late."
2083
- },
2084
2073
  {
2085
2074
  "kind": "field",
2086
2075
  "name": "_filterConfig",
@@ -8909,24 +8898,6 @@
8909
8898
  }
8910
8899
  ]
8911
8900
  },
8912
- {
8913
- "kind": "method",
8914
- "name": "applyTransaction",
8915
- "privacy": "protected",
8916
- "return": {
8917
- "type": {
8918
- "text": "any"
8919
- }
8920
- },
8921
- "parameters": [
8922
- {
8923
- "name": "transaction",
8924
- "type": {
8925
- "text": "any"
8926
- }
8927
- }
8928
- ]
8929
- },
8930
8901
  {
8931
8902
  "kind": "method",
8932
8903
  "name": "mapTransaction",
@@ -10689,28 +10660,6 @@
10689
10660
  "module": "src/datasource/base.datasource.ts"
10690
10661
  }
10691
10662
  },
10692
- {
10693
- "kind": "method",
10694
- "name": "applyTransaction",
10695
- "privacy": "protected",
10696
- "return": {
10697
- "type": {
10698
- "text": "any"
10699
- }
10700
- },
10701
- "parameters": [
10702
- {
10703
- "name": "transaction",
10704
- "type": {
10705
- "text": "any"
10706
- }
10707
- }
10708
- ],
10709
- "inheritedFrom": {
10710
- "name": "GridProBaseDatasource",
10711
- "module": "src/datasource/base.datasource.ts"
10712
- }
10713
- },
10714
10663
  {
10715
10664
  "kind": "method",
10716
10665
  "name": "handleSizeChanged",
@@ -11913,6 +11862,193 @@
11913
11862
  }
11914
11863
  ]
11915
11864
  },
11865
+ {
11866
+ "kind": "javascript-module",
11867
+ "path": "src/datasource/filter.utils.ts",
11868
+ "declarations": [
11869
+ {
11870
+ "kind": "function",
11871
+ "name": "convertTextFilterToCriteria",
11872
+ "return": {
11873
+ "type": {
11874
+ "text": ""
11875
+ }
11876
+ },
11877
+ "parameters": [
11878
+ {
11879
+ "name": "filterModel",
11880
+ "type": {
11881
+ "text": "any"
11882
+ },
11883
+ "description": "The AG Grid filter model"
11884
+ },
11885
+ {
11886
+ "name": "fieldName",
11887
+ "type": {
11888
+ "text": "string"
11889
+ },
11890
+ "description": "The field name being filtered"
11891
+ }
11892
+ ],
11893
+ "description": "Converts text filters to Genesis criteria strings."
11894
+ },
11895
+ {
11896
+ "kind": "function",
11897
+ "name": "convertSetFilterToCriteria",
11898
+ "return": {
11899
+ "type": {
11900
+ "text": ""
11901
+ }
11902
+ },
11903
+ "parameters": [
11904
+ {
11905
+ "name": "filterModel",
11906
+ "type": {
11907
+ "text": "any"
11908
+ },
11909
+ "description": "The AG Grid filter model"
11910
+ },
11911
+ {
11912
+ "name": "fieldName",
11913
+ "type": {
11914
+ "text": "string"
11915
+ },
11916
+ "description": "The field name being filtered"
11917
+ },
11918
+ {
11919
+ "name": "colMeta",
11920
+ "optional": true,
11921
+ "type": {
11922
+ "text": "MetadataDetail"
11923
+ },
11924
+ "description": "Column metadata for detecting all values"
11925
+ }
11926
+ ],
11927
+ "description": "Converts set filters (for enum fields) to Genesis criteria strings."
11928
+ },
11929
+ {
11930
+ "kind": "function",
11931
+ "name": "convertNumberFilterToCriteria",
11932
+ "return": {
11933
+ "type": {
11934
+ "text": ""
11935
+ }
11936
+ },
11937
+ "parameters": [
11938
+ {
11939
+ "name": "filterModel",
11940
+ "type": {
11941
+ "text": "any"
11942
+ },
11943
+ "description": "The AG Grid filter model"
11944
+ },
11945
+ {
11946
+ "name": "fieldName",
11947
+ "type": {
11948
+ "text": "string"
11949
+ },
11950
+ "description": "The field name being filtered"
11951
+ }
11952
+ ],
11953
+ "description": "Converts number filters to Genesis criteria strings."
11954
+ },
11955
+ {
11956
+ "kind": "function",
11957
+ "name": "convertDateFilterToCriteria",
11958
+ "return": {
11959
+ "type": {
11960
+ "text": ""
11961
+ }
11962
+ },
11963
+ "parameters": [
11964
+ {
11965
+ "name": "filterModel",
11966
+ "type": {
11967
+ "text": "any"
11968
+ },
11969
+ "description": "The AG Grid filter model"
11970
+ },
11971
+ {
11972
+ "name": "fieldName",
11973
+ "type": {
11974
+ "text": "string"
11975
+ },
11976
+ "description": "The field name being filtered"
11977
+ }
11978
+ ],
11979
+ "description": "Converts date filters to Genesis criteria strings."
11980
+ },
11981
+ {
11982
+ "kind": "function",
11983
+ "name": "convertFilterModelToCriteria",
11984
+ "return": {
11985
+ "type": {
11986
+ "text": ""
11987
+ }
11988
+ },
11989
+ "parameters": [
11990
+ {
11991
+ "name": "filterModel",
11992
+ "type": {
11993
+ "text": "any"
11994
+ },
11995
+ "description": "The AG Grid filter model"
11996
+ },
11997
+ {
11998
+ "name": "colDefs",
11999
+ "optional": true,
12000
+ "type": {
12001
+ "text": "MetadataDetail[]"
12002
+ },
12003
+ "description": "Column definitions for metadata (optional but recommended)"
12004
+ }
12005
+ ],
12006
+ "description": "Converts AG Grid filter model to Genesis criteria string.\nThis is the main entry point for converting filters.\nHandles both simple filters and multi-filters (filterType: \"multi\" with filterModels array)."
12007
+ }
12008
+ ],
12009
+ "exports": [
12010
+ {
12011
+ "kind": "js",
12012
+ "name": "convertTextFilterToCriteria",
12013
+ "declaration": {
12014
+ "name": "convertTextFilterToCriteria",
12015
+ "module": "src/datasource/filter.utils.ts"
12016
+ }
12017
+ },
12018
+ {
12019
+ "kind": "js",
12020
+ "name": "convertSetFilterToCriteria",
12021
+ "declaration": {
12022
+ "name": "convertSetFilterToCriteria",
12023
+ "module": "src/datasource/filter.utils.ts"
12024
+ }
12025
+ },
12026
+ {
12027
+ "kind": "js",
12028
+ "name": "convertNumberFilterToCriteria",
12029
+ "declaration": {
12030
+ "name": "convertNumberFilterToCriteria",
12031
+ "module": "src/datasource/filter.utils.ts"
12032
+ }
12033
+ },
12034
+ {
12035
+ "kind": "js",
12036
+ "name": "convertDateFilterToCriteria",
12037
+ "declaration": {
12038
+ "name": "convertDateFilterToCriteria",
12039
+ "module": "src/datasource/filter.utils.ts"
12040
+ }
12041
+ },
12042
+ {
12043
+ "kind": "js",
12044
+ "name": "convertFilterModelToCriteria",
12045
+ "declaration": {
12046
+ "name": "convertFilterModelToCriteria",
12047
+ "module": "src/datasource/filter.utils.ts"
12048
+ }
12049
+ }
12050
+ ]
12051
+ },
11916
12052
  {
11917
12053
  "kind": "javascript-module",
11918
12054
  "path": "src/datasource/index.ts",
@@ -11958,6 +12094,22 @@
11958
12094
  "package": "./datasource.types"
11959
12095
  }
11960
12096
  },
12097
+ {
12098
+ "kind": "js",
12099
+ "name": "*",
12100
+ "declaration": {
12101
+ "name": "*",
12102
+ "package": "./filter.utils"
12103
+ }
12104
+ },
12105
+ {
12106
+ "kind": "js",
12107
+ "name": "*",
12108
+ "declaration": {
12109
+ "name": "*",
12110
+ "package": "./infinite.datasource"
12111
+ }
12112
+ },
11961
12113
  {
11962
12114
  "kind": "js",
11963
12115
  "name": "*",
@@ -11994,43 +12146,1937 @@
11994
12146
  },
11995
12147
  {
11996
12148
  "kind": "javascript-module",
11997
- "path": "src/datasource/row-match.classes.ts",
12149
+ "path": "src/datasource/infinite.datasource.ts",
11998
12150
  "declarations": [
11999
12151
  {
12000
- "kind": "variable",
12001
- "name": "ROW_MATCH_ALERT_CLASS",
12002
- "type": {
12003
- "text": "string"
12004
- },
12005
- "default": "'grid-pro-row-alert'",
12006
- "description": "Class the grid puts on rows satisfying the criteria. The grid's own styles flash it in step\nwith any alerting tab, so a tab that draws you to a grid also shows you which rows caused it.",
12007
- "privacy": "public"
12008
- },
12009
- {
12010
- "kind": "variable",
12011
- "name": "ROW_MATCH_ALERT_CELL_CLASS",
12012
- "type": {
12013
- "text": "string"
12014
- },
12015
- "default": "'grid-pro-row-alert-cell'",
12016
- "description": "Class the grid puts on just the `flashField` cell of a matching row, for grids that flash a\nsingle column rather than the whole row.",
12017
- "privacy": "public"
12018
- },
12019
- {
12020
- "kind": "function",
12021
- "name": "createRowMatchClassRules",
12022
- "return": {
12023
- "type": {
12024
- "text": "Record<string, (params: { data?: unknown }) => boolean>"
12025
- }
12026
- },
12027
- "parameters": [
12152
+ "kind": "class",
12153
+ "description": "A Genesis Datasource element for AG Grid's Infinite Row Model.",
12154
+ "name": "GridProInfiniteDatasource",
12155
+ "members": [
12028
12156
  {
12029
- "name": "criteria",
12157
+ "kind": "field",
12158
+ "name": "connect",
12030
12159
  "type": {
12031
- "text": "RowMatchCriteria"
12160
+ "text": "Connect"
12161
+ },
12162
+ "inheritedFrom": {
12163
+ "name": "GenesisGridDatasourceElement",
12164
+ "module": "src/datasource/base.datasource.ts"
12032
12165
  }
12033
- }
12166
+ },
12167
+ {
12168
+ "kind": "field",
12169
+ "name": "connectEvents",
12170
+ "type": {
12171
+ "text": "ConnectEvents"
12172
+ }
12173
+ },
12174
+ {
12175
+ "kind": "field",
12176
+ "name": "datasource",
12177
+ "type": {
12178
+ "text": "Datasource"
12179
+ },
12180
+ "inheritedFrom": {
12181
+ "name": "GenesisGridDatasourceElement",
12182
+ "module": "src/datasource/base.datasource.ts"
12183
+ }
12184
+ },
12185
+ {
12186
+ "kind": "field",
12187
+ "name": "request",
12188
+ "type": {
12189
+ "text": "any"
12190
+ },
12191
+ "description": "Similar to fields but for Request Server scenarios. This optional parameter enables you to specify request fields, which can include wildcards.",
12192
+ "inheritedFrom": {
12193
+ "name": "GenesisGridDatasourceElement",
12194
+ "module": "src/datasource/base.datasource.ts"
12195
+ },
12196
+ "default": "{}"
12197
+ },
12198
+ {
12199
+ "kind": "field",
12200
+ "name": "indexes",
12201
+ "type": {
12202
+ "text": "Map<string, string[]>"
12203
+ },
12204
+ "privacy": "private"
12205
+ },
12206
+ {
12207
+ "kind": "field",
12208
+ "name": "infiniteDatasource",
12209
+ "type": {
12210
+ "text": "GenesisInfiniteDatasource"
12211
+ },
12212
+ "privacy": "private"
12213
+ },
12214
+ {
12215
+ "kind": "field",
12216
+ "name": "commitResponseUnsubscribe",
12217
+ "type": {
12218
+ "text": "() => void | undefined"
12219
+ },
12220
+ "privacy": "private",
12221
+ "description": "Unsubscribes the commit-response listener behind `pollTriggerEvents`. @internal"
12222
+ },
12223
+ {
12224
+ "kind": "method",
12225
+ "name": "resourceNameChanged",
12226
+ "parameters": [
12227
+ {
12228
+ "name": "oldValue",
12229
+ "type": {
12230
+ "text": "string"
12231
+ }
12232
+ },
12233
+ {
12234
+ "name": "newValue",
12235
+ "type": {
12236
+ "text": "string"
12237
+ }
12238
+ }
12239
+ ]
12240
+ },
12241
+ {
12242
+ "kind": "method",
12243
+ "name": "criteriaChanged",
12244
+ "parameters": [
12245
+ {
12246
+ "name": "oldCriteria",
12247
+ "type": {
12248
+ "text": "string"
12249
+ }
12250
+ },
12251
+ {
12252
+ "name": "newCriteria",
12253
+ "type": {
12254
+ "text": "string"
12255
+ }
12256
+ }
12257
+ ]
12258
+ },
12259
+ {
12260
+ "kind": "method",
12261
+ "name": "deepClone",
12262
+ "return": {
12263
+ "type": {
12264
+ "text": "Node"
12265
+ }
12266
+ },
12267
+ "inheritedFrom": {
12268
+ "name": "LifecycleMixin",
12269
+ "module": "src/mixins/lifecycle/lifecycle.ts"
12270
+ }
12271
+ },
12272
+ {
12273
+ "kind": "method",
12274
+ "name": "reloadResourceData",
12275
+ "return": {
12276
+ "type": {
12277
+ "text": "Promise<void>"
12278
+ }
12279
+ },
12280
+ "description": "Resets the grid data while keeping columnDefs and reloads data.",
12281
+ "inheritedFrom": {
12282
+ "name": "GridProBaseDatasource",
12283
+ "module": "src/datasource/base.datasource.ts"
12284
+ }
12285
+ },
12286
+ {
12287
+ "kind": "method",
12288
+ "name": "init"
12289
+ },
12290
+ {
12291
+ "kind": "method",
12292
+ "name": "destroy",
12293
+ "inheritedFrom": {
12294
+ "name": "GridProBaseDatasource",
12295
+ "module": "src/datasource/base.datasource.ts"
12296
+ }
12297
+ },
12298
+ {
12299
+ "kind": "method",
12300
+ "name": "restart",
12301
+ "inheritedFrom": {
12302
+ "name": "GridProBaseDatasource",
12303
+ "module": "src/datasource/base.datasource.ts"
12304
+ }
12305
+ },
12306
+ {
12307
+ "kind": "method",
12308
+ "name": "clearRowData",
12309
+ "privacy": "private",
12310
+ "parameters": [
12311
+ {
12312
+ "name": "withColumnDefs",
12313
+ "default": "true"
12314
+ }
12315
+ ]
12316
+ },
12317
+ {
12318
+ "kind": "method",
12319
+ "name": "teardownCommitTriggeredRefresh",
12320
+ "privacy": "private",
12321
+ "return": {
12322
+ "type": {
12323
+ "text": "void"
12324
+ }
12325
+ },
12326
+ "description": "Safe to call when the listener was never registered. @internal"
12327
+ },
12328
+ {
12329
+ "kind": "method",
12330
+ "name": "createSnapshot",
12331
+ "privacy": "private",
12332
+ "return": {
12333
+ "type": {
12334
+ "text": ""
12335
+ }
12336
+ },
12337
+ "parameters": [
12338
+ {
12339
+ "name": "existingParams",
12340
+ "default": "null",
12341
+ "type": {
12342
+ "text": "any"
12343
+ },
12344
+ "description": "Optional existing parameters to include"
12345
+ }
12346
+ ],
12347
+ "description": "Creates a snapshot request to the server."
12348
+ },
12349
+ {
12350
+ "kind": "method",
12351
+ "name": "getAgColumnDefs",
12352
+ "privacy": "private",
12353
+ "return": {
12354
+ "type": {
12355
+ "text": "Promise<ColDef[]>"
12356
+ }
12357
+ },
12358
+ "parameters": [
12359
+ {
12360
+ "name": "fieldsMetadata",
12361
+ "type": {
12362
+ "text": "FieldMetadata[]"
12363
+ }
12364
+ }
12365
+ ]
12366
+ },
12367
+ {
12368
+ "kind": "method",
12369
+ "name": "loadMore",
12370
+ "inheritedFrom": {
12371
+ "name": "GridProBaseDatasource",
12372
+ "module": "src/datasource/base.datasource.ts"
12373
+ }
12374
+ },
12375
+ {
12376
+ "kind": "method",
12377
+ "name": "cloneNode",
12378
+ "return": {
12379
+ "type": {
12380
+ "text": "Node"
12381
+ }
12382
+ },
12383
+ "parameters": [
12384
+ {
12385
+ "name": "deep",
12386
+ "optional": true,
12387
+ "type": {
12388
+ "text": "boolean"
12389
+ }
12390
+ }
12391
+ ],
12392
+ "inheritedFrom": {
12393
+ "name": "LifecycleMixin",
12394
+ "module": "src/mixins/lifecycle/lifecycle.ts"
12395
+ }
12396
+ },
12397
+ {
12398
+ "kind": "field",
12399
+ "name": "shouldRunDisconnect",
12400
+ "return": {
12401
+ "type": {
12402
+ "text": ""
12403
+ }
12404
+ },
12405
+ "readonly": true,
12406
+ "inheritedFrom": {
12407
+ "name": "LifecycleMixin",
12408
+ "module": "src/mixins/lifecycle/lifecycle.ts"
12409
+ }
12410
+ },
12411
+ {
12412
+ "kind": "field",
12413
+ "name": "shouldRunConnect",
12414
+ "return": {
12415
+ "type": {
12416
+ "text": ""
12417
+ }
12418
+ },
12419
+ "readonly": true,
12420
+ "inheritedFrom": {
12421
+ "name": "LifecycleMixin",
12422
+ "module": "src/mixins/lifecycle/lifecycle.ts"
12423
+ }
12424
+ },
12425
+ {
12426
+ "kind": "method",
12427
+ "name": "#_blockLifecycleDueToTokenChange",
12428
+ "return": {
12429
+ "type": {
12430
+ "text": "boolean"
12431
+ }
12432
+ },
12433
+ "parameters": [
12434
+ {
12435
+ "name": "lifecycleType",
12436
+ "type": {
12437
+ "text": "Lifecycletype"
12438
+ }
12439
+ }
12440
+ ],
12441
+ "inheritedFrom": {
12442
+ "name": "LifecycleMixin",
12443
+ "module": "src/mixins/lifecycle/lifecycle.ts"
12444
+ }
12445
+ },
12446
+ {
12447
+ "kind": "field",
12448
+ "name": "dataSubWasLoggedOff",
12449
+ "type": {
12450
+ "text": "boolean"
12451
+ },
12452
+ "privacy": "protected",
12453
+ "default": "false",
12454
+ "inheritedFrom": {
12455
+ "name": "GridProBaseDatasource",
12456
+ "module": "src/datasource/base.datasource.ts"
12457
+ }
12458
+ },
12459
+ {
12460
+ "kind": "field",
12461
+ "name": "keepColDefsOnClearRowData",
12462
+ "type": {
12463
+ "text": "boolean"
12464
+ },
12465
+ "privacy": "public",
12466
+ "default": "false",
12467
+ "inheritedFrom": {
12468
+ "name": "GridProBaseDatasource",
12469
+ "module": "src/datasource/base.datasource.ts"
12470
+ }
12471
+ },
12472
+ {
12473
+ "kind": "field",
12474
+ "name": "rowData",
12475
+ "type": {
12476
+ "text": "Map<string, any>"
12477
+ },
12478
+ "default": "new Map()",
12479
+ "inheritedFrom": {
12480
+ "name": "GridProBaseDatasource",
12481
+ "module": "src/datasource/base.datasource.ts"
12482
+ }
12483
+ },
12484
+ {
12485
+ "kind": "field",
12486
+ "name": "transactionData",
12487
+ "type": {
12488
+ "text": "TransactionData"
12489
+ },
12490
+ "privacy": "protected",
12491
+ "default": "{\n add: [],\n remove: [],\n update: [],\n }",
12492
+ "inheritedFrom": {
12493
+ "name": "GridProBaseDatasource",
12494
+ "module": "src/datasource/base.datasource.ts"
12495
+ }
12496
+ },
12497
+ {
12498
+ "kind": "field",
12499
+ "name": "connectionSub",
12500
+ "type": {
12501
+ "text": "Subscription | undefined"
12502
+ },
12503
+ "privacy": "protected",
12504
+ "inheritedFrom": {
12505
+ "name": "GridProBaseDatasource",
12506
+ "module": "src/datasource/base.datasource.ts"
12507
+ }
12508
+ },
12509
+ {
12510
+ "kind": "method",
12511
+ "name": "subscribeToConnection",
12512
+ "privacy": "protected",
12513
+ "inheritedFrom": {
12514
+ "name": "GridProBaseDatasource",
12515
+ "module": "src/datasource/base.datasource.ts"
12516
+ }
12517
+ },
12518
+ {
12519
+ "kind": "method",
12520
+ "name": "unsubscribeFromConnection",
12521
+ "privacy": "protected",
12522
+ "inheritedFrom": {
12523
+ "name": "GridProBaseDatasource",
12524
+ "module": "src/datasource/base.datasource.ts"
12525
+ }
12526
+ },
12527
+ {
12528
+ "kind": "method",
12529
+ "name": "generateColumnDefsFromMetadata",
12530
+ "privacy": "protected",
12531
+ "return": {
12532
+ "type": {
12533
+ "text": "ColDef[]"
12534
+ }
12535
+ },
12536
+ "parameters": [
12537
+ {
12538
+ "name": "fieldsMetadata",
12539
+ "type": {
12540
+ "text": "FieldMetadata[]"
12541
+ }
12542
+ },
12543
+ {
12544
+ "name": "getFilterParamsByFieldType",
12545
+ "type": {
12546
+ "text": "(field: FieldMetadata) => ColDef['filterParams'] | any"
12547
+ }
12548
+ },
12549
+ {
12550
+ "name": "getFilterByFieldType",
12551
+ "type": {
12552
+ "text": "(type: FieldTypeEnum) => string"
12553
+ }
12554
+ }
12555
+ ],
12556
+ "inheritedFrom": {
12557
+ "name": "GridProBaseDatasource",
12558
+ "module": "src/datasource/base.datasource.ts"
12559
+ }
12560
+ },
12561
+ {
12562
+ "kind": "method",
12563
+ "name": "handleStreamInserts",
12564
+ "privacy": "protected",
12565
+ "parameters": [
12566
+ {
12567
+ "name": "insertedRows",
12568
+ "type": {
12569
+ "text": "any[]"
12570
+ }
12571
+ },
12572
+ {
12573
+ "name": "addIndex",
12574
+ "default": "0",
12575
+ "type": {
12576
+ "text": "number"
12577
+ }
12578
+ }
12579
+ ],
12580
+ "inheritedFrom": {
12581
+ "name": "GridProBaseDatasource",
12582
+ "module": "src/datasource/base.datasource.ts"
12583
+ }
12584
+ },
12585
+ {
12586
+ "kind": "method",
12587
+ "name": "handleStreamDeletes",
12588
+ "privacy": "protected",
12589
+ "parameters": [
12590
+ {
12591
+ "name": "deletedRows",
12592
+ "type": {
12593
+ "text": "any[]"
12594
+ }
12595
+ }
12596
+ ],
12597
+ "inheritedFrom": {
12598
+ "name": "GridProBaseDatasource",
12599
+ "module": "src/datasource/base.datasource.ts"
12600
+ }
12601
+ },
12602
+ {
12603
+ "kind": "method",
12604
+ "name": "handleStreamUpdates",
12605
+ "privacy": "protected",
12606
+ "parameters": [
12607
+ {
12608
+ "name": "updatedRows",
12609
+ "type": {
12610
+ "text": "any[]"
12611
+ }
12612
+ }
12613
+ ],
12614
+ "inheritedFrom": {
12615
+ "name": "GridProBaseDatasource",
12616
+ "module": "src/datasource/base.datasource.ts"
12617
+ }
12618
+ },
12619
+ {
12620
+ "kind": "method",
12621
+ "name": "applyAllTransactions",
12622
+ "privacy": "protected",
12623
+ "inheritedFrom": {
12624
+ "name": "GridProBaseDatasource",
12625
+ "module": "src/datasource/base.datasource.ts"
12626
+ }
12627
+ },
12628
+ {
12629
+ "kind": "method",
12630
+ "name": "applyMappedTransaction",
12631
+ "privacy": "private",
12632
+ "parameters": [
12633
+ {
12634
+ "name": "transaction",
12635
+ "type": {
12636
+ "text": "TransactionData"
12637
+ }
12638
+ },
12639
+ {
12640
+ "name": "operation",
12641
+ "type": {
12642
+ "text": "OperationType"
12643
+ }
12644
+ }
12645
+ ],
12646
+ "inheritedFrom": {
12647
+ "name": "GridProBaseDatasource",
12648
+ "module": "src/datasource/base.datasource.ts"
12649
+ }
12650
+ },
12651
+ {
12652
+ "kind": "method",
12653
+ "name": "mapTransaction",
12654
+ "privacy": "private",
12655
+ "parameters": [
12656
+ {
12657
+ "name": "transaction",
12658
+ "type": {
12659
+ "text": "TransactionData"
12660
+ },
12661
+ "description": "The transaction data to be mapped."
12662
+ },
12663
+ {
12664
+ "name": "operations",
12665
+ "default": "Object.values(OperationType)",
12666
+ "type": {
12667
+ "text": "OperationType[]"
12668
+ },
12669
+ "description": "The operations to be mapped. Can be 'add', 'update' or 'remove'."
12670
+ }
12671
+ ],
12672
+ "description": "Maps the transaction data to the row data mapper function, if it exists.",
12673
+ "return": {
12674
+ "type": {
12675
+ "text": ""
12676
+ }
12677
+ },
12678
+ "inheritedFrom": {
12679
+ "name": "GridProBaseDatasource",
12680
+ "module": "src/datasource/base.datasource.ts"
12681
+ }
12682
+ },
12683
+ {
12684
+ "kind": "method",
12685
+ "name": "setVisibleColumns",
12686
+ "return": {
12687
+ "type": {
12688
+ "text": "void"
12689
+ }
12690
+ },
12691
+ "parameters": [
12692
+ {
12693
+ "name": "visibleFields",
12694
+ "type": {
12695
+ "text": "string[]"
12696
+ },
12697
+ "description": "Field names of the currently visible columns."
12698
+ }
12699
+ ],
12700
+ "description": "Notifies the datasource of the field names of the currently visible columns.",
12701
+ "privacy": "public",
12702
+ "inheritedFrom": {
12703
+ "name": "GridProBaseDatasource",
12704
+ "module": "src/datasource/base.datasource.ts"
12705
+ }
12706
+ },
12707
+ {
12708
+ "kind": "field",
12709
+ "name": "_isDisconnected",
12710
+ "type": {
12711
+ "text": "boolean"
12712
+ },
12713
+ "privacy": "private",
12714
+ "default": "false",
12715
+ "inheritedFrom": {
12716
+ "name": "GridProBaseDatasource",
12717
+ "module": "src/datasource/base.datasource.ts"
12718
+ }
12719
+ },
12720
+ {
12721
+ "kind": "method",
12722
+ "name": "setDisconnected",
12723
+ "privacy": "public",
12724
+ "parameters": [
12725
+ {
12726
+ "name": "disconnected",
12727
+ "type": {
12728
+ "text": "boolean"
12729
+ },
12730
+ "description": "true to set, false to remove"
12731
+ }
12732
+ ],
12733
+ "description": "Sets the disconnected state and emits appropriate events.",
12734
+ "inheritedFrom": {
12735
+ "name": "GridProBaseDatasource",
12736
+ "module": "src/datasource/base.datasource.ts"
12737
+ }
12738
+ },
12739
+ {
12740
+ "kind": "method",
12741
+ "name": "isDisconnected",
12742
+ "privacy": "public",
12743
+ "return": {
12744
+ "type": {
12745
+ "text": "boolean"
12746
+ }
12747
+ },
12748
+ "description": "Returns true if the datasource is disconnected.",
12749
+ "inheritedFrom": {
12750
+ "name": "GridProBaseDatasource",
12751
+ "module": "src/datasource/base.datasource.ts"
12752
+ }
12753
+ },
12754
+ {
12755
+ "kind": "method",
12756
+ "name": "getDatasourceStatusBarPanels",
12757
+ "privacy": "public",
12758
+ "return": {
12759
+ "type": {
12760
+ "text": "any[]"
12761
+ }
12762
+ },
12763
+ "parameters": [
12764
+ {
12765
+ "name": "isServerSide",
12766
+ "type": {
12767
+ "text": "boolean"
12768
+ }
12769
+ },
12770
+ {
12771
+ "name": "statusBarConfig",
12772
+ "type": {
12773
+ "text": "any"
12774
+ }
12775
+ }
12776
+ ],
12777
+ "description": "Gets datasource-specific status bar component configurations.\nThis method should be called by the grid to get status bar panels specific to this datasource.",
12778
+ "inheritedFrom": {
12779
+ "name": "GridProBaseDatasource",
12780
+ "module": "src/datasource/base.datasource.ts"
12781
+ }
12782
+ },
12783
+ {
12784
+ "kind": "field",
12785
+ "name": "deferredGridOptions",
12786
+ "type": {
12787
+ "text": "GridOptions"
12788
+ },
12789
+ "inheritedFrom": {
12790
+ "name": "GenesisGridDatasourceElement",
12791
+ "module": "src/datasource/base.datasource.ts"
12792
+ }
12793
+ },
12794
+ {
12795
+ "kind": "field",
12796
+ "name": "deferredColumnStates",
12797
+ "type": {
12798
+ "text": "ColumnState[]"
12799
+ },
12800
+ "inheritedFrom": {
12801
+ "name": "GenesisGridDatasourceElement",
12802
+ "module": "src/datasource/base.datasource.ts"
12803
+ }
12804
+ },
12805
+ {
12806
+ "kind": "field",
12807
+ "name": "rowDataMapper",
12808
+ "type": {
12809
+ "text": "Function"
12810
+ },
12811
+ "description": "Allows grid data updates to be processed via and external function before applying in grid",
12812
+ "inheritedFrom": {
12813
+ "name": "GenesisGridDatasourceElement",
12814
+ "module": "src/datasource/base.datasource.ts"
12815
+ }
12816
+ },
12817
+ {
12818
+ "kind": "field",
12819
+ "name": "criteria",
12820
+ "type": {
12821
+ "text": "string"
12822
+ },
12823
+ "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
12824
+ "inheritedFrom": {
12825
+ "name": "GenesisGridDatasourceElement",
12826
+ "module": "src/datasource/base.datasource.ts"
12827
+ }
12828
+ },
12829
+ {
12830
+ "kind": "field",
12831
+ "name": "isSnapshot",
12832
+ "type": {
12833
+ "text": "boolean"
12834
+ },
12835
+ "default": "false",
12836
+ "description": "Request a snapshot from the server.",
12837
+ "inheritedFrom": {
12838
+ "name": "GenesisGridDatasourceElement",
12839
+ "module": "src/datasource/base.datasource.ts"
12840
+ }
12841
+ },
12842
+ {
12843
+ "kind": "field",
12844
+ "name": "maxRows",
12845
+ "type": {
12846
+ "text": "number"
12847
+ },
12848
+ "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
12849
+ "inheritedFrom": {
12850
+ "name": "GenesisGridDatasourceElement",
12851
+ "module": "src/datasource/base.datasource.ts"
12852
+ }
12853
+ },
12854
+ {
12855
+ "kind": "field",
12856
+ "name": "orderBy",
12857
+ "type": {
12858
+ "text": "string"
12859
+ },
12860
+ "description": "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.",
12861
+ "inheritedFrom": {
12862
+ "name": "GenesisGridDatasourceElement",
12863
+ "module": "src/datasource/base.datasource.ts"
12864
+ }
12865
+ },
12866
+ {
12867
+ "kind": "field",
12868
+ "name": "resourceName",
12869
+ "type": {
12870
+ "text": "string"
12871
+ },
12872
+ "description": "The name of the target Data Server query or Request Server requestReply.",
12873
+ "inheritedFrom": {
12874
+ "name": "GenesisGridDatasourceElement",
12875
+ "module": "src/datasource/base.datasource.ts"
12876
+ }
12877
+ },
12878
+ {
12879
+ "kind": "field",
12880
+ "name": "viewNumber",
12881
+ "type": {
12882
+ "text": "number"
12883
+ },
12884
+ "description": "The desired view/page you want data from.",
12885
+ "inheritedFrom": {
12886
+ "name": "GenesisGridDatasourceElement",
12887
+ "module": "src/datasource/base.datasource.ts"
12888
+ }
12889
+ },
12890
+ {
12891
+ "kind": "field",
12892
+ "name": "fields",
12893
+ "type": {
12894
+ "text": "string"
12895
+ },
12896
+ "description": "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.",
12897
+ "inheritedFrom": {
12898
+ "name": "GenesisGridDatasourceElement",
12899
+ "module": "src/datasource/base.datasource.ts"
12900
+ }
12901
+ },
12902
+ {
12903
+ "kind": "field",
12904
+ "name": "maxView",
12905
+ "type": {
12906
+ "text": "number"
12907
+ },
12908
+ "description": "Maximum number of rows to track as part of a client \"view\".",
12909
+ "inheritedFrom": {
12910
+ "name": "GenesisGridDatasourceElement",
12911
+ "module": "src/datasource/base.datasource.ts"
12912
+ }
12913
+ },
12914
+ {
12915
+ "kind": "field",
12916
+ "name": "movingView",
12917
+ "type": {
12918
+ "text": "boolean"
12919
+ },
12920
+ "default": "false",
12921
+ "description": "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.",
12922
+ "inheritedFrom": {
12923
+ "name": "GenesisGridDatasourceElement",
12924
+ "module": "src/datasource/base.datasource.ts"
12925
+ }
12926
+ },
12927
+ {
12928
+ "kind": "field",
12929
+ "name": "reverse",
12930
+ "type": {
12931
+ "text": "boolean"
12932
+ },
12933
+ "default": "false",
12934
+ "description": "Option that changes the Data Server index iteration.",
12935
+ "inheritedFrom": {
12936
+ "name": "GenesisGridDatasourceElement",
12937
+ "module": "src/datasource/base.datasource.ts"
12938
+ }
12939
+ },
12940
+ {
12941
+ "kind": "field",
12942
+ "name": "disablePolling",
12943
+ "type": {
12944
+ "text": "boolean"
12945
+ },
12946
+ "default": "false",
12947
+ "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
12948
+ "inheritedFrom": {
12949
+ "name": "GenesisGridDatasourceElement",
12950
+ "module": "src/datasource/base.datasource.ts"
12951
+ }
12952
+ },
12953
+ {
12954
+ "kind": "field",
12955
+ "name": "offset",
12956
+ "type": {
12957
+ "text": "number"
12958
+ },
12959
+ "description": "The offset for pagination in REQUEST_SERVER scenarios.",
12960
+ "inheritedFrom": {
12961
+ "name": "GenesisGridDatasourceElement",
12962
+ "module": "src/datasource/base.datasource.ts"
12963
+ }
12964
+ },
12965
+ {
12966
+ "kind": "field",
12967
+ "name": "pollingInterval",
12968
+ "type": {
12969
+ "text": "number"
12970
+ },
12971
+ "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
12972
+ "inheritedFrom": {
12973
+ "name": "GenesisGridDatasourceElement",
12974
+ "module": "src/datasource/base.datasource.ts"
12975
+ }
12976
+ },
12977
+ {
12978
+ "kind": "field",
12979
+ "name": "pollTriggerEvents",
12980
+ "type": {
12981
+ "text": "string[]"
12982
+ },
12983
+ "default": "[]",
12984
+ "description": "Array of event names that will trigger a poll when received as commit responses.",
12985
+ "inheritedFrom": {
12986
+ "name": "GenesisGridDatasourceElement",
12987
+ "module": "src/datasource/base.datasource.ts"
12988
+ }
12989
+ },
12990
+ {
12991
+ "kind": "field",
12992
+ "name": "requestAutoSetup",
12993
+ "type": {
12994
+ "text": "boolean"
12995
+ },
12996
+ "default": "true",
12997
+ "description": "Attribute to set whether the REQUEST object should be automatically set up.",
12998
+ "inheritedFrom": {
12999
+ "name": "GenesisGridDatasourceElement",
13000
+ "module": "src/datasource/base.datasource.ts"
13001
+ }
13002
+ },
13003
+ {
13004
+ "kind": "field",
13005
+ "name": "rowIdAttr",
13006
+ "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
13007
+ "inheritedFrom": {
13008
+ "name": "GenesisGridDatasourceElement",
13009
+ "module": "src/datasource/base.datasource.ts"
13010
+ }
13011
+ },
13012
+ {
13013
+ "kind": "field",
13014
+ "name": "restartOnReconnection",
13015
+ "type": {
13016
+ "text": "boolean"
13017
+ },
13018
+ "default": "true",
13019
+ "description": "Attribute to set whether the datasource should restart when it reconnects.",
13020
+ "inheritedFrom": {
13021
+ "name": "GenesisGridDatasourceElement",
13022
+ "module": "src/datasource/base.datasource.ts"
13023
+ }
13024
+ },
13025
+ {
13026
+ "kind": "field",
13027
+ "name": "defaultRowIdByResourceType",
13028
+ "type": {
13029
+ "text": "string"
13030
+ },
13031
+ "privacy": "protected",
13032
+ "readonly": true,
13033
+ "inheritedFrom": {
13034
+ "name": "GenesisGridDatasourceElement",
13035
+ "module": "src/datasource/base.datasource.ts"
13036
+ }
13037
+ },
13038
+ {
13039
+ "kind": "field",
13040
+ "name": "criteriaFromFilters",
13041
+ "type": {
13042
+ "text": "Map<string, string>"
13043
+ },
13044
+ "privacy": "protected",
13045
+ "default": "new Map()",
13046
+ "inheritedFrom": {
13047
+ "name": "GenesisGridDatasourceElement",
13048
+ "module": "src/datasource/base.datasource.ts"
13049
+ }
13050
+ },
13051
+ {
13052
+ "kind": "field",
13053
+ "name": "update",
13054
+ "type": {
13055
+ "text": "BehaviorSubject<Map<string, string>>"
13056
+ },
13057
+ "privacy": "protected",
13058
+ "default": "new BehaviorSubject(new Map())",
13059
+ "inheritedFrom": {
13060
+ "name": "GenesisGridDatasourceElement",
13061
+ "module": "src/datasource/base.datasource.ts"
13062
+ }
13063
+ },
13064
+ {
13065
+ "kind": "method",
13066
+ "name": "datasourceOptions",
13067
+ "privacy": "protected",
13068
+ "return": {
13069
+ "type": {
13070
+ "text": "DatasourceOptions"
13071
+ }
13072
+ },
13073
+ "inheritedFrom": {
13074
+ "name": "GenesisGridDatasourceElement",
13075
+ "module": "src/datasource/base.datasource.ts"
13076
+ }
13077
+ },
13078
+ {
13079
+ "kind": "method",
13080
+ "name": "buildCriteria",
13081
+ "privacy": "private",
13082
+ "return": {
13083
+ "type": {
13084
+ "text": "string"
13085
+ }
13086
+ },
13087
+ "inheritedFrom": {
13088
+ "name": "GenesisGridDatasourceElement",
13089
+ "module": "src/datasource/base.datasource.ts"
13090
+ }
13091
+ },
13092
+ {
13093
+ "kind": "method",
13094
+ "name": "setFilter",
13095
+ "privacy": "public",
13096
+ "parameters": [
13097
+ {
13098
+ "name": "fieldName",
13099
+ "type": {
13100
+ "text": "string"
13101
+ }
13102
+ },
13103
+ {
13104
+ "name": "newFilter",
13105
+ "type": {
13106
+ "text": "string"
13107
+ }
13108
+ }
13109
+ ],
13110
+ "inheritedFrom": {
13111
+ "name": "GenesisGridDatasourceElement",
13112
+ "module": "src/datasource/base.datasource.ts"
13113
+ }
13114
+ },
13115
+ {
13116
+ "kind": "method",
13117
+ "name": "removeFilter",
13118
+ "privacy": "public",
13119
+ "parameters": [
13120
+ {
13121
+ "name": "fieldName",
13122
+ "type": {
13123
+ "text": "string"
13124
+ }
13125
+ }
13126
+ ],
13127
+ "inheritedFrom": {
13128
+ "name": "GenesisGridDatasourceElement",
13129
+ "module": "src/datasource/base.datasource.ts"
13130
+ }
13131
+ },
13132
+ {
13133
+ "kind": "field",
13134
+ "name": "isRequestServer",
13135
+ "type": {
13136
+ "text": "boolean"
13137
+ },
13138
+ "readonly": true,
13139
+ "inheritedFrom": {
13140
+ "name": "GenesisGridDatasourceElement",
13141
+ "module": "src/datasource/base.datasource.ts"
13142
+ }
13143
+ },
13144
+ {
13145
+ "kind": "method",
13146
+ "name": "datasourceStatusChanged",
13147
+ "parameters": [
13148
+ {
13149
+ "name": "prev",
13150
+ "type": {
13151
+ "text": "DatasourceStatus"
13152
+ }
13153
+ },
13154
+ {
13155
+ "name": "next",
13156
+ "type": {
13157
+ "text": "DatasourceStatus"
13158
+ }
13159
+ }
13160
+ ],
13161
+ "inheritedFrom": {
13162
+ "name": "GenesisGridDatasourceElement",
13163
+ "module": "src/datasource/base.datasource.ts"
13164
+ }
13165
+ },
13166
+ {
13167
+ "kind": "method",
13168
+ "name": "handleErrors",
13169
+ "parameters": [
13170
+ {
13171
+ "name": "errors",
13172
+ "type": {
13173
+ "text": "string | any[]"
13174
+ },
13175
+ "description": "The error message or array of error messages"
13176
+ },
13177
+ {
13178
+ "name": "type",
13179
+ "default": "'unknown'",
13180
+ "type": {
13181
+ "text": "BaseDatasourceErrorEventDetail['type']"
13182
+ },
13183
+ "description": "The type of error that occurred"
13184
+ }
13185
+ ],
13186
+ "description": "Handles errors and emits appropriate error events.",
13187
+ "privacy": "public",
13188
+ "inheritedFrom": {
13189
+ "name": "GenesisGridDatasourceElement",
13190
+ "module": "src/datasource/base.datasource.ts"
13191
+ }
13192
+ },
13193
+ {
13194
+ "kind": "method",
13195
+ "name": "clearErrors",
13196
+ "description": "Clears error state and emits connected event.",
13197
+ "privacy": "public",
13198
+ "inheritedFrom": {
13199
+ "name": "GenesisGridDatasourceElement",
13200
+ "module": "src/datasource/base.datasource.ts"
13201
+ }
13202
+ },
13203
+ {
13204
+ "kind": "field",
13205
+ "name": "_presentation",
13206
+ "type": {
13207
+ "text": "ComponentPresentation | null | undefined"
13208
+ },
13209
+ "privacy": "private",
13210
+ "default": "void 0",
13211
+ "inheritedFrom": {
13212
+ "name": "FoundationElement",
13213
+ "module": "src/foundation-element/foundation-element.ts"
13214
+ }
13215
+ },
13216
+ {
13217
+ "kind": "field",
13218
+ "name": "$presentation",
13219
+ "type": {
13220
+ "text": "ComponentPresentation | null"
13221
+ },
13222
+ "privacy": "public",
13223
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
13224
+ "inheritedFrom": {
13225
+ "name": "FoundationElement",
13226
+ "module": "src/foundation-element/foundation-element.ts"
13227
+ }
13228
+ },
13229
+ {
13230
+ "kind": "field",
13231
+ "name": "template",
13232
+ "type": {
13233
+ "text": "ElementViewTemplate | void | null"
13234
+ },
13235
+ "privacy": "public",
13236
+ "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
13237
+ "inheritedFrom": {
13238
+ "name": "FoundationElement",
13239
+ "module": "src/foundation-element/foundation-element.ts"
13240
+ }
13241
+ },
13242
+ {
13243
+ "kind": "method",
13244
+ "name": "templateChanged",
13245
+ "privacy": "protected",
13246
+ "return": {
13247
+ "type": {
13248
+ "text": "void"
13249
+ }
13250
+ },
13251
+ "inheritedFrom": {
13252
+ "name": "FoundationElement",
13253
+ "module": "src/foundation-element/foundation-element.ts"
13254
+ }
13255
+ },
13256
+ {
13257
+ "kind": "field",
13258
+ "name": "styles",
13259
+ "type": {
13260
+ "text": "ElementStyles | void | null"
13261
+ },
13262
+ "privacy": "public",
13263
+ "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
13264
+ "inheritedFrom": {
13265
+ "name": "FoundationElement",
13266
+ "module": "src/foundation-element/foundation-element.ts"
13267
+ }
13268
+ },
13269
+ {
13270
+ "kind": "method",
13271
+ "name": "stylesChanged",
13272
+ "privacy": "protected",
13273
+ "return": {
13274
+ "type": {
13275
+ "text": "void"
13276
+ }
13277
+ },
13278
+ "inheritedFrom": {
13279
+ "name": "FoundationElement",
13280
+ "module": "src/foundation-element/foundation-element.ts"
13281
+ }
13282
+ },
13283
+ {
13284
+ "kind": "method",
13285
+ "name": "compose",
13286
+ "privacy": "public",
13287
+ "static": true,
13288
+ "return": {
13289
+ "type": {
13290
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
13291
+ }
13292
+ },
13293
+ "parameters": [
13294
+ {
13295
+ "name": "this",
13296
+ "type": {
13297
+ "text": "K"
13298
+ }
13299
+ },
13300
+ {
13301
+ "name": "elementDefinition",
13302
+ "type": {
13303
+ "text": "T"
13304
+ },
13305
+ "description": "The definition of the element to create the registry\nfunction for."
13306
+ }
13307
+ ],
13308
+ "description": "Defines an element registry function with a set of element definition defaults.",
13309
+ "inheritedFrom": {
13310
+ "name": "FoundationElement",
13311
+ "module": "src/foundation-element/foundation-element.ts"
13312
+ }
13313
+ }
13314
+ ],
13315
+ "events": [
13316
+ {
13317
+ "description": "Fired when a datasource error is reported. detail: `BaseDatasourceErrorEventDetail`",
13318
+ "name": "base-datasource-error",
13319
+ "inheritedFrom": {
13320
+ "name": "GenesisGridDatasourceElement",
13321
+ "module": "src/datasource/base.datasource.ts"
13322
+ }
13323
+ },
13324
+ {
13325
+ "description": "Fired when a datasource error occurs (for grid integration). detail: `DatasourceErrorEventDetail`",
13326
+ "name": "datasource-error",
13327
+ "inheritedFrom": {
13328
+ "name": "GenesisGridDatasourceElement",
13329
+ "module": "src/datasource/base.datasource.ts"
13330
+ }
13331
+ },
13332
+ {
13333
+ "description": "Fired when error state is cleared after connection succeeds",
13334
+ "name": "base-datasource-connected",
13335
+ "inheritedFrom": {
13336
+ "name": "GenesisGridDatasourceElement",
13337
+ "module": "src/datasource/base.datasource.ts"
13338
+ }
13339
+ },
13340
+ {
13341
+ "description": "Fired to hand off infinite row model grid options. detail: `InitializeEventDetail`",
13342
+ "name": "datasource-initialize"
13343
+ },
13344
+ {
13345
+ "description": "Fired when the infinite grid model should initialize data",
13346
+ "name": "datasource-init"
13347
+ },
13348
+ {
13349
+ "description": "Fired when column metadata or defs are updated. detail: `SchemaUpdatedEventDetail`",
13350
+ "name": "datasource-schema-updated"
13351
+ },
13352
+ {
13353
+ "description": "Fired to attach or clear the infinite row model datasource. detail: `SetInfiniteDatasourceEventDetail`",
13354
+ "name": "set-infinite-datasource"
13355
+ },
13356
+ {
13357
+ "description": "Fired to request an infinite row model refresh; `purge` drops the block cache and re-reads. detail: `RefreshInfiniteCacheEventDetail`",
13358
+ "name": "refresh-infinite-cache"
13359
+ },
13360
+ {
13361
+ "description": "Fired to persist filter configuration for the grid",
13362
+ "name": "cache-filter-config"
13363
+ },
13364
+ {
13365
+ "description": "Fired when infinite row data is cleared. detail: `DataClearedEventDetail`",
13366
+ "name": "datasource-data-cleared"
13367
+ },
13368
+ {
13369
+ "description": "Fired when persisted filters are reapplied",
13370
+ "name": "datasource-filters-restored"
13371
+ },
13372
+ {
13373
+ "description": "Fired when pending stream transactions are flushed with no row changes",
13374
+ "name": "datasource-loading-finished",
13375
+ "inheritedFrom": {
13376
+ "name": "GenesisGridDatasourceElement",
13377
+ "module": "src/datasource/base.datasource.ts"
13378
+ }
13379
+ },
13380
+ {
13381
+ "description": "Fired when loading finishes with an empty row set",
13382
+ "name": "datasource-no-data-available",
13383
+ "inheritedFrom": {
13384
+ "name": "GenesisGridDatasourceElement",
13385
+ "module": "src/datasource/base.datasource.ts"
13386
+ }
13387
+ },
13388
+ {
13389
+ "description": "Fired when row data changes from applied stream transactions. detail: `DataChangedEventDetail`",
13390
+ "name": "datasource-data-changed",
13391
+ "inheritedFrom": {
13392
+ "name": "GenesisGridDatasourceElement",
13393
+ "module": "src/datasource/base.datasource.ts"
13394
+ }
13395
+ }
13396
+ ],
13397
+ "mixins": [
13398
+ {
13399
+ "name": "LifecycleMixin",
13400
+ "package": "@genesislcap/foundation-utils"
13401
+ }
13402
+ ],
13403
+ "superclass": {
13404
+ "name": "GridProBaseDatasource",
13405
+ "module": "/src/datasource/base.datasource"
13406
+ },
13407
+ "tagName": "grid-pro-infinite-datasource",
13408
+ "customElement": true,
13409
+ "attributes": [
13410
+ {
13411
+ "name": "criteria",
13412
+ "type": {
13413
+ "text": "string"
13414
+ },
13415
+ "description": "Groovy expression to perform filters on the query server; these remain active for the life of the subscription.",
13416
+ "fieldName": "criteria",
13417
+ "inheritedFrom": {
13418
+ "name": "GenesisGridDatasourceElement",
13419
+ "module": "src/datasource/base.datasource.ts"
13420
+ }
13421
+ },
13422
+ {
13423
+ "name": "is-snapshot",
13424
+ "type": {
13425
+ "text": "boolean"
13426
+ },
13427
+ "default": "false",
13428
+ "description": "Request a snapshot from the server.",
13429
+ "fieldName": "isSnapshot",
13430
+ "inheritedFrom": {
13431
+ "name": "GenesisGridDatasourceElement",
13432
+ "module": "src/datasource/base.datasource.ts"
13433
+ }
13434
+ },
13435
+ {
13436
+ "name": "max-rows",
13437
+ "type": {
13438
+ "text": "number"
13439
+ },
13440
+ "description": "Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE_ROWS messages.",
13441
+ "fieldName": "maxRows",
13442
+ "inheritedFrom": {
13443
+ "name": "GenesisGridDatasourceElement",
13444
+ "module": "src/datasource/base.datasource.ts"
13445
+ }
13446
+ },
13447
+ {
13448
+ "name": "order-by",
13449
+ "type": {
13450
+ "text": "string"
13451
+ },
13452
+ "description": "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.",
13453
+ "fieldName": "orderBy",
13454
+ "inheritedFrom": {
13455
+ "name": "GenesisGridDatasourceElement",
13456
+ "module": "src/datasource/base.datasource.ts"
13457
+ }
13458
+ },
13459
+ {
13460
+ "name": "resource-name",
13461
+ "type": {
13462
+ "text": "string"
13463
+ },
13464
+ "description": "The name of the target Data Server query or Request Server requestReply.",
13465
+ "fieldName": "resourceName",
13466
+ "inheritedFrom": {
13467
+ "name": "GenesisGridDatasourceElement",
13468
+ "module": "src/datasource/base.datasource.ts"
13469
+ }
13470
+ },
13471
+ {
13472
+ "name": "view-number",
13473
+ "type": {
13474
+ "text": "number"
13475
+ },
13476
+ "description": "The desired view/page you want data from.",
13477
+ "fieldName": "viewNumber",
13478
+ "inheritedFrom": {
13479
+ "name": "GenesisGridDatasourceElement",
13480
+ "module": "src/datasource/base.datasource.ts"
13481
+ }
13482
+ },
13483
+ {
13484
+ "name": "fields",
13485
+ "type": {
13486
+ "text": "string"
13487
+ },
13488
+ "description": "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.",
13489
+ "fieldName": "fields",
13490
+ "inheritedFrom": {
13491
+ "name": "GenesisGridDatasourceElement",
13492
+ "module": "src/datasource/base.datasource.ts"
13493
+ }
13494
+ },
13495
+ {
13496
+ "name": "max-view",
13497
+ "type": {
13498
+ "text": "number"
13499
+ },
13500
+ "description": "Maximum number of rows to track as part of a client \"view\".",
13501
+ "fieldName": "maxView",
13502
+ "inheritedFrom": {
13503
+ "name": "GenesisGridDatasourceElement",
13504
+ "module": "src/datasource/base.datasource.ts"
13505
+ }
13506
+ },
13507
+ {
13508
+ "name": "moving-view",
13509
+ "type": {
13510
+ "text": "boolean"
13511
+ },
13512
+ "default": "false",
13513
+ "description": "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.",
13514
+ "fieldName": "movingView",
13515
+ "inheritedFrom": {
13516
+ "name": "GenesisGridDatasourceElement",
13517
+ "module": "src/datasource/base.datasource.ts"
13518
+ }
13519
+ },
13520
+ {
13521
+ "type": {
13522
+ "text": "number"
13523
+ },
13524
+ "description": "Option that changes the Data Server index iteration.",
13525
+ "fieldName": "reverse",
13526
+ "default": "false",
13527
+ "inheritedFrom": {
13528
+ "name": "GenesisGridDatasourceElement",
13529
+ "module": "src/datasource/base.datasource.ts"
13530
+ }
13531
+ },
13532
+ {
13533
+ "name": "disable-polling",
13534
+ "type": {
13535
+ "text": "boolean"
13536
+ },
13537
+ "default": "false",
13538
+ "description": "Disables polling if set to true (data updates for the grid will not be fetched automatically).",
13539
+ "fieldName": "disablePolling",
13540
+ "inheritedFrom": {
13541
+ "name": "GenesisGridDatasourceElement",
13542
+ "module": "src/datasource/base.datasource.ts"
13543
+ }
13544
+ },
13545
+ {
13546
+ "name": "polling-interval",
13547
+ "type": {
13548
+ "text": "number"
13549
+ },
13550
+ "description": "Custom polling frequency (in milliseconds) for a Request Server resource.",
13551
+ "fieldName": "pollingInterval",
13552
+ "inheritedFrom": {
13553
+ "name": "GenesisGridDatasourceElement",
13554
+ "module": "src/datasource/base.datasource.ts"
13555
+ }
13556
+ },
13557
+ {
13558
+ "name": "request-auto-setup",
13559
+ "type": {
13560
+ "text": "boolean"
13561
+ },
13562
+ "default": "true",
13563
+ "description": "Attribute to set whether the REQUEST object should be automatically set up.",
13564
+ "fieldName": "requestAutoSetup",
13565
+ "inheritedFrom": {
13566
+ "name": "GenesisGridDatasourceElement",
13567
+ "module": "src/datasource/base.datasource.ts"
13568
+ }
13569
+ },
13570
+ {
13571
+ "name": "row-id",
13572
+ "description": "Attribute to set an unique identifier for the row.\n\nDefaults to `ROW_REF` or `RECORD_ID` depending on the resource type.",
13573
+ "fieldName": "rowIdAttr",
13574
+ "inheritedFrom": {
13575
+ "name": "GenesisGridDatasourceElement",
13576
+ "module": "src/datasource/base.datasource.ts"
13577
+ }
13578
+ },
13579
+ {
13580
+ "name": "restart-on-reconnection",
13581
+ "type": {
13582
+ "text": "boolean"
13583
+ },
13584
+ "default": "true",
13585
+ "description": "Attribute to set whether the datasource should restart when it reconnects.",
13586
+ "fieldName": "restartOnReconnection",
13587
+ "inheritedFrom": {
13588
+ "name": "GenesisGridDatasourceElement",
13589
+ "module": "src/datasource/base.datasource.ts"
13590
+ }
13591
+ }
13592
+ ]
13593
+ }
13594
+ ],
13595
+ "exports": [
13596
+ {
13597
+ "kind": "js",
13598
+ "name": "GridProInfiniteDatasource",
13599
+ "declaration": {
13600
+ "name": "GridProInfiniteDatasource",
13601
+ "module": "src/datasource/infinite.datasource.ts"
13602
+ }
13603
+ },
13604
+ {
13605
+ "kind": "custom-element-definition",
13606
+ "name": "grid-pro-infinite-datasource",
13607
+ "declaration": {
13608
+ "name": "GridProInfiniteDatasource",
13609
+ "module": "src/datasource/infinite.datasource.ts"
13610
+ }
13611
+ }
13612
+ ]
13613
+ },
13614
+ {
13615
+ "kind": "javascript-module",
13616
+ "path": "src/datasource/infinite.resource.ts",
13617
+ "declarations": [
13618
+ {
13619
+ "kind": "function",
13620
+ "name": "convertSortModelToOrderBy",
13621
+ "return": {
13622
+ "type": {
13623
+ "text": ""
13624
+ }
13625
+ },
13626
+ "parameters": [
13627
+ {
13628
+ "name": "sortModel",
13629
+ "type": {
13630
+ "text": "SortModelItem[]"
13631
+ },
13632
+ "description": "The AG Grid sort model"
13633
+ },
13634
+ {
13635
+ "name": "resourceIndexes",
13636
+ "type": {
13637
+ "text": "Map<string, string[]>"
13638
+ },
13639
+ "description": "Available indexes for sorting (DATASERVER)"
13640
+ },
13641
+ {
13642
+ "name": "isRequestServer",
13643
+ "default": "false",
13644
+ "description": "Whether the resource is a REQUEST_SERVER"
13645
+ }
13646
+ ],
13647
+ "description": "Converts an AG Grid sort model to the Genesis ORDER_BY form the resource expects."
13648
+ },
13649
+ {
13650
+ "kind": "class",
13651
+ "description": "AG Grid Infinite Row Model datasource implementation.\nThis class implements the IDatasource interface required by AG Grid's Infinite Row Model.",
13652
+ "name": "GenesisInfiniteDatasource",
13653
+ "members": [
13654
+ {
13655
+ "kind": "field",
13656
+ "name": "rowCount",
13657
+ "type": {
13658
+ "text": "number | undefined"
13659
+ }
13660
+ },
13661
+ {
13662
+ "kind": "field",
13663
+ "name": "resourceName",
13664
+ "type": {
13665
+ "text": "string"
13666
+ },
13667
+ "privacy": "private"
13668
+ },
13669
+ {
13670
+ "kind": "field",
13671
+ "name": "resourceParams",
13672
+ "type": {
13673
+ "text": "any"
13674
+ },
13675
+ "privacy": "private",
13676
+ "default": "{ ...options.resourceParams }"
13677
+ },
13678
+ {
13679
+ "kind": "field",
13680
+ "name": "resourceIndexes",
13681
+ "type": {
13682
+ "text": "Map<string, string[]>"
13683
+ },
13684
+ "privacy": "private"
13685
+ },
13686
+ {
13687
+ "kind": "field",
13688
+ "name": "resourceColDefs",
13689
+ "type": {
13690
+ "text": "MetadataDetail[]"
13691
+ },
13692
+ "privacy": "private"
13693
+ },
13694
+ {
13695
+ "kind": "field",
13696
+ "name": "maxRows",
13697
+ "type": {
13698
+ "text": "number"
13699
+ },
13700
+ "privacy": "private"
13701
+ },
13702
+ {
13703
+ "kind": "field",
13704
+ "name": "rowId",
13705
+ "type": {
13706
+ "text": "string"
13707
+ },
13708
+ "privacy": "private"
13709
+ },
13710
+ {
13711
+ "kind": "field",
13712
+ "name": "baseCriteria",
13713
+ "type": {
13714
+ "text": "string"
13715
+ },
13716
+ "privacy": "private"
13717
+ },
13718
+ {
13719
+ "kind": "field",
13720
+ "name": "isRequestServer",
13721
+ "type": {
13722
+ "text": "boolean"
13723
+ },
13724
+ "privacy": "private"
13725
+ },
13726
+ {
13727
+ "kind": "field",
13728
+ "name": "createSnapshotFunc",
13729
+ "type": {
13730
+ "text": "(\n params?: any,\n ) => Promise<RequestServerResult | FilteredDataServerResult>"
13731
+ },
13732
+ "privacy": "private"
13733
+ },
13734
+ {
13735
+ "kind": "field",
13736
+ "name": "createDataserverStreamFunc",
13737
+ "type": {
13738
+ "text": "(params?: any) => SocketObservable<FilteredDataServerResult>"
13739
+ },
13740
+ "privacy": "private"
13741
+ },
13742
+ {
13743
+ "kind": "field",
13744
+ "name": "getMoreRowsFunc",
13745
+ "type": {
13746
+ "text": "(sourceRef: string) => Promise<unknown>"
13747
+ },
13748
+ "privacy": "private"
13749
+ },
13750
+ {
13751
+ "kind": "field",
13752
+ "name": "errorHandlerFunc",
13753
+ "type": {
13754
+ "text": "(message: string, type: string) => void"
13755
+ },
13756
+ "privacy": "private"
13757
+ },
13758
+ {
13759
+ "kind": "field",
13760
+ "name": "HTTP_NOT_FOUND",
13761
+ "type": {
13762
+ "text": "number"
13763
+ },
13764
+ "privacy": "private",
13765
+ "static": true,
13766
+ "readonly": true,
13767
+ "default": "404",
13768
+ "description": "MORE_ROWS answered 404: the connection has no such endpoint (HTTP mode). @internal"
13769
+ },
13770
+ {
13771
+ "kind": "field",
13772
+ "name": "dataserverStreamSubscription",
13773
+ "type": {
13774
+ "text": "SocketSubscription"
13775
+ },
13776
+ "privacy": "private"
13777
+ },
13778
+ {
13779
+ "kind": "field",
13780
+ "name": "sourceRef",
13781
+ "type": {
13782
+ "text": "string"
13783
+ },
13784
+ "privacy": "private"
13785
+ },
13786
+ {
13787
+ "kind": "field",
13788
+ "name": "pendingBlocks",
13789
+ "type": {
13790
+ "text": "Set<PendingBlock>"
13791
+ },
13792
+ "privacy": "private",
13793
+ "default": "new Set()",
13794
+ "description": "Blocks waiting for the cache to reach their range. @internal"
13795
+ },
13796
+ {
13797
+ "kind": "field",
13798
+ "name": "deliveredRowCount",
13799
+ "type": {
13800
+ "text": "number"
13801
+ },
13802
+ "privacy": "private",
13803
+ "default": "0",
13804
+ "description": "Highest absolute row index already handed to AG Grid. @internal"
13805
+ },
13806
+ {
13807
+ "kind": "field",
13808
+ "name": "streamStarted",
13809
+ "type": {
13810
+ "text": "boolean"
13811
+ },
13812
+ "privacy": "private",
13813
+ "default": "false",
13814
+ "description": "False until the first message arrives on the subscription. @internal"
13815
+ },
13816
+ {
13817
+ "kind": "field",
13818
+ "name": "moreRows",
13819
+ "type": {
13820
+ "text": "boolean | undefined"
13821
+ },
13822
+ "privacy": "private",
13823
+ "description": "MORE_ROWS from the most recent batch. @internal"
13824
+ },
13825
+ {
13826
+ "kind": "field",
13827
+ "name": "moreRowsInFlight",
13828
+ "type": {
13829
+ "text": "boolean"
13830
+ },
13831
+ "privacy": "private",
13832
+ "default": "false",
13833
+ "description": "Whether a MORE_ROWS request is awaiting its batch. @internal"
13834
+ },
13835
+ {
13836
+ "kind": "field",
13837
+ "name": "hasCriteria",
13838
+ "type": {
13839
+ "text": "boolean"
13840
+ },
13841
+ "privacy": "private",
13842
+ "default": "false",
13843
+ "description": "Whether the current subscription was opened with a CRITERIA_MATCH. @internal"
13844
+ },
13845
+ {
13846
+ "kind": "field",
13847
+ "name": "viewTruncationWarned",
13848
+ "type": {
13849
+ "text": "boolean"
13850
+ },
13851
+ "privacy": "private",
13852
+ "default": "false",
13853
+ "description": "So the MAX_VIEW truncation warning is logged once per subscription. @internal"
13854
+ },
13855
+ {
13856
+ "kind": "method",
13857
+ "name": "buildRequestServerParams",
13858
+ "privacy": "private",
13859
+ "return": {
13860
+ "type": {
13861
+ "text": "any"
13862
+ }
13863
+ },
13864
+ "parameters": [
13865
+ {
13866
+ "name": "startRow",
13867
+ "type": {
13868
+ "text": "number"
13869
+ }
13870
+ },
13871
+ {
13872
+ "name": "criteria",
13873
+ "type": {
13874
+ "text": "string"
13875
+ }
13876
+ },
13877
+ {
13878
+ "name": "sortConfig",
13879
+ "type": {
13880
+ "text": "{ orderBy: string | null; reverse: boolean }"
13881
+ }
13882
+ }
13883
+ ],
13884
+ "description": "Builds request parameters for REQUEST_SERVER resources.\nUses OFFSET-based pagination."
13885
+ },
13886
+ {
13887
+ "kind": "method",
13888
+ "name": "buildDataserverLogonParams",
13889
+ "privacy": "private",
13890
+ "return": {
13891
+ "type": {
13892
+ "text": "any"
13893
+ }
13894
+ },
13895
+ "parameters": [
13896
+ {
13897
+ "name": "criteria",
13898
+ "type": {
13899
+ "text": "string"
13900
+ }
13901
+ },
13902
+ {
13903
+ "name": "sortConfig",
13904
+ "type": {
13905
+ "text": "{ orderBy: string | null; reverse: boolean }"
13906
+ }
13907
+ }
13908
+ ],
13909
+ "description": "Builds the DATA_LOGON parameters for the DATASERVER subscription."
13910
+ },
13911
+ {
13912
+ "kind": "method",
13913
+ "name": "getLastRow",
13914
+ "privacy": "private",
13915
+ "return": {
13916
+ "type": {
13917
+ "text": "number"
13918
+ }
13919
+ },
13920
+ "parameters": [
13921
+ {
13922
+ "name": "result",
13923
+ "type": {
13924
+ "text": "any"
13925
+ }
13926
+ },
13927
+ {
13928
+ "name": "startRow",
13929
+ "type": {
13930
+ "text": "number"
13931
+ }
13932
+ },
13933
+ {
13934
+ "name": "rowDataLength",
13935
+ "type": {
13936
+ "text": "number"
13937
+ }
13938
+ },
13939
+ {
13940
+ "name": "hasCriteria",
13941
+ "type": {
13942
+ "text": "boolean"
13943
+ }
13944
+ }
13945
+ ],
13946
+ "description": "Determines the last row index from the server response."
13947
+ },
13948
+ {
13949
+ "kind": "method",
13950
+ "name": "getRows",
13951
+ "return": {
13952
+ "type": {
13953
+ "text": "Promise<void>"
13954
+ }
13955
+ },
13956
+ "parameters": [
13957
+ {
13958
+ "name": "params",
13959
+ "type": {
13960
+ "text": "IGetRowsParams"
13961
+ }
13962
+ }
13963
+ ],
13964
+ "description": "Called by AG Grid when more rows are needed.\nImplements the IDatasource.getRows method."
13965
+ },
13966
+ {
13967
+ "kind": "method",
13968
+ "name": "cacheIndexOf",
13969
+ "privacy": "private",
13970
+ "return": {
13971
+ "type": {
13972
+ "text": "number"
13973
+ }
13974
+ },
13975
+ "parameters": [
13976
+ {
13977
+ "name": "rows",
13978
+ "type": {
13979
+ "text": "Map<string, any>"
13980
+ }
13981
+ },
13982
+ {
13983
+ "name": "key",
13984
+ "type": {
13985
+ "text": "string"
13986
+ }
13987
+ }
13988
+ ],
13989
+ "description": "Position of a key in the cache, or -1. @internal"
13990
+ },
13991
+ {
13992
+ "kind": "method",
13993
+ "name": "reset",
13994
+ "return": {
13995
+ "type": {
13996
+ "text": "void"
13997
+ }
13998
+ },
13999
+ "description": "Drops the accumulated rows and the subscription, so the next block re-reads from the server.",
14000
+ "privacy": "public"
14001
+ },
14002
+ {
14003
+ "kind": "method",
14004
+ "name": "destroy",
14005
+ "return": {
14006
+ "type": {
14007
+ "text": "void"
14008
+ }
14009
+ }
14010
+ },
14011
+ {
14012
+ "kind": "field",
14013
+ "name": "onRowsInvalidatedFunc"
14014
+ },
14015
+ {
14016
+ "kind": "field",
14017
+ "name": "onRowsUpdatedFunc"
14018
+ }
14019
+ ]
14020
+ }
14021
+ ],
14022
+ "exports": [
14023
+ {
14024
+ "kind": "js",
14025
+ "name": "convertSortModelToOrderBy",
14026
+ "declaration": {
14027
+ "name": "convertSortModelToOrderBy",
14028
+ "module": "src/datasource/infinite.resource.ts"
14029
+ }
14030
+ },
14031
+ {
14032
+ "kind": "js",
14033
+ "name": "GenesisInfiniteDatasource",
14034
+ "declaration": {
14035
+ "name": "GenesisInfiniteDatasource",
14036
+ "module": "src/datasource/infinite.resource.ts"
14037
+ }
14038
+ }
14039
+ ]
14040
+ },
14041
+ {
14042
+ "kind": "javascript-module",
14043
+ "path": "src/datasource/row-match.classes.ts",
14044
+ "declarations": [
14045
+ {
14046
+ "kind": "variable",
14047
+ "name": "ROW_MATCH_ALERT_CLASS",
14048
+ "type": {
14049
+ "text": "string"
14050
+ },
14051
+ "default": "'grid-pro-row-alert'",
14052
+ "description": "Class the grid puts on rows satisfying the criteria. The grid's own styles flash it in step\nwith any alerting tab, so a tab that draws you to a grid also shows you which rows caused it.",
14053
+ "privacy": "public"
14054
+ },
14055
+ {
14056
+ "kind": "variable",
14057
+ "name": "ROW_MATCH_ALERT_CELL_CLASS",
14058
+ "type": {
14059
+ "text": "string"
14060
+ },
14061
+ "default": "'grid-pro-row-alert-cell'",
14062
+ "description": "Class the grid puts on just the `flashField` cell of a matching row, for grids that flash a\nsingle column rather than the whole row.",
14063
+ "privacy": "public"
14064
+ },
14065
+ {
14066
+ "kind": "function",
14067
+ "name": "createRowMatchClassRules",
14068
+ "return": {
14069
+ "type": {
14070
+ "text": "Record<string, (params: { data?: unknown }) => boolean>"
14071
+ }
14072
+ },
14073
+ "parameters": [
14074
+ {
14075
+ "name": "criteria",
14076
+ "type": {
14077
+ "text": "RowMatchCriteria"
14078
+ }
14079
+ }
12034
14080
  ],
12035
14081
  "description": "Row class rules that flag rows meeting RowMatchCriteria, for spreading into\n`gridOptions.rowClassRules`.\n\nPairs with DatasourceRowMatchTracker: the tracker decides whether a tab should flash,\nthese decide which rows made it flash. Both take the same criteria, so the two cannot disagree.\n\n```ts\ngridOptions = { rowClassRules: createRowMatchClassRules(criteria) };\n```",
12036
14082
  "privacy": "public"
@@ -12327,7 +14373,7 @@
12327
14373
  "kind": "field",
12328
14374
  "name": "indexes",
12329
14375
  "type": {
12330
- "text": "Map<string, [string]>"
14376
+ "text": "Map<string, string[]>"
12331
14377
  },
12332
14378
  "privacy": "private"
12333
14379
  },
@@ -12469,30 +14515,6 @@
12469
14515
  }
12470
14516
  ]
12471
14517
  },
12472
- {
12473
- "kind": "method",
12474
- "name": "getResourceIndexes",
12475
- "privacy": "private",
12476
- "return": {
12477
- "type": {
12478
- "text": "Map<string, [string]>"
12479
- }
12480
- },
12481
- "parameters": [
12482
- {
12483
- "name": "avaialbleIndexes",
12484
- "type": {
12485
- "text": "IndexDetail[]"
12486
- }
12487
- },
12488
- {
12489
- "name": "availableSortableFields",
12490
- "type": {
12491
- "text": "string[]"
12492
- }
12493
- }
12494
- ]
12495
- },
12496
14518
  {
12497
14519
  "kind": "method",
12498
14520
  "name": "createReqRepRequest",
@@ -12561,28 +14583,6 @@
12561
14583
  }
12562
14584
  ]
12563
14585
  },
12564
- {
12565
- "kind": "method",
12566
- "name": "applyTransaction",
12567
- "privacy": "protected",
12568
- "return": {
12569
- "type": {
12570
- "text": "any"
12571
- }
12572
- },
12573
- "parameters": [
12574
- {
12575
- "name": "transaction",
12576
- "type": {
12577
- "text": "any"
12578
- }
12579
- }
12580
- ],
12581
- "inheritedFrom": {
12582
- "name": "GridProBaseDatasource",
12583
- "module": "src/datasource/base.datasource.ts"
12584
- }
12585
- },
12586
14586
  {
12587
14587
  "kind": "method",
12588
14588
  "name": "loadMore",
@@ -14038,7 +16038,7 @@
14038
16038
  "kind": "field",
14039
16039
  "name": "resourceIndexes",
14040
16040
  "type": {
14041
- "text": "Map<string, [string]>"
16041
+ "text": "Map<string, string[]>"
14042
16042
  },
14043
16043
  "privacy": "protected"
14044
16044
  },
@@ -14739,7 +16739,7 @@
14739
16739
  "kind": "field",
14740
16740
  "name": "resourceIndexes",
14741
16741
  "type": {
14742
- "text": "Map<string, [string]>"
16742
+ "text": "Map<string, string[]>"
14743
16743
  },
14744
16744
  "privacy": "protected",
14745
16745
  "inheritedFrom": {
@@ -15661,7 +17661,7 @@
15661
17661
  "kind": "field",
15662
17662
  "name": "resourceIndexes",
15663
17663
  "type": {
15664
- "text": "Map<string, [string]>"
17664
+ "text": "Map<string, string[]>"
15665
17665
  },
15666
17666
  "privacy": "protected",
15667
17667
  "inheritedFrom": {
@@ -16423,9 +18423,9 @@
16423
18423
  "kind": "variable",
16424
18424
  "name": "datasourceEventNames",
16425
18425
  "type": {
16426
- "text": "{\n // Initialization events\n initialize: 'datasource-initialize',\n ready: 'datasource-ready',\n\n // Data events\n dataLoaded: 'datasource-data-loaded',\n dataChanged: 'datasource-data-changed',\n dataCleared: 'datasource-data-cleared',\n\n // Schema events\n schemaUpdated: 'datasource-schema-updated',\n\n // Status events\n loadingStarted: 'datasource-loading-started',\n loadingFinished: 'datasource-loading-finished',\n noDataAvailable: 'datasource-no-data-available',\n moreDataAvailable: 'datasource-more-data-available',\n\n // Filter events\n filtersRestored: 'datasource-filters-restored',\n\n // Error events\n error: 'datasource-error',\n\n // Destroy datasource events\n destroy: 'datasource-destroy',\n\n // Size events\n sizeChanged: 'datasource-size-changed',\n\n // Server-side specific events\n cacheFilterConfig: 'cache-filter-config',\n refreshServerSide: 'refresh-server-side',\n setServerSideDatasource: 'set-server-side-datasource',\n addGridCssClass: 'add-grid-css-class',\n removeGridCssClass: 'remove-grid-css-class',\n applyServerSideTransaction: 'apply-server-side-transaction',\n}"
18426
+ "text": "{\n // Initialization events\n initialize: 'datasource-initialize',\n ready: 'datasource-ready',\n\n // Data events\n dataLoaded: 'datasource-data-loaded',\n dataChanged: 'datasource-data-changed',\n dataCleared: 'datasource-data-cleared',\n\n // Schema events\n schemaUpdated: 'datasource-schema-updated',\n\n // Status events\n loadingStarted: 'datasource-loading-started',\n loadingFinished: 'datasource-loading-finished',\n noDataAvailable: 'datasource-no-data-available',\n moreDataAvailable: 'datasource-more-data-available',\n\n // Filter events\n filtersRestored: 'datasource-filters-restored',\n\n // Error events\n error: 'datasource-error',\n\n // Destroy datasource events\n destroy: 'datasource-destroy',\n\n // Size events\n sizeChanged: 'datasource-size-changed',\n\n // Server-side specific events\n cacheFilterConfig: 'cache-filter-config',\n refreshServerSide: 'refresh-server-side',\n setServerSideDatasource: 'set-server-side-datasource',\n addGridCssClass: 'add-grid-css-class',\n removeGridCssClass: 'remove-grid-css-class',\n applyServerSideTransaction: 'apply-server-side-transaction',\n\n // Infinite Row Model specific events\n setInfiniteDatasource: 'set-infinite-datasource',\n refreshInfiniteCache: 'refresh-infinite-cache',\n}"
16427
18427
  },
16428
- "default": "{\n // Initialization events\n initialize: 'datasource-initialize',\n ready: 'datasource-ready',\n\n // Data events\n dataLoaded: 'datasource-data-loaded',\n dataChanged: 'datasource-data-changed',\n dataCleared: 'datasource-data-cleared',\n\n // Schema events\n schemaUpdated: 'datasource-schema-updated',\n\n // Status events\n loadingStarted: 'datasource-loading-started',\n loadingFinished: 'datasource-loading-finished',\n noDataAvailable: 'datasource-no-data-available',\n moreDataAvailable: 'datasource-more-data-available',\n\n // Filter events\n filtersRestored: 'datasource-filters-restored',\n\n // Error events\n error: 'datasource-error',\n\n // Destroy datasource events\n destroy: 'datasource-destroy',\n\n // Size events\n sizeChanged: 'datasource-size-changed',\n\n // Server-side specific events\n cacheFilterConfig: 'cache-filter-config',\n refreshServerSide: 'refresh-server-side',\n setServerSideDatasource: 'set-server-side-datasource',\n addGridCssClass: 'add-grid-css-class',\n removeGridCssClass: 'remove-grid-css-class',\n applyServerSideTransaction: 'apply-server-side-transaction',\n}",
18428
+ "default": "{\n // Initialization events\n initialize: 'datasource-initialize',\n ready: 'datasource-ready',\n\n // Data events\n dataLoaded: 'datasource-data-loaded',\n dataChanged: 'datasource-data-changed',\n dataCleared: 'datasource-data-cleared',\n\n // Schema events\n schemaUpdated: 'datasource-schema-updated',\n\n // Status events\n loadingStarted: 'datasource-loading-started',\n loadingFinished: 'datasource-loading-finished',\n noDataAvailable: 'datasource-no-data-available',\n moreDataAvailable: 'datasource-more-data-available',\n\n // Filter events\n filtersRestored: 'datasource-filters-restored',\n\n // Error events\n error: 'datasource-error',\n\n // Destroy datasource events\n destroy: 'datasource-destroy',\n\n // Size events\n sizeChanged: 'datasource-size-changed',\n\n // Server-side specific events\n cacheFilterConfig: 'cache-filter-config',\n refreshServerSide: 'refresh-server-side',\n setServerSideDatasource: 'set-server-side-datasource',\n addGridCssClass: 'add-grid-css-class',\n removeGridCssClass: 'remove-grid-css-class',\n applyServerSideTransaction: 'apply-server-side-transaction',\n\n // Infinite Row Model specific events\n setInfiniteDatasource: 'set-infinite-datasource',\n refreshInfiniteCache: 'refresh-infinite-cache',\n}",
16429
18429
  "description": "Event names for datasource-grid communication\nThese represent datasource operations, not grid-specific actions"
16430
18430
  }
16431
18431
  ],
@@ -16880,28 +18880,6 @@
16880
18880
  "module": "src/datasource/base.datasource.ts"
16881
18881
  }
16882
18882
  },
16883
- {
16884
- "kind": "method",
16885
- "name": "applyTransaction",
16886
- "privacy": "protected",
16887
- "return": {
16888
- "type": {
16889
- "text": "any"
16890
- }
16891
- },
16892
- "parameters": [
16893
- {
16894
- "name": "transaction",
16895
- "type": {
16896
- "text": "any"
16897
- }
16898
- }
16899
- ],
16900
- "inheritedFrom": {
16901
- "name": "GridProBaseDatasource",
16902
- "module": "src/datasource/base.datasource.ts"
16903
- }
16904
- },
16905
18883
  {
16906
18884
  "kind": "method",
16907
18885
  "name": "handleSizeChanged",
@@ -20444,7 +22422,7 @@
20444
22422
  {
20445
22423
  "name": "data",
20446
22424
  "type": {
20447
- "text": "Map<string, [string]>"
22425
+ "text": "Map<string, string[]>"
20448
22426
  },
20449
22427
  "description": "the map data to have the keys extracted from"
20450
22428
  }
@@ -20464,7 +22442,7 @@
20464
22442
  {
20465
22443
  "name": "data",
20466
22444
  "type": {
20467
- "text": "Map<string, [string]>"
22445
+ "text": "Map<string, string[]>"
20468
22446
  },
20469
22447
  "description": "the map data to have the values extracted from"
20470
22448
  }