@genesislcap/grid-pro 14.107.1 → 14.109.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 (101) hide show
  1. package/dist/custom-elements.json +691 -23
  2. package/dist/dts/cell-editors/date.editor.d.ts +5 -0
  3. package/dist/dts/cell-editors/date.editor.d.ts.map +1 -1
  4. package/dist/dts/cell-editors/index.d.ts +1 -0
  5. package/dist/dts/cell-editors/index.d.ts.map +1 -1
  6. package/dist/dts/cell-editors/multiselect.editor.d.ts +1 -0
  7. package/dist/dts/cell-editors/multiselect.editor.d.ts.map +1 -1
  8. package/dist/dts/cell-editors/number.editor.d.ts +2 -0
  9. package/dist/dts/cell-editors/number.editor.d.ts.map +1 -1
  10. package/dist/dts/cell-editors/select.editor.d.ts +2 -1
  11. package/dist/dts/cell-editors/select.editor.d.ts.map +1 -1
  12. package/dist/dts/cell-editors/string.editor.d.ts +56 -0
  13. package/dist/dts/cell-editors/string.editor.d.ts.map +1 -0
  14. package/dist/dts/cell-renderers/action.renderer.d.ts.map +1 -1
  15. package/dist/dts/cell-renderers/boolean.renderer.d.ts +1 -0
  16. package/dist/dts/cell-renderers/boolean.renderer.d.ts.map +1 -1
  17. package/dist/dts/cell-renderers/editable.renderer.d.ts +42 -0
  18. package/dist/dts/cell-renderers/editable.renderer.d.ts.map +1 -0
  19. package/dist/dts/cell-renderers/index.d.ts +1 -0
  20. package/dist/dts/cell-renderers/index.d.ts.map +1 -1
  21. package/dist/dts/grid-components.d.ts +18 -0
  22. package/dist/dts/grid-components.d.ts.map +1 -1
  23. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
  24. package/dist/dts/grid-pro.d.ts +0 -6
  25. package/dist/dts/grid-pro.d.ts.map +1 -1
  26. package/dist/dts/grid-pro.types.d.ts +12 -0
  27. package/dist/dts/grid-pro.types.d.ts.map +1 -1
  28. package/dist/dts/index.d.ts +1 -0
  29. package/dist/dts/index.d.ts.map +1 -1
  30. package/dist/dts/tooltips/error-tooltip.d.ts +11 -0
  31. package/dist/dts/tooltips/error-tooltip.d.ts.map +1 -0
  32. package/dist/dts/tooltips/index.d.ts +2 -0
  33. package/dist/dts/tooltips/index.d.ts.map +1 -0
  34. package/dist/esm/cell-editors/date.editor.js +15 -2
  35. package/dist/esm/cell-editors/index.js +1 -0
  36. package/dist/esm/cell-editors/multiselect.editor.js +5 -10
  37. package/dist/esm/cell-editors/number.editor.js +9 -1
  38. package/dist/esm/cell-editors/select.editor.js +10 -12
  39. package/dist/esm/cell-editors/string.editor.js +86 -0
  40. package/dist/esm/cell-renderers/action.renderer.js +6 -0
  41. package/dist/esm/cell-renderers/boolean.renderer.js +4 -0
  42. package/dist/esm/cell-renderers/editable.renderer.js +60 -0
  43. package/dist/esm/cell-renderers/index.js +1 -0
  44. package/dist/esm/grid-components.js +4 -2
  45. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +3 -0
  46. package/dist/esm/grid-pro.js +31 -3
  47. package/dist/esm/grid-pro.types.js +12 -0
  48. package/dist/esm/index.js +1 -0
  49. package/dist/esm/tooltips/error-tooltip.js +21 -0
  50. package/dist/esm/tooltips/index.js +1 -0
  51. package/dist/grid-pro.api.json +2314 -670
  52. package/dist/grid-pro.d.ts +156 -7
  53. package/docs/api/grid-pro.ageditablerendererstyles.md +13 -0
  54. package/docs/api/grid-pro.agstringeditorstyles.md +13 -0
  55. package/docs/api/grid-pro.booleanrenderer.iscancelbeforestart.md +15 -0
  56. package/docs/api/grid-pro.booleanrenderer.md +1 -0
  57. package/docs/api/grid-pro.dateeditor.actualwidth.md +11 -0
  58. package/docs/api/grid-pro.dateeditor.afterguiattached.md +15 -0
  59. package/docs/api/grid-pro.dateeditor.input.md +11 -0
  60. package/docs/api/grid-pro.dateeditor.iscancelbeforestart.md +15 -0
  61. package/docs/api/grid-pro.dateeditor.md +5 -0
  62. package/docs/api/grid-pro.dateeditor.params.md +11 -0
  63. package/docs/api/grid-pro.editablerenderer.getgui.md +15 -0
  64. package/docs/api/grid-pro.editablerenderer.init.md +22 -0
  65. package/docs/api/grid-pro.editablerenderer.md +31 -0
  66. package/docs/api/grid-pro.editablerenderer.refresh.md +22 -0
  67. package/docs/api/grid-pro.editablerenderer.valueformatted.md +11 -0
  68. package/docs/api/grid-pro.edited_column_field.md +13 -0
  69. package/docs/api/grid-pro.error_column_field.md +13 -0
  70. package/docs/api/grid-pro.foundationageditablerenderer.md +26 -0
  71. package/docs/api/grid-pro.foundationgridcomponents.md +18 -0
  72. package/docs/api/grid-pro.foundationstringeditor.md +24 -0
  73. package/docs/api/grid-pro.getageditablerenderertemplate.md +13 -0
  74. package/docs/api/grid-pro.getstringeditortemplate.md +13 -0
  75. package/docs/api/grid-pro.gridprorenderertypes.md +2 -0
  76. package/docs/api/grid-pro.md +11 -0
  77. package/docs/api/grid-pro.multiselecteditor.iscancelbeforestart.md +15 -0
  78. package/docs/api/grid-pro.multiselecteditor.md +1 -0
  79. package/docs/api/grid-pro.numbereditor.actualwidth.md +11 -0
  80. package/docs/api/grid-pro.numbereditor.iscancelbeforestart.md +15 -0
  81. package/docs/api/grid-pro.numbereditor.md +2 -0
  82. package/docs/api/grid-pro.selecteditor.actualwidth.md +11 -0
  83. package/docs/api/grid-pro.selecteditor.iscancelbeforestart.md +15 -0
  84. package/docs/api/grid-pro.selecteditor.md +2 -1
  85. package/docs/api/grid-pro.stringeditor.actualwidth.md +11 -0
  86. package/docs/api/grid-pro.stringeditor.afterguiattached.md +15 -0
  87. package/docs/api/grid-pro.stringeditor.changehandler.md +22 -0
  88. package/docs/api/grid-pro.stringeditor.getgui.md +15 -0
  89. package/docs/api/grid-pro.stringeditor.getvalue.md +15 -0
  90. package/docs/api/grid-pro.stringeditor.init.md +22 -0
  91. package/docs/api/grid-pro.stringeditor.input.md +11 -0
  92. package/docs/api/grid-pro.stringeditor.iscancelbeforestart.md +15 -0
  93. package/docs/api/{grid-pro.selecteditor.destroy.md → grid-pro.stringeditor.ispopup.md} +4 -4
  94. package/docs/api/grid-pro.stringeditor.md +39 -0
  95. package/docs/api/grid-pro.stringeditor.params.md +11 -0
  96. package/docs/api/grid-pro.stringeditor.refresh.md +22 -0
  97. package/docs/api/grid-pro.stringeditor.value.md +11 -0
  98. package/docs/api/grid-pro.stringeditorparams.md +21 -0
  99. package/docs/api/grid-pro.stringeditorparams.placeholder.md +11 -0
  100. package/docs/api-report.md +142 -2
  101. package/package.json +8 -8
@@ -0,0 +1,24 @@
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; [foundationStringEditor](./grid-pro.foundationstringeditor.md)
4
+
5
+ ## foundationStringEditor variable
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ foundationStringEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
11
+ baseName: string;
12
+ styles: import("@microsoft/fast-element").ElementStyles;
13
+ template: import("@microsoft/fast-element").ViewTemplate<StringEditor, any>;
14
+ }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
15
+ baseName: string;
16
+ styles: import("@microsoft/fast-element").ElementStyles;
17
+ template: import("@microsoft/fast-element").ViewTemplate<StringEditor, any>;
18
+ }, typeof StringEditor>
19
+ ```
20
+
21
+ ## Remarks
22
+
23
+ HTML Element: &lt;<!-- -->foundation-string-editor<!-- -->&gt;
24
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getAgEditableRendererTemplate](./grid-pro.getageditablerenderertemplate.md)
4
+
5
+ ## getAgEditableRendererTemplate variable
6
+
7
+ Get a Design System prefixed Checkbox template.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getAgEditableRendererTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<EditableRenderer, any>
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [getStringEditorTemplate](./grid-pro.getstringeditortemplate.md)
4
+
5
+ ## getStringEditorTemplate variable
6
+
7
+ Get a Design System prefixed String template.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getStringEditorTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<StringEditor, any>
13
+ ```
@@ -20,9 +20,11 @@ export declare enum GridProRendererTypes
20
20
  | actionsMenu | <code>&quot;actionsMenu&quot;</code> | |
21
21
  | boolean | <code>&quot;boolean&quot;</code> | |
22
22
  | dateEditor | <code>&quot;dateEditor&quot;</code> | |
23
+ | editable | <code>&quot;editable&quot;</code> | |
23
24
  | multiselectEditor | <code>&quot;multiselectEditor&quot;</code> | |
24
25
  | numberEditor | <code>&quot;numberEditor&quot;</code> | |
25
26
  | select | <code>&quot;select&quot;</code> | |
26
27
  | selectEditor | <code>&quot;selectEditor&quot;</code> | |
28
+ | stringEditor | <code>&quot;stringEditor&quot;</code> | |
27
29
  | text | <code>&quot;text&quot;</code> | |
28
30
 
@@ -14,6 +14,7 @@
14
14
  | [AgTextRenderer](./grid-pro.agtextrenderer.md) | |
15
15
  | [BooleanRenderer](./grid-pro.booleanrenderer.md) | The AG Boolean Renderer element. |
16
16
  | [DateEditor](./grid-pro.dateeditor.md) | The AG Date Editor element. |
17
+ | [EditableRenderer](./grid-pro.editablerenderer.md) | The AG Editable Renderer element. |
17
18
  | [GridPro](./grid-pro.gridpro.md) | The Grid Pro element. |
18
19
  | [GridProCell](./grid-pro.gridprocell.md) | The Grid Pro Cell element. |
19
20
  | [GridProClientSideDatasource](./grid-pro.gridproclientsidedatasource.md) | The Genesis Datasource element, for client-side \| CSRM-compatible data fetching and used exclusively by the GridPro element. |
@@ -23,6 +24,7 @@
23
24
  | [NumberEditor](./grid-pro.numbereditor.md) | The AG Number Editor element. |
24
25
  | [SelectEditor](./grid-pro.selecteditor.md) | The AG Select Editor element. |
25
26
  | [SelectRenderer](./grid-pro.selectrenderer.md) | The AG Select Renderer element. |
27
+ | [StringEditor](./grid-pro.stringeditor.md) | The AG String Editor element. |
26
28
 
27
29
  ## Enumerations
28
30
 
@@ -49,6 +51,7 @@
49
51
  | [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) | Parameters used to configure [MultiselectEditor](./grid-pro.multiselecteditor.md) |
50
52
  | [NumberEditorParams](./grid-pro.numbereditorparams.md) | Parameters used to configure [NumberEditor](./grid-pro.numbereditor.md) |
51
53
  | [SelectEditorParams](./grid-pro.selecteditorparams.md) | Parameters used to configure [SelectEditor](./grid-pro.selecteditor.md) |
54
+ | [StringEditorParams](./grid-pro.stringeditorparams.md) | Parameters used to configure [StringEditor](./grid-pro.stringeditor.md) |
52
55
 
53
56
  ## Variables
54
57
 
@@ -58,6 +61,7 @@
58
61
  | [agActionRendererStyles](./grid-pro.agactionrendererstyles.md) | The AG Action Renderer Styles. |
59
62
  | [agBooleanRendererStyles](./grid-pro.agbooleanrendererstyles.md) | The AG Boolean Renderer Styles. |
60
63
  | [agDateEditorStyles](./grid-pro.agdateeditorstyles.md) | The AG Select Renderer Styles. |
64
+ | [agEditableRendererStyles](./grid-pro.ageditablerendererstyles.md) | The AG Editable Renderer Styles. |
61
65
  | [agExternalStockStyles](./grid-pro.agexternalstockstyles.md) | All External AG Grid Stock in one CSS. |
62
66
  | [agGridAlpineFontFace](./grid-pro.aggridalpinefontface.md) | The AG Alpine font face used on ag-theme-alpine/ag-theme-alpine-dark Grid Pro themes. |
63
67
  | [agGridBalhamFontFace](./grid-pro.aggridbalhamfontface.md) | The AG Balham font face used on ag-theme-balham/ag-theme-balham-dark Grid Pro themes. |
@@ -68,6 +72,7 @@
68
72
  | [agNumberEditorStyles](./grid-pro.agnumbereditorstyles.md) | The AG Number Editor Styles. |
69
73
  | [agSelectEditorStyles](./grid-pro.agselecteditorstyles.md) | The AG Select Renderer Styles. |
70
74
  | [agSelectRendererStyles](./grid-pro.agselectrendererstyles.md) | The AG Select Renderer Styles. |
75
+ | [agStringEditorStyles](./grid-pro.agstringeditorstyles.md) | The AG String Renderer Styles. |
71
76
  | [agThemeAlpineNofontsCSS](./grid-pro.agthemealpinenofontscss.md) | AG Alpine Theme (no fonts) CSS. |
72
77
  | [agThemeBalhamNofontsCSS](./grid-pro.agthemebalhamnofontscss.md) | AG Balham Theme (no fonts) CSS. |
73
78
  | [agThemeFontFaceMap](./grid-pro.agthemefontfacemap.md) | Font Face map with all the font faces for each theme. |
@@ -80,7 +85,10 @@
80
85
  | [convertToKebabCase](./grid-pro.converttokebabcase.md) | Convert string values from 'camelCase' to 'kebab-case' |
81
86
  | [defaultAgGridFontFace](./grid-pro.defaultaggridfontface.md) | The default font face for Grid Pro (agGridAlpine). |
82
87
  | [defaultGridProConfig](./grid-pro.defaultgridproconfig.md) | Grid Pro default configuration. |
88
+ | [EDITED\_COLUMN\_FIELD](./grid-pro.edited_column_field.md) | Key used to store currently edited column when it being synced with server side data |
89
+ | [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 |
83
90
  | [foundationAgBooleanRenderer](./grid-pro.foundationagbooleanrenderer.md) | A function that returns a Foundation Boolean Renderer registration for configuring the component with a DesignSystem. |
91
+ | [foundationAgEditableRenderer](./grid-pro.foundationageditablerenderer.md) | A function that returns a Foundation Editable Renderer registration for configuring the component with a DesignSystem. |
84
92
  | [foundationAgSelectRenderer](./grid-pro.foundationagselectrenderer.md) | A function that returns a Foundation Select Renderer registration for configuring the component with a DesignSystem. |
85
93
  | [foundationAgTextFieldRenderer](./grid-pro.foundationagtextfieldrenderer.md) | A function that returns a Foundation Text Field Renderer registration for configuring the component with a DesignSystem. |
86
94
  | [foundationAgTextRenderer](./grid-pro.foundationagtextrenderer.md) | A function that returns a Foundation Text Renderer registration for configuring the component with a DesignSystem. |
@@ -94,13 +102,16 @@
94
102
  | [foundationMultiselectEditor](./grid-pro.foundationmultiselecteditor.md) | |
95
103
  | [foundationNumberEditor](./grid-pro.foundationnumbereditor.md) | |
96
104
  | [foundationSelectEditor](./grid-pro.foundationselecteditor.md) | |
105
+ | [foundationStringEditor](./grid-pro.foundationstringeditor.md) | |
97
106
  | [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). |
98
107
  | [getAgBooleanRendererTemplate](./grid-pro.getagbooleanrenderertemplate.md) | Get a Design System prefixed Checkbox template. |
108
+ | [getAgEditableRendererTemplate](./grid-pro.getageditablerenderertemplate.md) | Get a Design System prefixed Checkbox template. |
99
109
  | [getDateEditorTemplate](./grid-pro.getdateeditortemplate.md) | Get a Design System prefixed Select template. |
100
110
  | [getMultiselectEditorTemplate](./grid-pro.getmultiselecteditortemplate.md) | Get a Design System prefixed Select template. |
101
111
  | [getNumberEditorTemplate](./grid-pro.getnumbereditortemplate.md) | Get a Design System prefixed Select template. |
102
112
  | [getSelectEditorTemplate](./grid-pro.getselecteditortemplate.md) | Get a Design System prefixed Select template. |
103
113
  | [getSelectRendererTemplate](./grid-pro.getselectrenderertemplate.md) | Get a Design System prefixed Select template. |
114
+ | [getStringEditorTemplate](./grid-pro.getstringeditortemplate.md) | Get a Design System prefixed String template. |
104
115
  | [getTextFieldRendererTemplate](./grid-pro.gettextfieldrenderertemplate.md) | Get a Design System prefixed Text Field template. |
105
116
  | [getTextRendererTemplate](./grid-pro.gettextrenderertemplate.md) | |
106
117
  | [GRID\_READY\_EVENT](./grid-pro.grid_ready_event.md) | Event fired when grid is ready |
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [MultiselectEditor](./grid-pro.multiselecteditor.md) &gt; [isCancelBeforeStart](./grid-pro.multiselecteditor.iscancelbeforestart.md)
4
+
5
+ ## MultiselectEditor.isCancelBeforeStart() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ isCancelBeforeStart(): boolean;
11
+ ```
12
+ **Returns:**
13
+
14
+ boolean
15
+
@@ -31,6 +31,7 @@ export declare class MultiselectEditor extends FoundationElement implements ICel
31
31
  | [getGui()](./grid-pro.multiselecteditor.getgui.md) | | |
32
32
  | [getValue()](./grid-pro.multiselecteditor.getvalue.md) | | |
33
33
  | [init(params)](./grid-pro.multiselecteditor.init.md) | | |
34
+ | [isCancelBeforeStart()](./grid-pro.multiselecteditor.iscancelbeforestart.md) | | |
34
35
  | [isPopup()](./grid-pro.multiselecteditor.ispopup.md) | | |
35
36
  | [refresh(params)](./grid-pro.multiselecteditor.refresh.md) | | |
36
37
 
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [NumberEditor](./grid-pro.numbereditor.md) &gt; [actualWidth](./grid-pro.numbereditor.actualwidth.md)
4
+
5
+ ## NumberEditor.actualWidth property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ actualWidth: number;
11
+ ```
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [NumberEditor](./grid-pro.numbereditor.md) &gt; [isCancelBeforeStart](./grid-pro.numbereditor.iscancelbeforestart.md)
4
+
5
+ ## NumberEditor.isCancelBeforeStart() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ isCancelBeforeStart(): boolean;
11
+ ```
12
+ **Returns:**
13
+
14
+ boolean
15
+
@@ -19,6 +19,7 @@ export declare class NumberEditor extends FoundationElement implements ICellEdit
19
19
 
20
20
  | Property | Modifiers | Type | Description |
21
21
  | --- | --- | --- | --- |
22
+ | [actualWidth](./grid-pro.numbereditor.actualwidth.md) | | number | |
22
23
  | [input](./grid-pro.numbereditor.input.md) | | any | |
23
24
  | [params](./grid-pro.numbereditor.params.md) | | [NumberEditorParams](./grid-pro.numbereditorparams.md) | |
24
25
  | [value](./grid-pro.numbereditor.value.md) | | number | |
@@ -32,6 +33,7 @@ export declare class NumberEditor extends FoundationElement implements ICellEdit
32
33
  | [getGui()](./grid-pro.numbereditor.getgui.md) | | |
33
34
  | [getValue()](./grid-pro.numbereditor.getvalue.md) | | |
34
35
  | [init(params)](./grid-pro.numbereditor.init.md) | | |
36
+ | [isCancelBeforeStart()](./grid-pro.numbereditor.iscancelbeforestart.md) | | |
35
37
  | [isPopup()](./grid-pro.numbereditor.ispopup.md) | | |
36
38
  | [refresh(params)](./grid-pro.numbereditor.refresh.md) | | |
37
39
 
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SelectEditor](./grid-pro.selecteditor.md) &gt; [actualWidth](./grid-pro.selecteditor.actualwidth.md)
4
+
5
+ ## SelectEditor.actualWidth property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ actualWidth: number;
11
+ ```
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SelectEditor](./grid-pro.selecteditor.md) &gt; [isCancelBeforeStart](./grid-pro.selecteditor.iscancelbeforestart.md)
4
+
5
+ ## SelectEditor.isCancelBeforeStart() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ isCancelBeforeStart(): boolean;
11
+ ```
12
+ **Returns:**
13
+
14
+ boolean
15
+
@@ -19,6 +19,7 @@ export declare class SelectEditor extends FoundationElement implements ICellEdit
19
19
 
20
20
  | Property | Modifiers | Type | Description |
21
21
  | --- | --- | --- | --- |
22
+ | [actualWidth](./grid-pro.selecteditor.actualwidth.md) | | number | |
22
23
  | [combobox](./grid-pro.selecteditor.combobox.md) | | any | |
23
24
  | [params](./grid-pro.selecteditor.params.md) | | [SelectEditorParams](./grid-pro.selecteditorparams.md) | |
24
25
  | [value](./grid-pro.selecteditor.value.md) | | string | |
@@ -29,10 +30,10 @@ export declare class SelectEditor extends FoundationElement implements ICellEdit
29
30
  | --- | --- | --- |
30
31
  | [afterGuiAttached()](./grid-pro.selecteditor.afterguiattached.md) | | |
31
32
  | [changeHandler(event)](./grid-pro.selecteditor.changehandler.md) | | |
32
- | [destroy()](./grid-pro.selecteditor.destroy.md) | | |
33
33
  | [getGui()](./grid-pro.selecteditor.getgui.md) | | |
34
34
  | [getValue()](./grid-pro.selecteditor.getvalue.md) | | |
35
35
  | [init(params)](./grid-pro.selecteditor.init.md) | | |
36
+ | [isCancelBeforeStart()](./grid-pro.selecteditor.iscancelbeforestart.md) | | |
36
37
  | [isPopup()](./grid-pro.selecteditor.ispopup.md) | | |
37
38
  | [refresh(params)](./grid-pro.selecteditor.refresh.md) | | |
38
39
 
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditor](./grid-pro.stringeditor.md) &gt; [actualWidth](./grid-pro.stringeditor.actualwidth.md)
4
+
5
+ ## StringEditor.actualWidth property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ actualWidth: number;
11
+ ```
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditor](./grid-pro.stringeditor.md) &gt; [afterGuiAttached](./grid-pro.stringeditor.afterguiattached.md)
4
+
5
+ ## StringEditor.afterGuiAttached() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ afterGuiAttached(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditor](./grid-pro.stringeditor.md) &gt; [changeHandler](./grid-pro.stringeditor.changehandler.md)
4
+
5
+ ## StringEditor.changeHandler() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ changeHandler(event: any): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | event | any | |
18
+
19
+ **Returns:**
20
+
21
+ void
22
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditor](./grid-pro.stringeditor.md) &gt; [getGui](./grid-pro.stringeditor.getgui.md)
4
+
5
+ ## StringEditor.getGui() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ getGui(): HTMLElement;
11
+ ```
12
+ **Returns:**
13
+
14
+ HTMLElement
15
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditor](./grid-pro.stringeditor.md) &gt; [getValue](./grid-pro.stringeditor.getvalue.md)
4
+
5
+ ## StringEditor.getValue() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ getValue(): string;
11
+ ```
12
+ **Returns:**
13
+
14
+ string
15
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditor](./grid-pro.stringeditor.md) &gt; [init](./grid-pro.stringeditor.init.md)
4
+
5
+ ## StringEditor.init() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ init(params: StringEditorParams): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | params | [StringEditorParams](./grid-pro.stringeditorparams.md) | |
18
+
19
+ **Returns:**
20
+
21
+ void
22
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditor](./grid-pro.stringeditor.md) &gt; [input](./grid-pro.stringeditor.input.md)
4
+
5
+ ## StringEditor.input property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ input: any;
11
+ ```
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditor](./grid-pro.stringeditor.md) &gt; [isCancelBeforeStart](./grid-pro.stringeditor.iscancelbeforestart.md)
4
+
5
+ ## StringEditor.isCancelBeforeStart() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ isCancelBeforeStart(): boolean;
11
+ ```
12
+ **Returns:**
13
+
14
+ boolean
15
+
@@ -1,15 +1,15 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SelectEditor](./grid-pro.selecteditor.md) &gt; [destroy](./grid-pro.selecteditor.destroy.md)
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditor](./grid-pro.stringeditor.md) &gt; [isPopup](./grid-pro.stringeditor.ispopup.md)
4
4
 
5
- ## SelectEditor.destroy() method
5
+ ## StringEditor.isPopup() method
6
6
 
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- destroy(): void;
10
+ isPopup(): boolean;
11
11
  ```
12
12
  **Returns:**
13
13
 
14
- void
14
+ boolean
15
15
 
@@ -0,0 +1,39 @@
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; [StringEditor](./grid-pro.stringeditor.md)
4
+
5
+ ## StringEditor class
6
+
7
+ The AG String Editor element.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare class StringEditor extends FoundationElement implements ICellEditorComp
13
+ ```
14
+ **Extends:** FoundationElement
15
+
16
+ **Implements:** ICellEditorComp
17
+
18
+ ## Properties
19
+
20
+ | Property | Modifiers | Type | Description |
21
+ | --- | --- | --- | --- |
22
+ | [actualWidth](./grid-pro.stringeditor.actualwidth.md) | | number | |
23
+ | [input](./grid-pro.stringeditor.input.md) | | any | |
24
+ | [params](./grid-pro.stringeditor.params.md) | | [StringEditorParams](./grid-pro.stringeditorparams.md) | |
25
+ | [value](./grid-pro.stringeditor.value.md) | | string | |
26
+
27
+ ## Methods
28
+
29
+ | Method | Modifiers | Description |
30
+ | --- | --- | --- |
31
+ | [afterGuiAttached()](./grid-pro.stringeditor.afterguiattached.md) | | |
32
+ | [changeHandler(event)](./grid-pro.stringeditor.changehandler.md) | | |
33
+ | [getGui()](./grid-pro.stringeditor.getgui.md) | | |
34
+ | [getValue()](./grid-pro.stringeditor.getvalue.md) | | |
35
+ | [init(params)](./grid-pro.stringeditor.init.md) | | |
36
+ | [isCancelBeforeStart()](./grid-pro.stringeditor.iscancelbeforestart.md) | | |
37
+ | [isPopup()](./grid-pro.stringeditor.ispopup.md) | | |
38
+ | [refresh(params)](./grid-pro.stringeditor.refresh.md) | | |
39
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditor](./grid-pro.stringeditor.md) &gt; [params](./grid-pro.stringeditor.params.md)
4
+
5
+ ## StringEditor.params property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ params: StringEditorParams;
11
+ ```
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditor](./grid-pro.stringeditor.md) &gt; [refresh](./grid-pro.stringeditor.refresh.md)
4
+
5
+ ## StringEditor.refresh() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ refresh(params: StringEditorParams): boolean;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | params | [StringEditorParams](./grid-pro.stringeditorparams.md) | |
18
+
19
+ **Returns:**
20
+
21
+ boolean
22
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditor](./grid-pro.stringeditor.md) &gt; [value](./grid-pro.stringeditor.value.md)
4
+
5
+ ## StringEditor.value property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ value: string;
11
+ ```
@@ -0,0 +1,21 @@
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; [StringEditorParams](./grid-pro.stringeditorparams.md)
4
+
5
+ ## StringEditorParams interface
6
+
7
+ Parameters used to configure [StringEditor](./grid-pro.stringeditor.md)
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface StringEditorParams extends ICellEditorParams
13
+ ```
14
+ **Extends:** ICellEditorParams
15
+
16
+ ## Properties
17
+
18
+ | Property | Modifiers | Type | Description |
19
+ | --- | --- | --- | --- |
20
+ | [placeholder](./grid-pro.stringeditorparams.placeholder.md) | | string | |
21
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StringEditorParams](./grid-pro.stringeditorparams.md) &gt; [placeholder](./grid-pro.stringeditorparams.placeholder.md)
4
+
5
+ ## StringEditorParams.placeholder property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ placeholder: string;
11
+ ```