@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) > [agThemeFontsId](./grid-pro.agthemefontsid.md)
4
4
 
5
- ## agThemeFontsId() function
5
+ ## agThemeFontsId variable
6
6
 
7
7
  Generates the id name for custom Grid Pro fonts.
8
8
 
@@ -12,18 +12,6 @@ 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
-
27
15
  ## Example
28
16
 
29
17
  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() function
5
+ ## agThemeTokenMapClassname variable
6
6
 
7
7
  Generates the class name for a given Grid Pro theme name.
8
8
 
@@ -12,18 +12,6 @@ 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
-
27
15
  ## Example
28
16
 
29
17
  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() function
5
+ ## agThemeTokenMapCSS variable
6
6
 
7
7
  Generates the CSS for a given GridPro theme name and token map
8
8
 
@@ -12,19 +12,6 @@ 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
-
28
15
  ## Example
29
16
 
30
17
 
@@ -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() function
5
+ ## convertToKebabCase variable
6
6
 
7
7
  Convert string values from 'camelCase' to 'kebab-case'
8
8
 
@@ -11,16 +11,3 @@ 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
-
@@ -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() function
5
+ ## foundationAgBooleanRenderer variable
6
6
 
7
7
  A function that returns a Foundation Boolean Renderer registration for configuring the component with a DesignSystem.
8
8
 
@@ -20,16 +20,6 @@ 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
-
33
23
  ## Remarks
34
24
 
35
25
  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() function
5
+ ## foundationAgEditableRenderer variable
6
6
 
7
7
  A function that returns a Foundation Editable Renderer registration for configuring the component with a DesignSystem.
8
8
 
@@ -20,16 +20,6 @@ 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
-
33
23
  ## Remarks
34
24
 
35
25
  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() function
5
+ ## foundationAgSelectRenderer variable
6
6
 
7
7
  A function that returns a Foundation Select Renderer registration for configuring the component with a DesignSystem.
8
8
 
@@ -20,16 +20,6 @@ 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
-
33
23
  ## Remarks
34
24
 
35
25
  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() function
5
+ ## foundationAgTextFieldRenderer variable
6
6
 
7
7
  A function that returns a Foundation Text Field Renderer registration for configuring the component with a DesignSystem.
8
8
 
@@ -20,16 +20,6 @@ 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
-
33
23
  ## Remarks
34
24
 
35
25
  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() function
5
+ ## foundationAgTextRenderer variable
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
@@ -25,16 +25,6 @@ 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
-
38
28
  ## Remarks
39
29
 
40
30
  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() function
5
+ ## foundationDateEditor variable
6
6
 
7
7
  **Signature:**
8
8
 
@@ -18,16 +18,6 @@ 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
-
31
21
  ## Remarks
32
22
 
33
23
  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() function
5
+ ## foundationGridPro variable
6
6
 
7
7
  A function that returns a Foundation Grid Pro registration for configuring the component with a DesignSystem.
8
8
 
@@ -22,16 +22,6 @@ 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
-
35
25
  ## Remarks
36
26
 
37
27
  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() function
5
+ ## foundationGridProActionRenderer variable
6
6
 
7
7
  A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem.
8
8
 
@@ -20,16 +20,6 @@ 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
-
33
23
  ## Remarks
34
24
 
35
25
  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() function
5
+ ## foundationGridProActionsMenuRenderer variable
6
6
 
7
7
  A function that returns a Foundation Actions Menu for configuring the component with a DesignSystem.
8
8
 
@@ -18,16 +18,6 @@ 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
-
31
21
  ## Remarks
32
22
 
33
23
  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() function
5
+ ## foundationMultiselectEditor variable
6
6
 
7
7
  **Signature:**
8
8
 
@@ -18,16 +18,6 @@ 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
-
31
21
  ## Remarks
32
22
 
33
23
  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() function
5
+ ## foundationNumberEditor variable
6
6
 
7
7
  **Signature:**
8
8
 
@@ -18,16 +18,6 @@ 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
-
31
21
  ## Remarks
32
22
 
33
23
  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() function
5
+ ## foundationSelectEditor variable
6
6
 
7
7
  **Signature:**
8
8
 
@@ -18,16 +18,6 @@ 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
-
31
21
  ## Remarks
32
22
 
33
23
  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() function
5
+ ## foundationStringEditor variable
6
6
 
7
7
  **Signature:**
8
8
 
@@ -18,16 +18,6 @@ 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
-
31
21
  ## Remarks
32
22
 
33
23
  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() function
5
+ ## getActionsMenuDef variable
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,22 +12,6 @@ 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
-
31
15
  ## Example
32
16
 
33
17
 
@@ -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() function
5
+ ## getAgBooleanRendererTemplate variable
6
6
 
7
7
  Get a Design System prefixed Checkbox template.
8
8
 
@@ -11,16 +11,3 @@ 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() function
5
+ ## getAgEditableRendererTemplate variable
6
6
 
7
7
  Get a Design System prefixed Checkbox template.
8
8
 
@@ -11,16 +11,3 @@ 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
-
@@ -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() function
5
+ ## getDateEditorTemplate 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
  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
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getGridProTemplate](./grid-pro.getgridprotemplate.md)
4
4
 
5
- ## getGridProTemplate() function
5
+ ## getGridProTemplate variable
6
6
 
7
7
  Get a Design System prefixed The Grid Pro template.
8
8
 
@@ -11,16 +11,3 @@ Get a Design System prefixed The Grid Pro template.
11
11
  ```typescript
12
12
  getGridProTemplate: (prefix?: string) => ViewTemplate<GridPro, 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
- ViewTemplate&lt;[GridPro](./grid-pro.gridpro.md)<!-- -->, any&gt;
24
-
25
- A grid Pro 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; [getMultiselectEditorTemplate](./grid-pro.getmultiselecteditortemplate.md)
4
4
 
5
- ## getMultiselectEditorTemplate() function
5
+ ## getMultiselectEditorTemplate 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
  getMultiselectEditorTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<MultiselectEditor, 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;[MultiselectEditor](./grid-pro.multiselecteditor.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; [getNumberEditorTemplate](./grid-pro.getnumbereditortemplate.md)
4
4
 
5
- ## getNumberEditorTemplate() function
5
+ ## getNumberEditorTemplate 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
  getNumberEditorTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<NumberEditor, 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;[NumberEditor](./grid-pro.numbereditor.md)<!-- -->, any&gt;
24
-
25
- A Select component template prefixed with the correct design system.
26
-