@genesislcap/grid-pro 14.104.0 → 14.105.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 +301 -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 +60 -0
- package/dist/dts/cell-editors/multiselect.editor.d.ts.map +1 -0
- package/dist/dts/cell-editors/select.editor.d.ts +2 -0
- package/dist/dts/cell-editors/select.editor.d.ts.map +1 -1
- package/dist/dts/grid-components.d.ts +9 -0
- package/dist/dts/grid-components.d.ts.map +1 -1
- package/dist/dts/grid-pro.d.ts +3 -3
- package/dist/dts/grid-pro.d.ts.map +1 -1
- package/dist/dts/grid-pro.types.d.ts +2 -1
- package/dist/dts/grid-pro.types.d.ts.map +1 -1
- package/dist/esm/cell-editors/index.js +1 -0
- package/dist/esm/cell-editors/multiselect.editor.js +94 -0
- package/dist/esm/cell-editors/select.editor.js +6 -4
- package/dist/esm/grid-components.js +2 -1
- package/dist/esm/grid-pro.js +2 -1
- package/dist/esm/grid-pro.types.js +1 -0
- package/dist/grid-pro.api.json +975 -12
- package/dist/grid-pro.d.ts +77 -4
- package/docs/api/grid-pro.agmultiselecteditorstyles.md +13 -0
- package/docs/api/grid-pro.foundationgridcomponents.md +9 -0
- package/docs/api/grid-pro.foundationmultiselecteditor.md +24 -0
- package/docs/api/grid-pro.getmultiselecteditortemplate.md +13 -0
- package/docs/api/grid-pro.gridprorenderertypes.md +1 -0
- package/docs/api/grid-pro.md +5 -0
- package/docs/api/grid-pro.multiselecteditor.changehandler.md +22 -0
- package/docs/api/grid-pro.multiselecteditor.destroy.md +15 -0
- package/docs/api/grid-pro.multiselecteditor.getgui.md +15 -0
- package/docs/api/grid-pro.multiselecteditor.getvalue.md +15 -0
- package/docs/api/grid-pro.multiselecteditor.init.md +22 -0
- package/docs/api/grid-pro.multiselecteditor.ispopup.md +15 -0
- package/docs/api/grid-pro.multiselecteditor.md +36 -0
- package/docs/api/grid-pro.multiselecteditor.params.md +11 -0
- package/docs/api/grid-pro.multiselecteditor.refresh.md +22 -0
- package/docs/api/grid-pro.multiselecteditor.selectedoptions.md +11 -0
- package/docs/api/grid-pro.multiselecteditorparams.alloptionsresourcename.md +11 -0
- package/docs/api/grid-pro.multiselecteditorparams.async.md +11 -0
- package/docs/api/grid-pro.multiselecteditorparams.datasourceoptions.md +11 -0
- package/docs/api/grid-pro.multiselecteditorparams.labelfield.md +11 -0
- package/docs/api/grid-pro.multiselecteditorparams.md +27 -0
- package/docs/api/grid-pro.multiselecteditorparams.selectedoptionscallback.md +11 -0
- package/docs/api/grid-pro.multiselecteditorparams.valuefield.md +11 -0
- package/docs/api/grid-pro.multiselecteditorparams.values.md +11 -0
- package/docs/api/grid-pro.selecteditor.changehandler.md +22 -0
- package/docs/api/grid-pro.selecteditor.md +1 -0
- package/docs/api/grid-pro.selecteditorparams.async.md +11 -0
- package/docs/api/grid-pro.selecteditorparams.md +1 -0
- package/docs/api-report.md +72 -0
- package/package.json +8 -8
package/dist/grid-pro.d.ts
CHANGED
|
@@ -229,6 +229,12 @@ export declare enum AgGridTheme {
|
|
|
229
229
|
*/
|
|
230
230
|
export declare const agHeadCSS: ElementStyles;
|
|
231
231
|
|
|
232
|
+
/**
|
|
233
|
+
* The AG Select Renderer Styles.
|
|
234
|
+
* @public
|
|
235
|
+
*/
|
|
236
|
+
export declare const agMultiselectEditorStyles: ElementStyles;
|
|
237
|
+
|
|
232
238
|
/**
|
|
233
239
|
* The AG Number Editor Styles.
|
|
234
240
|
* @public
|
|
@@ -620,6 +626,15 @@ export declare const foundationGridComponents: {
|
|
|
620
626
|
styles: ElementStyles;
|
|
621
627
|
template: ViewTemplate<NumberEditor, any>;
|
|
622
628
|
}, NumberEditor>;
|
|
629
|
+
foundationMultiselectEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
630
|
+
baseName: string;
|
|
631
|
+
styles: ElementStyles;
|
|
632
|
+
template: ViewTemplate<MultiselectEditor, any>;
|
|
633
|
+
}>) => FoundationElementRegistry< {
|
|
634
|
+
baseName: string;
|
|
635
|
+
styles: ElementStyles;
|
|
636
|
+
template: ViewTemplate<MultiselectEditor, any>;
|
|
637
|
+
}, MultiselectEditor>;
|
|
623
638
|
register(container?: Container, ...rest: any[]): void;
|
|
624
639
|
};
|
|
625
640
|
|
|
@@ -689,6 +704,22 @@ export declare const foundationGridProShadowOptions: ShadowRootInit;
|
|
|
689
704
|
*/
|
|
690
705
|
export declare const foundationGridProStyles: ElementStyles;
|
|
691
706
|
|
|
707
|
+
/**
|
|
708
|
+
*
|
|
709
|
+
* @public
|
|
710
|
+
* @remarks
|
|
711
|
+
* HTML Element: \<foundation-multiselect-editor\>
|
|
712
|
+
*/
|
|
713
|
+
export declare const foundationMultiselectEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
714
|
+
baseName: string;
|
|
715
|
+
styles: ElementStyles;
|
|
716
|
+
template: ViewTemplate<MultiselectEditor, any>;
|
|
717
|
+
}>) => FoundationElementRegistry< {
|
|
718
|
+
baseName: string;
|
|
719
|
+
styles: ElementStyles;
|
|
720
|
+
template: ViewTemplate<MultiselectEditor, any>;
|
|
721
|
+
}, typeof MultiselectEditor>;
|
|
722
|
+
|
|
692
723
|
/**
|
|
693
724
|
*
|
|
694
725
|
* @public
|
|
@@ -796,6 +827,14 @@ export declare function getFilterByFieldType(type: string): string;
|
|
|
796
827
|
*/
|
|
797
828
|
export declare function getFilterParamsByFieldType(type: string): any;
|
|
798
829
|
|
|
830
|
+
/**
|
|
831
|
+
* Get a Design System prefixed Select template.
|
|
832
|
+
* @param designSystem - The design system prefix to use. Defaults to 'foundation'.
|
|
833
|
+
* @returns A Select component template prefixed with the correct design system.
|
|
834
|
+
* @public
|
|
835
|
+
*/
|
|
836
|
+
export declare const getMultiselectEditorTemplate: (designSystem?: string) => ViewTemplate<MultiselectEditor, any>;
|
|
837
|
+
|
|
799
838
|
/**
|
|
800
839
|
* Get a Design System prefixed Select template.
|
|
801
840
|
* @param designSystem - The design system prefix to use. Defaults to 'foundation'.
|
|
@@ -1106,11 +1145,11 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1106
1145
|
readonly nodeName: string;
|
|
1107
1146
|
readonly nodeType: number;
|
|
1108
1147
|
nodeValue: string;
|
|
1109
|
-
readonly parentElement: HTMLElement;
|
|
1148
|
+
readonly parentElement: HTMLElement;
|
|
1149
|
+
readonly parentNode: ParentNode;
|
|
1150
|
+
readonly previousSibling: ChildNode; /**
|
|
1110
1151
|
* @public
|
|
1111
1152
|
*/
|
|
1112
|
-
readonly parentNode: ParentNode;
|
|
1113
|
-
readonly previousSibling: ChildNode;
|
|
1114
1153
|
textContent: string;
|
|
1115
1154
|
appendChild<T_1 extends Node>(node: T_1): T_1;
|
|
1116
1155
|
compareDocumentPosition(other: Node): number;
|
|
@@ -1838,7 +1877,8 @@ export declare enum GridProRendererTypes {
|
|
|
1838
1877
|
text = "text",
|
|
1839
1878
|
select = "select",
|
|
1840
1879
|
selectEditor = "selectEditor",
|
|
1841
|
-
numberEditor = "numberEditor"
|
|
1880
|
+
numberEditor = "numberEditor",
|
|
1881
|
+
multiselectEditor = "multiselectEditor"
|
|
1842
1882
|
}
|
|
1843
1883
|
|
|
1844
1884
|
/**
|
|
@@ -2223,6 +2263,37 @@ export declare const logger: Logger;
|
|
|
2223
2263
|
*/
|
|
2224
2264
|
export declare function mergeAndDedupColDefWithColumnState(colDefs: ColDef[], columnStates: ColumnState[]): ColDef[];
|
|
2225
2265
|
|
|
2266
|
+
/**
|
|
2267
|
+
* The AG Multiselect Editor element.
|
|
2268
|
+
* @public
|
|
2269
|
+
* @tagname %%prefix%%-multiselect-editor
|
|
2270
|
+
*/
|
|
2271
|
+
export declare class MultiselectEditor extends FoundationElement implements ICellEditorComp {
|
|
2272
|
+
params: MultiselectEditorParams;
|
|
2273
|
+
selectedOptions: any[];
|
|
2274
|
+
init(params: MultiselectEditorParams): void;
|
|
2275
|
+
getGui(): HTMLElement;
|
|
2276
|
+
destroy(): void;
|
|
2277
|
+
refresh(params: MultiselectEditorParams): boolean;
|
|
2278
|
+
getValue(): any[];
|
|
2279
|
+
isPopup(): boolean;
|
|
2280
|
+
changeHandler(event: any): void;
|
|
2281
|
+
}
|
|
2282
|
+
|
|
2283
|
+
/**
|
|
2284
|
+
* Parameters used to configure {@link MultiselectEditor}
|
|
2285
|
+
* @public
|
|
2286
|
+
*/
|
|
2287
|
+
export declare interface MultiselectEditorParams extends ICellEditorParams {
|
|
2288
|
+
allOptionsResourceName: string;
|
|
2289
|
+
selectedOptionsCallback: (data: any) => Promise<[]>;
|
|
2290
|
+
valueField: string;
|
|
2291
|
+
labelField: string;
|
|
2292
|
+
async: boolean;
|
|
2293
|
+
values: any[];
|
|
2294
|
+
datasourceOptions: DatasourceOptions[];
|
|
2295
|
+
}
|
|
2296
|
+
|
|
2226
2297
|
/**
|
|
2227
2298
|
* The AG Number Editor element.
|
|
2228
2299
|
* @public
|
|
@@ -2287,6 +2358,7 @@ export declare class SelectEditor extends FoundationElement implements ICellEdit
|
|
|
2287
2358
|
getValue(): string;
|
|
2288
2359
|
isPopup(): boolean;
|
|
2289
2360
|
afterGuiAttached(): void;
|
|
2361
|
+
changeHandler(event: any): void;
|
|
2290
2362
|
}
|
|
2291
2363
|
|
|
2292
2364
|
/**
|
|
@@ -2296,6 +2368,7 @@ export declare class SelectEditor extends FoundationElement implements ICellEdit
|
|
|
2296
2368
|
export declare interface SelectEditorParams extends ICellEditorParams {
|
|
2297
2369
|
allOptionsResourceName: string;
|
|
2298
2370
|
valueField: string;
|
|
2371
|
+
async: boolean;
|
|
2299
2372
|
labelField: string;
|
|
2300
2373
|
values: any[];
|
|
2301
2374
|
datasourceOptions: DatasourceOptions[];
|
|
@@ -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) > [agMultiselectEditorStyles](./grid-pro.agmultiselecteditorstyles.md)
|
|
4
|
+
|
|
5
|
+
## agMultiselectEditorStyles variable
|
|
6
|
+
|
|
7
|
+
The AG Select Renderer Styles.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
agMultiselectEditorStyles: import("@microsoft/fast-element").ElementStyles
|
|
13
|
+
```
|
|
@@ -91,6 +91,15 @@ foundationGridComponents: {
|
|
|
91
91
|
styles: import("@microsoft/fast-element").ElementStyles;
|
|
92
92
|
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").NumberEditor, any>;
|
|
93
93
|
}, typeof import("./cell-editors").NumberEditor>;
|
|
94
|
+
foundationMultiselectEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
95
|
+
baseName: string;
|
|
96
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
97
|
+
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").MultiselectEditor, any>;
|
|
98
|
+
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
99
|
+
baseName: string;
|
|
100
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
101
|
+
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").MultiselectEditor, any>;
|
|
102
|
+
}, typeof import("./cell-editors").MultiselectEditor>;
|
|
94
103
|
register(container?: Container, ...rest: any[]): void;
|
|
95
104
|
}
|
|
96
105
|
```
|
|
@@ -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) > [foundationMultiselectEditor](./grid-pro.foundationmultiselecteditor.md)
|
|
4
|
+
|
|
5
|
+
## foundationMultiselectEditor variable
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
foundationMultiselectEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
11
|
+
baseName: string;
|
|
12
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
13
|
+
template: import("@microsoft/fast-element").ViewTemplate<MultiselectEditor, any>;
|
|
14
|
+
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
15
|
+
baseName: string;
|
|
16
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
17
|
+
template: import("@microsoft/fast-element").ViewTemplate<MultiselectEditor, any>;
|
|
18
|
+
}, typeof MultiselectEditor>
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Remarks
|
|
22
|
+
|
|
23
|
+
HTML Element: <<!-- -->foundation-multiselect-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) > [getMultiselectEditorTemplate](./grid-pro.getmultiselecteditortemplate.md)
|
|
4
|
+
|
|
5
|
+
## getMultiselectEditorTemplate variable
|
|
6
|
+
|
|
7
|
+
Get a Design System prefixed Select template.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getMultiselectEditorTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<MultiselectEditor, any>
|
|
13
|
+
```
|
|
@@ -19,6 +19,7 @@ export declare enum GridProRendererTypes
|
|
|
19
19
|
| action | <code>"action"</code> | |
|
|
20
20
|
| actionsMenu | <code>"actionsMenu"</code> | |
|
|
21
21
|
| boolean | <code>"boolean"</code> | |
|
|
22
|
+
| multiselectEditor | <code>"multiselectEditor"</code> | |
|
|
22
23
|
| numberEditor | <code>"numberEditor"</code> | |
|
|
23
24
|
| select | <code>"select"</code> | |
|
|
24
25
|
| selectEditor | <code>"selectEditor"</code> | |
|
package/docs/api/grid-pro.md
CHANGED
|
@@ -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
|
+
| [MultiselectEditor](./grid-pro.multiselecteditor.md) | The AG Multiselect Editor element. |
|
|
21
22
|
| [NumberEditor](./grid-pro.numbereditor.md) | The AG Number Editor element. |
|
|
22
23
|
| [SelectEditor](./grid-pro.selecteditor.md) | The AG Select Editor element. |
|
|
23
24
|
| [SelectRenderer](./grid-pro.selectrenderer.md) | The AG Select Renderer element. |
|
|
@@ -43,6 +44,7 @@
|
|
|
43
44
|
|
|
44
45
|
| Interface | Description |
|
|
45
46
|
| --- | --- |
|
|
47
|
+
| [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) | Parameters used to configure [MultiselectEditor](./grid-pro.multiselecteditor.md) |
|
|
46
48
|
| [NumberEditorParams](./grid-pro.numbereditorparams.md) | Parameters used to configure [NumberEditor](./grid-pro.numbereditor.md) |
|
|
47
49
|
| [SelectEditorParams](./grid-pro.selecteditorparams.md) | Parameters used to configure [SelectEditor](./grid-pro.selecteditor.md) |
|
|
48
50
|
|
|
@@ -59,6 +61,7 @@
|
|
|
59
61
|
| [agGridCSS](./grid-pro.aggridcss.md) | AG Grid core CSS. |
|
|
60
62
|
| [agGridMaterialFontFace](./grid-pro.aggridmaterialfontface.md) | The AG Material font face used on ag-theme-material Grid Pro theme. |
|
|
61
63
|
| [agHeadCSS](./grid-pro.agheadcss.md) | Custom Drag n Drop CSS for Grid Pro. |
|
|
64
|
+
| [agMultiselectEditorStyles](./grid-pro.agmultiselecteditorstyles.md) | The AG Select Renderer Styles. |
|
|
62
65
|
| [agNumberEditorStyles](./grid-pro.agnumbereditorstyles.md) | The AG Number Editor Styles. |
|
|
63
66
|
| [agSelectEditorStyles](./grid-pro.agselecteditorstyles.md) | The AG Select Renderer Styles. |
|
|
64
67
|
| [agSelectRendererStyles](./grid-pro.agselectrendererstyles.md) | The AG Select Renderer Styles. |
|
|
@@ -84,10 +87,12 @@
|
|
|
84
87
|
| [foundationGridProActionsMenuRenderer](./grid-pro.foundationgridproactionsmenurenderer.md) | A function that returns a Foundation Actions Menu for configuring the component with a DesignSystem. |
|
|
85
88
|
| [foundationGridProShadowOptions](./grid-pro.foundationgridproshadowoptions.md) | GridPro shadow root options. |
|
|
86
89
|
| [foundationGridProStyles](./grid-pro.foundationgridprostyles.md) | The Grid Pro styles. |
|
|
90
|
+
| [foundationMultiselectEditor](./grid-pro.foundationmultiselecteditor.md) | |
|
|
87
91
|
| [foundationNumberEditor](./grid-pro.foundationnumbereditor.md) | |
|
|
88
92
|
| [foundationSelectEditor](./grid-pro.foundationselecteditor.md) | |
|
|
89
93
|
| [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). |
|
|
90
94
|
| [getAgBooleanRendererTemplate](./grid-pro.getagbooleanrenderertemplate.md) | Get a Design System prefixed Checkbox template. |
|
|
95
|
+
| [getMultiselectEditorTemplate](./grid-pro.getmultiselecteditortemplate.md) | Get a Design System prefixed Select template. |
|
|
91
96
|
| [getNumberEditorTemplate](./grid-pro.getnumbereditortemplate.md) | Get a Design System prefixed Select template. |
|
|
92
97
|
| [getSelectEditorTemplate](./grid-pro.getselecteditortemplate.md) | Get a Design System prefixed Select template. |
|
|
93
98
|
| [getSelectRendererTemplate](./grid-pro.getselectrenderertemplate.md) | Get a Design System prefixed Select template. |
|
|
@@ -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) > [MultiselectEditor](./grid-pro.multiselecteditor.md) > [changeHandler](./grid-pro.multiselecteditor.changehandler.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditor.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) > [MultiselectEditor](./grid-pro.multiselecteditor.md) > [destroy](./grid-pro.multiselecteditor.destroy.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditor.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) > [@genesislcap/grid-pro](./grid-pro.md) > [MultiselectEditor](./grid-pro.multiselecteditor.md) > [getGui](./grid-pro.multiselecteditor.getgui.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditor.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) > [MultiselectEditor](./grid-pro.multiselecteditor.md) > [getValue](./grid-pro.multiselecteditor.getvalue.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditor.getValue() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
getValue(): any[];
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
any\[\]
|
|
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) > [MultiselectEditor](./grid-pro.multiselecteditor.md) > [init](./grid-pro.multiselecteditor.init.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditor.init() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
init(params: MultiselectEditorParams): void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| params | [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) | |
|
|
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) > [MultiselectEditor](./grid-pro.multiselecteditor.md) > [isPopup](./grid-pro.multiselecteditor.ispopup.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditor.isPopup() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
isPopup(): boolean;
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
boolean
|
|
15
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
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)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditor class
|
|
6
|
+
|
|
7
|
+
The AG Multiselect Editor element.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare class MultiselectEditor extends FoundationElement implements ICellEditorComp
|
|
13
|
+
```
|
|
14
|
+
**Extends:** FoundationElement
|
|
15
|
+
|
|
16
|
+
**Implements:** ICellEditorComp
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
| Property | Modifiers | Type | Description |
|
|
21
|
+
| --- | --- | --- | --- |
|
|
22
|
+
| [params](./grid-pro.multiselecteditor.params.md) | | [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) | |
|
|
23
|
+
| [selectedOptions](./grid-pro.multiselecteditor.selectedoptions.md) | | any\[\] | |
|
|
24
|
+
|
|
25
|
+
## Methods
|
|
26
|
+
|
|
27
|
+
| Method | Modifiers | Description |
|
|
28
|
+
| --- | --- | --- |
|
|
29
|
+
| [changeHandler(event)](./grid-pro.multiselecteditor.changehandler.md) | | |
|
|
30
|
+
| [destroy()](./grid-pro.multiselecteditor.destroy.md) | | |
|
|
31
|
+
| [getGui()](./grid-pro.multiselecteditor.getgui.md) | | |
|
|
32
|
+
| [getValue()](./grid-pro.multiselecteditor.getvalue.md) | | |
|
|
33
|
+
| [init(params)](./grid-pro.multiselecteditor.init.md) | | |
|
|
34
|
+
| [isPopup()](./grid-pro.multiselecteditor.ispopup.md) | | |
|
|
35
|
+
| [refresh(params)](./grid-pro.multiselecteditor.refresh.md) | | |
|
|
36
|
+
|
|
@@ -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) > [MultiselectEditor](./grid-pro.multiselecteditor.md) > [params](./grid-pro.multiselecteditor.params.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditor.params property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
params: MultiselectEditorParams;
|
|
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) > [MultiselectEditor](./grid-pro.multiselecteditor.md) > [refresh](./grid-pro.multiselecteditor.refresh.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditor.refresh() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
refresh(params: MultiselectEditorParams): boolean;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| params | [MultiselectEditorParams](./grid-pro.multiselecteditorparams.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) > [MultiselectEditor](./grid-pro.multiselecteditor.md) > [selectedOptions](./grid-pro.multiselecteditor.selectedoptions.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditor.selectedOptions property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
selectedOptions: any[];
|
|
11
|
+
```
|
|
@@ -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) > [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) > [allOptionsResourceName](./grid-pro.multiselecteditorparams.alloptionsresourcename.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditorParams.allOptionsResourceName property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
allOptionsResourceName: string;
|
|
11
|
+
```
|
|
@@ -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) > [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) > [async](./grid-pro.multiselecteditorparams.async.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditorParams.async property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
async: boolean;
|
|
11
|
+
```
|
|
@@ -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) > [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) > [datasourceOptions](./grid-pro.multiselecteditorparams.datasourceoptions.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditorParams.datasourceOptions property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
datasourceOptions: DatasourceOptions[];
|
|
11
|
+
```
|
|
@@ -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) > [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) > [labelField](./grid-pro.multiselecteditorparams.labelfield.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditorParams.labelField property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
labelField: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditorParams interface
|
|
6
|
+
|
|
7
|
+
Parameters used to configure [MultiselectEditor](./grid-pro.multiselecteditor.md)
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface MultiselectEditorParams extends ICellEditorParams
|
|
13
|
+
```
|
|
14
|
+
**Extends:** ICellEditorParams
|
|
15
|
+
|
|
16
|
+
## Properties
|
|
17
|
+
|
|
18
|
+
| Property | Modifiers | Type | Description |
|
|
19
|
+
| --- | --- | --- | --- |
|
|
20
|
+
| [allOptionsResourceName](./grid-pro.multiselecteditorparams.alloptionsresourcename.md) | | string | |
|
|
21
|
+
| [async](./grid-pro.multiselecteditorparams.async.md) | | boolean | |
|
|
22
|
+
| [datasourceOptions](./grid-pro.multiselecteditorparams.datasourceoptions.md) | | DatasourceOptions\[\] | |
|
|
23
|
+
| [labelField](./grid-pro.multiselecteditorparams.labelfield.md) | | string | |
|
|
24
|
+
| [selectedOptionsCallback](./grid-pro.multiselecteditorparams.selectedoptionscallback.md) | | (data: any) => Promise<\[\]> | |
|
|
25
|
+
| [valueField](./grid-pro.multiselecteditorparams.valuefield.md) | | string | |
|
|
26
|
+
| [values](./grid-pro.multiselecteditorparams.values.md) | | any\[\] | |
|
|
27
|
+
|
|
@@ -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) > [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) > [selectedOptionsCallback](./grid-pro.multiselecteditorparams.selectedoptionscallback.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditorParams.selectedOptionsCallback property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
selectedOptionsCallback: (data: any) => Promise<[]>;
|
|
11
|
+
```
|
|
@@ -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) > [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) > [valueField](./grid-pro.multiselecteditorparams.valuefield.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditorParams.valueField property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
valueField: string;
|
|
11
|
+
```
|
|
@@ -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) > [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) > [values](./grid-pro.multiselecteditorparams.values.md)
|
|
4
|
+
|
|
5
|
+
## MultiselectEditorParams.values property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
values: any[];
|
|
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) > [SelectEditor](./grid-pro.selecteditor.md) > [changeHandler](./grid-pro.selecteditor.changehandler.md)
|
|
4
|
+
|
|
5
|
+
## SelectEditor.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
|
+
|
|
@@ -28,6 +28,7 @@ export declare class SelectEditor extends FoundationElement implements ICellEdit
|
|
|
28
28
|
| Method | Modifiers | Description |
|
|
29
29
|
| --- | --- | --- |
|
|
30
30
|
| [afterGuiAttached()](./grid-pro.selecteditor.afterguiattached.md) | | |
|
|
31
|
+
| [changeHandler(event)](./grid-pro.selecteditor.changehandler.md) | | |
|
|
31
32
|
| [destroy()](./grid-pro.selecteditor.destroy.md) | | |
|
|
32
33
|
| [getGui()](./grid-pro.selecteditor.getgui.md) | | |
|
|
33
34
|
| [getValue()](./grid-pro.selecteditor.getvalue.md) | | |
|
|
@@ -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) > [SelectEditorParams](./grid-pro.selecteditorparams.md) > [async](./grid-pro.selecteditorparams.async.md)
|
|
4
|
+
|
|
5
|
+
## SelectEditorParams.async property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
async: boolean;
|
|
11
|
+
```
|
|
@@ -18,6 +18,7 @@ export interface SelectEditorParams extends ICellEditorParams
|
|
|
18
18
|
| Property | Modifiers | Type | Description |
|
|
19
19
|
| --- | --- | --- | --- |
|
|
20
20
|
| [allOptionsResourceName](./grid-pro.selecteditorparams.alloptionsresourcename.md) | | string | |
|
|
21
|
+
| [async](./grid-pro.selecteditorparams.async.md) | | boolean | |
|
|
21
22
|
| [datasourceOptions](./grid-pro.selecteditorparams.datasourceoptions.md) | | DatasourceOptions\[\] | |
|
|
22
23
|
| [labelField](./grid-pro.selecteditorparams.labelfield.md) | | string | |
|
|
23
24
|
| [valueField](./grid-pro.selecteditorparams.valuefield.md) | | string | |
|