@genesislcap/grid-pro 14.108.0 → 14.109.1-alpha-cf055218219.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/custom-elements.json +691 -23
- package/dist/dts/cell-editors/date.editor.d.ts +5 -0
- package/dist/dts/cell-editors/date.editor.d.ts.map +1 -1
- package/dist/dts/cell-editors/index.d.ts +1 -0
- package/dist/dts/cell-editors/index.d.ts.map +1 -1
- package/dist/dts/cell-editors/multiselect.editor.d.ts +1 -0
- package/dist/dts/cell-editors/multiselect.editor.d.ts.map +1 -1
- package/dist/dts/cell-editors/number.editor.d.ts +2 -0
- package/dist/dts/cell-editors/number.editor.d.ts.map +1 -1
- package/dist/dts/cell-editors/select.editor.d.ts +2 -1
- package/dist/dts/cell-editors/select.editor.d.ts.map +1 -1
- package/dist/dts/cell-editors/string.editor.d.ts +56 -0
- package/dist/dts/cell-editors/string.editor.d.ts.map +1 -0
- package/dist/dts/cell-renderers/action.renderer.d.ts.map +1 -1
- package/dist/dts/cell-renderers/boolean.renderer.d.ts +1 -0
- package/dist/dts/cell-renderers/boolean.renderer.d.ts.map +1 -1
- package/dist/dts/cell-renderers/editable.renderer.d.ts +42 -0
- package/dist/dts/cell-renderers/editable.renderer.d.ts.map +1 -0
- package/dist/dts/cell-renderers/index.d.ts +1 -0
- package/dist/dts/cell-renderers/index.d.ts.map +1 -1
- package/dist/dts/grid-components.d.ts +18 -0
- package/dist/dts/grid-components.d.ts.map +1 -1
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
- package/dist/dts/grid-pro.d.ts +0 -6
- package/dist/dts/grid-pro.d.ts.map +1 -1
- package/dist/dts/grid-pro.types.d.ts +12 -0
- package/dist/dts/grid-pro.types.d.ts.map +1 -1
- package/dist/dts/index.d.ts +1 -0
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/tooltips/error-tooltip.d.ts +11 -0
- package/dist/dts/tooltips/error-tooltip.d.ts.map +1 -0
- package/dist/dts/tooltips/index.d.ts +2 -0
- package/dist/dts/tooltips/index.d.ts.map +1 -0
- package/dist/esm/cell-editors/date.editor.js +15 -2
- package/dist/esm/cell-editors/index.js +1 -0
- package/dist/esm/cell-editors/multiselect.editor.js +5 -10
- package/dist/esm/cell-editors/number.editor.js +9 -1
- package/dist/esm/cell-editors/select.editor.js +10 -12
- package/dist/esm/cell-editors/string.editor.js +86 -0
- package/dist/esm/cell-renderers/action.renderer.js +6 -0
- package/dist/esm/cell-renderers/boolean.renderer.js +4 -0
- package/dist/esm/cell-renderers/editable.renderer.js +60 -0
- package/dist/esm/cell-renderers/index.js +1 -0
- package/dist/esm/grid-components.js +4 -2
- package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +10 -6
- package/dist/esm/grid-pro.js +34 -3
- package/dist/esm/grid-pro.types.js +12 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/tooltips/error-tooltip.js +21 -0
- package/dist/esm/tooltips/index.js +1 -0
- package/dist/grid-pro.api.json +2314 -670
- package/dist/grid-pro.d.ts +156 -7
- package/docs/api/grid-pro.ageditablerendererstyles.md +13 -0
- package/docs/api/grid-pro.agstringeditorstyles.md +13 -0
- package/docs/api/grid-pro.booleanrenderer.iscancelbeforestart.md +15 -0
- package/docs/api/grid-pro.booleanrenderer.md +1 -0
- package/docs/api/grid-pro.dateeditor.actualwidth.md +11 -0
- package/docs/api/grid-pro.dateeditor.afterguiattached.md +15 -0
- package/docs/api/grid-pro.dateeditor.input.md +11 -0
- package/docs/api/grid-pro.dateeditor.iscancelbeforestart.md +15 -0
- package/docs/api/grid-pro.dateeditor.md +5 -0
- package/docs/api/grid-pro.dateeditor.params.md +11 -0
- package/docs/api/grid-pro.editablerenderer.getgui.md +15 -0
- package/docs/api/grid-pro.editablerenderer.init.md +22 -0
- package/docs/api/grid-pro.editablerenderer.md +31 -0
- package/docs/api/grid-pro.editablerenderer.refresh.md +22 -0
- package/docs/api/grid-pro.editablerenderer.valueformatted.md +11 -0
- package/docs/api/grid-pro.edited_column_field.md +13 -0
- package/docs/api/grid-pro.error_column_field.md +13 -0
- package/docs/api/grid-pro.foundationageditablerenderer.md +26 -0
- package/docs/api/grid-pro.foundationgridcomponents.md +18 -0
- package/docs/api/grid-pro.foundationstringeditor.md +24 -0
- package/docs/api/grid-pro.getageditablerenderertemplate.md +13 -0
- package/docs/api/grid-pro.getstringeditortemplate.md +13 -0
- package/docs/api/grid-pro.gridprorenderertypes.md +2 -0
- package/docs/api/grid-pro.md +11 -0
- package/docs/api/grid-pro.multiselecteditor.iscancelbeforestart.md +15 -0
- package/docs/api/grid-pro.multiselecteditor.md +1 -0
- package/docs/api/grid-pro.numbereditor.actualwidth.md +11 -0
- package/docs/api/grid-pro.numbereditor.iscancelbeforestart.md +15 -0
- package/docs/api/grid-pro.numbereditor.md +2 -0
- package/docs/api/grid-pro.selecteditor.actualwidth.md +11 -0
- package/docs/api/grid-pro.selecteditor.iscancelbeforestart.md +15 -0
- package/docs/api/grid-pro.selecteditor.md +2 -1
- package/docs/api/grid-pro.stringeditor.actualwidth.md +11 -0
- package/docs/api/grid-pro.stringeditor.afterguiattached.md +15 -0
- package/docs/api/grid-pro.stringeditor.changehandler.md +22 -0
- package/docs/api/grid-pro.stringeditor.getgui.md +15 -0
- package/docs/api/grid-pro.stringeditor.getvalue.md +15 -0
- package/docs/api/grid-pro.stringeditor.init.md +22 -0
- package/docs/api/grid-pro.stringeditor.input.md +11 -0
- package/docs/api/grid-pro.stringeditor.iscancelbeforestart.md +15 -0
- package/docs/api/{grid-pro.selecteditor.destroy.md → grid-pro.stringeditor.ispopup.md} +4 -4
- package/docs/api/grid-pro.stringeditor.md +39 -0
- package/docs/api/grid-pro.stringeditor.params.md +11 -0
- package/docs/api/grid-pro.stringeditor.refresh.md +22 -0
- package/docs/api/grid-pro.stringeditor.value.md +11 -0
- package/docs/api/grid-pro.stringeditorparams.md +21 -0
- package/docs/api/grid-pro.stringeditorparams.placeholder.md +11 -0
- package/docs/api-report.md +142 -2
- package/package.json +8 -8
package/dist/grid-pro.d.ts
CHANGED
|
@@ -28,6 +28,8 @@ import { ICellRendererFunc } from '@ag-grid-community/core';
|
|
|
28
28
|
import { ICellRendererParams } from '@ag-grid-community/core';
|
|
29
29
|
import type { IServerSideDatasource } from '@ag-grid-community/core';
|
|
30
30
|
import type { IServerSideGetRowsParams } from '@ag-grid-community/core';
|
|
31
|
+
import { ITooltipComp } from '@ag-grid-community/core';
|
|
32
|
+
import { ITooltipParams } from '@ag-grid-community/core';
|
|
31
33
|
import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
|
|
32
34
|
import { Logger } from '@genesislcap/foundation-logger';
|
|
33
35
|
import { MetadataDetail } from '@genesislcap/foundation-comms';
|
|
@@ -133,6 +135,12 @@ export declare const agBooleanRendererStyles: ElementStyles;
|
|
|
133
135
|
*/
|
|
134
136
|
export declare const agDateEditorStyles: ElementStyles;
|
|
135
137
|
|
|
138
|
+
/**
|
|
139
|
+
* The AG Editable Renderer Styles.
|
|
140
|
+
* @public
|
|
141
|
+
*/
|
|
142
|
+
export declare const agEditableRendererStyles: ElementStyles;
|
|
143
|
+
|
|
136
144
|
/**
|
|
137
145
|
* All External AG Grid Stock in one CSS.
|
|
138
146
|
* @remarks This is a collection of multiple AG themes, only needed if the target element needs more than one stock theme.
|
|
@@ -259,6 +267,12 @@ export declare const agSelectEditorStyles: ElementStyles;
|
|
|
259
267
|
*/
|
|
260
268
|
export declare const agSelectRendererStyles: ElementStyles;
|
|
261
269
|
|
|
270
|
+
/**
|
|
271
|
+
* The AG String Renderer Styles.
|
|
272
|
+
* @public
|
|
273
|
+
*/
|
|
274
|
+
export declare const agStringEditorStyles: ElementStyles;
|
|
275
|
+
|
|
262
276
|
/**
|
|
263
277
|
* The AG Text Field Renderer element.
|
|
264
278
|
* @public
|
|
@@ -401,6 +415,7 @@ export declare class BooleanRenderer extends FoundationElement implements ICellR
|
|
|
401
415
|
destroy(): void;
|
|
402
416
|
refresh(params: ICellRendererParams): boolean;
|
|
403
417
|
getValue(): boolean;
|
|
418
|
+
isCancelBeforeStart(): boolean;
|
|
404
419
|
}
|
|
405
420
|
|
|
406
421
|
/**
|
|
@@ -430,7 +445,10 @@ export declare const convertToKebabCase: (value: string) => string;
|
|
|
430
445
|
*/
|
|
431
446
|
export declare class DateEditor extends FoundationElement implements ICellEditorComp {
|
|
432
447
|
value: number;
|
|
448
|
+
actualWidth: number;
|
|
449
|
+
params: DateEditorParams;
|
|
433
450
|
dateFormat: string;
|
|
451
|
+
input: any;
|
|
434
452
|
inputType: 'datetime-local' | 'date';
|
|
435
453
|
init(params: DateEditorParams): void;
|
|
436
454
|
getGui(): HTMLElement;
|
|
@@ -438,6 +456,8 @@ export declare class DateEditor extends FoundationElement implements ICellEditor
|
|
|
438
456
|
getValue(): number;
|
|
439
457
|
isPopup(): boolean;
|
|
440
458
|
changeHandler(event: any): void;
|
|
459
|
+
afterGuiAttached(): void;
|
|
460
|
+
isCancelBeforeStart(): boolean;
|
|
441
461
|
}
|
|
442
462
|
|
|
443
463
|
/**
|
|
@@ -485,6 +505,40 @@ export declare const defaultGridProConfig: {
|
|
|
485
505
|
shadowOptions: any;
|
|
486
506
|
};
|
|
487
507
|
|
|
508
|
+
/**
|
|
509
|
+
* The AG Editable Renderer element.
|
|
510
|
+
* @public
|
|
511
|
+
* @tagname %%prefix%%-editable-renderer
|
|
512
|
+
*/
|
|
513
|
+
export declare class EditableRenderer extends FoundationElement implements ICellRendererComp {
|
|
514
|
+
valueFormatted: string;
|
|
515
|
+
init(params: ICellRendererParams): void;
|
|
516
|
+
getGui(): HTMLElement;
|
|
517
|
+
refresh(params: ICellRendererParams): boolean;
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
/**
|
|
521
|
+
* Key used to store currently edited column when it being synced with server side data
|
|
522
|
+
* @public
|
|
523
|
+
*/
|
|
524
|
+
export declare const EDITED_COLUMN_FIELD = "__editedColumn";
|
|
525
|
+
|
|
526
|
+
/**
|
|
527
|
+
* Key used to store error details (column, message) when inline edit fails sync with server side data
|
|
528
|
+
* @public
|
|
529
|
+
*/
|
|
530
|
+
export declare const ERROR_COLUMN_FIELD = "__errorColumn";
|
|
531
|
+
|
|
532
|
+
/**
|
|
533
|
+
* Tooltip for errors that happen while syncing data with server after inline editing
|
|
534
|
+
* @internal
|
|
535
|
+
*/
|
|
536
|
+
export declare class ErrorTooltip implements ITooltipComp {
|
|
537
|
+
private eGui;
|
|
538
|
+
init(params: ITooltipParams): void;
|
|
539
|
+
getGui(): HTMLElement;
|
|
540
|
+
}
|
|
541
|
+
|
|
488
542
|
/**
|
|
489
543
|
* The foreground color swatch.
|
|
490
544
|
* @internal
|
|
@@ -518,6 +572,23 @@ styles: ElementStyles;
|
|
|
518
572
|
template: ViewTemplate<BooleanRenderer, any>;
|
|
519
573
|
}, typeof BooleanRenderer>;
|
|
520
574
|
|
|
575
|
+
/**
|
|
576
|
+
* A function that returns a Foundation Editable Renderer registration for configuring the component with a DesignSystem.
|
|
577
|
+
*
|
|
578
|
+
* @public
|
|
579
|
+
* @remarks
|
|
580
|
+
* HTML Element: \<foundation-editable-renderer\>
|
|
581
|
+
*/
|
|
582
|
+
export declare const foundationAgEditableRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
583
|
+
baseName: string;
|
|
584
|
+
styles: ElementStyles;
|
|
585
|
+
template: ViewTemplate<EditableRenderer, any>;
|
|
586
|
+
}>) => FoundationElementRegistry< {
|
|
587
|
+
baseName: string;
|
|
588
|
+
styles: ElementStyles;
|
|
589
|
+
template: ViewTemplate<EditableRenderer, any>;
|
|
590
|
+
}, typeof EditableRenderer>;
|
|
591
|
+
|
|
521
592
|
/**
|
|
522
593
|
* A function that returns a Foundation Select Renderer registration for configuring the component with a DesignSystem.
|
|
523
594
|
*
|
|
@@ -635,6 +706,15 @@ export declare const foundationGridComponents: {
|
|
|
635
706
|
styles: ElementStyles;
|
|
636
707
|
template: ViewTemplate<AgTextFieldRenderer, any>;
|
|
637
708
|
}, AgTextFieldRenderer>;
|
|
709
|
+
foundationAgEditableRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
710
|
+
baseName: string;
|
|
711
|
+
styles: ElementStyles;
|
|
712
|
+
template: ViewTemplate<EditableRenderer, any>;
|
|
713
|
+
}>) => FoundationElementRegistry< {
|
|
714
|
+
baseName: string;
|
|
715
|
+
styles: ElementStyles;
|
|
716
|
+
template: ViewTemplate<EditableRenderer, any>;
|
|
717
|
+
}, EditableRenderer>;
|
|
638
718
|
foundationAgSelectRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
639
719
|
baseName: string;
|
|
640
720
|
styles: ElementStyles;
|
|
@@ -691,6 +771,15 @@ export declare const foundationGridComponents: {
|
|
|
691
771
|
styles: ElementStyles;
|
|
692
772
|
template: ViewTemplate<MultiselectEditor, any>;
|
|
693
773
|
}, MultiselectEditor>;
|
|
774
|
+
foundationStringEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
775
|
+
baseName: string;
|
|
776
|
+
styles: ElementStyles;
|
|
777
|
+
template: ViewTemplate<StringEditor, any>;
|
|
778
|
+
}>) => FoundationElementRegistry< {
|
|
779
|
+
baseName: string;
|
|
780
|
+
styles: ElementStyles;
|
|
781
|
+
template: ViewTemplate<StringEditor, any>;
|
|
782
|
+
}, StringEditor>;
|
|
694
783
|
register(container?: Container, ...rest: any[]): void;
|
|
695
784
|
};
|
|
696
785
|
|
|
@@ -808,6 +897,22 @@ styles: ElementStyles;
|
|
|
808
897
|
template: ViewTemplate<SelectEditor, any>;
|
|
809
898
|
}, typeof SelectEditor>;
|
|
810
899
|
|
|
900
|
+
/**
|
|
901
|
+
*
|
|
902
|
+
* @public
|
|
903
|
+
* @remarks
|
|
904
|
+
* HTML Element: \<foundation-string-editor\>
|
|
905
|
+
*/
|
|
906
|
+
export declare const foundationStringEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
907
|
+
baseName: string;
|
|
908
|
+
styles: ElementStyles;
|
|
909
|
+
template: ViewTemplate<StringEditor, any>;
|
|
910
|
+
}>) => FoundationElementRegistry< {
|
|
911
|
+
baseName: string;
|
|
912
|
+
styles: ElementStyles;
|
|
913
|
+
template: ViewTemplate<StringEditor, any>;
|
|
914
|
+
}, typeof StringEditor>;
|
|
915
|
+
|
|
811
916
|
declare interface FuiCellRendererParams extends ICellRendererParams {
|
|
812
917
|
accessor?: string;
|
|
813
918
|
onChange?: (value: string, params: FuiCellRendererParams) => void;
|
|
@@ -856,6 +961,14 @@ export declare const getActionsMenuDef: (actions: ActionMenuItem[], overrideDef?
|
|
|
856
961
|
*/
|
|
857
962
|
export declare const getAgBooleanRendererTemplate: (designSystem?: string) => ViewTemplate<BooleanRenderer, any>;
|
|
858
963
|
|
|
964
|
+
/**
|
|
965
|
+
* Get a Design System prefixed Checkbox template.
|
|
966
|
+
* @param designSystem - The design system prefix to use. Defaults to 'foundation'.
|
|
967
|
+
* @returns A Checkbox component template prefixed with the correct design system.
|
|
968
|
+
* @public
|
|
969
|
+
*/
|
|
970
|
+
export declare const getAgEditableRendererTemplate: (designSystem?: string) => ViewTemplate<EditableRenderer, any>;
|
|
971
|
+
|
|
859
972
|
/**
|
|
860
973
|
* Return a column type base on each field's metadata from the selected resource.
|
|
861
974
|
* @param metadataType - The type of the field/column
|
|
@@ -923,6 +1036,14 @@ export declare const getSelectEditorTemplate: (designSystem?: string) => ViewTem
|
|
|
923
1036
|
*/
|
|
924
1037
|
export declare const getSelectRendererTemplate: (designSystem?: string) => ViewTemplate<any, any>;
|
|
925
1038
|
|
|
1039
|
+
/**
|
|
1040
|
+
* Get a Design System prefixed String template.
|
|
1041
|
+
* @param designSystem - The design system prefix to use. Defaults to 'foundation'.
|
|
1042
|
+
* @returns A String component template prefixed with the correct design system.
|
|
1043
|
+
* @public
|
|
1044
|
+
*/
|
|
1045
|
+
export declare const getStringEditorTemplate: (designSystem?: string) => ViewTemplate<StringEditor, any>;
|
|
1046
|
+
|
|
926
1047
|
/**
|
|
927
1048
|
* Get a Design System prefixed Text Field template.
|
|
928
1049
|
* @param designSystem - The design system prefix to use. Defaults to 'foundation'.
|
|
@@ -1183,12 +1304,6 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1183
1304
|
removeAttributeNS(namespace: string, localName: string): void;
|
|
1184
1305
|
removeAttributeNode(attr: Attr): Attr;
|
|
1185
1306
|
requestFullscreen(options?: FullscreenOptions): Promise<void>;
|
|
1186
|
-
/**
|
|
1187
|
-
* Gets the saved grid ColumnState[] from local storage
|
|
1188
|
-
* @remarks This is used to restore the grid state when the grid is rehydrated
|
|
1189
|
-
* @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering.
|
|
1190
|
-
* @public
|
|
1191
|
-
*/
|
|
1192
1307
|
requestPointerLock(): void;
|
|
1193
1308
|
scroll(options?: ScrollToOptions): void;
|
|
1194
1309
|
scroll(x: number, y: number): void;
|
|
@@ -1944,11 +2059,13 @@ export declare enum GridProRendererTypes {
|
|
|
1944
2059
|
action = "action",
|
|
1945
2060
|
actionsMenu = "actionsMenu",
|
|
1946
2061
|
boolean = "boolean",
|
|
2062
|
+
editable = "editable",
|
|
1947
2063
|
text = "text",
|
|
1948
2064
|
select = "select",
|
|
1949
2065
|
dateEditor = "dateEditor",
|
|
1950
2066
|
selectEditor = "selectEditor",
|
|
1951
2067
|
numberEditor = "numberEditor",
|
|
2068
|
+
stringEditor = "stringEditor",
|
|
1952
2069
|
multiselectEditor = "multiselectEditor"
|
|
1953
2070
|
}
|
|
1954
2071
|
|
|
@@ -2340,6 +2457,7 @@ export declare class MultiselectEditor extends FoundationElement implements ICel
|
|
|
2340
2457
|
getValue(): any[];
|
|
2341
2458
|
isPopup(): boolean;
|
|
2342
2459
|
changeHandler(event: any): void;
|
|
2460
|
+
isCancelBeforeStart(): boolean;
|
|
2343
2461
|
}
|
|
2344
2462
|
|
|
2345
2463
|
/**
|
|
@@ -2364,6 +2482,7 @@ export declare interface MultiselectEditorParams extends ICellEditorParams {
|
|
|
2364
2482
|
export declare class NumberEditor extends FoundationElement implements ICellEditorComp {
|
|
2365
2483
|
params: NumberEditorParams;
|
|
2366
2484
|
value: number;
|
|
2485
|
+
actualWidth: number;
|
|
2367
2486
|
input: any;
|
|
2368
2487
|
init(params: NumberEditorParams): void;
|
|
2369
2488
|
getGui(): HTMLElement;
|
|
@@ -2372,6 +2491,7 @@ export declare class NumberEditor extends FoundationElement implements ICellEdit
|
|
|
2372
2491
|
isPopup(): boolean;
|
|
2373
2492
|
afterGuiAttached(): void;
|
|
2374
2493
|
changeHandler(event: any): void;
|
|
2494
|
+
isCancelBeforeStart(): boolean;
|
|
2375
2495
|
}
|
|
2376
2496
|
|
|
2377
2497
|
/**
|
|
@@ -2410,15 +2530,16 @@ declare interface SelectCellRendererParams extends ICellRendererParams {
|
|
|
2410
2530
|
export declare class SelectEditor extends FoundationElement implements ICellEditorComp {
|
|
2411
2531
|
params: SelectEditorParams;
|
|
2412
2532
|
value: string;
|
|
2533
|
+
actualWidth: number;
|
|
2413
2534
|
combobox: any;
|
|
2414
2535
|
init(params: SelectEditorParams): void;
|
|
2415
2536
|
getGui(): HTMLElement;
|
|
2416
|
-
destroy(): void;
|
|
2417
2537
|
refresh(params: SelectEditorParams): boolean;
|
|
2418
2538
|
getValue(): string;
|
|
2419
2539
|
isPopup(): boolean;
|
|
2420
2540
|
afterGuiAttached(): void;
|
|
2421
2541
|
changeHandler(event: any): void;
|
|
2542
|
+
isCancelBeforeStart(): boolean;
|
|
2422
2543
|
}
|
|
2423
2544
|
|
|
2424
2545
|
/**
|
|
@@ -2518,6 +2639,34 @@ export declare type StreamDatasourceOptions = {
|
|
|
2518
2639
|
pagination?: boolean;
|
|
2519
2640
|
};
|
|
2520
2641
|
|
|
2642
|
+
/**
|
|
2643
|
+
* The AG String Editor element.
|
|
2644
|
+
* @public
|
|
2645
|
+
* @tagname %%prefix%%-string-editor
|
|
2646
|
+
*/
|
|
2647
|
+
export declare class StringEditor extends FoundationElement implements ICellEditorComp {
|
|
2648
|
+
params: StringEditorParams;
|
|
2649
|
+
value: string;
|
|
2650
|
+
actualWidth: number;
|
|
2651
|
+
input: any;
|
|
2652
|
+
init(params: StringEditorParams): void;
|
|
2653
|
+
getGui(): HTMLElement;
|
|
2654
|
+
refresh(params: StringEditorParams): boolean;
|
|
2655
|
+
getValue(): string;
|
|
2656
|
+
isPopup(): boolean;
|
|
2657
|
+
afterGuiAttached(): void;
|
|
2658
|
+
changeHandler(event: any): void;
|
|
2659
|
+
isCancelBeforeStart(): boolean;
|
|
2660
|
+
}
|
|
2661
|
+
|
|
2662
|
+
/**
|
|
2663
|
+
* Parameters used to configure {@link StringEditor}
|
|
2664
|
+
* @public
|
|
2665
|
+
*/
|
|
2666
|
+
export declare interface StringEditorParams extends ICellEditorParams {
|
|
2667
|
+
placeholder: string;
|
|
2668
|
+
}
|
|
2669
|
+
|
|
2521
2670
|
/**
|
|
2522
2671
|
* The AG Text Field Renderer Styles.
|
|
2523
2672
|
* @public
|
|
@@ -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) > [agEditableRendererStyles](./grid-pro.ageditablerendererstyles.md)
|
|
4
|
+
|
|
5
|
+
## agEditableRendererStyles variable
|
|
6
|
+
|
|
7
|
+
The AG Editable Renderer Styles.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
agEditableRendererStyles: import("@microsoft/fast-element").ElementStyles
|
|
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) > [agStringEditorStyles](./grid-pro.agstringeditorstyles.md)
|
|
4
|
+
|
|
5
|
+
## agStringEditorStyles variable
|
|
6
|
+
|
|
7
|
+
The AG String Renderer Styles.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
agStringEditorStyles: import("@microsoft/fast-element").ElementStyles
|
|
13
|
+
```
|
|
@@ -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) > [isCancelBeforeStart](./grid-pro.booleanrenderer.iscancelbeforestart.md)
|
|
4
|
+
|
|
5
|
+
## BooleanRenderer.isCancelBeforeStart() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
isCancelBeforeStart(): boolean;
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
boolean
|
|
15
|
+
|
|
@@ -31,5 +31,6 @@ export declare class BooleanRenderer extends FoundationElement implements ICellR
|
|
|
31
31
|
| [getGui()](./grid-pro.booleanrenderer.getgui.md) | | |
|
|
32
32
|
| [getValue()](./grid-pro.booleanrenderer.getvalue.md) | | |
|
|
33
33
|
| [init(params)](./grid-pro.booleanrenderer.init.md) | | |
|
|
34
|
+
| [isCancelBeforeStart()](./grid-pro.booleanrenderer.iscancelbeforestart.md) | | |
|
|
34
35
|
| [refresh(params)](./grid-pro.booleanrenderer.refresh.md) | | |
|
|
35
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) > [DateEditor](./grid-pro.dateeditor.md) > [actualWidth](./grid-pro.dateeditor.actualwidth.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor.actualWidth property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
actualWidth: number;
|
|
11
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [DateEditor](./grid-pro.dateeditor.md) > [afterGuiAttached](./grid-pro.dateeditor.afterguiattached.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor.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) > [DateEditor](./grid-pro.dateeditor.md) > [input](./grid-pro.dateeditor.input.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor.input property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
input: any;
|
|
11
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [DateEditor](./grid-pro.dateeditor.md) > [isCancelBeforeStart](./grid-pro.dateeditor.iscancelbeforestart.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor.isCancelBeforeStart() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
isCancelBeforeStart(): boolean;
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
boolean
|
|
15
|
+
|
|
@@ -19,18 +19,23 @@ export declare class DateEditor extends FoundationElement implements ICellEditor
|
|
|
19
19
|
|
|
20
20
|
| Property | Modifiers | Type | Description |
|
|
21
21
|
| --- | --- | --- | --- |
|
|
22
|
+
| [actualWidth](./grid-pro.dateeditor.actualwidth.md) | | number | |
|
|
22
23
|
| [dateFormat](./grid-pro.dateeditor.dateformat.md) | | string | |
|
|
24
|
+
| [input](./grid-pro.dateeditor.input.md) | | any | |
|
|
23
25
|
| [inputType](./grid-pro.dateeditor.inputtype.md) | | 'datetime-local' \| 'date' | |
|
|
26
|
+
| [params](./grid-pro.dateeditor.params.md) | | [DateEditorParams](./grid-pro.dateeditorparams.md) | |
|
|
24
27
|
| [value](./grid-pro.dateeditor.value.md) | | number | |
|
|
25
28
|
|
|
26
29
|
## Methods
|
|
27
30
|
|
|
28
31
|
| Method | Modifiers | Description |
|
|
29
32
|
| --- | --- | --- |
|
|
33
|
+
| [afterGuiAttached()](./grid-pro.dateeditor.afterguiattached.md) | | |
|
|
30
34
|
| [changeHandler(event)](./grid-pro.dateeditor.changehandler.md) | | |
|
|
31
35
|
| [getGui()](./grid-pro.dateeditor.getgui.md) | | |
|
|
32
36
|
| [getValue()](./grid-pro.dateeditor.getvalue.md) | | |
|
|
33
37
|
| [init(params)](./grid-pro.dateeditor.init.md) | | |
|
|
38
|
+
| [isCancelBeforeStart()](./grid-pro.dateeditor.iscancelbeforestart.md) | | |
|
|
34
39
|
| [isPopup()](./grid-pro.dateeditor.ispopup.md) | | |
|
|
35
40
|
| [refresh(params)](./grid-pro.dateeditor.refresh.md) | | |
|
|
36
41
|
|
|
@@ -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) > [DateEditor](./grid-pro.dateeditor.md) > [params](./grid-pro.dateeditor.params.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor.params property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
params: DateEditorParams;
|
|
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) > [EditableRenderer](./grid-pro.editablerenderer.md) > [getGui](./grid-pro.editablerenderer.getgui.md)
|
|
4
|
+
|
|
5
|
+
## EditableRenderer.getGui() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
getGui(): HTMLElement;
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
HTMLElement
|
|
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) > [EditableRenderer](./grid-pro.editablerenderer.md) > [init](./grid-pro.editablerenderer.init.md)
|
|
4
|
+
|
|
5
|
+
## EditableRenderer.init() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
init(params: ICellRendererParams): void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| params | ICellRendererParams | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
void
|
|
22
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [EditableRenderer](./grid-pro.editablerenderer.md)
|
|
4
|
+
|
|
5
|
+
## EditableRenderer class
|
|
6
|
+
|
|
7
|
+
The AG Editable Renderer element.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare class EditableRenderer extends FoundationElement implements ICellRendererComp
|
|
13
|
+
```
|
|
14
|
+
**Extends:** FoundationElement
|
|
15
|
+
|
|
16
|
+
**Implements:** ICellRendererComp
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
| Property | Modifiers | Type | Description |
|
|
21
|
+
| --- | --- | --- | --- |
|
|
22
|
+
| [valueFormatted](./grid-pro.editablerenderer.valueformatted.md) | | string | |
|
|
23
|
+
|
|
24
|
+
## Methods
|
|
25
|
+
|
|
26
|
+
| Method | Modifiers | Description |
|
|
27
|
+
| --- | --- | --- |
|
|
28
|
+
| [getGui()](./grid-pro.editablerenderer.getgui.md) | | |
|
|
29
|
+
| [init(params)](./grid-pro.editablerenderer.init.md) | | |
|
|
30
|
+
| [refresh(params)](./grid-pro.editablerenderer.refresh.md) | | |
|
|
31
|
+
|
|
@@ -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) > [EditableRenderer](./grid-pro.editablerenderer.md) > [refresh](./grid-pro.editablerenderer.refresh.md)
|
|
4
|
+
|
|
5
|
+
## EditableRenderer.refresh() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
refresh(params: ICellRendererParams): boolean;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| params | ICellRendererParams | |
|
|
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) > [EditableRenderer](./grid-pro.editablerenderer.md) > [valueFormatted](./grid-pro.editablerenderer.valueformatted.md)
|
|
4
|
+
|
|
5
|
+
## EditableRenderer.valueFormatted property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
valueFormatted: string;
|
|
11
|
+
```
|
|
@@ -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) > [EDITED\_COLUMN\_FIELD](./grid-pro.edited_column_field.md)
|
|
4
|
+
|
|
5
|
+
## EDITED\_COLUMN\_FIELD variable
|
|
6
|
+
|
|
7
|
+
Key used to store currently edited column when it being synced with server side data
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
EDITED_COLUMN_FIELD = "__editedColumn"
|
|
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) > [ERROR\_COLUMN\_FIELD](./grid-pro.error_column_field.md)
|
|
4
|
+
|
|
5
|
+
## ERROR\_COLUMN\_FIELD variable
|
|
6
|
+
|
|
7
|
+
Key used to store error details (column, message) when inline edit fails sync with server side data
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
ERROR_COLUMN_FIELD = "__errorColumn"
|
|
13
|
+
```
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [foundationAgEditableRenderer](./grid-pro.foundationageditablerenderer.md)
|
|
4
|
+
|
|
5
|
+
## foundationAgEditableRenderer variable
|
|
6
|
+
|
|
7
|
+
A function that returns a Foundation Editable Renderer registration for configuring the component with a DesignSystem.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
foundationAgEditableRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
13
|
+
baseName: string;
|
|
14
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
15
|
+
template: import("@microsoft/fast-element").ViewTemplate<EditableRenderer, any>;
|
|
16
|
+
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
17
|
+
baseName: string;
|
|
18
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
19
|
+
template: import("@microsoft/fast-element").ViewTemplate<EditableRenderer, any>;
|
|
20
|
+
}, typeof EditableRenderer>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Remarks
|
|
24
|
+
|
|
25
|
+
HTML Element: <<!-- -->foundation-editable-renderer<!-- -->>
|
|
26
|
+
|
|
@@ -53,6 +53,15 @@ foundationGridComponents: {
|
|
|
53
53
|
styles: import("@microsoft/fast-element").ElementStyles;
|
|
54
54
|
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").AgTextFieldRenderer, any>;
|
|
55
55
|
}, typeof import("./cell-renderers").AgTextFieldRenderer>;
|
|
56
|
+
foundationAgEditableRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
57
|
+
baseName: string;
|
|
58
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
59
|
+
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").EditableRenderer, any>;
|
|
60
|
+
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
61
|
+
baseName: string;
|
|
62
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
63
|
+
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-renderers").EditableRenderer, any>;
|
|
64
|
+
}, typeof import("./cell-renderers").EditableRenderer>;
|
|
56
65
|
foundationAgSelectRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
57
66
|
baseName: string;
|
|
58
67
|
styles: import("@microsoft/fast-element").ElementStyles;
|
|
@@ -109,6 +118,15 @@ foundationGridComponents: {
|
|
|
109
118
|
styles: import("@microsoft/fast-element").ElementStyles;
|
|
110
119
|
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").MultiselectEditor, any>;
|
|
111
120
|
}, typeof import("./cell-editors").MultiselectEditor>;
|
|
121
|
+
foundationStringEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
122
|
+
baseName: string;
|
|
123
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
124
|
+
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").StringEditor, any>;
|
|
125
|
+
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
126
|
+
baseName: string;
|
|
127
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
128
|
+
template: import("@microsoft/fast-element").ViewTemplate<import("./cell-editors").StringEditor, any>;
|
|
129
|
+
}, typeof import("./cell-editors").StringEditor>;
|
|
112
130
|
register(container?: Container, ...rest: any[]): void;
|
|
113
131
|
}
|
|
114
132
|
```
|