@genesislcap/grid-pro 14.275.3 → 14.276.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 (150) hide show
  1. package/README.md +428 -15
  2. package/dist/custom-elements.json +1306 -141
  3. package/dist/dts/datasource/base.datasource.d.ts +38 -1
  4. package/dist/dts/datasource/base.datasource.d.ts.map +1 -1
  5. package/dist/dts/datasource/index.d.ts +1 -0
  6. package/dist/dts/datasource/index.d.ts.map +1 -1
  7. package/dist/dts/datasource/server-side.datasource.d.ts +6 -5
  8. package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
  9. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +34 -12
  10. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
  11. package/dist/dts/grid-pro.d.ts +65 -16
  12. package/dist/dts/grid-pro.d.ts.map +1 -1
  13. package/dist/dts/grid-pro.styles.d.ts.map +1 -1
  14. package/dist/dts/grid-pro.types.d.ts +91 -0
  15. package/dist/dts/grid-pro.types.d.ts.map +1 -1
  16. package/dist/dts/index.d.ts +1 -0
  17. package/dist/dts/index.d.ts.map +1 -1
  18. package/dist/dts/status-bar-components/index.d.ts +5 -0
  19. package/dist/dts/status-bar-components/index.d.ts.map +1 -0
  20. package/dist/dts/status-bar-components/label-value.status-bar.d.ts +21 -0
  21. package/dist/dts/status-bar-components/label-value.status-bar.d.ts.map +1 -0
  22. package/dist/dts/status-bar-components/load-more.status-bar.d.ts +43 -0
  23. package/dist/dts/status-bar-components/load-more.status-bar.d.ts.map +1 -0
  24. package/dist/dts/status-bar-components/pagination.status-bar.d.ts +32 -0
  25. package/dist/dts/status-bar-components/pagination.status-bar.d.ts.map +1 -0
  26. package/dist/dts/status-bar-components/reload.status-bar.d.ts +36 -0
  27. package/dist/dts/status-bar-components/reload.status-bar.d.ts.map +1 -0
  28. package/dist/esm/datasource/base.datasource.js +124 -7
  29. package/dist/esm/datasource/index.js +1 -0
  30. package/dist/esm/datasource/server-side.datasource.js +9 -9
  31. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +111 -34
  32. package/dist/esm/grid-pro.js +116 -2
  33. package/dist/esm/grid-pro.styles.js +10 -0
  34. package/dist/esm/grid-pro.types.js +28 -0
  35. package/dist/esm/index.js +1 -0
  36. package/dist/esm/status-bar-components/index.js +4 -0
  37. package/dist/esm/status-bar-components/label-value.status-bar.js +33 -0
  38. package/dist/esm/status-bar-components/load-more.status-bar.js +209 -0
  39. package/dist/esm/status-bar-components/pagination.status-bar.js +206 -0
  40. package/dist/esm/status-bar-components/reload.status-bar.js +162 -0
  41. package/dist/grid-pro.api.json +6872 -3339
  42. package/dist/grid-pro.d.ts +384 -32
  43. package/docs/api/grid-pro.criteriadelimiter.md +13 -0
  44. package/docs/api/grid-pro.criteriajoin.md +13 -0
  45. package/docs/api/grid-pro.default_status_bar_config.md +13 -0
  46. package/docs/api/grid-pro.genesisgriddatasourceelement.aggrid.md +11 -0
  47. package/docs/api/grid-pro.genesisgriddatasourceelement.connect.md +11 -0
  48. package/docs/api/grid-pro.genesisgriddatasourceelement.criteria.md +11 -0
  49. package/docs/api/grid-pro.genesisgriddatasourceelement.criteriafromfilters.md +11 -0
  50. package/docs/api/grid-pro.genesisgriddatasourceelement.datasource.md +11 -0
  51. package/docs/api/grid-pro.genesisgriddatasourceelement.datasourceoptions.md +15 -0
  52. package/docs/api/grid-pro.genesisgriddatasourceelement.datasourcestatuschanged.md +23 -0
  53. package/docs/api/grid-pro.genesisgriddatasourceelement.defaultrowidbyresourcetype.md +11 -0
  54. package/docs/api/grid-pro.genesisgriddatasourceelement.deferredcolumnstates.md +11 -0
  55. package/docs/api/grid-pro.genesisgriddatasourceelement.deferredgridoptions.md +11 -0
  56. package/docs/api/grid-pro.genesisgriddatasourceelement.disablepolling.md +11 -0
  57. package/docs/api/grid-pro.genesisgriddatasourceelement.fields.md +11 -0
  58. package/docs/api/grid-pro.genesisgriddatasourceelement.isrequestserver.md +11 -0
  59. package/docs/api/grid-pro.genesisgriddatasourceelement.issnapshot.md +11 -0
  60. package/docs/api/grid-pro.genesisgriddatasourceelement.maxrows.md +11 -0
  61. package/docs/api/grid-pro.genesisgriddatasourceelement.maxview.md +11 -0
  62. package/docs/api/grid-pro.genesisgriddatasourceelement.md +55 -0
  63. package/docs/api/grid-pro.genesisgriddatasourceelement.movingview.md +11 -0
  64. package/docs/api/grid-pro.genesisgriddatasourceelement.orderby.md +11 -0
  65. package/docs/api/grid-pro.genesisgriddatasourceelement.pollinginterval.md +11 -0
  66. package/docs/api/grid-pro.genesisgriddatasourceelement.removefilter.md +22 -0
  67. package/docs/api/grid-pro.genesisgriddatasourceelement.request.md +11 -0
  68. package/docs/api/grid-pro.genesisgriddatasourceelement.requestautosetup.md +18 -0
  69. package/docs/api/grid-pro.genesisgriddatasourceelement.resourcename.md +11 -0
  70. package/docs/api/grid-pro.genesisgriddatasourceelement.reverse.md +11 -0
  71. package/docs/api/grid-pro.genesisgriddatasourceelement.rowdatamapper.md +13 -0
  72. package/docs/api/grid-pro.genesisgriddatasourceelement.rowid.md +11 -0
  73. package/docs/api/grid-pro.genesisgriddatasourceelement.rowidattr.md +15 -0
  74. package/docs/api/grid-pro.genesisgriddatasourceelement.setfilter.md +23 -0
  75. package/docs/api/grid-pro.genesisgriddatasourceelement.update.md +11 -0
  76. package/docs/api/grid-pro.genesisgriddatasourceelement.viewnumber.md +11 -0
  77. package/docs/api/grid-pro.gridpro.clearlocalgridoptions.md +17 -0
  78. package/docs/api/grid-pro.gridpro.gridprodatasource.md +2 -2
  79. package/docs/api/grid-pro.gridpro.md +8 -2
  80. package/docs/api/grid-pro.gridpro.pagination.md +18 -0
  81. package/docs/api/grid-pro.gridpro.paginationpagesize.md +18 -0
  82. package/docs/api/grid-pro.gridpro.persistcolumnstatekey.md +1 -1
  83. package/docs/api/grid-pro.gridpro.setuppaginationandstatusbar.md +22 -0
  84. package/docs/api/grid-pro.gridpro.statusbarconfig.md +18 -0
  85. package/docs/api/grid-pro.gridpro.withstatusbar.md +18 -0
  86. package/docs/api/grid-pro.gridprobasedatasource.agtransaction.md +11 -0
  87. package/docs/api/grid-pro.gridprobasedatasource.applyallagtransactions.md +15 -0
  88. package/docs/api/grid-pro.gridprobasedatasource.applyasyncfuncname.md +11 -0
  89. package/docs/api/grid-pro.gridprobasedatasource.applyfuncname.md +11 -0
  90. package/docs/api/grid-pro.gridprobasedatasource.applytransaction.md +22 -0
  91. package/docs/api/grid-pro.gridprobasedatasource.applytransactionasync.md +23 -0
  92. package/docs/api/grid-pro.gridprobasedatasource.datasubwasloggedoff.md +11 -0
  93. package/docs/api/grid-pro.gridprobasedatasource.destroy.md +15 -0
  94. package/docs/api/grid-pro.gridprobasedatasource.generatecolumndefsfrommetadata.md +23 -0
  95. package/docs/api/grid-pro.gridprobasedatasource.getdatasourcestatusbarpanels.md +24 -0
  96. package/docs/api/grid-pro.gridprobasedatasource.handlestreamdeletes.md +22 -0
  97. package/docs/api/grid-pro.gridprobasedatasource.handlestreaminserts.md +23 -0
  98. package/docs/api/grid-pro.gridprobasedatasource.handlestreamupdates.md +22 -0
  99. package/docs/api/grid-pro.gridprobasedatasource.loadmore.md +15 -0
  100. package/docs/api/grid-pro.gridprobasedatasource.md +42 -0
  101. package/docs/api/grid-pro.gridprobasedatasource.pagination.md +11 -0
  102. package/docs/api/grid-pro.gridprobasedatasource.reloadresourcedata.md +15 -0
  103. package/docs/api/grid-pro.gridprobasedatasource.restart.md +15 -0
  104. package/docs/api/grid-pro.gridprobasedatasource.rowdata.md +11 -0
  105. package/docs/api/grid-pro.gridprogenesisdatasource.handlestreamdeletes.md +24 -0
  106. package/docs/api/grid-pro.gridprogenesisdatasource.handlestreaminserts.md +22 -0
  107. package/docs/api/grid-pro.gridprogenesisdatasource.handlestreamupdates.md +22 -0
  108. package/docs/api/grid-pro.gridprogenesisdatasource.loadmore.md +15 -0
  109. package/docs/api/grid-pro.gridprogenesisdatasource.md +6 -1
  110. package/docs/api/grid-pro.gridprogenesisdatasource.reloadresourcedata.md +21 -0
  111. package/docs/api/grid-pro.gridprogenesisdatasource.restart.md +3 -3
  112. package/docs/api/grid-pro.gridprostatusbarconfig.loadmore.md +18 -0
  113. package/docs/api/grid-pro.gridprostatusbarconfig.maxrows.md +18 -0
  114. package/docs/api/grid-pro.gridprostatusbarconfig.md +27 -0
  115. package/docs/api/grid-pro.gridprostatusbarconfig.reload.md +18 -0
  116. package/docs/api/grid-pro.gridprostatusbarconfig.rows.md +18 -0
  117. package/docs/api/grid-pro.gridprostatusbarloadmoreconfig.appearance.md +18 -0
  118. package/docs/api/grid-pro.gridprostatusbarloadmoreconfig.md +22 -0
  119. package/docs/api/grid-pro.gridprostatusbarloadmoreconfig.onloadmore.md +13 -0
  120. package/docs/api/grid-pro.gridprostatusbarloadmoreconfig.tooltip.md +18 -0
  121. package/docs/api/grid-pro.gridprostatusbarreloadconfig.icon.md +18 -0
  122. package/docs/api/grid-pro.gridprostatusbarreloadconfig.md +22 -0
  123. package/docs/api/grid-pro.gridprostatusbarreloadconfig.onreload.md +13 -0
  124. package/docs/api/grid-pro.gridprostatusbarreloadconfig.tooltip.md +18 -0
  125. package/docs/api/grid-pro.gridprostatusbartypes.md +27 -0
  126. package/docs/api/grid-pro.labelvaluestatusbarcomponent.destroy.md +15 -0
  127. package/docs/api/grid-pro.labelvaluestatusbarcomponent.getgui.md +15 -0
  128. package/docs/api/grid-pro.labelvaluestatusbarcomponent.init.md +22 -0
  129. package/docs/api/grid-pro.labelvaluestatusbarcomponent.md +23 -0
  130. package/docs/api/grid-pro.labelvaluestatusbarparams.md +17 -0
  131. package/docs/api/grid-pro.loadmorestatusbarcomponent.destroy.md +15 -0
  132. package/docs/api/grid-pro.loadmorestatusbarcomponent.getgui.md +15 -0
  133. package/docs/api/grid-pro.loadmorestatusbarcomponent.init.md +22 -0
  134. package/docs/api/grid-pro.loadmorestatusbarcomponent.md +25 -0
  135. package/docs/api/grid-pro.loadmorestatusbarcomponent.updatebuttonvisibility.md +15 -0
  136. package/docs/api/grid-pro.loadmorestatusbarcomponent.updateparams.md +22 -0
  137. package/docs/api/grid-pro.loadmorestatusbarparams.md +18 -0
  138. package/docs/api/grid-pro.md +16 -0
  139. package/docs/api/grid-pro.paginationstatusbarcomponent.destroy.md +15 -0
  140. package/docs/api/grid-pro.paginationstatusbarcomponent.getgui.md +15 -0
  141. package/docs/api/grid-pro.paginationstatusbarcomponent.init.md +22 -0
  142. package/docs/api/grid-pro.paginationstatusbarcomponent.md +23 -0
  143. package/docs/api/grid-pro.reloadstatusbarcomponent.destroy.md +15 -0
  144. package/docs/api/grid-pro.reloadstatusbarcomponent.getgui.md +15 -0
  145. package/docs/api/grid-pro.reloadstatusbarcomponent.init.md +22 -0
  146. package/docs/api/grid-pro.reloadstatusbarcomponent.md +24 -0
  147. package/docs/api/grid-pro.reloadstatusbarcomponent.updateparams.md +22 -0
  148. package/docs/api/grid-pro.reloadstatusbarparams.md +17 -0
  149. package/docs/api-report.md +256 -6
  150. package/package.json +13 -13
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [paginationPageSize](./grid-pro.gridpro.paginationpagesize.md)
4
+
5
+ ## GridPro.paginationPageSize property
6
+
7
+ Number of rows per page when pagination is enabled.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ paginationPageSize: number;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ \*\*Default Value:\*\* `DatasourceDefaults.DEFAULT_PAGINATION_PAGE_SIZE (25)` (default MAX\_ROWS divided by 10) Only used when pagination is enabled. Note that AG Grid's full pagination functionality requires the Enterprise module.
18
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## GridPro.persistColumnStateKey property
6
6
 
7
- The key to use for persisting the column state in local broswer or KV storage.
7
+ The key to use for persisting the column state in local browser or KV storage.
8
8
 
9
9
  **Signature:**
10
10
 
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [setupPaginationAndStatusBar](./grid-pro.gridpro.setuppaginationandstatusbar.md)
4
+
5
+ ## GridPro.setupPaginationAndStatusBar() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected setupPaginationAndStatusBar(gridOptions: GridOptions): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | gridOptions | GridOptions | |
18
+
19
+ **Returns:**
20
+
21
+ void
22
+
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [statusBarConfig](./grid-pro.gridpro.statusbarconfig.md)
4
+
5
+ ## GridPro.statusBarConfig property
6
+
7
+ Configuration for the grid status bar components.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ statusBarConfig: GridProStatusBarConfig;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ This requires AG Grid Enterprise module to be enabled. The status bar will only be displayed if the Enterprise module is available.
18
+
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [withStatusBar](./grid-pro.gridpro.withstatusbar.md)
4
+
5
+ ## GridPro.withStatusBar property
6
+
7
+ Enables or disables the grid status bar.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ withStatusBar: boolean;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Default is false. When disabled, no status bar will be displayed regardless of statusBarConfig. This requires AG Grid Enterprise module to be available for the status bar to be displayed when enabled.
18
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [agTransaction](./grid-pro.gridprobasedatasource.agtransaction.md)
4
+
5
+ ## GridProBaseDatasource.agTransaction property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected agTransaction: RowDataTransaction | ServerSideTransaction;
11
+ ```
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [applyAllAgTransactions](./grid-pro.gridprobasedatasource.applyallagtransactions.md)
4
+
5
+ ## GridProBaseDatasource.applyAllAgTransactions() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected applyAllAgTransactions(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [applyAsyncFuncName](./grid-pro.gridprobasedatasource.applyasyncfuncname.md)
4
+
5
+ ## GridProBaseDatasource.applyAsyncFuncName property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected applyAsyncFuncName: string;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [applyFuncName](./grid-pro.gridprobasedatasource.applyfuncname.md)
4
+
5
+ ## GridProBaseDatasource.applyFuncName property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected applyFuncName: string;
11
+ ```
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [applyTransaction](./grid-pro.gridprobasedatasource.applytransaction.md)
4
+
5
+ ## GridProBaseDatasource.applyTransaction() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected applyTransaction(agTransaction: RowDataTransaction): any;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | agTransaction | RowDataTransaction | |
18
+
19
+ **Returns:**
20
+
21
+ any
22
+
@@ -0,0 +1,23 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [applyTransactionAsync](./grid-pro.gridprobasedatasource.applytransactionasync.md)
4
+
5
+ ## GridProBaseDatasource.applyTransactionAsync() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: any) => void): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | agTransaction | RowDataTransaction | |
18
+ | callback | (res: any) =&gt; void | _(Optional)_ |
19
+
20
+ **Returns:**
21
+
22
+ void
23
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [dataSubWasLoggedOff](./grid-pro.gridprobasedatasource.datasubwasloggedoff.md)
4
+
5
+ ## GridProBaseDatasource.dataSubWasLoggedOff property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected dataSubWasLoggedOff: boolean;
11
+ ```
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [destroy](./grid-pro.gridprobasedatasource.destroy.md)
4
+
5
+ ## GridProBaseDatasource.destroy() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ destroy(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -0,0 +1,23 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [generateColumnDefsFromMetadata](./grid-pro.gridprobasedatasource.generatecolumndefsfrommetadata.md)
4
+
5
+ ## GridProBaseDatasource.generateColumnDefsFromMetadata() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected generateColumnDefsFromMetadata(fieldsMetadata: FieldMetadata[], getFilterParamsByFieldType: Function): ColDef[];
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | fieldsMetadata | FieldMetadata\[\] | |
18
+ | getFilterParamsByFieldType | Function | |
19
+
20
+ **Returns:**
21
+
22
+ ColDef\[\]
23
+
@@ -0,0 +1,24 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [getDatasourceStatusBarPanels](./grid-pro.gridprobasedatasource.getdatasourcestatusbarpanels.md)
4
+
5
+ ## GridProBaseDatasource.getDatasourceStatusBarPanels() method
6
+
7
+ Gets datasource-specific status bar component configurations. This method should be called by the grid to get status bar panels specific to this datasource.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getDatasourceStatusBarPanels(isServerSide: boolean): any[];
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | isServerSide | boolean | |
20
+
21
+ **Returns:**
22
+
23
+ any\[\]
24
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [handleStreamDeletes](./grid-pro.gridprobasedatasource.handlestreamdeletes.md)
4
+
5
+ ## GridProBaseDatasource.handleStreamDeletes() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected handleStreamDeletes(deletedRows: any[]): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | deletedRows | any\[\] | |
18
+
19
+ **Returns:**
20
+
21
+ void
22
+
@@ -0,0 +1,23 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [handleStreamInserts](./grid-pro.gridprobasedatasource.handlestreaminserts.md)
4
+
5
+ ## GridProBaseDatasource.handleStreamInserts() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected handleStreamInserts(insertedRows: any[], addIndex?: number): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | insertedRows | any\[\] | |
18
+ | addIndex | number | _(Optional)_ |
19
+
20
+ **Returns:**
21
+
22
+ void
23
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [handleStreamUpdates](./grid-pro.gridprobasedatasource.handlestreamupdates.md)
4
+
5
+ ## GridProBaseDatasource.handleStreamUpdates() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected handleStreamUpdates(updatedRows: any[]): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | updatedRows | any\[\] | |
18
+
19
+ **Returns:**
20
+
21
+ void
22
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [loadMore](./grid-pro.gridprobasedatasource.loadmore.md)
4
+
5
+ ## GridProBaseDatasource.loadMore() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ loadMore(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -0,0 +1,42 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md)
4
+
5
+ ## GridProBaseDatasource class
6
+
7
+
8
+ **Signature:**
9
+
10
+ ```typescript
11
+ export declare class GridProBaseDatasource extends GenesisGridDatasourceElement
12
+ ```
13
+ **Extends:** [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md)
14
+
15
+ ## Properties
16
+
17
+ | Property | Modifiers | Type | Description |
18
+ | --- | --- | --- | --- |
19
+ | [agTransaction](./grid-pro.gridprobasedatasource.agtransaction.md) | <code>protected</code> | RowDataTransaction \| ServerSideTransaction | |
20
+ | [applyAsyncFuncName](./grid-pro.gridprobasedatasource.applyasyncfuncname.md) | <code>protected</code> | string | |
21
+ | [applyFuncName](./grid-pro.gridprobasedatasource.applyfuncname.md) | <code>protected</code> | string | |
22
+ | [dataSubWasLoggedOff](./grid-pro.gridprobasedatasource.datasubwasloggedoff.md) | <code>protected</code> | boolean | |
23
+ | [pagination](./grid-pro.gridprobasedatasource.pagination.md) | <p><code>protected</code></p><p><code>readonly</code></p> | boolean | |
24
+ | [rowData](./grid-pro.gridprobasedatasource.rowdata.md) | | Map&lt;string, any&gt; | |
25
+
26
+ ## Methods
27
+
28
+ | Method | Modifiers | Description |
29
+ | --- | --- | --- |
30
+ | [applyAllAgTransactions()](./grid-pro.gridprobasedatasource.applyallagtransactions.md) | <code>protected</code> | |
31
+ | [applyTransaction(agTransaction)](./grid-pro.gridprobasedatasource.applytransaction.md) | <code>protected</code> | |
32
+ | [applyTransactionAsync(agTransaction, callback)](./grid-pro.gridprobasedatasource.applytransactionasync.md) | <code>protected</code> | |
33
+ | [destroy()](./grid-pro.gridprobasedatasource.destroy.md) | | |
34
+ | [generateColumnDefsFromMetadata(fieldsMetadata, getFilterParamsByFieldType)](./grid-pro.gridprobasedatasource.generatecolumndefsfrommetadata.md) | <code>protected</code> | |
35
+ | [getDatasourceStatusBarPanels(isServerSide)](./grid-pro.gridprobasedatasource.getdatasourcestatusbarpanels.md) | | Gets datasource-specific status bar component configurations. This method should be called by the grid to get status bar panels specific to this datasource. |
36
+ | [handleStreamDeletes(deletedRows)](./grid-pro.gridprobasedatasource.handlestreamdeletes.md) | <code>protected</code> | |
37
+ | [handleStreamInserts(insertedRows, addIndex)](./grid-pro.gridprobasedatasource.handlestreaminserts.md) | <code>protected</code> | |
38
+ | [handleStreamUpdates(updatedRows)](./grid-pro.gridprobasedatasource.handlestreamupdates.md) | <code>protected</code> | |
39
+ | [loadMore()](./grid-pro.gridprobasedatasource.loadmore.md) | | |
40
+ | [reloadResourceData()](./grid-pro.gridprobasedatasource.reloadresourcedata.md) | | |
41
+ | [restart()](./grid-pro.gridprobasedatasource.restart.md) | | |
42
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [pagination](./grid-pro.gridprobasedatasource.pagination.md)
4
+
5
+ ## GridProBaseDatasource.pagination property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected get pagination(): boolean;
11
+ ```
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [reloadResourceData](./grid-pro.gridprobasedatasource.reloadresourcedata.md)
4
+
5
+ ## GridProBaseDatasource.reloadResourceData() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ reloadResourceData(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [restart](./grid-pro.gridprobasedatasource.restart.md)
4
+
5
+ ## GridProBaseDatasource.restart() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ restart(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [rowData](./grid-pro.gridprobasedatasource.rowdata.md)
4
+
5
+ ## GridProBaseDatasource.rowData property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ rowData: Map<string, any>;
11
+ ```
@@ -0,0 +1,24 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [handleStreamDeletes](./grid-pro.gridprogenesisdatasource.handlestreamdeletes.md)
4
+
5
+ ## GridProGenesisDatasource.handleStreamDeletes() method
6
+
7
+ Handles stream deletes by removing records from the grid.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ handleStreamDeletes(deletes?: any[]): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | deletes | any\[\] | _(Optional)_ List of records to remove from the grid stream |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [handleStreamInserts](./grid-pro.gridprogenesisdatasource.handlestreaminserts.md)
4
+
5
+ ## GridProGenesisDatasource.handleStreamInserts() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ handleStreamInserts(inserts?: any[]): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | inserts | any\[\] | _(Optional)_ |
18
+
19
+ **Returns:**
20
+
21
+ void
22
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [handleStreamUpdates](./grid-pro.gridprogenesisdatasource.handlestreamupdates.md)
4
+
5
+ ## GridProGenesisDatasource.handleStreamUpdates() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ handleStreamUpdates(updates?: any[]): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | updates | any\[\] | _(Optional)_ |
18
+
19
+ **Returns:**
20
+
21
+ void
22
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [loadMore](./grid-pro.gridprogenesisdatasource.loadmore.md)
4
+
5
+ ## GridProGenesisDatasource.loadMore() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ loadMore(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -39,12 +39,17 @@ Only supports Client-Side Row Model.
39
39
  | [destroy()](./grid-pro.gridprogenesisdatasource.destroy.md) | | Destroys the datasource, resetting it to its initial state. |
40
40
  | [disconnectedCallback()](./grid-pro.gridprogenesisdatasource.disconnectedcallback.md) | | |
41
41
  | [handleErrors(errors)](./grid-pro.gridprogenesisdatasource.handleerrors.md) | | |
42
+ | [handleStreamDeletes(deletes)](./grid-pro.gridprogenesisdatasource.handlestreamdeletes.md) | | Handles stream deletes by removing records from the grid. |
43
+ | [handleStreamInserts(inserts)](./grid-pro.gridprogenesisdatasource.handlestreaminserts.md) | | |
44
+ | [handleStreamUpdates(updates)](./grid-pro.gridprogenesisdatasource.handlestreamupdates.md) | | |
42
45
  | [init(columnDefinitions, columnStates)](./grid-pro.gridprogenesisdatasource.init.md) | | Initializes the datasource. |
46
+ | [loadMore()](./grid-pro.gridprogenesisdatasource.loadmore.md) | | |
43
47
  | [refreshRows()](./grid-pro.gridprogenesisdatasource.refreshrows.md) | | Force the grid to redispatch the current rows |
48
+ | [reloadResourceData()](./grid-pro.gridprogenesisdatasource.reloadresourcedata.md) | | Resets the grid data while keeping columnDefs and sends a DATA\_LOGOFF message if it's a stream. Loads resource data without full initialization (no metadata fetch). |
44
49
  | [removeFilter(fieldName)](./grid-pro.gridprogenesisdatasource.removefilter.md) | | |
45
50
  | [requestChanged(oldRequest, newRequest)](./grid-pro.gridprogenesisdatasource.requestchanged.md) | | |
46
51
  | [reset()](./grid-pro.gridprogenesisdatasource.reset.md) | | Resets the datasource to its initial state. |
47
52
  | [resourceNameChanged(oldValue, newValue)](./grid-pro.gridprogenesisdatasource.resourcenamechanged.md) | | |
48
- | [restart()](./grid-pro.gridprogenesisdatasource.restart.md) | | Restarts the datasource, uses <code>deinit</code> and <code>init</code> in sequence. |
53
+ | [restart()](./grid-pro.gridprogenesisdatasource.restart.md) | | Restarts the datasource, uses <code>destroy</code> and <code>init</code> in sequence. |
49
54
  | [setFilter(fieldName, newFilter)](./grid-pro.gridprogenesisdatasource.setfilter.md) | | |
50
55
 
@@ -0,0 +1,21 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [reloadResourceData](./grid-pro.gridprogenesisdatasource.reloadresourcedata.md)
4
+
5
+ ## GridProGenesisDatasource.reloadResourceData() method
6
+
7
+ Resets the grid data while keeping columnDefs and sends a DATA\_LOGOFF message if it's a stream. Loads resource data without full initialization (no metadata fetch).
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ reloadResourceData(): Promise<void>;
13
+ ```
14
+ **Returns:**
15
+
16
+ Promise&lt;void&gt;
17
+
18
+ ## Remarks
19
+
20
+ This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
21
+
@@ -4,14 +4,14 @@
4
4
 
5
5
  ## GridProGenesisDatasource.restart() method
6
6
 
7
- Restarts the datasource, uses `deinit` and `init` in sequence.
7
+ Restarts the datasource, uses `destroy` and `init` in sequence.
8
8
 
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- restart(): void;
12
+ restart(): Promise<void>;
13
13
  ```
14
14
  **Returns:**
15
15
 
16
- void
16
+ Promise&lt;void&gt;
17
17
 
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProStatusBarConfig](./grid-pro.gridprostatusbarconfig.md) &gt; [loadMore](./grid-pro.gridprostatusbarconfig.loadmore.md)
4
+
5
+ ## GridProStatusBarConfig.loadMore property
6
+
7
+ Configure load more button status bar component.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ loadMore?: boolean | GridProStatusBarLoadMoreConfig;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Can be boolean for simple enable/disable or object for detailed configuration.
18
+
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProStatusBarConfig](./grid-pro.gridprostatusbarconfig.md) &gt; [maxRows](./grid-pro.gridprostatusbarconfig.maxrows.md)
4
+
5
+ ## GridProStatusBarConfig.maxRows property
6
+
7
+ Enable max rows status bar component.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ maxRows?: boolean;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Default is false.
18
+