@genesislcap/grid-pro 14.237.1 → 14.237.2-alpha-78ebbc0.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 (68) hide show
  1. package/dist/dts/column/column.d.ts +46 -29
  2. package/dist/dts/column/column.d.ts.map +1 -1
  3. package/dist/dts/datasource/base.datasource.d.ts +45 -29
  4. package/dist/dts/datasource/base.datasource.d.ts.map +1 -1
  5. package/dist/dts/datasource/server-side.datasource.d.ts +46 -29
  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 +53 -30
  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 +49 -36
  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 +1303 -317
  23. package/dist/grid-pro.d.ts +238 -154
  24. package/docs/api/grid-pro.agthemefontsid.md +13 -1
  25. package/docs/api/grid-pro.agthemetokenmapclassname.md +13 -1
  26. package/docs/api/grid-pro.agthemetokenmapcss.md +14 -1
  27. package/docs/api/grid-pro.converttokebabcase.md +14 -1
  28. package/docs/api/grid-pro.formatdateextra.md +34 -0
  29. package/docs/api/grid-pro.foundationagbooleanrenderer.md +11 -1
  30. package/docs/api/grid-pro.foundationageditablerenderer.md +11 -1
  31. package/docs/api/grid-pro.foundationagselectrenderer.md +11 -1
  32. package/docs/api/grid-pro.foundationagtextfieldrenderer.md +11 -1
  33. package/docs/api/grid-pro.foundationagtextrenderer.md +11 -1
  34. package/docs/api/grid-pro.foundationdateeditor.md +11 -1
  35. package/docs/api/grid-pro.foundationgridpro.md +11 -1
  36. package/docs/api/grid-pro.foundationgridproactionrenderer.md +11 -1
  37. package/docs/api/grid-pro.foundationgridproactionsmenurenderer.md +11 -1
  38. package/docs/api/grid-pro.foundationmultiselecteditor.md +11 -1
  39. package/docs/api/grid-pro.foundationnumbereditor.md +11 -1
  40. package/docs/api/grid-pro.foundationselecteditor.md +11 -1
  41. package/docs/api/grid-pro.foundationstringeditor.md +11 -1
  42. package/docs/api/grid-pro.getactionsmenudef.md +17 -1
  43. package/docs/api/grid-pro.getagbooleanrenderertemplate.md +14 -1
  44. package/docs/api/grid-pro.getageditablerenderertemplate.md +14 -1
  45. package/docs/api/grid-pro.getcolumntype.md +33 -0
  46. package/docs/api/grid-pro.getdateeditortemplate.md +14 -1
  47. package/docs/api/grid-pro.getfilterbyfieldtype.md +33 -0
  48. package/docs/api/grid-pro.getgridprotemplate.md +14 -1
  49. package/docs/api/grid-pro.getmultiselecteditortemplate.md +14 -1
  50. package/docs/api/grid-pro.getnumbereditortemplate.md +14 -1
  51. package/docs/api/grid-pro.getselecteditortemplate.md +14 -1
  52. package/docs/api/grid-pro.getselectrenderertemplate.md +14 -1
  53. package/docs/api/grid-pro.getstringeditortemplate.md +14 -1
  54. package/docs/api/grid-pro.gettextfieldrenderertemplate.md +14 -1
  55. package/docs/api/grid-pro.gettextrenderertemplate.md +12 -1
  56. package/docs/api/grid-pro.gridpro.md +1 -1
  57. package/docs/api/grid-pro.gridproserversidedatasource.applyasyncfuncname.md +14 -0
  58. package/docs/api/grid-pro.gridproserversidedatasource.applyfuncname.md +14 -0
  59. package/docs/api/grid-pro.gridproserversidedatasource.liveupdates.md +21 -0
  60. package/docs/api/grid-pro.gridproserversidedatasource.md +35 -0
  61. package/docs/api/grid-pro.gridproserversidedatasource.pagination.md +14 -0
  62. package/docs/api/grid-pro.gridproserversidedatasource.params.md +14 -0
  63. package/docs/api/grid-pro.gridproserversidedatasource.request.md +14 -0
  64. package/docs/api/grid-pro.gridproserversidedatasource.rowmodel.md +14 -0
  65. package/docs/api/grid-pro.gridproserversidedatasource.zerobasedviewnumber.md +21 -0
  66. package/docs/api/grid-pro.md +33 -29
  67. package/docs/{api-report.md → api-report.md.api.md} +3 -1
  68. package/package.json +14 -14
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [agThemeFontsId](./grid-pro.agthemefontsid.md)
4
4
 
5
- ## agThemeFontsId variable
5
+ ## agThemeFontsId() function
6
6
 
7
7
  Generates the id name for custom Grid Pro fonts.
8
8
 
@@ -12,6 +12,18 @@ Generates the id name for custom Grid Pro fonts.
12
12
  agThemeFontsId: (themeName: string) => string
13
13
  ```
14
14
 
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | themeName | string | the Grid Pro theme name |
20
+
21
+ **Returns:**
22
+
23
+ string
24
+
25
+ the id name for the Grid Pro fonts
26
+
15
27
  ## Example
16
28
 
17
29
  The result of this is used in the id of style tag:
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [agThemeTokenMapClassname](./grid-pro.agthemetokenmapclassname.md)
4
4
 
5
- ## agThemeTokenMapClassname variable
5
+ ## agThemeTokenMapClassname() function
6
6
 
7
7
  Generates the class name for a given Grid Pro theme name.
8
8
 
@@ -12,6 +12,18 @@ Generates the class name for a given Grid Pro theme name.
12
12
  agThemeTokenMapClassname: (themeName: string) => string
13
13
  ```
14
14
 
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | themeName | string | the Grid Pro theme name |
20
+
21
+ **Returns:**
22
+
23
+ string
24
+
25
+ the class name for the Grid Pro token map
26
+
15
27
  ## Example
16
28
 
17
29
  The result of this will be a class name that is applied to the grid part of GridPro template (actual content of the class comes from agThemeTokenMapCSS):
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [agThemeTokenMapCSS](./grid-pro.agthemetokenmapcss.md)
4
4
 
5
- ## agThemeTokenMapCSS variable
5
+ ## agThemeTokenMapCSS() function
6
6
 
7
7
  Generates the CSS for a given GridPro theme name and token map
8
8
 
@@ -12,6 +12,19 @@ Generates the CSS for a given GridPro theme name and token map
12
12
  agThemeTokenMapCSS: (themeName: string, tokenMap: CSSVarTokenMap<any>) => import("@microsoft/fast-element").ElementStyles
13
13
  ```
14
14
 
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | themeName | string | the GridPro theme name |
20
+ | tokenMap | CSSVarTokenMap&lt;any&gt; | a map of CSS variables [AgGridCSSVars](./grid-pro.aggridcssvars.md) and custom token values |
21
+
22
+ **Returns:**
23
+
24
+ import("@microsoft/fast-element").ElementStyles
25
+
26
+ the CSS for the Grid Pro token map
27
+
15
28
  ## Example
16
29
 
17
30
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [convertToKebabCase](./grid-pro.converttokebabcase.md)
4
4
 
5
- ## convertToKebabCase variable
5
+ ## convertToKebabCase() function
6
6
 
7
7
  Convert string values from 'camelCase' to 'kebab-case'
8
8
 
@@ -11,3 +11,16 @@ Convert string values from 'camelCase' to 'kebab-case'
11
11
  ```typescript
12
12
  convertToKebabCase: (value: string) => string
13
13
  ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | value | string | The value to convert to Kebab case. |
20
+
21
+ **Returns:**
22
+
23
+ string
24
+
25
+ The Kebab case result.
26
+
@@ -0,0 +1,34 @@
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
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationAgBooleanRenderer](./grid-pro.foundationagbooleanrenderer.md)
4
4
 
5
- ## foundationAgBooleanRenderer variable
5
+ ## foundationAgBooleanRenderer() function
6
6
 
7
7
  A function that returns a Foundation Boolean Renderer registration for configuring the component with a DesignSystem.
8
8
 
@@ -20,6 +20,16 @@ foundationAgBooleanRenderer: (overrideDefinition?: import("@microsoft/fast-found
20
20
  }, typeof BooleanRenderer>
21
21
  ```
22
22
 
23
+ ## Parameters
24
+
25
+ | Parameter | Type | Description |
26
+ | --- | --- | --- |
27
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[BooleanRenderer](./grid-pro.booleanrenderer.md)<!-- -->, any&gt;; }&gt; | _(Optional)_ |
28
+
29
+ **Returns:**
30
+
31
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[BooleanRenderer](./grid-pro.booleanrenderer.md)<!-- -->, any&gt;; }, typeof [BooleanRenderer](./grid-pro.booleanrenderer.md)<!-- -->&gt;
32
+
23
33
  ## Remarks
24
34
 
25
35
  HTML Element: &lt;<!-- -->foundation-boolean-renderer<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationAgEditableRenderer](./grid-pro.foundationageditablerenderer.md)
4
4
 
5
- ## foundationAgEditableRenderer variable
5
+ ## foundationAgEditableRenderer() function
6
6
 
7
7
  A function that returns a Foundation Editable Renderer registration for configuring the component with a DesignSystem.
8
8
 
@@ -20,6 +20,16 @@ foundationAgEditableRenderer: (overrideDefinition?: import("@microsoft/fast-foun
20
20
  }, typeof EditableRenderer>
21
21
  ```
22
22
 
23
+ ## Parameters
24
+
25
+ | Parameter | Type | Description |
26
+ | --- | --- | --- |
27
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[EditableRenderer](./grid-pro.editablerenderer.md)<!-- -->, any&gt;; }&gt; | _(Optional)_ |
28
+
29
+ **Returns:**
30
+
31
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[EditableRenderer](./grid-pro.editablerenderer.md)<!-- -->, any&gt;; }, typeof [EditableRenderer](./grid-pro.editablerenderer.md)<!-- -->&gt;
32
+
23
33
  ## Remarks
24
34
 
25
35
  HTML Element: &lt;<!-- -->foundation-editable-renderer<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationAgSelectRenderer](./grid-pro.foundationagselectrenderer.md)
4
4
 
5
- ## foundationAgSelectRenderer variable
5
+ ## foundationAgSelectRenderer() function
6
6
 
7
7
  A function that returns a Foundation Select Renderer registration for configuring the component with a DesignSystem.
8
8
 
@@ -20,6 +20,16 @@ foundationAgSelectRenderer: (overrideDefinition?: import("@microsoft/fast-founda
20
20
  }, typeof SelectRenderer>
21
21
  ```
22
22
 
23
+ ## Parameters
24
+
25
+ | Parameter | Type | Description |
26
+ | --- | --- | --- |
27
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;any, any&gt;; }&gt; | _(Optional)_ |
28
+
29
+ **Returns:**
30
+
31
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;any, any&gt;; }, typeof [SelectRenderer](./grid-pro.selectrenderer.md)<!-- -->&gt;
32
+
23
33
  ## Remarks
24
34
 
25
35
  HTML Element: &lt;<!-- -->foundation-select-renderer<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationAgTextFieldRenderer](./grid-pro.foundationagtextfieldrenderer.md)
4
4
 
5
- ## foundationAgTextFieldRenderer variable
5
+ ## foundationAgTextFieldRenderer() function
6
6
 
7
7
  A function that returns a Foundation Text Field Renderer registration for configuring the component with a DesignSystem.
8
8
 
@@ -20,6 +20,16 @@ foundationAgTextFieldRenderer: (overrideDefinition?: import("@microsoft/fast-fou
20
20
  }, typeof AgTextFieldRenderer>
21
21
  ```
22
22
 
23
+ ## Parameters
24
+
25
+ | Parameter | Type | Description |
26
+ | --- | --- | --- |
27
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[AgTextFieldRenderer](./grid-pro.agtextfieldrenderer.md)<!-- -->, any&gt;; }&gt; | _(Optional)_ |
28
+
29
+ **Returns:**
30
+
31
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[AgTextFieldRenderer](./grid-pro.agtextfieldrenderer.md)<!-- -->, any&gt;; }, typeof [AgTextFieldRenderer](./grid-pro.agtextfieldrenderer.md)<!-- -->&gt;
32
+
23
33
  ## Remarks
24
34
 
25
35
  HTML Element: &lt;<!-- -->foundation-grid-pro-text-field-renderer<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationAgTextRenderer](./grid-pro.foundationagtextrenderer.md)
4
4
 
5
- ## foundationAgTextRenderer variable
5
+ ## foundationAgTextRenderer() function
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
@@ -25,6 +25,16 @@ foundationAgTextRenderer: (overrideDefinition?: import("@microsoft/fast-foundati
25
25
  }, typeof AgTextRenderer>
26
26
  ```
27
27
 
28
+ ## Parameters
29
+
30
+ | Parameter | Type | Description |
31
+ | --- | --- | --- |
32
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[AgTextFieldRenderer](./grid-pro.agtextfieldrenderer.md)<!-- -->, any&gt;; }&gt; | _(Optional)_ |
33
+
34
+ **Returns:**
35
+
36
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[AgTextFieldRenderer](./grid-pro.agtextfieldrenderer.md)<!-- -->, any&gt;; }, typeof [AgTextRenderer](./grid-pro.agtextrenderer.md)<!-- -->&gt;
37
+
28
38
  ## Remarks
29
39
 
30
40
  HTML Element: &lt;<!-- -->foundation-grid-text-renderer<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationDateEditor](./grid-pro.foundationdateeditor.md)
4
4
 
5
- ## foundationDateEditor variable
5
+ ## foundationDateEditor() function
6
6
 
7
7
  **Signature:**
8
8
 
@@ -18,6 +18,16 @@ foundationDateEditor: (overrideDefinition?: import("@microsoft/fast-foundation")
18
18
  }, typeof DateEditor>
19
19
  ```
20
20
 
21
+ ## Parameters
22
+
23
+ | Parameter | Type | Description |
24
+ | --- | --- | --- |
25
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[DateEditor](./grid-pro.dateeditor.md)<!-- -->, any&gt;; }&gt; | _(Optional)_ |
26
+
27
+ **Returns:**
28
+
29
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[DateEditor](./grid-pro.dateeditor.md)<!-- -->, any&gt;; }, typeof [DateEditor](./grid-pro.dateeditor.md)<!-- -->&gt;
30
+
21
31
  ## Remarks
22
32
 
23
33
  HTML Element: &lt;<!-- -->foundation-select-editor<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationGridPro](./grid-pro.foundationgridpro.md)
4
4
 
5
- ## foundationGridPro variable
5
+ ## foundationGridPro() function
6
6
 
7
7
  A function that returns a Foundation Grid Pro registration for configuring the component with a DesignSystem.
8
8
 
@@ -22,6 +22,16 @@ foundationGridPro: (overrideDefinition?: import("@microsoft/fast-foundation").Ov
22
22
  }, typeof GridPro>
23
23
  ```
24
24
 
25
+ ## Parameters
26
+
27
+ | Parameter | Type | Description |
28
+ | --- | --- | --- |
29
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ shadowOptions: any; baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;any, any&gt;; }&gt; | _(Optional)_ |
30
+
31
+ **Returns:**
32
+
33
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ shadowOptions: any; baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;any, any&gt;; }, typeof [GridPro](./grid-pro.gridpro.md)<!-- -->&gt;
34
+
25
35
  ## Remarks
26
36
 
27
37
  HTML Element: &lt;<!-- -->foundation-grid-pro<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationGridProActionRenderer](./grid-pro.foundationgridproactionrenderer.md)
4
4
 
5
- ## foundationGridProActionRenderer variable
5
+ ## foundationGridProActionRenderer() function
6
6
 
7
7
  A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem.
8
8
 
@@ -20,6 +20,16 @@ foundationGridProActionRenderer: (overrideDefinition?: import("@microsoft/fast-f
20
20
  }, typeof ActionRenderer>
21
21
  ```
22
22
 
23
+ ## Parameters
24
+
25
+ | Parameter | Type | Description |
26
+ | --- | --- | --- |
27
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[ActionRenderer](./grid-pro.actionrenderer.md)<!-- -->, any&gt;; }&gt; | _(Optional)_ |
28
+
29
+ **Returns:**
30
+
31
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[ActionRenderer](./grid-pro.actionrenderer.md)<!-- -->, any&gt;; }, typeof [ActionRenderer](./grid-pro.actionrenderer.md)<!-- -->&gt;
32
+
23
33
  ## Remarks
24
34
 
25
35
  HTML Element: &lt;<!-- -->foundation-grid-pro-action-renderer<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationGridProActionsMenuRenderer](./grid-pro.foundationgridproactionsmenurenderer.md)
4
4
 
5
- ## foundationGridProActionsMenuRenderer variable
5
+ ## foundationGridProActionsMenuRenderer() function
6
6
 
7
7
  A function that returns a Foundation Actions Menu for configuring the component with a DesignSystem.
8
8
 
@@ -18,6 +18,16 @@ foundationGridProActionsMenuRenderer: (overrideDefinition?: import("@microsoft/f
18
18
  }, typeof ActionsMenuRenderer>
19
19
  ```
20
20
 
21
+ ## Parameters
22
+
23
+ | Parameter | Type | Description |
24
+ | --- | --- | --- |
25
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; template: import("@microsoft/fast-element").ViewTemplate&lt;any, any&gt;; }&gt; | _(Optional)_ |
26
+
27
+ **Returns:**
28
+
29
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; template: import("@microsoft/fast-element").ViewTemplate&lt;any, any&gt;; }, typeof [ActionsMenuRenderer](./grid-pro.actionsmenurenderer.md)<!-- -->&gt;
30
+
21
31
  ## Remarks
22
32
 
23
33
  HTML Element: &lt;<!-- -->foundation-grid-pro-actions-menu-renderer<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationMultiselectEditor](./grid-pro.foundationmultiselecteditor.md)
4
4
 
5
- ## foundationMultiselectEditor variable
5
+ ## foundationMultiselectEditor() function
6
6
 
7
7
  **Signature:**
8
8
 
@@ -18,6 +18,16 @@ foundationMultiselectEditor: (overrideDefinition?: import("@microsoft/fast-found
18
18
  }, typeof MultiselectEditor>
19
19
  ```
20
20
 
21
+ ## Parameters
22
+
23
+ | Parameter | Type | Description |
24
+ | --- | --- | --- |
25
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[MultiselectEditor](./grid-pro.multiselecteditor.md)<!-- -->, any&gt;; }&gt; | _(Optional)_ |
26
+
27
+ **Returns:**
28
+
29
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[MultiselectEditor](./grid-pro.multiselecteditor.md)<!-- -->, any&gt;; }, typeof [MultiselectEditor](./grid-pro.multiselecteditor.md)<!-- -->&gt;
30
+
21
31
  ## Remarks
22
32
 
23
33
  HTML Element: &lt;<!-- -->foundation-multiselect-editor<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationNumberEditor](./grid-pro.foundationnumbereditor.md)
4
4
 
5
- ## foundationNumberEditor variable
5
+ ## foundationNumberEditor() function
6
6
 
7
7
  **Signature:**
8
8
 
@@ -18,6 +18,16 @@ foundationNumberEditor: (overrideDefinition?: import("@microsoft/fast-foundation
18
18
  }, typeof NumberEditor>
19
19
  ```
20
20
 
21
+ ## Parameters
22
+
23
+ | Parameter | Type | Description |
24
+ | --- | --- | --- |
25
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[NumberEditor](./grid-pro.numbereditor.md)<!-- -->, any&gt;; }&gt; | _(Optional)_ |
26
+
27
+ **Returns:**
28
+
29
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[NumberEditor](./grid-pro.numbereditor.md)<!-- -->, any&gt;; }, typeof [NumberEditor](./grid-pro.numbereditor.md)<!-- -->&gt;
30
+
21
31
  ## Remarks
22
32
 
23
33
  HTML Element: &lt;<!-- -->foundation-number-editor<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationSelectEditor](./grid-pro.foundationselecteditor.md)
4
4
 
5
- ## foundationSelectEditor variable
5
+ ## foundationSelectEditor() function
6
6
 
7
7
  **Signature:**
8
8
 
@@ -18,6 +18,16 @@ foundationSelectEditor: (overrideDefinition?: import("@microsoft/fast-foundation
18
18
  }, typeof SelectEditor>
19
19
  ```
20
20
 
21
+ ## Parameters
22
+
23
+ | Parameter | Type | Description |
24
+ | --- | --- | --- |
25
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[SelectEditor](./grid-pro.selecteditor.md)<!-- -->, any&gt;; }&gt; | _(Optional)_ |
26
+
27
+ **Returns:**
28
+
29
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[SelectEditor](./grid-pro.selecteditor.md)<!-- -->, any&gt;; }, typeof [SelectEditor](./grid-pro.selecteditor.md)<!-- -->&gt;
30
+
21
31
  ## Remarks
22
32
 
23
33
  HTML Element: &lt;<!-- -->foundation-select-editor<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [foundationStringEditor](./grid-pro.foundationstringeditor.md)
4
4
 
5
- ## foundationStringEditor variable
5
+ ## foundationStringEditor() function
6
6
 
7
7
  **Signature:**
8
8
 
@@ -18,6 +18,16 @@ foundationStringEditor: (overrideDefinition?: import("@microsoft/fast-foundation
18
18
  }, typeof StringEditor>
19
19
  ```
20
20
 
21
+ ## Parameters
22
+
23
+ | Parameter | Type | Description |
24
+ | --- | --- | --- |
25
+ | overrideDefinition | import("@microsoft/fast-foundation").OverrideFoundationElementDefinition&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[StringEditor](./grid-pro.stringeditor.md)<!-- -->, any&gt;; }&gt; | _(Optional)_ |
26
+
27
+ **Returns:**
28
+
29
+ import("@microsoft/fast-foundation").FoundationElementRegistry&lt;{ baseName: string; styles: import("@microsoft/fast-element").ElementStyles; template: import("@microsoft/fast-element").ViewTemplate&lt;[StringEditor](./grid-pro.stringeditor.md)<!-- -->, any&gt;; }, typeof [StringEditor](./grid-pro.stringeditor.md)<!-- -->&gt;
30
+
21
31
  ## Remarks
22
32
 
23
33
  HTML Element: &lt;<!-- -->foundation-string-editor<!-- -->&gt;
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getActionsMenuDef](./grid-pro.getactionsmenudef.md)
4
4
 
5
- ## getActionsMenuDef variable
5
+ ## getActionsMenuDef() function
6
6
 
7
7
  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).
8
8
 
@@ -12,6 +12,22 @@ Helper function to get ColDef [https://www.ag-grid.com/javascript-data-grid/colu
12
12
  getActionsMenuDef: (actions: ActionMenuItem[], overrideDef?: ColDef, customActionsOpenerName?: string, isVertical?: boolean, buttonAppearance?: string) => ColDef
13
13
  ```
14
14
 
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | actions | ActionMenuItem\[\] | Array of to be displayed in the menu. |
20
+ | overrideDef | ColDef | _(Optional)_ Optional override for the ColDef. Will override any of the default values. Default is an empty object. |
21
+ | customActionsOpenerName | string | _(Optional)_ Optional custom name for the button that opens the menu. Default is '⋮'. |
22
+ | isVertical | boolean | _(Optional)_ Optional flag to display the menu vertically. Default is false (displays the menu horizontally, follow the rowHeight). |
23
+ | buttonAppearance | string | _(Optional)_ Optional appearance for the button that opens the menu. Default is 'outline'. |
24
+
25
+ **Returns:**
26
+
27
+ ColDef
28
+
29
+ Merged ColDef (base ColDef created from the parameters + overrideDef) for Actions Menu Renderer.
30
+
15
31
  ## Example
16
32
 
17
33
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getAgBooleanRendererTemplate](./grid-pro.getagbooleanrenderertemplate.md)
4
4
 
5
- ## getAgBooleanRendererTemplate variable
5
+ ## getAgBooleanRendererTemplate() function
6
6
 
7
7
  Get a Design System prefixed Checkbox template.
8
8
 
@@ -11,3 +11,16 @@ Get a Design System prefixed Checkbox template.
11
11
  ```typescript
12
12
  getAgBooleanRendererTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<BooleanRenderer, 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;[BooleanRenderer](./grid-pro.booleanrenderer.md)<!-- -->, any&gt;
24
+
25
+ A Checkbox 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; [getAgEditableRendererTemplate](./grid-pro.getageditablerenderertemplate.md)
4
4
 
5
- ## getAgEditableRendererTemplate variable
5
+ ## getAgEditableRendererTemplate() function
6
6
 
7
7
  Get a Design System prefixed Checkbox template.
8
8
 
@@ -11,3 +11,16 @@ Get a Design System prefixed Checkbox template.
11
11
  ```typescript
12
12
  getAgEditableRendererTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<EditableRenderer, 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;[EditableRenderer](./grid-pro.editablerenderer.md)<!-- -->, any&gt;
24
+
25
+ A Checkbox component template prefixed with the correct design system.
26
+
@@ -0,0 +1,33 @@
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
+
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getDateEditorTemplate](./grid-pro.getdateeditortemplate.md)
4
4
 
5
- ## getDateEditorTemplate variable
5
+ ## getDateEditorTemplate() function
6
6
 
7
7
  Get a Design System prefixed Select template.
8
8
 
@@ -11,3 +11,16 @@ Get a Design System prefixed Select template.
11
11
  ```typescript
12
12
  getDateEditorTemplate: (prefix?: string) => import("@microsoft/fast-element").ViewTemplate<DateEditor, any>
13
13
  ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | prefix | string | _(Optional)_ The design system prefix to use. Defaults to 'foundation'. |
20
+
21
+ **Returns:**
22
+
23
+ import("@microsoft/fast-element").ViewTemplate&lt;[DateEditor](./grid-pro.dateeditor.md)<!-- -->, any&gt;
24
+
25
+ A Select component template prefixed with the correct design system.
26
+