@genesislcap/grid-pro 14.237.2-alpha-78ebbc0.0 → 14.238.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/dist/dts/column/column.d.ts +29 -46
  2. package/dist/dts/column/column.d.ts.map +1 -1
  3. package/dist/dts/datasource/base.datasource.d.ts +29 -45
  4. package/dist/dts/datasource/base.datasource.d.ts.map +1 -1
  5. package/dist/dts/datasource/server-side.datasource.d.ts +29 -46
  6. package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
  7. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +30 -53
  8. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
  9. package/dist/dts/grid-pro.d.ts +36 -49
  10. package/dist/dts/grid-pro.d.ts.map +1 -1
  11. package/dist/dts/grid-pro.types.d.ts +1 -1
  12. package/dist/dts/grid-pro.types.d.ts.map +1 -1
  13. package/dist/dts/tsdoc-metadata.json +1 -1
  14. package/dist/esm/cell-renderers/select.renderer.js +1 -1
  15. package/dist/esm/datasource/server-side.datasource.js +6 -6
  16. package/dist/esm/datasource/server-side.resource-base.js +1 -1
  17. package/dist/esm/datasource/server-side.resource-dataserver.js +1 -1
  18. package/dist/esm/datasource/server-side.resource-reqrep.js +1 -1
  19. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +4 -4
  20. package/dist/esm/grid-pro.js +5 -5
  21. package/dist/esm/state-persistence/kv-state.js +3 -3
  22. package/dist/grid-pro.api.json +316 -1302
  23. package/dist/grid-pro.d.ts +154 -238
  24. package/docs/api/grid-pro.agthemefontsid.md +1 -13
  25. package/docs/api/grid-pro.agthemetokenmapclassname.md +1 -13
  26. package/docs/api/grid-pro.agthemetokenmapcss.md +1 -14
  27. package/docs/api/grid-pro.converttokebabcase.md +1 -14
  28. package/docs/api/grid-pro.foundationagbooleanrenderer.md +1 -11
  29. package/docs/api/grid-pro.foundationageditablerenderer.md +1 -11
  30. package/docs/api/grid-pro.foundationagselectrenderer.md +1 -11
  31. package/docs/api/grid-pro.foundationagtextfieldrenderer.md +1 -11
  32. package/docs/api/grid-pro.foundationagtextrenderer.md +1 -11
  33. package/docs/api/grid-pro.foundationdateeditor.md +1 -11
  34. package/docs/api/grid-pro.foundationgridpro.md +1 -11
  35. package/docs/api/grid-pro.foundationgridproactionrenderer.md +1 -11
  36. package/docs/api/grid-pro.foundationgridproactionsmenurenderer.md +1 -11
  37. package/docs/api/grid-pro.foundationmultiselecteditor.md +1 -11
  38. package/docs/api/grid-pro.foundationnumbereditor.md +1 -11
  39. package/docs/api/grid-pro.foundationselecteditor.md +1 -11
  40. package/docs/api/grid-pro.foundationstringeditor.md +1 -11
  41. package/docs/api/grid-pro.getactionsmenudef.md +1 -17
  42. package/docs/api/grid-pro.getagbooleanrenderertemplate.md +1 -14
  43. package/docs/api/grid-pro.getageditablerenderertemplate.md +1 -14
  44. package/docs/api/grid-pro.getdateeditortemplate.md +1 -14
  45. package/docs/api/grid-pro.getgridprotemplate.md +1 -14
  46. package/docs/api/grid-pro.getmultiselecteditortemplate.md +1 -14
  47. package/docs/api/grid-pro.getnumbereditortemplate.md +1 -14
  48. package/docs/api/grid-pro.getselecteditortemplate.md +1 -14
  49. package/docs/api/grid-pro.getselectrenderertemplate.md +1 -14
  50. package/docs/api/grid-pro.getstringeditortemplate.md +1 -14
  51. package/docs/api/grid-pro.gettextfieldrenderertemplate.md +1 -14
  52. package/docs/api/grid-pro.gettextrenderertemplate.md +1 -12
  53. package/docs/api/grid-pro.gridpro.md +1 -1
  54. package/docs/api/grid-pro.md +29 -33
  55. package/docs/{api-report.md.api.md → api-report.md} +1 -3
  56. package/package.json +14 -14
  57. package/docs/api/grid-pro.formatdateextra.md +0 -34
  58. package/docs/api/grid-pro.getcolumntype.md +0 -33
  59. package/docs/api/grid-pro.getfilterbyfieldtype.md +0 -33
  60. package/docs/api/grid-pro.gridproserversidedatasource.applyasyncfuncname.md +0 -14
  61. package/docs/api/grid-pro.gridproserversidedatasource.applyfuncname.md +0 -14
  62. package/docs/api/grid-pro.gridproserversidedatasource.liveupdates.md +0 -21
  63. package/docs/api/grid-pro.gridproserversidedatasource.md +0 -35
  64. package/docs/api/grid-pro.gridproserversidedatasource.pagination.md +0 -14
  65. package/docs/api/grid-pro.gridproserversidedatasource.params.md +0 -14
  66. package/docs/api/grid-pro.gridproserversidedatasource.request.md +0 -14
  67. package/docs/api/grid-pro.gridproserversidedatasource.rowmodel.md +0 -14
  68. package/docs/api/grid-pro.gridproserversidedatasource.zerobasedviewnumber.md +0 -21
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [getSelectEditorTemplate](./grid-pro.getselecteditortemplate.md)
4
4
 
5
- ## getSelectEditorTemplate() function
5
+ ## getSelectEditorTemplate variable
6
6
 
7
7
  Get a Design System prefixed Select template.
8
8
 
@@ -11,16 +11,3 @@ Get a Design System prefixed Select template.
11
11
  ```typescript
12
12
  getSelectEditorTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<SelectEditor, any>
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | designSystem | string | _(Optional)_ The design system prefix to use. Defaults to 'foundation'. |
20
-
21
- **Returns:**
22
-
23
- import("@microsoft/fast-element").ViewTemplate&lt;[SelectEditor](./grid-pro.selecteditor.md)<!-- -->, any&gt;
24
-
25
- A Select component template prefixed with the correct design system.
26
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getSelectRendererTemplate](./grid-pro.getselectrenderertemplate.md)
4
4
 
5
- ## getSelectRendererTemplate() function
5
+ ## getSelectRendererTemplate variable
6
6
 
7
7
  Get a Design System prefixed Select template.
8
8
 
@@ -11,16 +11,3 @@ Get a Design System prefixed Select template.
11
11
  ```typescript
12
12
  getSelectRendererTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<any, any>
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | designSystem | string | _(Optional)_ The design system prefix to use. Defaults to 'foundation'. |
20
-
21
- **Returns:**
22
-
23
- import("@microsoft/fast-element").ViewTemplate&lt;any, any&gt;
24
-
25
- A Select component template prefixed with the correct design system.
26
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getStringEditorTemplate](./grid-pro.getstringeditortemplate.md)
4
4
 
5
- ## getStringEditorTemplate() function
5
+ ## getStringEditorTemplate variable
6
6
 
7
7
  Get a Design System prefixed String template.
8
8
 
@@ -11,16 +11,3 @@ Get a Design System prefixed String template.
11
11
  ```typescript
12
12
  getStringEditorTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<StringEditor, any>
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | designSystem | string | _(Optional)_ The design system prefix to use. Defaults to 'foundation'. |
20
-
21
- **Returns:**
22
-
23
- import("@microsoft/fast-element").ViewTemplate&lt;[StringEditor](./grid-pro.stringeditor.md)<!-- -->, any&gt;
24
-
25
- A String component template prefixed with the correct design system.
26
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getTextFieldRendererTemplate](./grid-pro.gettextfieldrenderertemplate.md)
4
4
 
5
- ## getTextFieldRendererTemplate() function
5
+ ## getTextFieldRendererTemplate variable
6
6
 
7
7
  Get a Design System prefixed Text Field template.
8
8
 
@@ -11,16 +11,3 @@ Get a Design System prefixed Text Field template.
11
11
  ```typescript
12
12
  getTextFieldRendererTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<AgTextFieldRenderer, any>
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | designSystem | string | _(Optional)_ The design system prefix to use. Defaults to 'foundation'. |
20
-
21
- **Returns:**
22
-
23
- import("@microsoft/fast-element").ViewTemplate&lt;[AgTextFieldRenderer](./grid-pro.agtextfieldrenderer.md)<!-- -->, any&gt;
24
-
25
- A Text Field component template prefixed with the correct design system.
26
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getTextRendererTemplate](./grid-pro.gettextrenderertemplate.md)
4
4
 
5
- ## getTextRendererTemplate() function
5
+ ## getTextRendererTemplate variable
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
@@ -14,14 +14,3 @@
14
14
  ```typescript
15
15
  getTextRendererTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<AgTextFieldRenderer, any>
16
16
  ```
17
-
18
- ## Parameters
19
-
20
- | Parameter | Type | Description |
21
- | --- | --- | --- |
22
- | designSystem | string | _(Optional)_ |
23
-
24
- **Returns:**
25
-
26
- import("@microsoft/fast-element").ViewTemplate&lt;[AgTextFieldRenderer](./grid-pro.agtextfieldrenderer.md)<!-- -->, any&gt;
27
-
@@ -51,7 +51,7 @@ 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](./grid-pro.gridproserversidedatasource.md) | Get the datasource element. |
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. |
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 | |
@@ -20,7 +20,6 @@
20
20
  | [GridProClientSideDatasource](./grid-pro.gridproclientsidedatasource.md) | The Genesis Datasource element, for client-side \| CSRM-compatible data fetching and used exclusively by the GridPro element. |
21
21
  | [GridProColumn](./grid-pro.gridprocolumn.md) | The Grid Pro Column element. |
22
22
  | [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) | The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element. |
23
- | [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) | **_(ALPHA)_** A Genesis Datasource element, for server-side \| SSRM-compatible data fetching and used exclusively by the GridPro element. |
24
23
  | [KVStorageStatePersistence](./grid-pro.kvstoragestatepersistence.md) | Implementation for the KV Storage State Persistence interface. |
25
24
  | [LocalStorageStatePersistence](./grid-pro.localstoragestatepersistence.md) | Implementation for the Local Storage State Persistence interface. |
26
25
  | [MultiselectEditor](./grid-pro.multiselecteditor.md) | The AG Multiselect Editor element. |
@@ -42,42 +41,10 @@
42
41
 
43
42
  | Function | Description |
44
43
  | --- | --- |
45
- | [agThemeFontsId(themeName)](./grid-pro.agthemefontsid.md) | Generates the id name for custom Grid Pro fonts. |
46
- | [agThemeTokenMapClassname(themeName)](./grid-pro.agthemetokenmapclassname.md) | Generates the class name for a given Grid Pro theme name. |
47
- | [agThemeTokenMapCSS(themeName, tokenMap)](./grid-pro.agthemetokenmapcss.md) | Generates the CSS for a given GridPro theme name and token map |
48
- | [convertToKebabCase(value)](./grid-pro.converttokebabcase.md) | Convert string values from 'camelCase' to 'kebab-case' |
49
44
  | [dateTimeValueFormatter({ value })](./grid-pro.datetimevalueformatter.md) | Returns a formatted date time value from the Grid Pro cell value. |
50
45
  | [dateValueFormatter({ value })](./grid-pro.datevalueformatter.md) | Returns a formatted date value from the Grid Pro cell value. |
51
- | [formatDateExtra(epoch)](./grid-pro.formatdateextra.md) | **_(ALPHA)_** Returns a formatted date value from an epoch number. |
52
- | [foundationAgBooleanRenderer(overrideDefinition)](./grid-pro.foundationagbooleanrenderer.md) | A function that returns a Foundation Boolean Renderer registration for configuring the component with a DesignSystem. |
53
- | [foundationAgEditableRenderer(overrideDefinition)](./grid-pro.foundationageditablerenderer.md) | A function that returns a Foundation Editable Renderer registration for configuring the component with a DesignSystem. |
54
- | [foundationAgSelectRenderer(overrideDefinition)](./grid-pro.foundationagselectrenderer.md) | A function that returns a Foundation Select Renderer registration for configuring the component with a DesignSystem. |
55
- | [foundationAgTextFieldRenderer(overrideDefinition)](./grid-pro.foundationagtextfieldrenderer.md) | A function that returns a Foundation Text Field Renderer registration for configuring the component with a DesignSystem. |
56
- | [foundationAgTextRenderer(overrideDefinition)](./grid-pro.foundationagtextrenderer.md) | A function that returns a Foundation Text Renderer registration for configuring the component with a DesignSystem. |
57
- | [foundationDateEditor(overrideDefinition)](./grid-pro.foundationdateeditor.md) | |
58
- | [foundationGridPro(overrideDefinition)](./grid-pro.foundationgridpro.md) | A function that returns a Foundation Grid Pro registration for configuring the component with a DesignSystem. |
59
- | [foundationGridProActionRenderer(overrideDefinition)](./grid-pro.foundationgridproactionrenderer.md) | A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem. |
60
- | [foundationGridProActionsMenuRenderer(overrideDefinition)](./grid-pro.foundationgridproactionsmenurenderer.md) | A function that returns a Foundation Actions Menu for configuring the component with a DesignSystem. |
61
- | [foundationMultiselectEditor(overrideDefinition)](./grid-pro.foundationmultiselecteditor.md) | |
62
- | [foundationNumberEditor(overrideDefinition)](./grid-pro.foundationnumbereditor.md) | |
63
- | [foundationSelectEditor(overrideDefinition)](./grid-pro.foundationselecteditor.md) | |
64
- | [foundationStringEditor(overrideDefinition)](./grid-pro.foundationstringeditor.md) | |
65
- | [getActionsMenuDef(actions, overrideDef, customActionsOpenerName, isVertical, buttonAppearance)](./grid-pro.getactionsmenudef.md) | Helper function to get ColDef [https://www.ag-grid.com/javascript-data-grid/column-properties/](https://www.ag-grid.com/javascript-data-grid/column-properties/) for Actions Menu Renderer. Will take the parameter values for a base ColDef and merge them with the overrideDef (if specified). |
66
- | [getAgBooleanRendererTemplate(designSystem)](./grid-pro.getagbooleanrenderertemplate.md) | Get a Design System prefixed Checkbox template. |
67
- | [getAgEditableRendererTemplate(designSystem)](./grid-pro.getageditablerenderertemplate.md) | Get a Design System prefixed Checkbox template. |
68
46
  | [getAvailableIndexes(data)](./grid-pro.getavailableindexes.md) | Get the keys of the Metadata indexes map |
69
47
  | [getAvailableIndexFields(data)](./grid-pro.getavailableindexfields.md) | Get the values of the Metadata indexes map |
70
- | [getColumnType(metadataType)](./grid-pro.getcolumntype.md) | **_(ALPHA)_** Return a column type base on each field's metadata from the selected resource. |
71
- | [getDateEditorTemplate(prefix)](./grid-pro.getdateeditortemplate.md) | Get a Design System prefixed Select template. |
72
- | [getFilterByFieldType(type)](./grid-pro.getfilterbyfieldtype.md) | **_(ALPHA)_** Returns a filter type based on the Grid Pro field/column type. |
73
- | [getGridProTemplate(prefix)](./grid-pro.getgridprotemplate.md) | Get a Design System prefixed The Grid Pro template. |
74
- | [getMultiselectEditorTemplate(designSystem)](./grid-pro.getmultiselecteditortemplate.md) | Get a Design System prefixed Select template. |
75
- | [getNumberEditorTemplate(designSystem)](./grid-pro.getnumbereditortemplate.md) | Get a Design System prefixed Select template. |
76
- | [getSelectEditorTemplate(designSystem)](./grid-pro.getselecteditortemplate.md) | Get a Design System prefixed Select template. |
77
- | [getSelectRendererTemplate(designSystem)](./grid-pro.getselectrenderertemplate.md) | Get a Design System prefixed Select template. |
78
- | [getStringEditorTemplate(designSystem)](./grid-pro.getstringeditortemplate.md) | Get a Design System prefixed String template. |
79
- | [getTextFieldRendererTemplate(designSystem)](./grid-pro.gettextfieldrenderertemplate.md) | Get a Design System prefixed Text Field template. |
80
- | [getTextRendererTemplate(designSystem)](./grid-pro.gettextrenderertemplate.md) | |
81
48
  | [gridProColumns(itemsBinding, includeRenderers)](./grid-pro.gridprocolumns.md) | A directive that renders a set of grid-pro-column elements from a given input binding |
82
49
  | [mergeAndDedupColDefWithColumnState(colDefs, columnStates)](./grid-pro.mergeanddedupcoldefwithcolumnstate.md) | Merges two arrays, one of <code>ColDef</code> and one of <code>ColumnState</code>, and deduplicates them. |
83
50
 
@@ -117,18 +84,47 @@
117
84
  | [agThemeAlpineNofontsCSS](./grid-pro.agthemealpinenofontscss.md) | AG Alpine Theme (no fonts) CSS. |
118
85
  | [agThemeBalhamNofontsCSS](./grid-pro.agthemebalhamnofontscss.md) | AG Balham Theme (no fonts) CSS. |
119
86
  | [agThemeFontFaceMap](./grid-pro.agthemefontfacemap.md) | Font Face map with all the font faces for each theme. |
87
+ | [agThemeFontsId](./grid-pro.agthemefontsid.md) | Generates the id name for custom Grid Pro fonts. |
120
88
  | [agThemeMaterialNofontsCSS](./grid-pro.agthemematerialnofontscss.md) | AG Material Theme (no fonts) CSS. |
89
+ | [agThemeTokenMapClassname](./grid-pro.agthemetokenmapclassname.md) | Generates the class name for a given Grid Pro theme name. |
90
+ | [agThemeTokenMapCSS](./grid-pro.agthemetokenmapcss.md) | Generates the CSS for a given GridPro theme name and token map |
121
91
  | [CellTemplate](./grid-pro.celltemplate.md) | The Grid Pro Cell Template. |
122
92
  | [ColumnTemplate](./grid-pro.columntemplate.md) | The Grid Pro Column Template. |
93
+ | [convertToKebabCase](./grid-pro.converttokebabcase.md) | Convert string values from 'camelCase' to 'kebab-case' |
123
94
  | [csvExportParams](./grid-pro.csvexportparams.md) | Allows secure export of CSV https://owasp.org/www-community/attacks/CSV\_Injection |
124
95
  | [defaultAgGridFontFace](./grid-pro.defaultaggridfontface.md) | The default font face for Grid Pro (agGridAlpine). |
125
96
  | [defaultGridOptionsConfig](./grid-pro.defaultgridoptionsconfig.md) | Default grid options |
126
97
  | [defaultGridProConfig](./grid-pro.defaultgridproconfig.md) | Grid Pro default configuration. |
127
98
  | [EDITED\_COLUMN\_FIELD](./grid-pro.edited_column_field.md) | Key used to store currently edited column when it being synced with server side data |
128
99
  | [ERROR\_COLUMN\_FIELD](./grid-pro.error_column_field.md) | Key used to store error details (column, message) when inline edit fails sync with server side data |
100
+ | [foundationAgBooleanRenderer](./grid-pro.foundationagbooleanrenderer.md) | A function that returns a Foundation Boolean Renderer registration for configuring the component with a DesignSystem. |
101
+ | [foundationAgEditableRenderer](./grid-pro.foundationageditablerenderer.md) | A function that returns a Foundation Editable Renderer registration for configuring the component with a DesignSystem. |
102
+ | [foundationAgSelectRenderer](./grid-pro.foundationagselectrenderer.md) | A function that returns a Foundation Select Renderer registration for configuring the component with a DesignSystem. |
103
+ | [foundationAgTextFieldRenderer](./grid-pro.foundationagtextfieldrenderer.md) | A function that returns a Foundation Text Field Renderer registration for configuring the component with a DesignSystem. |
104
+ | [foundationAgTextRenderer](./grid-pro.foundationagtextrenderer.md) | A function that returns a Foundation Text Renderer registration for configuring the component with a DesignSystem. |
105
+ | [foundationDateEditor](./grid-pro.foundationdateeditor.md) | |
129
106
  | [foundationGridComponents](./grid-pro.foundationgridcomponents.md) | The Grid Pro Components. |
107
+ | [foundationGridPro](./grid-pro.foundationgridpro.md) | A function that returns a Foundation Grid Pro registration for configuring the component with a DesignSystem. |
108
+ | [foundationGridProActionRenderer](./grid-pro.foundationgridproactionrenderer.md) | A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem. |
109
+ | [foundationGridProActionsMenuRenderer](./grid-pro.foundationgridproactionsmenurenderer.md) | A function that returns a Foundation Actions Menu for configuring the component with a DesignSystem. |
130
110
  | [foundationGridProShadowOptions](./grid-pro.foundationgridproshadowoptions.md) | GridPro shadow root options. |
131
111
  | [foundationGridProStyles](./grid-pro.foundationgridprostyles.md) | The Grid Pro styles. |
112
+ | [foundationMultiselectEditor](./grid-pro.foundationmultiselecteditor.md) | |
113
+ | [foundationNumberEditor](./grid-pro.foundationnumbereditor.md) | |
114
+ | [foundationSelectEditor](./grid-pro.foundationselecteditor.md) | |
115
+ | [foundationStringEditor](./grid-pro.foundationstringeditor.md) | |
116
+ | [getActionsMenuDef](./grid-pro.getactionsmenudef.md) | Helper function to get ColDef [https://www.ag-grid.com/javascript-data-grid/column-properties/](https://www.ag-grid.com/javascript-data-grid/column-properties/) for Actions Menu Renderer. Will take the parameter values for a base ColDef and merge them with the overrideDef (if specified). |
117
+ | [getAgBooleanRendererTemplate](./grid-pro.getagbooleanrenderertemplate.md) | Get a Design System prefixed Checkbox template. |
118
+ | [getAgEditableRendererTemplate](./grid-pro.getageditablerenderertemplate.md) | Get a Design System prefixed Checkbox template. |
119
+ | [getDateEditorTemplate](./grid-pro.getdateeditortemplate.md) | Get a Design System prefixed Select template. |
120
+ | [getGridProTemplate](./grid-pro.getgridprotemplate.md) | Get a Design System prefixed The Grid Pro template. |
121
+ | [getMultiselectEditorTemplate](./grid-pro.getmultiselecteditortemplate.md) | Get a Design System prefixed Select template. |
122
+ | [getNumberEditorTemplate](./grid-pro.getnumbereditortemplate.md) | Get a Design System prefixed Select template. |
123
+ | [getSelectEditorTemplate](./grid-pro.getselecteditortemplate.md) | Get a Design System prefixed Select template. |
124
+ | [getSelectRendererTemplate](./grid-pro.getselectrenderertemplate.md) | Get a Design System prefixed Select template. |
125
+ | [getStringEditorTemplate](./grid-pro.getstringeditortemplate.md) | Get a Design System prefixed String template. |
126
+ | [getTextFieldRendererTemplate](./grid-pro.gettextfieldrenderertemplate.md) | Get a Design System prefixed Text Field template. |
127
+ | [getTextRendererTemplate](./grid-pro.gettextrenderertemplate.md) | |
132
128
  | [GRID\_READY\_EVENT](./grid-pro.grid_ready_event.md) | Event fired when grid is ready |
133
129
  | [gridProErrorNames](./grid-pro.gridproerrornames.md) | The error names for the Grid Pro component. |
134
130
  | [gridProEventNames](./grid-pro.gridproeventnames.md) | The event names for the Grid Pro component. |
@@ -4,8 +4,6 @@
4
4
 
5
5
  ```ts
6
6
 
7
- /// <reference types="node" />
8
-
9
7
  import { ActionMenuItem } from '@genesislcap/foundation-ui';
10
8
  import { BehaviorSubject } from 'rxjs';
11
9
  import { Binding } from '@microsoft/fast-element';
@@ -1083,7 +1081,7 @@ export enum GridProRendererTypes {
1083
1081
  // (undocumented)
1084
1082
  dateEditor = "dateEditor",
1085
1083
  // (undocumented)
1086
- editable = "editable",// TODO: textField :(
1084
+ editable = "editable",
1087
1085
  // (undocumented)
1088
1086
  multiselectEditor = "multiselectEditor",
1089
1087
  // (undocumented)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/grid-pro",
3
3
  "description": "Genesis Foundation AG Grid",
4
- "version": "14.237.2-alpha-78ebbc0.0",
4
+ "version": "14.238.1",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -38,20 +38,20 @@
38
38
  }
39
39
  },
40
40
  "devDependencies": {
41
- "@genesislcap/foundation-testing": "14.237.2-alpha-78ebbc0.0",
42
- "@genesislcap/genx": "14.237.2-alpha-78ebbc0.0",
43
- "@genesislcap/rollup-builder": "14.237.2-alpha-78ebbc0.0",
44
- "@genesislcap/ts-builder": "14.237.2-alpha-78ebbc0.0",
45
- "@genesislcap/uvu-playwright-builder": "14.237.2-alpha-78ebbc0.0",
46
- "@genesislcap/vite-builder": "14.237.2-alpha-78ebbc0.0",
47
- "@genesislcap/webpack-builder": "14.237.2-alpha-78ebbc0.0",
41
+ "@genesislcap/foundation-testing": "14.238.1",
42
+ "@genesislcap/genx": "14.238.1",
43
+ "@genesislcap/rollup-builder": "14.238.1",
44
+ "@genesislcap/ts-builder": "14.238.1",
45
+ "@genesislcap/uvu-playwright-builder": "14.238.1",
46
+ "@genesislcap/vite-builder": "14.238.1",
47
+ "@genesislcap/webpack-builder": "14.238.1",
48
48
  "rimraf": "^5.0.0"
49
49
  },
50
50
  "dependencies": {
51
- "@genesislcap/foundation-comms": "14.237.2-alpha-78ebbc0.0",
52
- "@genesislcap/foundation-logger": "14.237.2-alpha-78ebbc0.0",
53
- "@genesislcap/foundation-ui": "14.237.2-alpha-78ebbc0.0",
54
- "@genesislcap/foundation-utils": "14.237.2-alpha-78ebbc0.0",
51
+ "@genesislcap/foundation-comms": "14.238.1",
52
+ "@genesislcap/foundation-logger": "14.238.1",
53
+ "@genesislcap/foundation-ui": "14.238.1",
54
+ "@genesislcap/foundation-utils": "14.238.1",
55
55
  "@microsoft/fast-colors": "5.3.1",
56
56
  "@microsoft/fast-components": "2.30.6",
57
57
  "@microsoft/fast-element": "1.14.0",
@@ -61,7 +61,7 @@
61
61
  "dayjs": "^1.11.7",
62
62
  "lodash.debounce": "^4.0.8",
63
63
  "rxjs": "^7.5.4",
64
- "tslib": "2.8.1"
64
+ "tslib": "^2.3.1"
65
65
  },
66
66
  "peerDependencies": {
67
67
  "@ag-grid-community/client-side-row-model": "29.2.0",
@@ -77,5 +77,5 @@
77
77
  "access": "public"
78
78
  },
79
79
  "customElements": "dist/custom-elements.json",
80
- "gitHead": "ab5fa0da6c1d82b0d69754c35801e2b17ae7d018"
80
+ "gitHead": "c0de8cfef19e4e0e11ea5799cb7d43d7bea6ff49"
81
81
  }
@@ -1,34 +0,0 @@
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; [formatDateExtra](./grid-pro.formatdateextra.md)
4
-
5
- ## formatDateExtra() function
6
-
7
- > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
- >
9
-
10
- > Warning: This API is now obsolete.
11
- >
12
- > No longer used in the Grid Pro package.
13
- >
14
-
15
- Returns a formatted date value from an epoch number.
16
-
17
- **Signature:**
18
-
19
- ```typescript
20
- export declare function formatDateExtra(epoch: number): string;
21
- ```
22
-
23
- ## Parameters
24
-
25
- | Parameter | Type | Description |
26
- | --- | --- | --- |
27
- | epoch | number | A number representing the number of milliseconds since the Unix epoch (1 January 1970 00:00:00 UTC). |
28
-
29
- **Returns:**
30
-
31
- string
32
-
33
- A formatted date value.
34
-
@@ -1,33 +0,0 @@
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; [getColumnType](./grid-pro.getcolumntype.md)
4
-
5
- ## getColumnType() function
6
-
7
- > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
- >
9
-
10
- Return a column type base on each field's metadata from the selected resource.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export declare function getColumnType(metadataType: string): string;
16
- ```
17
-
18
- ## Parameters
19
-
20
- | Parameter | Type | Description |
21
- | --- | --- | --- |
22
- | metadataType | string | The type of the field/column |
23
-
24
- **Returns:**
25
-
26
- string
27
-
28
- the column type
29
-
30
- ## Remarks
31
-
32
- Currently only handles numeric columns
33
-
@@ -1,33 +0,0 @@
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; [getFilterByFieldType](./grid-pro.getfilterbyfieldtype.md)
4
-
5
- ## getFilterByFieldType() function
6
-
7
- > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
- >
9
-
10
- Returns a filter type based on the Grid Pro field/column type.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export declare function getFilterByFieldType(type: string): string;
16
- ```
17
-
18
- ## Parameters
19
-
20
- | Parameter | Type | Description |
21
- | --- | --- | --- |
22
- | type | string | The type of the field/column |
23
-
24
- **Returns:**
25
-
26
- string
27
-
28
- The ag-grid filter type
29
-
30
- ## Remarks
31
-
32
- Currently only returns agTextColumnFilter
33
-
@@ -1,14 +0,0 @@
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; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [applyAsyncFuncName](./grid-pro.gridproserversidedatasource.applyasyncfuncname.md)
4
-
5
- ## GridProServerSideDatasource.applyAsyncFuncName property
6
-
7
- > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- applyAsyncFuncName: string;
14
- ```
@@ -1,14 +0,0 @@
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; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [applyFuncName](./grid-pro.gridproserversidedatasource.applyfuncname.md)
4
-
5
- ## GridProServerSideDatasource.applyFuncName property
6
-
7
- > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- applyFuncName: string;
14
- ```
@@ -1,21 +0,0 @@
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; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [liveUpdates](./grid-pro.gridproserversidedatasource.liveupdates.md)
4
-
5
- ## GridProServerSideDatasource.liveUpdates property
6
-
7
- > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
- >
9
-
10
- Enable live updates for the grid.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- liveUpdates: boolean;
16
- ```
17
-
18
- ## Remarks
19
-
20
- Only works with DATASERVER resources (StreamDatasource) right now.
21
-
@@ -1,35 +0,0 @@
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; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md)
4
-
5
- ## GridProServerSideDatasource class
6
-
7
- > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
- >
9
-
10
- A Genesis Datasource element, for server-side \| SSRM-compatible data fetching and used exclusively by the GridPro element.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export declare class GridProServerSideDatasource extends GridProServerSideDatasource_base
16
- ```
17
- **Extends:** GridProServerSideDatasource\_base
18
-
19
- ## Remarks
20
-
21
- Only supports Server-Side Row Model. Requires `@ag-grid-enterprise/server-side-row-model` setup and valid AG Grid Enterprise license.
22
-
23
- ## Properties
24
-
25
- | Property | Modifiers | Type | Description |
26
- | --- | --- | --- | --- |
27
- | [applyAsyncFuncName](./grid-pro.gridproserversidedatasource.applyasyncfuncname.md) | | string | **_(ALPHA)_** |
28
- | [applyFuncName](./grid-pro.gridproserversidedatasource.applyfuncname.md) | | string | **_(ALPHA)_** |
29
- | [liveUpdates](./grid-pro.gridproserversidedatasource.liveupdates.md) | | boolean | **_(ALPHA)_** Enable live updates for the grid. |
30
- | [pagination](./grid-pro.gridproserversidedatasource.pagination.md) | | boolean | **_(ALPHA)_** |
31
- | [params](./grid-pro.gridproserversidedatasource.params.md) | <code>readonly</code> | any | **_(ALPHA)_** |
32
- | [request](./grid-pro.gridproserversidedatasource.request.md) | | any | **_(ALPHA)_** |
33
- | [rowModel](./grid-pro.gridproserversidedatasource.rowmodel.md) | <code>readonly</code> | IServerSideRowModel | **_(ALPHA)_** |
34
- | [zeroBasedViewNumber](./grid-pro.gridproserversidedatasource.zerobasedviewnumber.md) | | boolean | **_(ALPHA)_** The starting VIEW\_NUMBER of the data to be fetched. |
35
-
@@ -1,14 +0,0 @@
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; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [pagination](./grid-pro.gridproserversidedatasource.pagination.md)
4
-
5
- ## GridProServerSideDatasource.pagination property
6
-
7
- > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- pagination: boolean;
14
- ```
@@ -1,14 +0,0 @@
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; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [params](./grid-pro.gridproserversidedatasource.params.md)
4
-
5
- ## GridProServerSideDatasource.params property
6
-
7
- > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- get params(): any;
14
- ```
@@ -1,14 +0,0 @@
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; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [request](./grid-pro.gridproserversidedatasource.request.md)
4
-
5
- ## GridProServerSideDatasource.request property
6
-
7
- > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- request: any;
14
- ```
@@ -1,14 +0,0 @@
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; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [rowModel](./grid-pro.gridproserversidedatasource.rowmodel.md)
4
-
5
- ## GridProServerSideDatasource.rowModel property
6
-
7
- > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
- >
9
-
10
- **Signature:**
11
-
12
- ```typescript
13
- get rowModel(): IServerSideRowModel;
14
- ```
@@ -1,21 +0,0 @@
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; [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) &gt; [zeroBasedViewNumber](./grid-pro.gridproserversidedatasource.zerobasedviewnumber.md)
4
-
5
- ## GridProServerSideDatasource.zeroBasedViewNumber property
6
-
7
- > This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
- >
9
-
10
- The starting VIEW\_NUMBER of the data to be fetched.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- zeroBasedViewNumber: boolean;
16
- ```
17
-
18
- ## Remarks
19
-
20
- The VIEW\_NUMBER isincremented by the grid as the user scrolls or changes pages.
21
-