@genesislcap/grid-pro 14.101.4 → 14.102.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 (48) hide show
  1. package/dist/custom-elements.json +571 -263
  2. package/dist/dts/cell-editors/index.d.ts +1 -0
  3. package/dist/dts/cell-editors/index.d.ts.map +1 -1
  4. package/dist/dts/cell-editors/number.editor.d.ts +59 -0
  5. package/dist/dts/cell-editors/number.editor.d.ts.map +1 -0
  6. package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
  7. package/dist/dts/grid-components.d.ts +10 -1
  8. package/dist/dts/grid-components.d.ts.map +1 -1
  9. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
  10. package/dist/dts/grid-pro.d.ts +3 -7
  11. package/dist/dts/grid-pro.d.ts.map +1 -1
  12. package/dist/dts/grid-pro.types.d.ts +2 -1
  13. package/dist/dts/grid-pro.types.d.ts.map +1 -1
  14. package/dist/esm/cell-editors/index.js +1 -0
  15. package/dist/esm/cell-editors/number.editor.js +86 -0
  16. package/dist/esm/datasource/server-side.datasource.js +3 -0
  17. package/dist/esm/grid-components.js +3 -2
  18. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +3 -0
  19. package/dist/esm/grid-pro.js +2 -1
  20. package/dist/esm/grid-pro.types.js +1 -0
  21. package/dist/grid-pro.api.json +887 -2
  22. package/dist/grid-pro.d.ts +77 -10
  23. package/docs/api/grid-pro.agnumbereditorstyles.md +13 -0
  24. package/docs/api/grid-pro.foundationgridcomponents.md +10 -1
  25. package/docs/api/grid-pro.foundationnumbereditor.md +24 -0
  26. package/docs/api/grid-pro.getnumbereditortemplate.md +13 -0
  27. package/docs/api/grid-pro.gridprorenderertypes.md +1 -0
  28. package/docs/api/grid-pro.md +5 -0
  29. package/docs/api/grid-pro.numbereditor.afterguiattached.md +15 -0
  30. package/docs/api/grid-pro.numbereditor.changehandler.md +22 -0
  31. package/docs/api/grid-pro.numbereditor.destroy.md +15 -0
  32. package/docs/api/grid-pro.numbereditor.focus.md +15 -0
  33. package/docs/api/grid-pro.numbereditor.getgui.md +15 -0
  34. package/docs/api/grid-pro.numbereditor.getvalue.md +15 -0
  35. package/docs/api/grid-pro.numbereditor.init.md +22 -0
  36. package/docs/api/grid-pro.numbereditor.input.md +11 -0
  37. package/docs/api/grid-pro.numbereditor.ispopup.md +15 -0
  38. package/docs/api/grid-pro.numbereditor.md +39 -0
  39. package/docs/api/grid-pro.numbereditor.params.md +11 -0
  40. package/docs/api/grid-pro.numbereditor.refresh.md +22 -0
  41. package/docs/api/grid-pro.numbereditor.value.md +11 -0
  42. package/docs/api/grid-pro.numbereditorparams.disabled.md +11 -0
  43. package/docs/api/grid-pro.numbereditorparams.formatoptions.md +11 -0
  44. package/docs/api/grid-pro.numbereditorparams.md +24 -0
  45. package/docs/api/grid-pro.numbereditorparams.placeholder.md +11 -0
  46. package/docs/api/grid-pro.numbereditorparams.withformatting.md +11 -0
  47. package/docs/api-report.md +69 -1
  48. package/package.json +8 -8
@@ -229,6 +229,12 @@ export declare enum AgGridTheme {
229
229
  */
230
230
  export declare const agHeadCSS: ElementStyles;
231
231
 
232
+ /**
233
+ * The AG Number Editor Styles.
234
+ * @public
235
+ */
236
+ export declare const agNumberEditorStyles: ElementStyles;
237
+
232
238
  /**
233
239
  * The AG Select Renderer Styles.
234
240
  * @public
@@ -596,7 +602,7 @@ export declare const foundationGridComponents: {
596
602
  styles: ElementStyles;
597
603
  template: ViewTemplate<any, any>;
598
604
  }, GridPro>;
599
- selectEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
605
+ foundationSelectEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
600
606
  baseName: string;
601
607
  styles: ElementStyles;
602
608
  template: ViewTemplate<SelectEditor, any>;
@@ -605,6 +611,15 @@ export declare const foundationGridComponents: {
605
611
  styles: ElementStyles;
606
612
  template: ViewTemplate<SelectEditor, any>;
607
613
  }, SelectEditor>;
614
+ foundationNumberEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
615
+ baseName: string;
616
+ styles: ElementStyles;
617
+ template: ViewTemplate<NumberEditor, any>;
618
+ }>) => FoundationElementRegistry< {
619
+ baseName: string;
620
+ styles: ElementStyles;
621
+ template: ViewTemplate<NumberEditor, any>;
622
+ }, NumberEditor>;
608
623
  register(container?: Container, ...rest: any[]): void;
609
624
  };
610
625
 
@@ -674,6 +689,22 @@ export declare const foundationGridProShadowOptions: ShadowRootInit;
674
689
  */
675
690
  export declare const foundationGridProStyles: ElementStyles;
676
691
 
692
+ /**
693
+ *
694
+ * @public
695
+ * @remarks
696
+ * HTML Element: \<foundation-number-editor\>
697
+ */
698
+ export declare const foundationNumberEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
699
+ baseName: string;
700
+ styles: ElementStyles;
701
+ template: ViewTemplate<NumberEditor, any>;
702
+ }>) => FoundationElementRegistry< {
703
+ baseName: string;
704
+ styles: ElementStyles;
705
+ template: ViewTemplate<NumberEditor, any>;
706
+ }, typeof NumberEditor>;
707
+
677
708
  /**
678
709
  *
679
710
  * @public
@@ -765,6 +796,14 @@ export declare function getFilterByFieldType(type: string): string;
765
796
  */
766
797
  export declare function getFilterParamsByFieldType(type: string): any;
767
798
 
799
+ /**
800
+ * Get a Design System prefixed Select template.
801
+ * @param designSystem - The design system prefix to use. Defaults to 'foundation'.
802
+ * @returns A Select component template prefixed with the correct design system.
803
+ * @public
804
+ */
805
+ export declare const getNumberEditorTemplate: (designSystem?: string) => ViewTemplate<NumberEditor, any>;
806
+
768
807
  /**
769
808
  * Get a Design System prefixed Select template.
770
809
  * @param designSystem - The design system prefix to use. Defaults to 'foundation'.
@@ -958,10 +997,7 @@ declare const GridPro_base: (new (...args: any[]) => {
958
997
  deepClone(): Node;
959
998
  readonly shouldRunDisconnect: boolean;
960
999
  readonly shouldRunConnect: boolean;
961
- "__#1@#_blockLifecycleDueToTokenChange"(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean; /**
962
- * If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef
963
- * @remarks Defaults to true
964
- */
1000
+ "__#1@#_blockLifecycleDueToTokenChange"(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
965
1001
  "__#1@#_tryFindContainingLayout"(e: Element): FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
966
1002
  connectedCallback(): void;
967
1003
  readonly $fastController: Controller;
@@ -1069,11 +1105,10 @@ declare const GridPro_base: (new (...args: any[]) => {
1069
1105
  readonly nextSibling: ChildNode;
1070
1106
  readonly nodeName: string;
1071
1107
  readonly nodeType: number;
1072
- /**
1073
- * @public
1074
- */
1075
1108
  nodeValue: string;
1076
- readonly parentElement: HTMLElement;
1109
+ readonly parentElement: HTMLElement; /**
1110
+ * @public
1111
+ */
1077
1112
  readonly parentNode: ParentNode;
1078
1113
  readonly previousSibling: ChildNode;
1079
1114
  textContent: string;
@@ -1811,7 +1846,8 @@ export declare enum GridProRendererTypes {
1811
1846
  boolean = "boolean",
1812
1847
  text = "text",
1813
1848
  select = "select",
1814
- selectEditor = "selectEditor"
1849
+ selectEditor = "selectEditor",
1850
+ numberEditor = "numberEditor"
1815
1851
  }
1816
1852
 
1817
1853
  /**
@@ -2196,6 +2232,37 @@ export declare const logger: Logger;
2196
2232
  */
2197
2233
  export declare function mergeAndDedupColDefWithColumnState(colDefs: ColDef[], columnStates: ColumnState[]): ColDef[];
2198
2234
 
2235
+ /**
2236
+ * The AG Number Editor element.
2237
+ * @public
2238
+ * @tagname %%prefix%%-number-editor
2239
+ */
2240
+ export declare class NumberEditor extends FoundationElement implements ICellEditorComp {
2241
+ params: NumberEditorParams;
2242
+ value: number;
2243
+ input: any;
2244
+ init(params: NumberEditorParams): void;
2245
+ getGui(): HTMLElement;
2246
+ focus(): void;
2247
+ destroy(): void;
2248
+ refresh(params: NumberEditorParams): boolean;
2249
+ getValue(): number;
2250
+ isPopup(): boolean;
2251
+ afterGuiAttached(): void;
2252
+ changeHandler(event: any): void;
2253
+ }
2254
+
2255
+ /**
2256
+ * Parameters used to configure {@link NumberEditor}
2257
+ * @public
2258
+ */
2259
+ export declare interface NumberEditorParams extends ICellEditorParams {
2260
+ withFormatting: boolean;
2261
+ formatOptions: any;
2262
+ placeholder: string;
2263
+ disabled: boolean;
2264
+ }
2265
+
2199
2266
  /**
2200
2267
  * The operation type for the {@link @genesislcap/grid-pro#GridProGenesisDatasource.mapTransaction} method.
2201
2268
  * @internal
@@ -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; [agNumberEditorStyles](./grid-pro.agnumbereditorstyles.md)
4
+
5
+ ## agNumberEditorStyles variable
6
+
7
+ The AG Number Editor Styles.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ agNumberEditorStyles: import("@microsoft/fast-element").ElementStyles
13
+ ```
@@ -73,7 +73,7 @@ foundationGridComponents: {
73
73
  styles: import("@microsoft/fast-element").ElementStyles;
74
74
  template: import("@microsoft/fast-element").ViewTemplate<any, any>;
75
75
  }, typeof import("./grid-pro").GridPro>;
76
- selectEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
76
+ foundationSelectEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
77
77
  baseName: string;
78
78
  styles: import("@microsoft/fast-element").ElementStyles;
79
79
  template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").SelectEditor, any>;
@@ -82,6 +82,15 @@ foundationGridComponents: {
82
82
  styles: import("@microsoft/fast-element").ElementStyles;
83
83
  template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").SelectEditor, any>;
84
84
  }, typeof import("./cell-editors").SelectEditor>;
85
+ foundationNumberEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
86
+ baseName: string;
87
+ styles: import("@microsoft/fast-element").ElementStyles;
88
+ template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").NumberEditor, any>;
89
+ }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
90
+ baseName: string;
91
+ styles: import("@microsoft/fast-element").ElementStyles;
92
+ template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").NumberEditor, any>;
93
+ }, typeof import("./cell-editors").NumberEditor>;
85
94
  register(container?: Container, ...rest: any[]): void;
86
95
  }
87
96
  ```
@@ -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; [foundationNumberEditor](./grid-pro.foundationnumbereditor.md)
4
+
5
+ ## foundationNumberEditor variable
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ foundationNumberEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
11
+ baseName: string;
12
+ styles: import("@microsoft/fast-element").ElementStyles;
13
+ template: import("@microsoft/fast-element").ViewTemplate<NumberEditor, any>;
14
+ }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
15
+ baseName: string;
16
+ styles: import("@microsoft/fast-element").ElementStyles;
17
+ template: import("@microsoft/fast-element").ViewTemplate<NumberEditor, any>;
18
+ }, typeof NumberEditor>
19
+ ```
20
+
21
+ ## Remarks
22
+
23
+ HTML Element: &lt;<!-- -->foundation-number-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; [getNumberEditorTemplate](./grid-pro.getnumbereditortemplate.md)
4
+
5
+ ## getNumberEditorTemplate variable
6
+
7
+ Get a Design System prefixed Select template.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getNumberEditorTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<NumberEditor, any>
13
+ ```
@@ -19,6 +19,7 @@ export declare enum GridProRendererTypes
19
19
  | action | <code>&quot;action&quot;</code> | |
20
20
  | actionsMenu | <code>&quot;actionsMenu&quot;</code> | |
21
21
  | boolean | <code>&quot;boolean&quot;</code> | |
22
+ | numberEditor | <code>&quot;numberEditor&quot;</code> | |
22
23
  | select | <code>&quot;select&quot;</code> | |
23
24
  | selectEditor | <code>&quot;selectEditor&quot;</code> | |
24
25
  | text | <code>&quot;text&quot;</code> | |
@@ -18,6 +18,7 @@
18
18
  | [GridProClientSideDatasource](./grid-pro.gridproclientsidedatasource.md) | The Genesis Datasource element, for client-side \| CSRM-compatible data fetching and used exclusively by the GridPro element. |
19
19
  | [GridProColumn](./grid-pro.gridprocolumn.md) | The Grid Pro Column element. |
20
20
  | [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) | The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element. |
21
+ | [NumberEditor](./grid-pro.numbereditor.md) | The AG Number Editor element. |
21
22
  | [SelectEditor](./grid-pro.selecteditor.md) | The AG Select Editor element. |
22
23
  | [SelectRenderer](./grid-pro.selectrenderer.md) | The AG Select Renderer element. |
23
24
 
@@ -42,6 +43,7 @@
42
43
 
43
44
  | Interface | Description |
44
45
  | --- | --- |
46
+ | [NumberEditorParams](./grid-pro.numbereditorparams.md) | Parameters used to configure [NumberEditor](./grid-pro.numbereditor.md) |
45
47
  | [SelectEditorParams](./grid-pro.selecteditorparams.md) | Parameters used to configure [SelectEditor](./grid-pro.selecteditor.md) |
46
48
 
47
49
  ## Variables
@@ -57,6 +59,7 @@
57
59
  | [agGridCSS](./grid-pro.aggridcss.md) | AG Grid core CSS. |
58
60
  | [agGridMaterialFontFace](./grid-pro.aggridmaterialfontface.md) | The AG Material font face used on ag-theme-material Grid Pro theme. |
59
61
  | [agHeadCSS](./grid-pro.agheadcss.md) | Custom Drag n Drop CSS for Grid Pro. |
62
+ | [agNumberEditorStyles](./grid-pro.agnumbereditorstyles.md) | The AG Number Editor Styles. |
60
63
  | [agSelectEditorStyles](./grid-pro.agselecteditorstyles.md) | The AG Select Renderer Styles. |
61
64
  | [agSelectRendererStyles](./grid-pro.agselectrendererstyles.md) | The AG Select Renderer Styles. |
62
65
  | [agThemeAlpineNofontsCSS](./grid-pro.agthemealpinenofontscss.md) | AG Alpine Theme (no fonts) CSS. |
@@ -81,9 +84,11 @@
81
84
  | [foundationGridProActionsMenuRenderer](./grid-pro.foundationgridproactionsmenurenderer.md) | A function that returns a Foundation Actions Menu for configuring the component with a DesignSystem. |
82
85
  | [foundationGridProShadowOptions](./grid-pro.foundationgridproshadowoptions.md) | GridPro shadow root options. |
83
86
  | [foundationGridProStyles](./grid-pro.foundationgridprostyles.md) | The Grid Pro styles. |
87
+ | [foundationNumberEditor](./grid-pro.foundationnumbereditor.md) | |
84
88
  | [foundationSelectEditor](./grid-pro.foundationselecteditor.md) | |
85
89
  | [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). |
86
90
  | [getAgBooleanRendererTemplate](./grid-pro.getagbooleanrenderertemplate.md) | Get a Design System prefixed Checkbox template. |
91
+ | [getNumberEditorTemplate](./grid-pro.getnumbereditortemplate.md) | Get a Design System prefixed Select template. |
87
92
  | [getSelectEditorTemplate](./grid-pro.getselecteditortemplate.md) | Get a Design System prefixed Select template. |
88
93
  | [getSelectRendererTemplate](./grid-pro.getselectrenderertemplate.md) | Get a Design System prefixed Select template. |
89
94
  | [getTextFieldRendererTemplate](./grid-pro.gettextfieldrenderertemplate.md) | Get a Design System prefixed Text Field template. |
@@ -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; [afterGuiAttached](./grid-pro.numbereditor.afterguiattached.md)
4
+
5
+ ## NumberEditor.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; [NumberEditor](./grid-pro.numbereditor.md) &gt; [changeHandler](./grid-pro.numbereditor.changehandler.md)
4
+
5
+ ## NumberEditor.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; [NumberEditor](./grid-pro.numbereditor.md) &gt; [destroy](./grid-pro.numbereditor.destroy.md)
4
+
5
+ ## NumberEditor.destroy() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ destroy(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
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; [NumberEditor](./grid-pro.numbereditor.md) &gt; [focus](./grid-pro.numbereditor.focus.md)
4
+
5
+ ## NumberEditor.focus() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ focus(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
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; [NumberEditor](./grid-pro.numbereditor.md) &gt; [getGui](./grid-pro.numbereditor.getgui.md)
4
+
5
+ ## NumberEditor.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; [NumberEditor](./grid-pro.numbereditor.md) &gt; [getValue](./grid-pro.numbereditor.getvalue.md)
4
+
5
+ ## NumberEditor.getValue() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ getValue(): number;
11
+ ```
12
+ **Returns:**
13
+
14
+ number
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; [NumberEditor](./grid-pro.numbereditor.md) &gt; [init](./grid-pro.numbereditor.init.md)
4
+
5
+ ## NumberEditor.init() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ init(params: NumberEditorParams): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | params | [NumberEditorParams](./grid-pro.numbereditorparams.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; [NumberEditor](./grid-pro.numbereditor.md) &gt; [input](./grid-pro.numbereditor.input.md)
4
+
5
+ ## NumberEditor.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; [NumberEditor](./grid-pro.numbereditor.md) &gt; [isPopup](./grid-pro.numbereditor.ispopup.md)
4
+
5
+ ## NumberEditor.isPopup() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ isPopup(): boolean;
11
+ ```
12
+ **Returns:**
13
+
14
+ boolean
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; [NumberEditor](./grid-pro.numbereditor.md)
4
+
5
+ ## NumberEditor class
6
+
7
+ The AG Number Editor element.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare class NumberEditor extends FoundationElement implements ICellEditorComp
13
+ ```
14
+ **Extends:** FoundationElement
15
+
16
+ **Implements:** ICellEditorComp
17
+
18
+ ## Properties
19
+
20
+ | Property | Modifiers | Type | Description |
21
+ | --- | --- | --- | --- |
22
+ | [input](./grid-pro.numbereditor.input.md) | | any | |
23
+ | [params](./grid-pro.numbereditor.params.md) | | [NumberEditorParams](./grid-pro.numbereditorparams.md) | |
24
+ | [value](./grid-pro.numbereditor.value.md) | | number | |
25
+
26
+ ## Methods
27
+
28
+ | Method | Modifiers | Description |
29
+ | --- | --- | --- |
30
+ | [afterGuiAttached()](./grid-pro.numbereditor.afterguiattached.md) | | |
31
+ | [changeHandler(event)](./grid-pro.numbereditor.changehandler.md) | | |
32
+ | [destroy()](./grid-pro.numbereditor.destroy.md) | | |
33
+ | [focus()](./grid-pro.numbereditor.focus.md) | | |
34
+ | [getGui()](./grid-pro.numbereditor.getgui.md) | | |
35
+ | [getValue()](./grid-pro.numbereditor.getvalue.md) | | |
36
+ | [init(params)](./grid-pro.numbereditor.init.md) | | |
37
+ | [isPopup()](./grid-pro.numbereditor.ispopup.md) | | |
38
+ | [refresh(params)](./grid-pro.numbereditor.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; [NumberEditor](./grid-pro.numbereditor.md) &gt; [params](./grid-pro.numbereditor.params.md)
4
+
5
+ ## NumberEditor.params property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ params: NumberEditorParams;
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; [NumberEditor](./grid-pro.numbereditor.md) &gt; [refresh](./grid-pro.numbereditor.refresh.md)
4
+
5
+ ## NumberEditor.refresh() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ refresh(params: NumberEditorParams): boolean;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | params | [NumberEditorParams](./grid-pro.numbereditorparams.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; [NumberEditor](./grid-pro.numbereditor.md) &gt; [value](./grid-pro.numbereditor.value.md)
4
+
5
+ ## NumberEditor.value property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ value: number;
11
+ ```
@@ -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; [NumberEditorParams](./grid-pro.numbereditorparams.md) &gt; [disabled](./grid-pro.numbereditorparams.disabled.md)
4
+
5
+ ## NumberEditorParams.disabled property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ disabled: boolean;
11
+ ```
@@ -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; [NumberEditorParams](./grid-pro.numbereditorparams.md) &gt; [formatOptions](./grid-pro.numbereditorparams.formatoptions.md)
4
+
5
+ ## NumberEditorParams.formatOptions property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ formatOptions: any;
11
+ ```
@@ -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; [NumberEditorParams](./grid-pro.numbereditorparams.md)
4
+
5
+ ## NumberEditorParams interface
6
+
7
+ Parameters used to configure [NumberEditor](./grid-pro.numbereditor.md)
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface NumberEditorParams extends ICellEditorParams
13
+ ```
14
+ **Extends:** ICellEditorParams
15
+
16
+ ## Properties
17
+
18
+ | Property | Modifiers | Type | Description |
19
+ | --- | --- | --- | --- |
20
+ | [disabled](./grid-pro.numbereditorparams.disabled.md) | | boolean | |
21
+ | [formatOptions](./grid-pro.numbereditorparams.formatoptions.md) | | any | |
22
+ | [placeholder](./grid-pro.numbereditorparams.placeholder.md) | | string | |
23
+ | [withFormatting](./grid-pro.numbereditorparams.withformatting.md) | | boolean | |
24
+
@@ -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; [NumberEditorParams](./grid-pro.numbereditorparams.md) &gt; [placeholder](./grid-pro.numbereditorparams.placeholder.md)
4
+
5
+ ## NumberEditorParams.placeholder property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ placeholder: string;
11
+ ```
@@ -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; [NumberEditorParams](./grid-pro.numbereditorparams.md) &gt; [withFormatting](./grid-pro.numbereditorparams.withformatting.md)
4
+
5
+ ## NumberEditorParams.withFormatting property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ withFormatting: boolean;
11
+ ```