@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,13 @@
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; [criteriaDelimiter](./grid-pro.criteriadelimiter.md)
4
+
5
+ ## criteriaDelimiter variable
6
+
7
+ The delimiter for the criteria string.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ criteriaDelimiter = ";"
13
+ ```
@@ -0,0 +1,13 @@
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; [criteriaJoin](./grid-pro.criteriajoin.md)
4
+
5
+ ## criteriaJoin variable
6
+
7
+ The join for the criteria string.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ criteriaJoin = " && "
13
+ ```
@@ -0,0 +1,13 @@
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; [DEFAULT\_STATUS\_BAR\_CONFIG](./grid-pro.default_status_bar_config.md)
4
+
5
+ ## DEFAULT\_STATUS\_BAR\_CONFIG variable
6
+
7
+ Default status bar configuration
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ DEFAULT_STATUS_BAR_CONFIG: GridProStatusBarConfig
13
+ ```
@@ -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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [agGrid](./grid-pro.genesisgriddatasourceelement.aggrid.md)
4
+
5
+ ## GenesisGridDatasourceElement.agGrid property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected get agGrid(): GridPro | null;
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [connect](./grid-pro.genesisgriddatasourceelement.connect.md)
4
+
5
+ ## GenesisGridDatasourceElement.connect property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ connect: Connect;
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [criteria](./grid-pro.genesisgriddatasourceelement.criteria.md)
4
+
5
+ ## GenesisGridDatasourceElement.criteria property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ criteria: 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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [criteriaFromFilters](./grid-pro.genesisgriddatasourceelement.criteriafromfilters.md)
4
+
5
+ ## GenesisGridDatasourceElement.criteriaFromFilters property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected criteriaFromFilters: Map<string, 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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [datasource](./grid-pro.genesisgriddatasourceelement.datasource.md)
4
+
5
+ ## GenesisGridDatasourceElement.datasource property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ datasource: Datasource;
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [datasourceOptions](./grid-pro.genesisgriddatasourceelement.datasourceoptions.md)
4
+
5
+ ## GenesisGridDatasourceElement.datasourceOptions() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected datasourceOptions(): DatasourceOptions;
11
+ ```
12
+ **Returns:**
13
+
14
+ DatasourceOptions
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [datasourceStatusChanged](./grid-pro.genesisgriddatasourceelement.datasourcestatuschanged.md)
4
+
5
+ ## GenesisGridDatasourceElement.datasourceStatusChanged() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | prev | DatasourceStatus | |
18
+ | next | DatasourceStatus | |
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [defaultRowIdByResourceType](./grid-pro.genesisgriddatasourceelement.defaultrowidbyresourcetype.md)
4
+
5
+ ## GenesisGridDatasourceElement.defaultRowIdByResourceType property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected get defaultRowIdByResourceType(): 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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [deferredColumnStates](./grid-pro.genesisgriddatasourceelement.deferredcolumnstates.md)
4
+
5
+ ## GenesisGridDatasourceElement.deferredColumnStates property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ deferredColumnStates: ColumnState[];
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [deferredGridOptions](./grid-pro.genesisgriddatasourceelement.deferredgridoptions.md)
4
+
5
+ ## GenesisGridDatasourceElement.deferredGridOptions property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ deferredGridOptions: GridOptions;
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [disablePolling](./grid-pro.genesisgriddatasourceelement.disablepolling.md)
4
+
5
+ ## GenesisGridDatasourceElement.disablePolling property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ disablePolling: boolean;
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [fields](./grid-pro.genesisgriddatasourceelement.fields.md)
4
+
5
+ ## GenesisGridDatasourceElement.fields property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ fields: 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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [isRequestServer](./grid-pro.genesisgriddatasourceelement.isrequestserver.md)
4
+
5
+ ## GenesisGridDatasourceElement.isRequestServer property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ get isRequestServer(): boolean;
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [isSnapshot](./grid-pro.genesisgriddatasourceelement.issnapshot.md)
4
+
5
+ ## GenesisGridDatasourceElement.isSnapshot property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ isSnapshot: boolean;
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [maxRows](./grid-pro.genesisgriddatasourceelement.maxrows.md)
4
+
5
+ ## GenesisGridDatasourceElement.maxRows property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ maxRows: number;
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [maxView](./grid-pro.genesisgriddatasourceelement.maxview.md)
4
+
5
+ ## GenesisGridDatasourceElement.maxView property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ maxView: number;
11
+ ```
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md)
4
+
5
+ ## GenesisGridDatasourceElement class
6
+
7
+ The base datasource element for the grid-pro element.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_base
13
+ ```
14
+ **Extends:** GenesisGridDatasourceElement\_base
15
+
16
+ ## Properties
17
+
18
+ | Property | Modifiers | Type | Description |
19
+ | --- | --- | --- | --- |
20
+ | [agGrid](./grid-pro.genesisgriddatasourceelement.aggrid.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [GridPro](./grid-pro.gridpro.md) \| null | |
21
+ | [connect](./grid-pro.genesisgriddatasourceelement.connect.md) | | Connect | |
22
+ | [criteria](./grid-pro.genesisgriddatasourceelement.criteria.md) | | string | |
23
+ | [criteriaFromFilters](./grid-pro.genesisgriddatasourceelement.criteriafromfilters.md) | <code>protected</code> | Map&lt;string, string&gt; | |
24
+ | [datasource](./grid-pro.genesisgriddatasourceelement.datasource.md) | | Datasource | |
25
+ | [defaultRowIdByResourceType](./grid-pro.genesisgriddatasourceelement.defaultrowidbyresourcetype.md) | <p><code>protected</code></p><p><code>readonly</code></p> | string | |
26
+ | [deferredColumnStates](./grid-pro.genesisgriddatasourceelement.deferredcolumnstates.md) | | ColumnState\[\] | |
27
+ | [deferredGridOptions](./grid-pro.genesisgriddatasourceelement.deferredgridoptions.md) | | GridOptions | |
28
+ | [disablePolling](./grid-pro.genesisgriddatasourceelement.disablepolling.md) | | boolean | |
29
+ | [fields](./grid-pro.genesisgriddatasourceelement.fields.md) | | string | |
30
+ | [isRequestServer](./grid-pro.genesisgriddatasourceelement.isrequestserver.md) | <code>readonly</code> | boolean | |
31
+ | [isSnapshot](./grid-pro.genesisgriddatasourceelement.issnapshot.md) | | boolean | |
32
+ | [maxRows](./grid-pro.genesisgriddatasourceelement.maxrows.md) | | number | |
33
+ | [maxView](./grid-pro.genesisgriddatasourceelement.maxview.md) | | number | |
34
+ | [movingView](./grid-pro.genesisgriddatasourceelement.movingview.md) | | boolean | |
35
+ | [orderBy](./grid-pro.genesisgriddatasourceelement.orderby.md) | | string | |
36
+ | [pollingInterval](./grid-pro.genesisgriddatasourceelement.pollinginterval.md) | | number | |
37
+ | [request](./grid-pro.genesisgriddatasourceelement.request.md) | | any | |
38
+ | [requestAutoSetup](./grid-pro.genesisgriddatasourceelement.requestautosetup.md) | | boolean | Attribute to set whether the REQUEST object should be automatically set up. |
39
+ | [resourceName](./grid-pro.genesisgriddatasourceelement.resourcename.md) | | string | |
40
+ | [reverse](./grid-pro.genesisgriddatasourceelement.reverse.md) | | boolean | |
41
+ | [rowDataMapper](./grid-pro.genesisgriddatasourceelement.rowdatamapper.md) | | Function | Allows grid data updates to be processed via and external function before applying in grid |
42
+ | [rowId](./grid-pro.genesisgriddatasourceelement.rowid.md) | <p><code>protected</code></p><p><code>readonly</code></p> | string | |
43
+ | [rowIdAttr](./grid-pro.genesisgriddatasourceelement.rowidattr.md) | | any | <p>Attribute to set an unique identifier for the row.</p><p>Defaults to <code>ROW_REF</code> or <code>RECORD_ID</code> depending on the resource type.</p> |
44
+ | [update](./grid-pro.genesisgriddatasourceelement.update.md) | <code>protected</code> | BehaviorSubject&lt;Map&lt;string, string&gt;&gt; | |
45
+ | [viewNumber](./grid-pro.genesisgriddatasourceelement.viewnumber.md) | | number | |
46
+
47
+ ## Methods
48
+
49
+ | Method | Modifiers | Description |
50
+ | --- | --- | --- |
51
+ | [datasourceOptions()](./grid-pro.genesisgriddatasourceelement.datasourceoptions.md) | <code>protected</code> | |
52
+ | [datasourceStatusChanged(prev, next)](./grid-pro.genesisgriddatasourceelement.datasourcestatuschanged.md) | | |
53
+ | [removeFilter(fieldName)](./grid-pro.genesisgriddatasourceelement.removefilter.md) | | |
54
+ | [setFilter(fieldName, newFilter)](./grid-pro.genesisgriddatasourceelement.setfilter.md) | | |
55
+
@@ -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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [movingView](./grid-pro.genesisgriddatasourceelement.movingview.md)
4
+
5
+ ## GenesisGridDatasourceElement.movingView property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ movingView: boolean;
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [orderBy](./grid-pro.genesisgriddatasourceelement.orderby.md)
4
+
5
+ ## GenesisGridDatasourceElement.orderBy property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ orderBy: 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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [pollingInterval](./grid-pro.genesisgriddatasourceelement.pollinginterval.md)
4
+
5
+ ## GenesisGridDatasourceElement.pollingInterval property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ pollingInterval: number;
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [removeFilter](./grid-pro.genesisgriddatasourceelement.removefilter.md)
4
+
5
+ ## GenesisGridDatasourceElement.removeFilter() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ removeFilter(fieldName: string): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | fieldName | string | |
18
+
19
+ **Returns:**
20
+
21
+ void
22
+
@@ -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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [request](./grid-pro.genesisgriddatasourceelement.request.md)
4
+
5
+ ## GenesisGridDatasourceElement.request property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ request: any;
11
+ ```
@@ -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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [requestAutoSetup](./grid-pro.genesisgriddatasourceelement.requestautosetup.md)
4
+
5
+ ## GenesisGridDatasourceElement.requestAutoSetup property
6
+
7
+ Attribute to set whether the REQUEST object should be automatically set up.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ requestAutoSetup: boolean;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Defaults to `true`<!-- -->. Only applies to REQUEST\_SERVER (REQ-REP) resources.
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [resourceName](./grid-pro.genesisgriddatasourceelement.resourcename.md)
4
+
5
+ ## GenesisGridDatasourceElement.resourceName property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ resourceName: 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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [reverse](./grid-pro.genesisgriddatasourceelement.reverse.md)
4
+
5
+ ## GenesisGridDatasourceElement.reverse property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ reverse: boolean;
11
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [rowDataMapper](./grid-pro.genesisgriddatasourceelement.rowdatamapper.md)
4
+
5
+ ## GenesisGridDatasourceElement.rowDataMapper property
6
+
7
+ Allows grid data updates to be processed via and external function before applying in grid
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ rowDataMapper: Function;
13
+ ```
@@ -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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [rowId](./grid-pro.genesisgriddatasourceelement.rowid.md)
4
+
5
+ ## GenesisGridDatasourceElement.rowId property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected get rowId(): string;
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [rowIdAttr](./grid-pro.genesisgriddatasourceelement.rowidattr.md)
4
+
5
+ ## GenesisGridDatasourceElement.rowIdAttr property
6
+
7
+ Attribute to set an unique identifier for the row.
8
+
9
+ Defaults to `ROW_REF` or `RECORD_ID` depending on the resource type.
10
+
11
+ **Signature:**
12
+
13
+ ```typescript
14
+ rowIdAttr: any;
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [setFilter](./grid-pro.genesisgriddatasourceelement.setfilter.md)
4
+
5
+ ## GenesisGridDatasourceElement.setFilter() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ setFilter(fieldName: string, newFilter: string): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | fieldName | string | |
18
+ | newFilter | string | |
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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [update](./grid-pro.genesisgriddatasourceelement.update.md)
4
+
5
+ ## GenesisGridDatasourceElement.update property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected update: BehaviorSubject<Map<string, 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; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [viewNumber](./grid-pro.genesisgriddatasourceelement.viewnumber.md)
4
+
5
+ ## GenesisGridDatasourceElement.viewNumber property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ viewNumber: number;
11
+ ```
@@ -0,0 +1,17 @@
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; [clearLocalGridOptions](./grid-pro.gridpro.clearlocalgridoptions.md)
4
+
5
+ ## GridPro.clearLocalGridOptions() method
6
+
7
+ Clears the local grid options, this is used to clear the grid options when the grid is restarted.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ clearLocalGridOptions(): void;
13
+ ```
14
+ **Returns:**
15
+
16
+ void
17
+
@@ -9,10 +9,10 @@ Get the datasource element.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- get gridProDatasource(): GridProGenesisDatasource | GridProClientSideDatasource | GridProServerSideDatasource;
12
+ get gridProDatasource(): GridProBaseDatasource;
13
13
  ```
14
14
 
15
15
  ## Remarks
16
16
 
17
- This will return the first datasource element found in the light DOM. Can be either `grid-pro-genesis-datasource`<!-- -->, `grid-pro-client-side-datasource`<!-- -->, or `grid-pro-server-side-datasource`<!-- -->.
17
+ This will return the first datasource element found in the light DOM, wrapping all concrete datasource implementations.
18
18
 
@@ -51,19 +51,23 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
51
51
  | [gridOptions](./grid-pro.gridpro.gridoptions.md) | | GridOptions | |
52
52
  | [gridOptionsConfig](./grid-pro.gridpro.gridoptionsconfig.md) | | [GridOptionsConfig](./grid-pro.gridoptionsconfig.md) | Injectable config that allows to change grid options on an app level basis To modify options, register instance of the config in DOM container that is above the grid or on the top level of the application, so it applies to all grids. |
53
53
  | [gridParams](./grid-pro.gridpro.gridparams.md) | <code>readonly</code> | GridParams | |
54
- | [gridProDatasource](./grid-pro.gridpro.gridprodatasource.md) | <code>readonly</code> | [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) \| [GridProClientSideDatasource](./grid-pro.gridproclientsidedatasource.md) \| GridProServerSideDatasource | Get the datasource element. |
54
+ | [gridProDatasource](./grid-pro.gridpro.gridprodatasource.md) | <code>readonly</code> | [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) | Get the datasource element. |
55
55
  | [gridSlot](./grid-pro.gridpro.gridslot.md) | | HTMLSlotElement | |
56
56
  | [headerCaseType](./grid-pro.gridpro.headercasetype.md) | | [GridProCaseType](./grid-pro.gridprocasetype.md) | The case type to use for the header names. If not set, the default CONSTANT\_CASE will be used. |
57
57
  | [headerHeight](./grid-pro.gridpro.headerheight.md) | | number | |
58
58
  | [initialised](./grid-pro.gridpro.initialised.md) | <code>protected</code> | boolean | |
59
59
  | [observedAttributes](./grid-pro.gridpro.observedattributes.md) | <code>readonly</code> | string\[\] | |
60
60
  | [onlyTemplateColDefs](./grid-pro.gridpro.onlytemplatecoldefs.md) | | boolean | |
61
- | [persistColumnStateKey](./grid-pro.gridpro.persistcolumnstatekey.md) | | string | The key to use for persisting the column state in local broswer or KV storage. |
61
+ | [pagination](./grid-pro.gridpro.pagination.md) | | boolean | Enable pagination for the grid. |
62
+ | [paginationPageSize](./grid-pro.gridpro.paginationpagesize.md) | | number | Number of rows per page when pagination is enabled. |
63
+ | [persistColumnStateKey](./grid-pro.gridpro.persistcolumnstatekey.md) | | string | The key to use for persisting the column state in local browser or KV storage. |
62
64
  | [persistFilterModelKey](./grid-pro.gridpro.persistfiltermodelkey.md) | | string | The key to use for persisting the filter model in local browser or KV storage. |
63
65
  | [rowData](./grid-pro.gridpro.rowdata.md) | | any\[\] | The row data to display in the grid. |
64
66
  | [rowHeight](./grid-pro.gridpro.rowheight.md) | | number | |
65
67
  | [statePersistence](./grid-pro.gridpro.statepersistence.md) | | [StatePersistence](./grid-pro.statepersistence.md) | |
68
+ | [statusBarConfig](./grid-pro.gridpro.statusbarconfig.md) | | [GridProStatusBarConfig](./grid-pro.gridprostatusbarconfig.md) | Configuration for the grid status bar components. |
66
69
  | [theme](./grid-pro.gridpro.theme.md) | | string | |
70
+ | [withStatusBar](./grid-pro.gridpro.withstatusbar.md) | | boolean | Enables or disables the grid status bar. |
67
71
 
68
72
  ## Methods
69
73
 
@@ -72,6 +76,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
72
76
  | [addEventListener(eventType, listener, options)](./grid-pro.gridpro.addeventlistener.md) | | Adds an event listener to the grid element. |
73
77
  | [agAttributeChangedCallback(attName, oldValue, newValue)](./grid-pro.gridpro.agattributechangedcallback.md) | | |
74
78
  | [applyTemplateDefinitions(columnDefs, deferredColumnDefsOrState)](./grid-pro.gridpro.applytemplatedefinitions.md) | | Will merge templated column definitions with <code>columnDefs</code> plus localStorage's column state or <code>deferredColumnStates</code>. |
79
+ | [clearLocalGridOptions()](./grid-pro.gridpro.clearlocalgridoptions.md) | | Clears the local grid options, this is used to clear the grid options when the grid is restarted. |
75
80
  | [combineAllGridComponents(gridOptionsComponents)](./grid-pro.gridpro.combineallgridcomponents.md) | | |
76
81
  | [connectedCallback()](./grid-pro.gridpro.connectedcallback.md) | | |
77
82
  | [disconnectedCallback()](./grid-pro.gridpro.disconnectedcallback.md) | | |
@@ -83,6 +88,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
83
88
  | [restoreCachedFilterConfig()](./grid-pro.gridpro.restorecachedfilterconfig.md) | | |
84
89
  | [rowDataChanged(\_, rowData)](./grid-pro.gridpro.rowdatachanged.md) | | |
85
90
  | [setFilterModel(value)](./grid-pro.gridpro.setfiltermodel.md) | | |
91
+ | [setupPaginationAndStatusBar(gridOptions)](./grid-pro.gridpro.setuppaginationandstatusbar.md) | <code>protected</code> | |
86
92
  | [statePersistanceEnabled()](./grid-pro.gridpro.statepersistanceenabled.md) | | |
87
93
  | [themeChanged(oldValue, newValue)](./grid-pro.gridpro.themechanged.md) | | |
88
94
 
@@ -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; [pagination](./grid-pro.gridpro.pagination.md)
4
+
5
+ ## GridPro.pagination property
6
+
7
+ Enable pagination for the grid.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ pagination: boolean;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ When enabled, the grid will automatically configure pagination settings. Note that AG Grid's full pagination functionality requires the Enterprise module. While basic pagination will work in Community edition, advanced features like custom pagination components require Enterprise.
18
+