@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.
- package/dist/custom-elements.json +691 -23
- package/dist/dts/cell-editors/date.editor.d.ts +5 -0
- package/dist/dts/cell-editors/date.editor.d.ts.map +1 -1
- package/dist/dts/cell-editors/index.d.ts +1 -0
- package/dist/dts/cell-editors/index.d.ts.map +1 -1
- package/dist/dts/cell-editors/multiselect.editor.d.ts +1 -0
- package/dist/dts/cell-editors/multiselect.editor.d.ts.map +1 -1
- package/dist/dts/cell-editors/number.editor.d.ts +2 -0
- package/dist/dts/cell-editors/number.editor.d.ts.map +1 -1
- package/dist/dts/cell-editors/select.editor.d.ts +2 -1
- package/dist/dts/cell-editors/select.editor.d.ts.map +1 -1
- package/dist/dts/cell-editors/string.editor.d.ts +56 -0
- package/dist/dts/cell-editors/string.editor.d.ts.map +1 -0
- package/dist/dts/cell-renderers/action.renderer.d.ts.map +1 -1
- package/dist/dts/cell-renderers/boolean.renderer.d.ts +1 -0
- package/dist/dts/cell-renderers/boolean.renderer.d.ts.map +1 -1
- package/dist/dts/cell-renderers/editable.renderer.d.ts +42 -0
- package/dist/dts/cell-renderers/editable.renderer.d.ts.map +1 -0
- package/dist/dts/cell-renderers/index.d.ts +1 -0
- package/dist/dts/cell-renderers/index.d.ts.map +1 -1
- package/dist/dts/grid-components.d.ts +18 -0
- package/dist/dts/grid-components.d.ts.map +1 -1
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
- package/dist/dts/grid-pro.d.ts +0 -6
- package/dist/dts/grid-pro.d.ts.map +1 -1
- package/dist/dts/grid-pro.types.d.ts +12 -0
- package/dist/dts/grid-pro.types.d.ts.map +1 -1
- package/dist/dts/index.d.ts +1 -0
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/tooltips/error-tooltip.d.ts +11 -0
- package/dist/dts/tooltips/error-tooltip.d.ts.map +1 -0
- package/dist/dts/tooltips/index.d.ts +2 -0
- package/dist/dts/tooltips/index.d.ts.map +1 -0
- package/dist/esm/cell-editors/date.editor.js +15 -2
- package/dist/esm/cell-editors/index.js +1 -0
- package/dist/esm/cell-editors/multiselect.editor.js +5 -10
- package/dist/esm/cell-editors/number.editor.js +9 -1
- package/dist/esm/cell-editors/select.editor.js +10 -12
- package/dist/esm/cell-editors/string.editor.js +86 -0
- package/dist/esm/cell-renderers/action.renderer.js +6 -0
- package/dist/esm/cell-renderers/boolean.renderer.js +4 -0
- package/dist/esm/cell-renderers/editable.renderer.js +60 -0
- package/dist/esm/cell-renderers/index.js +1 -0
- package/dist/esm/grid-components.js +4 -2
- package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +3 -0
- package/dist/esm/grid-pro.js +31 -3
- package/dist/esm/grid-pro.types.js +12 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/tooltips/error-tooltip.js +21 -0
- package/dist/esm/tooltips/index.js +1 -0
- package/dist/grid-pro.api.json +2314 -670
- package/dist/grid-pro.d.ts +156 -7
- package/docs/api/grid-pro.ageditablerendererstyles.md +13 -0
- package/docs/api/grid-pro.agstringeditorstyles.md +13 -0
- package/docs/api/grid-pro.booleanrenderer.iscancelbeforestart.md +15 -0
- package/docs/api/grid-pro.booleanrenderer.md +1 -0
- package/docs/api/grid-pro.dateeditor.actualwidth.md +11 -0
- package/docs/api/grid-pro.dateeditor.afterguiattached.md +15 -0
- package/docs/api/grid-pro.dateeditor.input.md +11 -0
- package/docs/api/grid-pro.dateeditor.iscancelbeforestart.md +15 -0
- package/docs/api/grid-pro.dateeditor.md +5 -0
- package/docs/api/grid-pro.dateeditor.params.md +11 -0
- package/docs/api/grid-pro.editablerenderer.getgui.md +15 -0
- package/docs/api/grid-pro.editablerenderer.init.md +22 -0
- package/docs/api/grid-pro.editablerenderer.md +31 -0
- package/docs/api/grid-pro.editablerenderer.refresh.md +22 -0
- package/docs/api/grid-pro.editablerenderer.valueformatted.md +11 -0
- package/docs/api/grid-pro.edited_column_field.md +13 -0
- package/docs/api/grid-pro.error_column_field.md +13 -0
- package/docs/api/grid-pro.foundationageditablerenderer.md +26 -0
- package/docs/api/grid-pro.foundationgridcomponents.md +18 -0
- package/docs/api/grid-pro.foundationstringeditor.md +24 -0
- package/docs/api/grid-pro.getageditablerenderertemplate.md +13 -0
- package/docs/api/grid-pro.getstringeditortemplate.md +13 -0
- package/docs/api/grid-pro.gridprorenderertypes.md +2 -0
- package/docs/api/grid-pro.md +11 -0
- package/docs/api/grid-pro.multiselecteditor.iscancelbeforestart.md +15 -0
- package/docs/api/grid-pro.multiselecteditor.md +1 -0
- package/docs/api/grid-pro.numbereditor.actualwidth.md +11 -0
- package/docs/api/grid-pro.numbereditor.iscancelbeforestart.md +15 -0
- package/docs/api/grid-pro.numbereditor.md +2 -0
- package/docs/api/grid-pro.selecteditor.actualwidth.md +11 -0
- package/docs/api/grid-pro.selecteditor.iscancelbeforestart.md +15 -0
- package/docs/api/grid-pro.selecteditor.md +2 -1
- package/docs/api/grid-pro.stringeditor.actualwidth.md +11 -0
- package/docs/api/grid-pro.stringeditor.afterguiattached.md +15 -0
- package/docs/api/grid-pro.stringeditor.changehandler.md +22 -0
- package/docs/api/grid-pro.stringeditor.getgui.md +15 -0
- package/docs/api/grid-pro.stringeditor.getvalue.md +15 -0
- package/docs/api/grid-pro.stringeditor.init.md +22 -0
- package/docs/api/grid-pro.stringeditor.input.md +11 -0
- package/docs/api/grid-pro.stringeditor.iscancelbeforestart.md +15 -0
- package/docs/api/{grid-pro.selecteditor.destroy.md → grid-pro.stringeditor.ispopup.md} +4 -4
- package/docs/api/grid-pro.stringeditor.md +39 -0
- package/docs/api/grid-pro.stringeditor.params.md +11 -0
- package/docs/api/grid-pro.stringeditor.refresh.md +22 -0
- package/docs/api/grid-pro.stringeditor.value.md +11 -0
- package/docs/api/grid-pro.stringeditorparams.md +21 -0
- package/docs/api/grid-pro.stringeditorparams.placeholder.md +11 -0
- package/docs/api-report.md +142 -2
- 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) > [@genesislcap/grid-pro](./grid-pro.md) > [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: <<!-- -->foundation-string-editor<!-- -->>
|
|
24
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [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>"actionsMenu"</code> | |
|
|
21
21
|
| boolean | <code>"boolean"</code> | |
|
|
22
22
|
| dateEditor | <code>"dateEditor"</code> | |
|
|
23
|
+
| editable | <code>"editable"</code> | |
|
|
23
24
|
| multiselectEditor | <code>"multiselectEditor"</code> | |
|
|
24
25
|
| numberEditor | <code>"numberEditor"</code> | |
|
|
25
26
|
| select | <code>"select"</code> | |
|
|
26
27
|
| selectEditor | <code>"selectEditor"</code> | |
|
|
28
|
+
| stringEditor | <code>"stringEditor"</code> | |
|
|
27
29
|
| text | <code>"text"</code> | |
|
|
28
30
|
|
package/docs/api/grid-pro.md
CHANGED
|
@@ -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) > [@genesislcap/grid-pro](./grid-pro.md) > [MultiselectEditor](./grid-pro.multiselecteditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [NumberEditor](./grid-pro.numbereditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [NumberEditor](./grid-pro.numbereditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [SelectEditor](./grid-pro.selecteditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [SelectEditor](./grid-pro.selecteditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditor](./grid-pro.stringeditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditor](./grid-pro.stringeditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditor](./grid-pro.stringeditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditor](./grid-pro.stringeditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditor](./grid-pro.stringeditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditor](./grid-pro.stringeditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditor](./grid-pro.stringeditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditor](./grid-pro.stringeditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditor](./grid-pro.stringeditor.md) > [isPopup](./grid-pro.stringeditor.ispopup.md)
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## StringEditor.isPopup() method
|
|
6
6
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
|
|
10
|
+
isPopup(): boolean;
|
|
11
11
|
```
|
|
12
12
|
**Returns:**
|
|
13
13
|
|
|
14
|
-
|
|
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) > [@genesislcap/grid-pro](./grid-pro.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditor](./grid-pro.stringeditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditor](./grid-pro.stringeditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditor](./grid-pro.stringeditor.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [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) > [@genesislcap/grid-pro](./grid-pro.md) > [StringEditorParams](./grid-pro.stringeditorparams.md) > [placeholder](./grid-pro.stringeditorparams.placeholder.md)
|
|
4
|
+
|
|
5
|
+
## StringEditorParams.placeholder property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
placeholder: string;
|
|
11
|
+
```
|