@genesislcap/grid-pro 14.100.1-alpha-da50d69.0 → 14.101.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 +334 -4
- package/dist/dts/cell-editors/index.d.ts +2 -0
- package/dist/dts/cell-editors/index.d.ts.map +1 -0
- package/dist/dts/cell-editors/select.editor.d.ts +59 -0
- package/dist/dts/cell-editors/select.editor.d.ts.map +1 -0
- package/dist/dts/cell-renderers/boolean.renderer.d.ts +9 -10
- package/dist/dts/cell-renderers/boolean.renderer.d.ts.map +1 -1
- package/dist/dts/grid-components.d.ts +11 -2
- package/dist/dts/grid-components.d.ts.map +1 -1
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource-next.d.ts.map +1 -1
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +8 -13
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
- 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/dts/index.d.ts +1 -0
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/esm/cell-editors/index.js +1 -0
- package/dist/esm/cell-editors/select.editor.js +88 -0
- package/dist/esm/cell-renderers/boolean.renderer.js +49 -3
- package/dist/esm/grid-components.js +2 -0
- package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource-next.js +15 -9
- package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +9 -3
- package/dist/esm/grid-pro.js +20 -28
- package/dist/esm/grid-pro.types.js +1 -0
- package/dist/esm/index.js +1 -0
- package/dist/grid-pro.api.json +1010 -18
- package/dist/grid-pro.d.ts +100 -33
- package/docs/api/grid-pro.agselecteditorstyles.md +13 -0
- package/docs/api/grid-pro.booleanrenderer.changehandler.md +22 -0
- package/docs/api/grid-pro.booleanrenderer.getvalue.md +15 -0
- package/docs/api/grid-pro.booleanrenderer.init.md +2 -2
- package/docs/api/grid-pro.booleanrenderer.md +4 -1
- package/docs/api/grid-pro.booleanrenderer.params.md +1 -1
- package/docs/api/grid-pro.booleanrenderer.refresh.md +2 -2
- package/docs/api/grid-pro.booleanrenderer.selected.md +11 -0
- package/docs/api/grid-pro.foundationagbooleanrenderer.md +2 -2
- package/docs/api/grid-pro.foundationgridcomponents.md +11 -2
- package/docs/api/grid-pro.foundationselecteditor.md +24 -0
- package/docs/api/grid-pro.getagbooleanrenderertemplate.md +1 -1
- package/docs/api/grid-pro.getselecteditortemplate.md +13 -0
- package/docs/api/grid-pro.gridprorenderertypes.md +1 -0
- package/docs/api/grid-pro.md +10 -0
- package/docs/api/grid-pro.selecteditor.afterguiattached.md +15 -0
- package/docs/api/grid-pro.selecteditor.combobox.md +11 -0
- package/docs/api/grid-pro.selecteditor.destroy.md +15 -0
- package/docs/api/grid-pro.selecteditor.getgui.md +15 -0
- package/docs/api/grid-pro.selecteditor.getvalue.md +15 -0
- package/docs/api/grid-pro.selecteditor.init.md +22 -0
- package/docs/api/grid-pro.selecteditor.ispopup.md +15 -0
- package/docs/api/grid-pro.selecteditor.md +37 -0
- package/docs/api/grid-pro.selecteditor.params.md +11 -0
- package/docs/api/grid-pro.selecteditor.refresh.md +22 -0
- package/docs/api/grid-pro.selecteditor.value.md +11 -0
- package/docs/api/grid-pro.selecteditorparams.alloptionsresourcename.md +11 -0
- package/docs/api/grid-pro.selecteditorparams.datasourceoptions.md +11 -0
- package/docs/api/grid-pro.selecteditorparams.labelfield.md +11 -0
- package/docs/api/grid-pro.selecteditorparams.md +25 -0
- package/docs/api/grid-pro.selecteditorparams.valuefield.md +11 -0
- package/docs/api/grid-pro.selecteditorparams.values.md +11 -0
- package/docs/api-report.md +87 -14
- package/package.json +8 -8
package/dist/grid-pro.d.ts
CHANGED
|
@@ -11,6 +11,7 @@ import { Controller } from '@microsoft/fast-element';
|
|
|
11
11
|
import { CSSDesignToken } from '@microsoft/fast-foundation';
|
|
12
12
|
import { CSSVarTokenMap } from '@genesislcap/foundation-ui';
|
|
13
13
|
import { Datasource } from '@genesislcap/foundation-comms';
|
|
14
|
+
import { DatasourceOptions } from '@genesislcap/foundation-comms';
|
|
14
15
|
import { DOMContainer } from '@genesislcap/foundation-utils';
|
|
15
16
|
import { ElementStyles } from '@microsoft/fast-element';
|
|
16
17
|
import { FilteredDataServerResult } from '@genesislcap/foundation-comms';
|
|
@@ -20,6 +21,8 @@ import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
|
|
|
20
21
|
import { Grid } from '@ag-grid-community/core';
|
|
21
22
|
import type { GridApi } from '@ag-grid-community/core';
|
|
22
23
|
import type { GridOptions } from '@ag-grid-community/core';
|
|
24
|
+
import { ICellEditorComp } from '@ag-grid-community/core';
|
|
25
|
+
import { ICellEditorParams } from '@ag-grid-community/core';
|
|
23
26
|
import { ICellRendererComp } from '@ag-grid-community/core';
|
|
24
27
|
import { ICellRendererFunc } from '@ag-grid-community/core';
|
|
25
28
|
import { ICellRendererParams } from '@ag-grid-community/core';
|
|
@@ -226,6 +229,12 @@ export declare enum AgGridTheme {
|
|
|
226
229
|
*/
|
|
227
230
|
export declare const agHeadCSS: ElementStyles;
|
|
228
231
|
|
|
232
|
+
/**
|
|
233
|
+
* The AG Select Renderer Styles.
|
|
234
|
+
* @public
|
|
235
|
+
*/
|
|
236
|
+
export declare const agSelectEditorStyles: ElementStyles;
|
|
237
|
+
|
|
229
238
|
/**
|
|
230
239
|
* The AG Select Renderer Styles.
|
|
231
240
|
* @public
|
|
@@ -241,11 +250,11 @@ export declare const agSelectRendererStyles: ElementStyles;
|
|
|
241
250
|
export declare class AgTextFieldRenderer extends FoundationElement implements ICellRendererComp {
|
|
242
251
|
textField: TextField;
|
|
243
252
|
textValue: string;
|
|
244
|
-
params:
|
|
245
|
-
init(params:
|
|
253
|
+
params: FuiCellRendererParams;
|
|
254
|
+
init(params: FuiCellRendererParams): void;
|
|
246
255
|
getGui(): HTMLElement;
|
|
247
256
|
destroy(): void;
|
|
248
|
-
refresh(params:
|
|
257
|
+
refresh(params: FuiCellRendererParams): boolean;
|
|
249
258
|
/**
|
|
250
259
|
* On text change handler
|
|
251
260
|
* @param e - CustomEvent
|
|
@@ -366,11 +375,14 @@ export declare const backgroundSwatch: SwatchRGB;
|
|
|
366
375
|
* @tagname %%prefix%%-boolean-renderer
|
|
367
376
|
*/
|
|
368
377
|
export declare class BooleanRenderer extends FoundationElement implements ICellRendererComp {
|
|
369
|
-
params:
|
|
370
|
-
|
|
378
|
+
params: ICellRendererParams;
|
|
379
|
+
selected: boolean;
|
|
380
|
+
init(params: ICellRendererParams): void;
|
|
381
|
+
changeHandler(e: any): void;
|
|
371
382
|
getGui(): HTMLElement;
|
|
372
383
|
destroy(): void;
|
|
373
|
-
refresh(params:
|
|
384
|
+
refresh(params: ICellRendererParams): boolean;
|
|
385
|
+
getValue(): boolean;
|
|
374
386
|
}
|
|
375
387
|
|
|
376
388
|
/**
|
|
@@ -456,11 +468,11 @@ export declare function formatDateExtra(epoch: number): string;
|
|
|
456
468
|
export declare const foundationAgBooleanRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
457
469
|
baseName: string;
|
|
458
470
|
styles: ElementStyles;
|
|
459
|
-
template: ViewTemplate<
|
|
471
|
+
template: ViewTemplate<BooleanRenderer, any>;
|
|
460
472
|
}>) => FoundationElementRegistry< {
|
|
461
473
|
baseName: string;
|
|
462
474
|
styles: ElementStyles;
|
|
463
|
-
template: ViewTemplate<
|
|
475
|
+
template: ViewTemplate<BooleanRenderer, any>;
|
|
464
476
|
}, typeof BooleanRenderer>;
|
|
465
477
|
|
|
466
478
|
/**
|
|
@@ -540,11 +552,11 @@ export declare const foundationGridComponents: {
|
|
|
540
552
|
foundationAgBooleanRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
541
553
|
baseName: string;
|
|
542
554
|
styles: ElementStyles;
|
|
543
|
-
template: ViewTemplate<
|
|
555
|
+
template: ViewTemplate<BooleanRenderer, any>;
|
|
544
556
|
}>) => FoundationElementRegistry< {
|
|
545
557
|
baseName: string;
|
|
546
558
|
styles: ElementStyles;
|
|
547
|
-
template: ViewTemplate<
|
|
559
|
+
template: ViewTemplate<BooleanRenderer, any>;
|
|
548
560
|
}, BooleanRenderer>;
|
|
549
561
|
foundationAgTextRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
550
562
|
baseName: string;
|
|
@@ -584,6 +596,15 @@ export declare const foundationGridComponents: {
|
|
|
584
596
|
styles: ElementStyles;
|
|
585
597
|
template: ViewTemplate<any, any>;
|
|
586
598
|
}, GridPro>;
|
|
599
|
+
selectEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
600
|
+
baseName: string;
|
|
601
|
+
styles: ElementStyles;
|
|
602
|
+
template: ViewTemplate<SelectEditor, any>;
|
|
603
|
+
}>) => FoundationElementRegistry< {
|
|
604
|
+
baseName: string;
|
|
605
|
+
styles: ElementStyles;
|
|
606
|
+
template: ViewTemplate<SelectEditor, any>;
|
|
607
|
+
}, SelectEditor>;
|
|
587
608
|
register(container?: Container, ...rest: any[]): void;
|
|
588
609
|
};
|
|
589
610
|
|
|
@@ -653,13 +674,25 @@ export declare const foundationGridProShadowOptions: ShadowRootInit;
|
|
|
653
674
|
*/
|
|
654
675
|
export declare const foundationGridProStyles: ElementStyles;
|
|
655
676
|
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
677
|
+
/**
|
|
678
|
+
*
|
|
679
|
+
* @public
|
|
680
|
+
* @remarks
|
|
681
|
+
* HTML Element: \<foundation-select-editor\>
|
|
682
|
+
*/
|
|
683
|
+
export declare const foundationSelectEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
684
|
+
baseName: string;
|
|
685
|
+
styles: ElementStyles;
|
|
686
|
+
template: ViewTemplate<SelectEditor, any>;
|
|
687
|
+
}>) => FoundationElementRegistry< {
|
|
688
|
+
baseName: string;
|
|
689
|
+
styles: ElementStyles;
|
|
690
|
+
template: ViewTemplate<SelectEditor, any>;
|
|
691
|
+
}, typeof SelectEditor>;
|
|
659
692
|
|
|
660
|
-
declare interface
|
|
693
|
+
declare interface FuiCellRendererParams extends ICellRendererParams {
|
|
661
694
|
accessor?: string;
|
|
662
|
-
onChange?: (value: string, params:
|
|
695
|
+
onChange?: (value: string, params: FuiCellRendererParams) => void;
|
|
663
696
|
}
|
|
664
697
|
|
|
665
698
|
/**
|
|
@@ -703,7 +736,7 @@ export declare const getActionsMenuDef: (actions: ActionMenuItem[], overrideDef?
|
|
|
703
736
|
* @returns A Checkbox component template prefixed with the correct design system.
|
|
704
737
|
* @public
|
|
705
738
|
*/
|
|
706
|
-
export declare const getAgBooleanRendererTemplate: (designSystem?: string) => ViewTemplate<
|
|
739
|
+
export declare const getAgBooleanRendererTemplate: (designSystem?: string) => ViewTemplate<BooleanRenderer, any>;
|
|
707
740
|
|
|
708
741
|
/**
|
|
709
742
|
* Return a column type base on each field's metadata from the selected resource.
|
|
@@ -732,6 +765,14 @@ export declare function getFilterByFieldType(type: string): string;
|
|
|
732
765
|
*/
|
|
733
766
|
export declare function getFilterParamsByFieldType(type: string): any;
|
|
734
767
|
|
|
768
|
+
/**
|
|
769
|
+
* Get a Design System prefixed Select template.
|
|
770
|
+
* @param designSystem - The design system prefix to use. Defaults to 'foundation'.
|
|
771
|
+
* @returns A Select component template prefixed with the correct design system.
|
|
772
|
+
* @public
|
|
773
|
+
*/
|
|
774
|
+
export declare const getSelectEditorTemplate: (designSystem?: string) => ViewTemplate<SelectEditor, any>;
|
|
775
|
+
|
|
735
776
|
/**
|
|
736
777
|
* Get a Design System prefixed Select template.
|
|
737
778
|
* @param designSystem - The design system prefix to use. Defaults to 'foundation'.
|
|
@@ -1446,11 +1487,6 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
1446
1487
|
lang: string;
|
|
1447
1488
|
readonly offsetHeight: number;
|
|
1448
1489
|
readonly offsetLeft: number;
|
|
1449
|
-
/**
|
|
1450
|
-
* Returns the row id attribute, depending on the resource type.
|
|
1451
|
-
* @remarks Will favour the `row-id` attribute if set.
|
|
1452
|
-
* @internal
|
|
1453
|
-
*/
|
|
1454
1490
|
readonly offsetParent: Element;
|
|
1455
1491
|
readonly offsetTop: number;
|
|
1456
1492
|
readonly offsetWidth: number;
|
|
@@ -1485,13 +1521,12 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
1485
1521
|
scrollTop: number;
|
|
1486
1522
|
readonly scrollWidth: number;
|
|
1487
1523
|
readonly shadowRoot: ShadowRoot;
|
|
1488
|
-
/**
|
|
1489
|
-
* Resets the datasource to its initial state.
|
|
1490
|
-
* @public
|
|
1491
|
-
* @deprecated Use `deinit` instead
|
|
1492
|
-
*/
|
|
1493
1524
|
slot: string;
|
|
1494
|
-
readonly tagName: string;
|
|
1525
|
+
readonly tagName: string; /**
|
|
1526
|
+
* Resets the datasource to its initial state.
|
|
1527
|
+
* @public
|
|
1528
|
+
* @deprecated Use `deinit` instead
|
|
1529
|
+
*/
|
|
1495
1530
|
attachShadow(init: ShadowRootInit): ShadowRoot;
|
|
1496
1531
|
closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
|
|
1497
1532
|
closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
|
|
@@ -1517,11 +1552,6 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
1517
1552
|
insertAdjacentElement(where: InsertPosition, element: Element): Element;
|
|
1518
1553
|
insertAdjacentHTML(position: InsertPosition, text: string): void;
|
|
1519
1554
|
insertAdjacentText(where: InsertPosition, data: string): void;
|
|
1520
|
-
/**
|
|
1521
|
-
* Sets the columnDefs and rowData for the grid.
|
|
1522
|
-
* @remarks This should only happen once, when the grid is first initialized. Follow up updates will use the agTransaction.
|
|
1523
|
-
* @internal
|
|
1524
|
-
*/
|
|
1525
1555
|
matches(selectors: string): boolean;
|
|
1526
1556
|
releasePointerCapture(pointerId: number): void;
|
|
1527
1557
|
removeAttribute(qualifiedName: string): void;
|
|
@@ -1674,6 +1704,12 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
1674
1704
|
onchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1675
1705
|
onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1676
1706
|
onclose: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1707
|
+
/**
|
|
1708
|
+
* Maps the transaction data to the row data mapper function, if it exists.
|
|
1709
|
+
* @param transaction - The transaction data to be mapped.
|
|
1710
|
+
* @param operations - The operations to be mapped. Can be 'add', 'update' or 'remove'.
|
|
1711
|
+
* @returns The mapped transaction (if the row data mapper function exists), or the original transaction.
|
|
1712
|
+
*/
|
|
1677
1713
|
oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1678
1714
|
oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1679
1715
|
ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
@@ -1768,7 +1804,8 @@ export declare enum GridProRendererTypes {
|
|
|
1768
1804
|
actionsMenu = "actionsMenu",
|
|
1769
1805
|
boolean = "boolean",
|
|
1770
1806
|
text = "text",
|
|
1771
|
-
select = "select"
|
|
1807
|
+
select = "select",
|
|
1808
|
+
selectEditor = "selectEditor"
|
|
1772
1809
|
}
|
|
1773
1810
|
|
|
1774
1811
|
/**
|
|
@@ -2170,6 +2207,36 @@ declare interface SelectCellRendererParams extends ICellRendererParams {
|
|
|
2170
2207
|
onSelect: (value: string, params: SelectCellRendererParams) => void;
|
|
2171
2208
|
}
|
|
2172
2209
|
|
|
2210
|
+
/**
|
|
2211
|
+
* The AG Select Editor element.
|
|
2212
|
+
* @public
|
|
2213
|
+
* @tagname %%prefix%%-select-editor
|
|
2214
|
+
*/
|
|
2215
|
+
export declare class SelectEditor extends FoundationElement implements ICellEditorComp {
|
|
2216
|
+
params: SelectEditorParams;
|
|
2217
|
+
value: string;
|
|
2218
|
+
combobox: any;
|
|
2219
|
+
init(params: SelectEditorParams): void;
|
|
2220
|
+
getGui(): HTMLElement;
|
|
2221
|
+
destroy(): void;
|
|
2222
|
+
refresh(params: SelectEditorParams): boolean;
|
|
2223
|
+
getValue(): string;
|
|
2224
|
+
isPopup(): boolean;
|
|
2225
|
+
afterGuiAttached(): void;
|
|
2226
|
+
}
|
|
2227
|
+
|
|
2228
|
+
/**
|
|
2229
|
+
* Parameters used to configure {@link SelectEditor}
|
|
2230
|
+
* @public
|
|
2231
|
+
*/
|
|
2232
|
+
export declare interface SelectEditorParams extends ICellEditorParams {
|
|
2233
|
+
allOptionsResourceName: string;
|
|
2234
|
+
valueField: string;
|
|
2235
|
+
labelField: string;
|
|
2236
|
+
values: any[];
|
|
2237
|
+
datasourceOptions: DatasourceOptions[];
|
|
2238
|
+
}
|
|
2239
|
+
|
|
2173
2240
|
declare interface SelectOptions {
|
|
2174
2241
|
name: string;
|
|
2175
2242
|
displayName: string;
|
|
@@ -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) > [agSelectEditorStyles](./grid-pro.agselecteditorstyles.md)
|
|
4
|
+
|
|
5
|
+
## agSelectEditorStyles variable
|
|
6
|
+
|
|
7
|
+
The AG Select Renderer Styles.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
agSelectEditorStyles: import("@microsoft/fast-element").ElementStyles
|
|
13
|
+
```
|
|
@@ -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) > [BooleanRenderer](./grid-pro.booleanrenderer.md) > [changeHandler](./grid-pro.booleanrenderer.changehandler.md)
|
|
4
|
+
|
|
5
|
+
## BooleanRenderer.changeHandler() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
changeHandler(e: any): void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| e | 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) > [BooleanRenderer](./grid-pro.booleanrenderer.md) > [getValue](./grid-pro.booleanrenderer.getvalue.md)
|
|
4
|
+
|
|
5
|
+
## BooleanRenderer.getValue() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
getValue(): boolean;
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
boolean
|
|
15
|
+
|
|
@@ -7,14 +7,14 @@
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
init(params:
|
|
10
|
+
init(params: ICellRendererParams): void;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
15
|
| Parameter | Type | Description |
|
|
16
16
|
| --- | --- | --- |
|
|
17
|
-
| params |
|
|
17
|
+
| params | ICellRendererParams | |
|
|
18
18
|
|
|
19
19
|
**Returns:**
|
|
20
20
|
|
|
@@ -19,14 +19,17 @@ export declare class BooleanRenderer extends FoundationElement implements ICellR
|
|
|
19
19
|
|
|
20
20
|
| Property | Modifiers | Type | Description |
|
|
21
21
|
| --- | --- | --- | --- |
|
|
22
|
-
| [params](./grid-pro.booleanrenderer.params.md) | |
|
|
22
|
+
| [params](./grid-pro.booleanrenderer.params.md) | | ICellRendererParams | |
|
|
23
|
+
| [selected](./grid-pro.booleanrenderer.selected.md) | | boolean | |
|
|
23
24
|
|
|
24
25
|
## Methods
|
|
25
26
|
|
|
26
27
|
| Method | Modifiers | Description |
|
|
27
28
|
| --- | --- | --- |
|
|
29
|
+
| [changeHandler(e)](./grid-pro.booleanrenderer.changehandler.md) | | |
|
|
28
30
|
| [destroy()](./grid-pro.booleanrenderer.destroy.md) | | |
|
|
29
31
|
| [getGui()](./grid-pro.booleanrenderer.getgui.md) | | |
|
|
32
|
+
| [getValue()](./grid-pro.booleanrenderer.getvalue.md) | | |
|
|
30
33
|
| [init(params)](./grid-pro.booleanrenderer.init.md) | | |
|
|
31
34
|
| [refresh(params)](./grid-pro.booleanrenderer.refresh.md) | | |
|
|
32
35
|
|
|
@@ -7,14 +7,14 @@
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
refresh(params:
|
|
10
|
+
refresh(params: ICellRendererParams): boolean;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
15
|
| Parameter | Type | Description |
|
|
16
16
|
| --- | --- | --- |
|
|
17
|
-
| params |
|
|
17
|
+
| params | ICellRendererParams | |
|
|
18
18
|
|
|
19
19
|
**Returns:**
|
|
20
20
|
|
|
@@ -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) > [BooleanRenderer](./grid-pro.booleanrenderer.md) > [selected](./grid-pro.booleanrenderer.selected.md)
|
|
4
|
+
|
|
5
|
+
## BooleanRenderer.selected property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
selected: boolean;
|
|
11
|
+
```
|
|
@@ -12,11 +12,11 @@ A function that returns a Foundation Boolean Renderer registration for configuri
|
|
|
12
12
|
foundationAgBooleanRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
13
13
|
baseName: string;
|
|
14
14
|
styles: import("@microsoft/fast-element").ElementStyles;
|
|
15
|
-
template: import("@microsoft/fast-element").ViewTemplate<
|
|
15
|
+
template: import("@microsoft/fast-element").ViewTemplate<BooleanRenderer, any>;
|
|
16
16
|
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
17
17
|
baseName: string;
|
|
18
18
|
styles: import("@microsoft/fast-element").ElementStyles;
|
|
19
|
-
template: import("@microsoft/fast-element").ViewTemplate<
|
|
19
|
+
template: import("@microsoft/fast-element").ViewTemplate<BooleanRenderer, any>;
|
|
20
20
|
}, typeof BooleanRenderer>
|
|
21
21
|
```
|
|
22
22
|
|
|
@@ -29,11 +29,11 @@ foundationGridComponents: {
|
|
|
29
29
|
foundationAgBooleanRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
30
30
|
baseName: string;
|
|
31
31
|
styles: import("@microsoft/fast-element").ElementStyles;
|
|
32
|
-
template: import("@microsoft/fast-element").ViewTemplate<
|
|
32
|
+
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").BooleanRenderer, any>;
|
|
33
33
|
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
34
34
|
baseName: string;
|
|
35
35
|
styles: import("@microsoft/fast-element").ElementStyles;
|
|
36
|
-
template: import("@microsoft/fast-element").ViewTemplate<
|
|
36
|
+
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").BooleanRenderer, any>;
|
|
37
37
|
}, typeof import("./cell-renderers").BooleanRenderer>;
|
|
38
38
|
foundationAgTextRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
39
39
|
baseName: string;
|
|
@@ -73,6 +73,15 @@ 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<{
|
|
77
|
+
baseName: string;
|
|
78
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
79
|
+
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").SelectEditor, any>;
|
|
80
|
+
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
81
|
+
baseName: string;
|
|
82
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
83
|
+
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").SelectEditor, any>;
|
|
84
|
+
}, typeof import("./cell-editors").SelectEditor>;
|
|
76
85
|
register(container?: Container, ...rest: any[]): void;
|
|
77
86
|
}
|
|
78
87
|
```
|
|
@@ -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) > [foundationSelectEditor](./grid-pro.foundationselecteditor.md)
|
|
4
|
+
|
|
5
|
+
## foundationSelectEditor variable
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
foundationSelectEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
11
|
+
baseName: string;
|
|
12
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
13
|
+
template: import("@microsoft/fast-element").ViewTemplate<SelectEditor, any>;
|
|
14
|
+
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
15
|
+
baseName: string;
|
|
16
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
17
|
+
template: import("@microsoft/fast-element").ViewTemplate<SelectEditor, any>;
|
|
18
|
+
}, typeof SelectEditor>
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Remarks
|
|
22
|
+
|
|
23
|
+
HTML Element: <<!-- -->foundation-select-editor<!-- -->>
|
|
24
|
+
|
|
@@ -9,5 +9,5 @@ Get a Design System prefixed Checkbox template.
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
getAgBooleanRendererTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<
|
|
12
|
+
getAgBooleanRendererTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<BooleanRenderer, any>
|
|
13
13
|
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [getSelectEditorTemplate](./grid-pro.getselecteditortemplate.md)
|
|
4
|
+
|
|
5
|
+
## getSelectEditorTemplate variable
|
|
6
|
+
|
|
7
|
+
Get a Design System prefixed Select template.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getSelectEditorTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate<SelectEditor, any>
|
|
13
|
+
```
|
|
@@ -20,5 +20,6 @@ export declare enum GridProRendererTypes
|
|
|
20
20
|
| actionsMenu | <code>"actionsMenu"</code> | |
|
|
21
21
|
| boolean | <code>"boolean"</code> | |
|
|
22
22
|
| select | <code>"select"</code> | |
|
|
23
|
+
| selectEditor | <code>"selectEditor"</code> | |
|
|
23
24
|
| text | <code>"text"</code> | |
|
|
24
25
|
|
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
|
+
| [SelectEditor](./grid-pro.selecteditor.md) | The AG Select Editor element. |
|
|
21
22
|
| [SelectRenderer](./grid-pro.selectrenderer.md) | The AG Select Renderer element. |
|
|
22
23
|
|
|
23
24
|
## Enumerations
|
|
@@ -37,6 +38,12 @@
|
|
|
37
38
|
| [gridProColumns(itemsBinding, includeRenderers)](./grid-pro.gridprocolumns.md) | A directive that renders a set of grid-pro-column elements from a given input binding |
|
|
38
39
|
| [mergeAndDedupColDefWithColumnState(colDefs, columnStates)](./grid-pro.mergeanddedupcoldefwithcolumnstate.md) | Merges two arrays, one of <code>ColDef</code> and one of <code>ColumnState</code>, and deduplicates them. |
|
|
39
40
|
|
|
41
|
+
## Interfaces
|
|
42
|
+
|
|
43
|
+
| Interface | Description |
|
|
44
|
+
| --- | --- |
|
|
45
|
+
| [SelectEditorParams](./grid-pro.selecteditorparams.md) | Parameters used to configure [SelectEditor](./grid-pro.selecteditor.md) |
|
|
46
|
+
|
|
40
47
|
## Variables
|
|
41
48
|
|
|
42
49
|
| Variable | Description |
|
|
@@ -50,6 +57,7 @@
|
|
|
50
57
|
| [agGridCSS](./grid-pro.aggridcss.md) | AG Grid core CSS. |
|
|
51
58
|
| [agGridMaterialFontFace](./grid-pro.aggridmaterialfontface.md) | The AG Material font face used on ag-theme-material Grid Pro theme. |
|
|
52
59
|
| [agHeadCSS](./grid-pro.agheadcss.md) | Custom Drag n Drop CSS for Grid Pro. |
|
|
60
|
+
| [agSelectEditorStyles](./grid-pro.agselecteditorstyles.md) | The AG Select Renderer Styles. |
|
|
53
61
|
| [agSelectRendererStyles](./grid-pro.agselectrendererstyles.md) | The AG Select Renderer Styles. |
|
|
54
62
|
| [agThemeAlpineNofontsCSS](./grid-pro.agthemealpinenofontscss.md) | AG Alpine Theme (no fonts) CSS. |
|
|
55
63
|
| [agThemeBalhamNofontsCSS](./grid-pro.agthemebalhamnofontscss.md) | AG Balham Theme (no fonts) CSS. |
|
|
@@ -73,8 +81,10 @@
|
|
|
73
81
|
| [foundationGridProActionsMenuRenderer](./grid-pro.foundationgridproactionsmenurenderer.md) | A function that returns a Foundation Actions Menu for configuring the component with a DesignSystem. |
|
|
74
82
|
| [foundationGridProShadowOptions](./grid-pro.foundationgridproshadowoptions.md) | GridPro shadow root options. |
|
|
75
83
|
| [foundationGridProStyles](./grid-pro.foundationgridprostyles.md) | The Grid Pro styles. |
|
|
84
|
+
| [foundationSelectEditor](./grid-pro.foundationselecteditor.md) | |
|
|
76
85
|
| [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). |
|
|
77
86
|
| [getAgBooleanRendererTemplate](./grid-pro.getagbooleanrenderertemplate.md) | Get a Design System prefixed Checkbox template. |
|
|
87
|
+
| [getSelectEditorTemplate](./grid-pro.getselecteditortemplate.md) | Get a Design System prefixed Select template. |
|
|
78
88
|
| [getSelectRendererTemplate](./grid-pro.getselectrenderertemplate.md) | Get a Design System prefixed Select template. |
|
|
79
89
|
| [getTextFieldRendererTemplate](./grid-pro.gettextfieldrenderertemplate.md) | Get a Design System prefixed Text Field template. |
|
|
80
90
|
| [getTextRendererTemplate](./grid-pro.gettextrenderertemplate.md) | |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [SelectEditor](./grid-pro.selecteditor.md) > [afterGuiAttached](./grid-pro.selecteditor.afterguiattached.md)
|
|
4
|
+
|
|
5
|
+
## SelectEditor.afterGuiAttached() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
afterGuiAttached(): void;
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
void
|
|
15
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [SelectEditor](./grid-pro.selecteditor.md) > [combobox](./grid-pro.selecteditor.combobox.md)
|
|
4
|
+
|
|
5
|
+
## SelectEditor.combobox property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
combobox: any;
|
|
11
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [SelectEditor](./grid-pro.selecteditor.md) > [destroy](./grid-pro.selecteditor.destroy.md)
|
|
4
|
+
|
|
5
|
+
## SelectEditor.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) > [SelectEditor](./grid-pro.selecteditor.md) > [getGui](./grid-pro.selecteditor.getgui.md)
|
|
4
|
+
|
|
5
|
+
## SelectEditor.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) > [SelectEditor](./grid-pro.selecteditor.md) > [getValue](./grid-pro.selecteditor.getvalue.md)
|
|
4
|
+
|
|
5
|
+
## SelectEditor.getValue() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
getValue(): string;
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
string
|
|
15
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [SelectEditor](./grid-pro.selecteditor.md) > [init](./grid-pro.selecteditor.init.md)
|
|
4
|
+
|
|
5
|
+
## SelectEditor.init() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
init(params: SelectEditorParams): void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| params | [SelectEditorParams](./grid-pro.selecteditorparams.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) > [SelectEditor](./grid-pro.selecteditor.md) > [isPopup](./grid-pro.selecteditor.ispopup.md)
|
|
4
|
+
|
|
5
|
+
## SelectEditor.isPopup() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
isPopup(): boolean;
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
boolean
|
|
15
|
+
|