@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,27 @@
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)
4
+
5
+ ## GridProStatusBarConfig interface
6
+
7
+ Configuration options for the grid status bar components
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface GridProStatusBarConfig
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ This requires AG Grid Enterprise module to be enabled. Status bar components will only be displayed if the Enterprise module is available.
18
+
19
+ ## Properties
20
+
21
+ | Property | Modifiers | Type | Description |
22
+ | --- | --- | --- | --- |
23
+ | [loadMore?](./grid-pro.gridprostatusbarconfig.loadmore.md) | | boolean \| [GridProStatusBarLoadMoreConfig](./grid-pro.gridprostatusbarloadmoreconfig.md) | _(Optional)_ Configure load more button status bar component. |
24
+ | [maxRows?](./grid-pro.gridprostatusbarconfig.maxrows.md) | | boolean | _(Optional)_ Enable max rows status bar component. |
25
+ | [reload?](./grid-pro.gridprostatusbarconfig.reload.md) | | boolean \| [GridProStatusBarReloadConfig](./grid-pro.gridprostatusbarreloadconfig.md) | _(Optional)_ Configure reload button status bar component. |
26
+ | [rows?](./grid-pro.gridprostatusbarconfig.rows.md) | | boolean | _(Optional)_ Enable row count status bar component. |
27
+
@@ -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; [reload](./grid-pro.gridprostatusbarconfig.reload.md)
4
+
5
+ ## GridProStatusBarConfig.reload property
6
+
7
+ Configure reload button status bar component.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ reload?: boolean | GridProStatusBarReloadConfig;
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; [rows](./grid-pro.gridprostatusbarconfig.rows.md)
4
+
5
+ ## GridProStatusBarConfig.rows property
6
+
7
+ Enable row count status bar component.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ rows?: boolean;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Default is false.
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; [GridProStatusBarLoadMoreConfig](./grid-pro.gridprostatusbarloadmoreconfig.md) &gt; [appearance](./grid-pro.gridprostatusbarloadmoreconfig.appearance.md)
4
+
5
+ ## GridProStatusBarLoadMoreConfig.appearance property
6
+
7
+ Custom appearance for the button.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ appearance?: string;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Options: 'accent', 'lightweight', 'neutral', 'outline', 'stealth'
18
+
@@ -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; [GridProStatusBarLoadMoreConfig](./grid-pro.gridprostatusbarloadmoreconfig.md)
4
+
5
+ ## GridProStatusBarLoadMoreConfig interface
6
+
7
+ Configuration options for load more status bar component
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface GridProStatusBarLoadMoreConfig
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ | Property | Modifiers | Type | Description |
18
+ | --- | --- | --- | --- |
19
+ | [appearance?](./grid-pro.gridprostatusbarloadmoreconfig.appearance.md) | | string | _(Optional)_ Custom appearance for the button. |
20
+ | [onLoadMore?](./grid-pro.gridprostatusbarloadmoreconfig.onloadmore.md) | | () =&gt; void | _(Optional)_ Custom callback function to execute when the action is triggered. If not provided, the component will use the default datasource behavior. |
21
+ | [tooltip?](./grid-pro.gridprostatusbarloadmoreconfig.tooltip.md) | | string | _(Optional)_ Custom tooltip text that appears on hover. |
22
+
@@ -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; [GridProStatusBarLoadMoreConfig](./grid-pro.gridprostatusbarloadmoreconfig.md) &gt; [onLoadMore](./grid-pro.gridprostatusbarloadmoreconfig.onloadmore.md)
4
+
5
+ ## GridProStatusBarLoadMoreConfig.onLoadMore property
6
+
7
+ Custom callback function to execute when the action is triggered. If not provided, the component will use the default datasource behavior.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ onLoadMore?: () => void;
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; [GridProStatusBarLoadMoreConfig](./grid-pro.gridprostatusbarloadmoreconfig.md) &gt; [tooltip](./grid-pro.gridprostatusbarloadmoreconfig.tooltip.md)
4
+
5
+ ## GridProStatusBarLoadMoreConfig.tooltip property
6
+
7
+ Custom tooltip text that appears on hover.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ tooltip?: string;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Default is 'Load More'.
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; [GridProStatusBarReloadConfig](./grid-pro.gridprostatusbarreloadconfig.md) &gt; [icon](./grid-pro.gridprostatusbarreloadconfig.icon.md)
4
+
5
+ ## GridProStatusBarReloadConfig.icon property
6
+
7
+ Custom FontAwesome icon name (without 'fa-' prefix).
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ icon?: string;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Default is 'refresh'.
18
+
@@ -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; [GridProStatusBarReloadConfig](./grid-pro.gridprostatusbarreloadconfig.md)
4
+
5
+ ## GridProStatusBarReloadConfig interface
6
+
7
+ Configuration options for reload status bar component
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface GridProStatusBarReloadConfig
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ | Property | Modifiers | Type | Description |
18
+ | --- | --- | --- | --- |
19
+ | [icon?](./grid-pro.gridprostatusbarreloadconfig.icon.md) | | string | _(Optional)_ Custom FontAwesome icon name (without 'fa-' prefix). |
20
+ | [onReload?](./grid-pro.gridprostatusbarreloadconfig.onreload.md) | | () =&gt; void | _(Optional)_ Custom callback function to execute when the action is triggered. If not provided, the component will use the default datasource behavior. |
21
+ | [tooltip?](./grid-pro.gridprostatusbarreloadconfig.tooltip.md) | | string | _(Optional)_ Custom tooltip text that appears on hover. |
22
+
@@ -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; [GridProStatusBarReloadConfig](./grid-pro.gridprostatusbarreloadconfig.md) &gt; [onReload](./grid-pro.gridprostatusbarreloadconfig.onreload.md)
4
+
5
+ ## GridProStatusBarReloadConfig.onReload property
6
+
7
+ Custom callback function to execute when the action is triggered. If not provided, the component will use the default datasource behavior.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ onReload?: () => void;
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; [GridProStatusBarReloadConfig](./grid-pro.gridprostatusbarreloadconfig.md) &gt; [tooltip](./grid-pro.gridprostatusbarreloadconfig.tooltip.md)
4
+
5
+ ## GridProStatusBarReloadConfig.tooltip property
6
+
7
+ Custom tooltip text that appears on hover.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ tooltip?: string;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Default is 'Reload'.
18
+
@@ -0,0 +1,27 @@
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; [GridProStatusBarTypes](./grid-pro.gridprostatusbartypes.md)
4
+
5
+ ## GridProStatusBarTypes enum
6
+
7
+ The available Grid Pro Status Bar Types
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare enum GridProStatusBarTypes
13
+ ```
14
+
15
+ ## Enumeration Members
16
+
17
+ | Member | Value | Description |
18
+ | --- | --- | --- |
19
+ | labelValue | <code>&quot;labelValue&quot;</code> | |
20
+ | loadMore | <code>&quot;loadMore&quot;</code> | |
21
+ | pagination | <code>&quot;pagination&quot;</code> | |
22
+ | reload | <code>&quot;reload&quot;</code> | |
23
+
24
+ ## Remarks
25
+
26
+ These status bar components require AG Grid Enterprise module to be enabled. Status bar components will only be displayed if the Enterprise module is available.
27
+
@@ -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; [LabelValueStatusBarComponent](./grid-pro.labelvaluestatusbarcomponent.md) &gt; [destroy](./grid-pro.labelvaluestatusbarcomponent.destroy.md)
4
+
5
+ ## LabelValueStatusBarComponent.destroy() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ destroy(): 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; [LabelValueStatusBarComponent](./grid-pro.labelvaluestatusbarcomponent.md) &gt; [getGui](./grid-pro.labelvaluestatusbarcomponent.getgui.md)
4
+
5
+ ## LabelValueStatusBarComponent.getGui() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ getGui(): HTMLElement;
11
+ ```
12
+ **Returns:**
13
+
14
+ HTMLElement
15
+
@@ -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; [LabelValueStatusBarComponent](./grid-pro.labelvaluestatusbarcomponent.md) &gt; [init](./grid-pro.labelvaluestatusbarcomponent.init.md)
4
+
5
+ ## LabelValueStatusBarComponent.init() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ init(params: IStatusPanelParams): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | params | IStatusPanelParams | |
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; [LabelValueStatusBarComponent](./grid-pro.labelvaluestatusbarcomponent.md)
4
+
5
+ ## LabelValueStatusBarComponent class
6
+
7
+ Label Value Status Bar Component
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare class LabelValueStatusBarComponent implements IStatusPanelComp
13
+ ```
14
+ **Implements:** IStatusPanelComp
15
+
16
+ ## Methods
17
+
18
+ | Method | Modifiers | Description |
19
+ | --- | --- | --- |
20
+ | [destroy()](./grid-pro.labelvaluestatusbarcomponent.destroy.md) | | |
21
+ | [getGui()](./grid-pro.labelvaluestatusbarcomponent.getgui.md) | | |
22
+ | [init(params)](./grid-pro.labelvaluestatusbarcomponent.init.md) | | |
23
+
@@ -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; [LabelValueStatusBarParams](./grid-pro.labelvaluestatusbarparams.md)
4
+
5
+ ## LabelValueStatusBarParams type
6
+
7
+ Label Value Status Bar Component
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type LabelValueStatusBarParams = {
13
+ label: string;
14
+ value: any;
15
+ hide: boolean;
16
+ };
17
+ ```
@@ -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; [LoadMoreStatusBarComponent](./grid-pro.loadmorestatusbarcomponent.md) &gt; [destroy](./grid-pro.loadmorestatusbarcomponent.destroy.md)
4
+
5
+ ## LoadMoreStatusBarComponent.destroy() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ destroy(): 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; [LoadMoreStatusBarComponent](./grid-pro.loadmorestatusbarcomponent.md) &gt; [getGui](./grid-pro.loadmorestatusbarcomponent.getgui.md)
4
+
5
+ ## LoadMoreStatusBarComponent.getGui() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ getGui(): HTMLElement;
11
+ ```
12
+ **Returns:**
13
+
14
+ HTMLElement
15
+
@@ -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; [LoadMoreStatusBarComponent](./grid-pro.loadmorestatusbarcomponent.md) &gt; [init](./grid-pro.loadmorestatusbarcomponent.init.md)
4
+
5
+ ## LoadMoreStatusBarComponent.init() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ init(params: IStatusPanelParams): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | params | IStatusPanelParams | |
18
+
19
+ **Returns:**
20
+
21
+ void
22
+
@@ -0,0 +1,25 @@
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; [LoadMoreStatusBarComponent](./grid-pro.loadmorestatusbarcomponent.md)
4
+
5
+ ## LoadMoreStatusBarComponent class
6
+
7
+ A status bar component that shows a "Load More" button when more rows are available
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare class LoadMoreStatusBarComponent implements IStatusPanelComp
13
+ ```
14
+ **Implements:** IStatusPanelComp
15
+
16
+ ## Methods
17
+
18
+ | Method | Modifiers | Description |
19
+ | --- | --- | --- |
20
+ | [destroy()](./grid-pro.loadmorestatusbarcomponent.destroy.md) | | |
21
+ | [getGui()](./grid-pro.loadmorestatusbarcomponent.getgui.md) | | |
22
+ | [init(params)](./grid-pro.loadmorestatusbarcomponent.init.md) | | |
23
+ | [updateButtonVisibility()](./grid-pro.loadmorestatusbarcomponent.updatebuttonvisibility.md) | | |
24
+ | [updateParams(params)](./grid-pro.loadmorestatusbarcomponent.updateparams.md) | | |
25
+
@@ -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; [LoadMoreStatusBarComponent](./grid-pro.loadmorestatusbarcomponent.md) &gt; [updateButtonVisibility](./grid-pro.loadmorestatusbarcomponent.updatebuttonvisibility.md)
4
+
5
+ ## LoadMoreStatusBarComponent.updateButtonVisibility() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ updateButtonVisibility(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -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; [LoadMoreStatusBarComponent](./grid-pro.loadmorestatusbarcomponent.md) &gt; [updateParams](./grid-pro.loadmorestatusbarcomponent.updateparams.md)
4
+
5
+ ## LoadMoreStatusBarComponent.updateParams() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ updateParams(params: LoadMoreStatusBarParams): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | params | [LoadMoreStatusBarParams](./grid-pro.loadmorestatusbarparams.md) | |
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; [LoadMoreStatusBarParams](./grid-pro.loadmorestatusbarparams.md)
4
+
5
+ ## LoadMoreStatusBarParams type
6
+
7
+ The parameters for the load more status bar component.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type LoadMoreStatusBarParams = {
13
+ moreRows?: boolean;
14
+ onLoadMore?: () => void;
15
+ appearance?: string;
16
+ tooltip?: string;
17
+ };
18
+ ```
@@ -15,15 +15,21 @@
15
15
  | [BooleanRenderer](./grid-pro.booleanrenderer.md) | The AG Boolean Renderer element. |
16
16
  | [DateEditor](./grid-pro.dateeditor.md) | The AG Date Editor element. |
17
17
  | [EditableRenderer](./grid-pro.editablerenderer.md) | The AG Editable Renderer element. |
18
+ | [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) | The base datasource element for the grid-pro element. |
18
19
  | [GridPro](./grid-pro.gridpro.md) | The Grid Pro element. |
20
+ | [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) | |
19
21
  | [GridProCell](./grid-pro.gridprocell.md) | The Grid Pro Cell element. |
20
22
  | [GridProClientSideDatasource](./grid-pro.gridproclientsidedatasource.md) | The Genesis Datasource element, for client-side \| CSRM-compatible data fetching and used exclusively by the GridPro element. |
21
23
  | [GridProColumn](./grid-pro.gridprocolumn.md) | The Grid Pro Column element. |
22
24
  | [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) | The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element. |
23
25
  | [KVStorageStatePersistence](./grid-pro.kvstoragestatepersistence.md) | Implementation for the KV Storage State Persistence interface. |
26
+ | [LabelValueStatusBarComponent](./grid-pro.labelvaluestatusbarcomponent.md) | Label Value Status Bar Component |
27
+ | [LoadMoreStatusBarComponent](./grid-pro.loadmorestatusbarcomponent.md) | A status bar component that shows a "Load More" button when more rows are available |
24
28
  | [LocalStorageStatePersistence](./grid-pro.localstoragestatepersistence.md) | Implementation for the Local Storage State Persistence interface. |
25
29
  | [MultiselectEditor](./grid-pro.multiselecteditor.md) | The AG Multiselect Editor element. |
26
30
  | [NumberEditor](./grid-pro.numbereditor.md) | The AG Number Editor element. |
31
+ | [PaginationStatusBarComponent](./grid-pro.paginationstatusbarcomponent.md) | Pagination Status Bar Component for AG Grid Displays pagination controls and information about current page and total rows |
32
+ | [ReloadStatusBarComponent](./grid-pro.reloadstatusbarcomponent.md) | A status bar component that shows a refresh icon to reload the grid data |
27
33
  | [SelectEditor](./grid-pro.selecteditor.md) | The AG Select Editor element. |
28
34
  | [SelectRenderer](./grid-pro.selectrenderer.md) | The AG Select Renderer element. |
29
35
  | [StringEditor](./grid-pro.stringeditor.md) | The AG String Editor element. |
@@ -36,6 +42,7 @@
36
42
  | [AgGridTheme](./grid-pro.aggridtheme.md) | The available Grid Pro themes. |
37
43
  | [GridProCaseType](./grid-pro.gridprocasetype.md) | The available Grid Pro header case types |
38
44
  | [GridProRendererTypes](./grid-pro.gridprorenderertypes.md) | The available Grid Pro Renderer Types |
45
+ | [GridProStatusBarTypes](./grid-pro.gridprostatusbartypes.md) | The available Grid Pro Status Bar Types |
39
46
 
40
47
  ## Functions
41
48
 
@@ -55,6 +62,9 @@
55
62
  | [DateEditorParams](./grid-pro.dateeditorparams.md) | Parameters used to configure [SelectEditor](./grid-pro.selecteditor.md) |
56
63
  | [GridOptionsConfig](./grid-pro.gridoptionsconfig.md) | Grid options config used to configure grids across the application |
57
64
  | [GridProErrorItem](./grid-pro.gridproerroritem.md) | Grid Pro Error Item |
65
+ | [GridProStatusBarConfig](./grid-pro.gridprostatusbarconfig.md) | Configuration options for the grid status bar components |
66
+ | [GridProStatusBarLoadMoreConfig](./grid-pro.gridprostatusbarloadmoreconfig.md) | Configuration options for load more status bar component |
67
+ | [GridProStatusBarReloadConfig](./grid-pro.gridprostatusbarreloadconfig.md) | Configuration options for reload status bar component |
58
68
  | [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) | Parameters used to configure [MultiselectEditor](./grid-pro.multiselecteditor.md) |
59
69
  | [NumberEditorParams](./grid-pro.numbereditorparams.md) | Parameters used to configure [NumberEditor](./grid-pro.numbereditor.md) |
60
70
  | [SelectCellRendererParams](./grid-pro.selectcellrendererparams.md) | The interface for the select renderer parameters |
@@ -93,7 +103,10 @@
93
103
  | [CellTemplate](./grid-pro.celltemplate.md) | The Grid Pro Cell Template. |
94
104
  | [ColumnTemplate](./grid-pro.columntemplate.md) | The Grid Pro Column Template. |
95
105
  | [convertToKebabCase](./grid-pro.converttokebabcase.md) | Convert string values from 'camelCase' to 'kebab-case' |
106
+ | [criteriaDelimiter](./grid-pro.criteriadelimiter.md) | The delimiter for the criteria string. |
107
+ | [criteriaJoin](./grid-pro.criteriajoin.md) | The join for the criteria string. |
96
108
  | [csvExportParams](./grid-pro.csvexportparams.md) | Allows secure export of CSV https://owasp.org/www-community/attacks/CSV\_Injection |
109
+ | [DEFAULT\_STATUS\_BAR\_CONFIG](./grid-pro.default_status_bar_config.md) | Default status bar configuration |
97
110
  | [defaultAgGridFontFace](./grid-pro.defaultaggridfontface.md) | The default font face for Grid Pro (agGridAlpine). |
98
111
  | [defaultGridOptionsConfig](./grid-pro.defaultgridoptionsconfig.md) | Default grid options |
99
112
  | [defaultGridProConfig](./grid-pro.defaultgridproconfig.md) | Grid Pro default configuration. |
@@ -152,5 +165,8 @@
152
165
  | [GridProGenesisDatasourceErrorEventDetail](./grid-pro.gridprogenesisdatasourceerroreventdetail.md) | The event detail for the grid pro genesis datasource <code>error</code> event. |
153
166
  | [GrigProGenesisDatasourceSizeChangedEvent](./grid-pro.grigprogenesisdatasourcesizechangedevent.md) | The change size event grid pro genesis datasource. |
154
167
  | [GrigProGenesisDatasourceSizeChangedEventDetail](./grid-pro.grigprogenesisdatasourcesizechangedeventdetail.md) | The event detail for the grid pro genesis datasource <code>sizeChanged</code> event. |
168
+ | [LabelValueStatusBarParams](./grid-pro.labelvaluestatusbarparams.md) | Label Value Status Bar Component |
169
+ | [LoadMoreStatusBarParams](./grid-pro.loadmorestatusbarparams.md) | The parameters for the load more status bar component. |
155
170
  | [MoreRowsDetail](./grid-pro.morerowsdetail.md) | The Genesis Datasource event payload types. |
171
+ | [ReloadStatusBarParams](./grid-pro.reloadstatusbarparams.md) | The parameters for the reload status bar component. |
156
172
 
@@ -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; [PaginationStatusBarComponent](./grid-pro.paginationstatusbarcomponent.md) &gt; [destroy](./grid-pro.paginationstatusbarcomponent.destroy.md)
4
+
5
+ ## PaginationStatusBarComponent.destroy() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ destroy(): 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; [PaginationStatusBarComponent](./grid-pro.paginationstatusbarcomponent.md) &gt; [getGui](./grid-pro.paginationstatusbarcomponent.getgui.md)
4
+
5
+ ## PaginationStatusBarComponent.getGui() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ getGui(): HTMLElement;
11
+ ```
12
+ **Returns:**
13
+
14
+ HTMLElement
15
+
@@ -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; [PaginationStatusBarComponent](./grid-pro.paginationstatusbarcomponent.md) &gt; [init](./grid-pro.paginationstatusbarcomponent.init.md)
4
+
5
+ ## PaginationStatusBarComponent.init() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ init(params: IStatusPanelParams): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | params | IStatusPanelParams | |
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; [PaginationStatusBarComponent](./grid-pro.paginationstatusbarcomponent.md)
4
+
5
+ ## PaginationStatusBarComponent class
6
+
7
+ Pagination Status Bar Component for AG Grid Displays pagination controls and information about current page and total rows
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare class PaginationStatusBarComponent implements IStatusPanelComp
13
+ ```
14
+ **Implements:** IStatusPanelComp
15
+
16
+ ## Methods
17
+
18
+ | Method | Modifiers | Description |
19
+ | --- | --- | --- |
20
+ | [destroy()](./grid-pro.paginationstatusbarcomponent.destroy.md) | | |
21
+ | [getGui()](./grid-pro.paginationstatusbarcomponent.getgui.md) | | |
22
+ | [init(params)](./grid-pro.paginationstatusbarcomponent.init.md) | | |
23
+
@@ -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; [ReloadStatusBarComponent](./grid-pro.reloadstatusbarcomponent.md) &gt; [destroy](./grid-pro.reloadstatusbarcomponent.destroy.md)
4
+
5
+ ## ReloadStatusBarComponent.destroy() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ destroy(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+