@genesislcap/grid-pro 14.104.0 → 14.106.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 +1421 -654
- 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/datasource/base.datasource.d.ts +18 -0
- package/dist/dts/datasource/base.datasource.d.ts.map +1 -0
- package/dist/dts/datasource/server-side.datasource.d.ts +3 -12
- package/dist/dts/datasource/server-side.datasource.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-genesis-datasource/grid-pro-genesis-datasource.d.ts +8 -17
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
- package/dist/dts/grid-pro.d.ts +6 -5
- 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/datasource/base.datasource.js +51 -0
- package/dist/esm/datasource/server-side.datasource.js +12 -53
- package/dist/esm/grid-components.js +2 -1
- package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +5 -44
- package/dist/esm/grid-pro.js +10 -8
- package/dist/esm/grid-pro.types.js +1 -0
- package/dist/grid-pro.api.json +1123 -527
- package/dist/grid-pro.d.ts +102 -30
- 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.gridpro.gridprodatasource.md +11 -0
- package/docs/api/grid-pro.gridpro.md +1 -1
- package/docs/api/grid-pro.gridprogenesisdatasource.md +0 -12
- 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 +77 -45
- package/package.json +8 -8
- package/docs/api/grid-pro.gridpro.gridprogenesisdatasource.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.connect.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.criteria.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.deferredcolumnstates.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.deferredgridoptions.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.fields.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.issnapshot.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.maxrows.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.maxview.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.movingview.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.orderby.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.resourcename.md +0 -11
- package/docs/api/grid-pro.gridprogenesisdatasource.reverse.md +0 -11
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'.
|
|
@@ -958,7 +997,7 @@ export declare class GridPro extends GridPro_base {
|
|
|
958
997
|
* @public
|
|
959
998
|
*/
|
|
960
999
|
get gridOptions(): GridOptions;
|
|
961
|
-
get
|
|
1000
|
+
get gridProDatasource(): GridProBaseDatasource;
|
|
962
1001
|
set gridOptions(options: GridOptions);
|
|
963
1002
|
private enableFlashingRows;
|
|
964
1003
|
/**
|
|
@@ -1002,6 +1041,9 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1002
1041
|
connectedCallback(): void;
|
|
1003
1042
|
readonly $fastController: Controller;
|
|
1004
1043
|
$emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
|
|
1044
|
+
/**
|
|
1045
|
+
* The key to use for persisting the column state in local storage.
|
|
1046
|
+
*/
|
|
1005
1047
|
disconnectedCallback(): void;
|
|
1006
1048
|
attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
|
|
1007
1049
|
accessKey: string;
|
|
@@ -1106,9 +1148,7 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1106
1148
|
readonly nodeName: string;
|
|
1107
1149
|
readonly nodeType: number;
|
|
1108
1150
|
nodeValue: string;
|
|
1109
|
-
readonly parentElement: HTMLElement;
|
|
1110
|
-
* @public
|
|
1111
|
-
*/
|
|
1151
|
+
readonly parentElement: HTMLElement;
|
|
1112
1152
|
readonly parentNode: ParentNode;
|
|
1113
1153
|
readonly previousSibling: ChildNode;
|
|
1114
1154
|
textContent: string;
|
|
@@ -1315,6 +1355,21 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1315
1355
|
focus(options?: FocusOptions): void;
|
|
1316
1356
|
}) & typeof FoundationElement;
|
|
1317
1357
|
|
|
1358
|
+
declare class GridProBaseDatasource extends FoundationElement {
|
|
1359
|
+
connect: Connect;
|
|
1360
|
+
deferredGridOptions: GridOptions;
|
|
1361
|
+
deferredColumnStates: ColumnState[];
|
|
1362
|
+
criteria: string;
|
|
1363
|
+
fields: string;
|
|
1364
|
+
isSnapshot: boolean;
|
|
1365
|
+
maxRows: number;
|
|
1366
|
+
maxView: number;
|
|
1367
|
+
movingView: boolean;
|
|
1368
|
+
orderBy: string;
|
|
1369
|
+
resourceName: string;
|
|
1370
|
+
reverse: boolean;
|
|
1371
|
+
}
|
|
1372
|
+
|
|
1318
1373
|
/**
|
|
1319
1374
|
* The Grid Pro Cell element.
|
|
1320
1375
|
* @remarks Used inside the Grid Pro Column element, to define a cell renderer from the template.
|
|
@@ -1367,24 +1422,12 @@ export declare function gridProColumns<TSource = any>(itemsBinding: Binding<TSou
|
|
|
1367
1422
|
*/
|
|
1368
1423
|
export declare class GridProGenesisDatasource extends GridProGenesisDatasource_base {
|
|
1369
1424
|
auth: Auth;
|
|
1370
|
-
connect: Connect;
|
|
1371
1425
|
datasource: Datasource;
|
|
1372
|
-
deferredGridOptions: GridOptions;
|
|
1373
|
-
deferredColumnStates: ColumnState[];
|
|
1374
|
-
criteria: string;
|
|
1375
1426
|
criteriaChanged(oldCriteria: string, newCriteria: string): void;
|
|
1376
|
-
fields: string;
|
|
1377
|
-
isSnapshot: boolean;
|
|
1378
|
-
maxRows: number;
|
|
1379
|
-
maxView: number;
|
|
1380
|
-
movingView: boolean;
|
|
1381
|
-
orderBy: string;
|
|
1382
1427
|
pollingInterval: number;
|
|
1383
1428
|
disablePolling: boolean;
|
|
1384
1429
|
request: any;
|
|
1385
|
-
resourceName: string;
|
|
1386
1430
|
resourceNameChanged(oldValue: string, newValue: string): void;
|
|
1387
|
-
reverse: boolean;
|
|
1388
1431
|
/**
|
|
1389
1432
|
* Attribute to set an unique identifier for the row.
|
|
1390
1433
|
*
|
|
@@ -1525,7 +1568,11 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
1525
1568
|
draggable: boolean;
|
|
1526
1569
|
hidden: boolean;
|
|
1527
1570
|
inert: boolean;
|
|
1528
|
-
innerText: string;
|
|
1571
|
+
innerText: string; /**
|
|
1572
|
+
* Initializes the datasource.
|
|
1573
|
+
* @public
|
|
1574
|
+
* @remarks This method is called automatically when the element is connected to the DOM.
|
|
1575
|
+
*/
|
|
1529
1576
|
lang: string;
|
|
1530
1577
|
readonly offsetHeight: number;
|
|
1531
1578
|
readonly offsetLeft: number;
|
|
@@ -1825,7 +1872,7 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
1825
1872
|
tabIndex: number;
|
|
1826
1873
|
blur(): void;
|
|
1827
1874
|
focus(options?: FocusOptions): void;
|
|
1828
|
-
}) & typeof
|
|
1875
|
+
}) & typeof GridProBaseDatasource;
|
|
1829
1876
|
|
|
1830
1877
|
/**
|
|
1831
1878
|
* The available Grid Pro Renderer Types
|
|
@@ -1838,7 +1885,8 @@ export declare enum GridProRendererTypes {
|
|
|
1838
1885
|
text = "text",
|
|
1839
1886
|
select = "select",
|
|
1840
1887
|
selectEditor = "selectEditor",
|
|
1841
|
-
numberEditor = "numberEditor"
|
|
1888
|
+
numberEditor = "numberEditor",
|
|
1889
|
+
multiselectEditor = "multiselectEditor"
|
|
1842
1890
|
}
|
|
1843
1891
|
|
|
1844
1892
|
/**
|
|
@@ -1847,25 +1895,16 @@ export declare enum GridProRendererTypes {
|
|
|
1847
1895
|
* @alpha
|
|
1848
1896
|
*/
|
|
1849
1897
|
export declare class GridProServerSideDatasource extends GridProServerSideDatasource_base {
|
|
1850
|
-
connect: Connect;
|
|
1851
|
-
criteria: string;
|
|
1852
1898
|
criteriaChanged(oldCriteria: string, newCriteria: string): void;
|
|
1853
|
-
fields: string;
|
|
1854
|
-
isSnapshot: boolean;
|
|
1855
|
-
maxRows: number;
|
|
1856
|
-
maxView: number;
|
|
1857
|
-
movingView: boolean;
|
|
1858
|
-
orderBy: string;
|
|
1859
|
-
resourceName: string;
|
|
1860
1899
|
resourceNameChanged(oldValue: string, newValue: string): void;
|
|
1861
1900
|
pagination: boolean;
|
|
1862
1901
|
rowId: string;
|
|
1863
|
-
reverse: boolean;
|
|
1864
1902
|
private indexes;
|
|
1865
1903
|
private dataserverStream;
|
|
1866
1904
|
private originalFieldDef;
|
|
1867
1905
|
connectedCallback(): void;
|
|
1868
1906
|
disconnectedCallback(): void;
|
|
1907
|
+
deepClone(): Node;
|
|
1869
1908
|
init(): void;
|
|
1870
1909
|
reset(): void;
|
|
1871
1910
|
restart(): void;
|
|
@@ -2201,7 +2240,7 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
|
|
|
2201
2240
|
tabIndex: number;
|
|
2202
2241
|
blur(): void;
|
|
2203
2242
|
focus(options?: FocusOptions): void;
|
|
2204
|
-
}) & typeof
|
|
2243
|
+
}) & typeof GridProBaseDatasource;
|
|
2205
2244
|
|
|
2206
2245
|
/**
|
|
2207
2246
|
* The Grid Pro Template.
|
|
@@ -2223,6 +2262,37 @@ export declare const logger: Logger;
|
|
|
2223
2262
|
*/
|
|
2224
2263
|
export declare function mergeAndDedupColDefWithColumnState(colDefs: ColDef[], columnStates: ColumnState[]): ColDef[];
|
|
2225
2264
|
|
|
2265
|
+
/**
|
|
2266
|
+
* The AG Multiselect Editor element.
|
|
2267
|
+
* @public
|
|
2268
|
+
* @tagname %%prefix%%-multiselect-editor
|
|
2269
|
+
*/
|
|
2270
|
+
export declare class MultiselectEditor extends FoundationElement implements ICellEditorComp {
|
|
2271
|
+
params: MultiselectEditorParams;
|
|
2272
|
+
selectedOptions: any[];
|
|
2273
|
+
init(params: MultiselectEditorParams): void;
|
|
2274
|
+
getGui(): HTMLElement;
|
|
2275
|
+
destroy(): void;
|
|
2276
|
+
refresh(params: MultiselectEditorParams): boolean;
|
|
2277
|
+
getValue(): any[];
|
|
2278
|
+
isPopup(): boolean;
|
|
2279
|
+
changeHandler(event: any): void;
|
|
2280
|
+
}
|
|
2281
|
+
|
|
2282
|
+
/**
|
|
2283
|
+
* Parameters used to configure {@link MultiselectEditor}
|
|
2284
|
+
* @public
|
|
2285
|
+
*/
|
|
2286
|
+
export declare interface MultiselectEditorParams extends ICellEditorParams {
|
|
2287
|
+
allOptionsResourceName: string;
|
|
2288
|
+
selectedOptionsCallback: (data: any) => Promise<[]>;
|
|
2289
|
+
valueField: string;
|
|
2290
|
+
labelField: string;
|
|
2291
|
+
async: boolean;
|
|
2292
|
+
values: any[];
|
|
2293
|
+
datasourceOptions: DatasourceOptions[];
|
|
2294
|
+
}
|
|
2295
|
+
|
|
2226
2296
|
/**
|
|
2227
2297
|
* The AG Number Editor element.
|
|
2228
2298
|
* @public
|
|
@@ -2287,6 +2357,7 @@ export declare class SelectEditor extends FoundationElement implements ICellEdit
|
|
|
2287
2357
|
getValue(): string;
|
|
2288
2358
|
isPopup(): boolean;
|
|
2289
2359
|
afterGuiAttached(): void;
|
|
2360
|
+
changeHandler(event: any): void;
|
|
2290
2361
|
}
|
|
2291
2362
|
|
|
2292
2363
|
/**
|
|
@@ -2296,6 +2367,7 @@ export declare class SelectEditor extends FoundationElement implements ICellEdit
|
|
|
2296
2367
|
export declare interface SelectEditorParams extends ICellEditorParams {
|
|
2297
2368
|
allOptionsResourceName: string;
|
|
2298
2369
|
valueField: string;
|
|
2370
|
+
async: boolean;
|
|
2299
2371
|
labelField: string;
|
|
2300
2372
|
values: any[];
|
|
2301
2373
|
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
|
+
```
|
|
@@ -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) > [GridPro](./grid-pro.gridpro.md) > [gridProDatasource](./grid-pro.gridpro.gridprodatasource.md)
|
|
4
|
+
|
|
5
|
+
## GridPro.gridProDatasource property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
get gridProDatasource(): GridProBaseDatasource;
|
|
11
|
+
```
|
|
@@ -48,7 +48,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
|
|
|
48
48
|
| [gridComponents](./grid-pro.gridpro.gridcomponents.md) | | { \[componentName: string\]: any; } | |
|
|
49
49
|
| [gridFontFace](./grid-pro.gridpro.gridfontface.md) | | string | |
|
|
50
50
|
| [gridOptions](./grid-pro.gridpro.gridoptions.md) | | GridOptions | |
|
|
51
|
-
| [
|
|
51
|
+
| [gridProDatasource](./grid-pro.gridpro.gridprodatasource.md) | <code>readonly</code> | GridProBaseDatasource | |
|
|
52
52
|
| [gridSlot](./grid-pro.gridpro.gridslot.md) | | HTMLSlotElement | |
|
|
53
53
|
| [headerHeight](./grid-pro.gridpro.headerheight.md) | | number | |
|
|
54
54
|
| [initialised](./grid-pro.gridpro.initialised.md) | <code>protected</code> | boolean | |
|
|
@@ -22,23 +22,11 @@ Only supports Client-Side Row Model.
|
|
|
22
22
|
| Property | Modifiers | Type | Description |
|
|
23
23
|
| --- | --- | --- | --- |
|
|
24
24
|
| [auth](./grid-pro.gridprogenesisdatasource.auth.md) | | Auth | |
|
|
25
|
-
| [connect](./grid-pro.gridprogenesisdatasource.connect.md) | | Connect | |
|
|
26
|
-
| [criteria](./grid-pro.gridprogenesisdatasource.criteria.md) | | string | |
|
|
27
25
|
| [datasource](./grid-pro.gridprogenesisdatasource.datasource.md) | | Datasource | |
|
|
28
|
-
| [deferredColumnStates](./grid-pro.gridprogenesisdatasource.deferredcolumnstates.md) | | ColumnState\[\] | |
|
|
29
|
-
| [deferredGridOptions](./grid-pro.gridprogenesisdatasource.deferredgridoptions.md) | | GridOptions | |
|
|
30
26
|
| [disablePolling](./grid-pro.gridprogenesisdatasource.disablepolling.md) | | boolean | |
|
|
31
|
-
| [fields](./grid-pro.gridprogenesisdatasource.fields.md) | | string | |
|
|
32
|
-
| [isSnapshot](./grid-pro.gridprogenesisdatasource.issnapshot.md) | | boolean | |
|
|
33
|
-
| [maxRows](./grid-pro.gridprogenesisdatasource.maxrows.md) | | number | |
|
|
34
|
-
| [maxView](./grid-pro.gridprogenesisdatasource.maxview.md) | | number | |
|
|
35
|
-
| [movingView](./grid-pro.gridprogenesisdatasource.movingview.md) | | boolean | |
|
|
36
|
-
| [orderBy](./grid-pro.gridprogenesisdatasource.orderby.md) | | string | |
|
|
37
27
|
| [pollingInterval](./grid-pro.gridprogenesisdatasource.pollinginterval.md) | | number | |
|
|
38
28
|
| [request](./grid-pro.gridprogenesisdatasource.request.md) | | any | |
|
|
39
|
-
| [resourceName](./grid-pro.gridprogenesisdatasource.resourcename.md) | | string | |
|
|
40
29
|
| [restartOnReconnection](./grid-pro.gridprogenesisdatasource.restartonreconnection.md) | | boolean | |
|
|
41
|
-
| [reverse](./grid-pro.gridprogenesisdatasource.reverse.md) | | boolean | |
|
|
42
30
|
| [rowDataMapper](./grid-pro.gridprogenesisdatasource.rowdatamapper.md) | | Function | Allows grid data updates to be processed via and external function before applying in grid |
|
|
43
31
|
| [rowIdAttr](./grid-pro.gridprogenesisdatasource.rowidattr.md) | | any | <p>Attribute to set an unique identifier for the row.</p><p>Defaults to <code>ROW_REF</code> or <code>RECORD_ID</code> depending on the resource type.</p> |
|
|
44
32
|
|
|
@@ -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
|
+
```
|