@genesislcap/grid-pro 14.106.1 → 14.107.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 +288 -16
- package/dist/dts/cell-editors/date.editor.d.ts +53 -0
- package/dist/dts/cell-editors/date.editor.d.ts.map +1 -0
- 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/number.editor.d.ts +0 -2
- package/dist/dts/cell-editors/number.editor.d.ts.map +1 -1
- package/dist/dts/grid-components.d.ts +9 -0
- package/dist/dts/grid-components.d.ts.map +1 -1
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +1 -5
- package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
- package/dist/dts/grid-pro.d.ts +4 -4
- package/dist/dts/grid-pro.d.ts.map +1 -1
- package/dist/dts/grid-pro.types.d.ts +1 -0
- package/dist/dts/grid-pro.types.d.ts.map +1 -1
- package/dist/esm/cell-editors/date.editor.js +73 -0
- package/dist/esm/cell-editors/index.js +1 -0
- package/dist/esm/cell-editors/number.editor.js +0 -4
- package/dist/esm/grid-components.js +2 -1
- package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +5 -0
- package/dist/esm/grid-pro.js +2 -2
- package/dist/esm/grid-pro.types.js +1 -0
- package/dist/grid-pro.api.json +842 -194
- package/dist/grid-pro.d.ts +70 -11
- package/docs/api/grid-pro.agdateeditorstyles.md +13 -0
- package/docs/api/grid-pro.dateeditor.changehandler.md +22 -0
- package/docs/api/grid-pro.dateeditor.dateformat.md +11 -0
- package/docs/api/grid-pro.dateeditor.getgui.md +15 -0
- package/docs/api/{grid-pro.numbereditor.destroy.md → grid-pro.dateeditor.getvalue.md} +4 -4
- package/docs/api/grid-pro.dateeditor.init.md +22 -0
- package/docs/api/grid-pro.dateeditor.inputtype.md +11 -0
- package/docs/api/{grid-pro.numbereditor.focus.md → grid-pro.dateeditor.ispopup.md} +4 -4
- package/docs/api/grid-pro.dateeditor.md +36 -0
- package/docs/api/grid-pro.dateeditor.refresh.md +22 -0
- package/docs/api/grid-pro.dateeditor.value.md +11 -0
- package/docs/api/grid-pro.dateeditorparams.md +21 -0
- package/docs/api/grid-pro.dateeditorparams.withtime.md +11 -0
- package/docs/api/grid-pro.foundationdateeditor.md +24 -0
- package/docs/api/grid-pro.foundationgridcomponents.md +9 -0
- package/docs/api/grid-pro.getdateeditortemplate.md +13 -0
- package/docs/api/grid-pro.gridprorenderertypes.md +1 -0
- package/docs/api/grid-pro.md +5 -0
- package/docs/api/grid-pro.numbereditor.md +0 -2
- package/docs/api-report.md +56 -4
- package/package.json +9 -8
package/dist/grid-pro.d.ts
CHANGED
|
@@ -127,6 +127,12 @@ export declare const agActionRendererStyles: ElementStyles;
|
|
|
127
127
|
*/
|
|
128
128
|
export declare const agBooleanRendererStyles: ElementStyles;
|
|
129
129
|
|
|
130
|
+
/**
|
|
131
|
+
* The AG Select Renderer Styles.
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
export declare const agDateEditorStyles: ElementStyles;
|
|
135
|
+
|
|
130
136
|
/**
|
|
131
137
|
* All External AG Grid Stock in one CSS.
|
|
132
138
|
* @remarks This is a collection of multiple AG themes, only needed if the target element needs more than one stock theme.
|
|
@@ -417,6 +423,31 @@ export declare const ColumnTemplate: ViewTemplate<GridProColumn, any>;
|
|
|
417
423
|
*/
|
|
418
424
|
export declare const convertToKebabCase: (value: string) => string;
|
|
419
425
|
|
|
426
|
+
/**
|
|
427
|
+
* The AG Date Editor element.
|
|
428
|
+
* @public
|
|
429
|
+
* @tagname %%prefix%%-date-editor
|
|
430
|
+
*/
|
|
431
|
+
export declare class DateEditor extends FoundationElement implements ICellEditorComp {
|
|
432
|
+
value: number;
|
|
433
|
+
dateFormat: string;
|
|
434
|
+
inputType: 'datetime-local' | 'date';
|
|
435
|
+
init(params: DateEditorParams): void;
|
|
436
|
+
getGui(): HTMLElement;
|
|
437
|
+
refresh(params: DateEditorParams): boolean;
|
|
438
|
+
getValue(): number;
|
|
439
|
+
isPopup(): boolean;
|
|
440
|
+
changeHandler(event: any): void;
|
|
441
|
+
}
|
|
442
|
+
|
|
443
|
+
/**
|
|
444
|
+
* Parameters used to configure {@link SelectEditor}
|
|
445
|
+
* @public
|
|
446
|
+
*/
|
|
447
|
+
export declare interface DateEditorParams extends ICellEditorParams {
|
|
448
|
+
withTime: boolean;
|
|
449
|
+
}
|
|
450
|
+
|
|
420
451
|
/**
|
|
421
452
|
* Returns a formatted date time value from the Grid Pro cell value.
|
|
422
453
|
* @param param - A ValueFormatterParams object.
|
|
@@ -539,6 +570,22 @@ styles: ElementStyles;
|
|
|
539
570
|
template: ViewTemplate<AgTextFieldRenderer, any>;
|
|
540
571
|
}, typeof AgTextRenderer>;
|
|
541
572
|
|
|
573
|
+
/**
|
|
574
|
+
*
|
|
575
|
+
* @public
|
|
576
|
+
* @remarks
|
|
577
|
+
* HTML Element: \<foundation-select-editor\>
|
|
578
|
+
*/
|
|
579
|
+
export declare const foundationDateEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
580
|
+
baseName: string;
|
|
581
|
+
styles: ElementStyles;
|
|
582
|
+
template: ViewTemplate<DateEditor, any>;
|
|
583
|
+
}>) => FoundationElementRegistry< {
|
|
584
|
+
baseName: string;
|
|
585
|
+
styles: ElementStyles;
|
|
586
|
+
template: ViewTemplate<DateEditor, any>;
|
|
587
|
+
}, typeof DateEditor>;
|
|
588
|
+
|
|
542
589
|
/**
|
|
543
590
|
* The Grid Pro Components.
|
|
544
591
|
* @remarks Contains all available components, from Grid Pro itself to the cell renderers.
|
|
@@ -626,6 +673,15 @@ export declare const foundationGridComponents: {
|
|
|
626
673
|
styles: ElementStyles;
|
|
627
674
|
template: ViewTemplate<NumberEditor, any>;
|
|
628
675
|
}, NumberEditor>;
|
|
676
|
+
foundationDateEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
677
|
+
baseName: string;
|
|
678
|
+
styles: ElementStyles;
|
|
679
|
+
template: ViewTemplate<DateEditor, any>;
|
|
680
|
+
}>) => FoundationElementRegistry< {
|
|
681
|
+
baseName: string;
|
|
682
|
+
styles: ElementStyles;
|
|
683
|
+
template: ViewTemplate<DateEditor, any>;
|
|
684
|
+
}, DateEditor>;
|
|
629
685
|
foundationMultiselectEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
630
686
|
baseName: string;
|
|
631
687
|
styles: ElementStyles;
|
|
@@ -809,6 +865,14 @@ export declare const getAgBooleanRendererTemplate: (designSystem?: string) => Vi
|
|
|
809
865
|
*/
|
|
810
866
|
export declare function getColumnType(metadataType: string): string;
|
|
811
867
|
|
|
868
|
+
/**
|
|
869
|
+
* Get a Design System prefixed Select template.
|
|
870
|
+
* @param prefix - The design system prefix to use. Defaults to 'foundation'.
|
|
871
|
+
* @returns A Select component template prefixed with the correct design system.
|
|
872
|
+
* @public
|
|
873
|
+
*/
|
|
874
|
+
export declare const getDateEditorTemplate: (prefix?: string) => ViewTemplate<DateEditor, any>;
|
|
875
|
+
|
|
812
876
|
/**
|
|
813
877
|
* Returns a filter type based on the Grid Pro field/column type.
|
|
814
878
|
* @param type - The type of the field/column
|
|
@@ -1035,15 +1099,15 @@ declare const GridPro_base: (new (...args: any[]) => {
|
|
|
1035
1099
|
cloneNode(deep?: boolean): Node;
|
|
1036
1100
|
deepClone(): Node;
|
|
1037
1101
|
readonly shouldRunDisconnect: boolean;
|
|
1038
|
-
readonly shouldRunConnect: boolean;
|
|
1102
|
+
readonly shouldRunConnect: boolean; /**
|
|
1103
|
+
* Whether to use the `applyTransactionAsync` function for *update* transactions
|
|
1104
|
+
* @remarks Defaults to true
|
|
1105
|
+
*/
|
|
1039
1106
|
"__#1@#_blockLifecycleDueToTokenChange"(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean;
|
|
1040
1107
|
"__#1@#_tryFindContainingLayout"(e: Element): FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
|
|
1041
1108
|
connectedCallback(): void;
|
|
1042
1109
|
readonly $fastController: Controller;
|
|
1043
1110
|
$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
|
-
*/
|
|
1047
1111
|
disconnectedCallback(): void;
|
|
1048
1112
|
attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
|
|
1049
1113
|
accessKey: string;
|
|
@@ -1568,11 +1632,7 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
|
|
|
1568
1632
|
draggable: boolean;
|
|
1569
1633
|
hidden: boolean;
|
|
1570
1634
|
inert: boolean;
|
|
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
|
-
*/
|
|
1635
|
+
innerText: string;
|
|
1576
1636
|
lang: string;
|
|
1577
1637
|
readonly offsetHeight: number;
|
|
1578
1638
|
readonly offsetLeft: number;
|
|
@@ -1884,6 +1944,7 @@ export declare enum GridProRendererTypes {
|
|
|
1884
1944
|
boolean = "boolean",
|
|
1885
1945
|
text = "text",
|
|
1886
1946
|
select = "select",
|
|
1947
|
+
dateEditor = "dateEditor",
|
|
1887
1948
|
selectEditor = "selectEditor",
|
|
1888
1949
|
numberEditor = "numberEditor",
|
|
1889
1950
|
multiselectEditor = "multiselectEditor"
|
|
@@ -2304,8 +2365,6 @@ export declare class NumberEditor extends FoundationElement implements ICellEdit
|
|
|
2304
2365
|
input: any;
|
|
2305
2366
|
init(params: NumberEditorParams): void;
|
|
2306
2367
|
getGui(): HTMLElement;
|
|
2307
|
-
focus(): void;
|
|
2308
|
-
destroy(): void;
|
|
2309
2368
|
refresh(params: NumberEditorParams): boolean;
|
|
2310
2369
|
getValue(): number;
|
|
2311
2370
|
isPopup(): boolean;
|
|
@@ -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) > [agDateEditorStyles](./grid-pro.agdateeditorstyles.md)
|
|
4
|
+
|
|
5
|
+
## agDateEditorStyles variable
|
|
6
|
+
|
|
7
|
+
The AG Select Renderer Styles.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
agDateEditorStyles: 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) > [DateEditor](./grid-pro.dateeditor.md) > [changeHandler](./grid-pro.dateeditor.changehandler.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor.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,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) > [dateFormat](./grid-pro.dateeditor.dateformat.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor.dateFormat property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
dateFormat: string;
|
|
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) > [getGui](./grid-pro.dateeditor.getgui.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor.getGui() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
getGui(): HTMLElement;
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
HTMLElement
|
|
15
|
+
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [DateEditor](./grid-pro.dateeditor.md) > [getValue](./grid-pro.dateeditor.getvalue.md)
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## DateEditor.getValue() method
|
|
6
6
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
|
|
10
|
+
getValue(): number;
|
|
11
11
|
```
|
|
12
12
|
**Returns:**
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
number
|
|
15
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) > [DateEditor](./grid-pro.dateeditor.md) > [init](./grid-pro.dateeditor.init.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor.init() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
init(params: DateEditorParams): void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| params | [DateEditorParams](./grid-pro.dateeditorparams.md) | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
void
|
|
22
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [DateEditor](./grid-pro.dateeditor.md) > [inputType](./grid-pro.dateeditor.inputtype.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor.inputType property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
inputType: 'datetime-local' | 'date';
|
|
11
|
+
```
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [DateEditor](./grid-pro.dateeditor.md) > [isPopup](./grid-pro.dateeditor.ispopup.md)
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## DateEditor.isPopup() method
|
|
6
6
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
|
|
10
|
+
isPopup(): boolean;
|
|
11
11
|
```
|
|
12
12
|
**Returns:**
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
boolean
|
|
15
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) > [DateEditor](./grid-pro.dateeditor.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor class
|
|
6
|
+
|
|
7
|
+
The AG Date Editor element.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare class DateEditor extends FoundationElement implements ICellEditorComp
|
|
13
|
+
```
|
|
14
|
+
**Extends:** FoundationElement
|
|
15
|
+
|
|
16
|
+
**Implements:** ICellEditorComp
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
| Property | Modifiers | Type | Description |
|
|
21
|
+
| --- | --- | --- | --- |
|
|
22
|
+
| [dateFormat](./grid-pro.dateeditor.dateformat.md) | | string | |
|
|
23
|
+
| [inputType](./grid-pro.dateeditor.inputtype.md) | | 'datetime-local' \| 'date' | |
|
|
24
|
+
| [value](./grid-pro.dateeditor.value.md) | | number | |
|
|
25
|
+
|
|
26
|
+
## Methods
|
|
27
|
+
|
|
28
|
+
| Method | Modifiers | Description |
|
|
29
|
+
| --- | --- | --- |
|
|
30
|
+
| [changeHandler(event)](./grid-pro.dateeditor.changehandler.md) | | |
|
|
31
|
+
| [getGui()](./grid-pro.dateeditor.getgui.md) | | |
|
|
32
|
+
| [getValue()](./grid-pro.dateeditor.getvalue.md) | | |
|
|
33
|
+
| [init(params)](./grid-pro.dateeditor.init.md) | | |
|
|
34
|
+
| [isPopup()](./grid-pro.dateeditor.ispopup.md) | | |
|
|
35
|
+
| [refresh(params)](./grid-pro.dateeditor.refresh.md) | | |
|
|
36
|
+
|
|
@@ -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) > [DateEditor](./grid-pro.dateeditor.md) > [refresh](./grid-pro.dateeditor.refresh.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor.refresh() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
refresh(params: DateEditorParams): boolean;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| params | [DateEditorParams](./grid-pro.dateeditorparams.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) > [DateEditor](./grid-pro.dateeditor.md) > [value](./grid-pro.dateeditor.value.md)
|
|
4
|
+
|
|
5
|
+
## DateEditor.value property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
value: number;
|
|
11
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/grid-pro](./grid-pro.md) > [DateEditorParams](./grid-pro.dateeditorparams.md)
|
|
4
|
+
|
|
5
|
+
## DateEditorParams interface
|
|
6
|
+
|
|
7
|
+
Parameters used to configure [SelectEditor](./grid-pro.selecteditor.md)
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface DateEditorParams extends ICellEditorParams
|
|
13
|
+
```
|
|
14
|
+
**Extends:** ICellEditorParams
|
|
15
|
+
|
|
16
|
+
## Properties
|
|
17
|
+
|
|
18
|
+
| Property | Modifiers | Type | Description |
|
|
19
|
+
| --- | --- | --- | --- |
|
|
20
|
+
| [withTime](./grid-pro.dateeditorparams.withtime.md) | | boolean | |
|
|
21
|
+
|
|
@@ -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) > [DateEditorParams](./grid-pro.dateeditorparams.md) > [withTime](./grid-pro.dateeditorparams.withtime.md)
|
|
4
|
+
|
|
5
|
+
## DateEditorParams.withTime property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
withTime: boolean;
|
|
11
|
+
```
|
|
@@ -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) > [foundationDateEditor](./grid-pro.foundationdateeditor.md)
|
|
4
|
+
|
|
5
|
+
## foundationDateEditor variable
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
foundationDateEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
11
|
+
baseName: string;
|
|
12
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
13
|
+
template: import("@microsoft/fast-element").ViewTemplate<DateEditor, any>;
|
|
14
|
+
}>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
|
|
15
|
+
baseName: string;
|
|
16
|
+
styles: import("@microsoft/fast-element").ElementStyles;
|
|
17
|
+
template: import("@microsoft/fast-element").ViewTemplate<DateEditor, any>;
|
|
18
|
+
}, typeof DateEditor>
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Remarks
|
|
22
|
+
|
|
23
|
+
HTML Element: <<!-- -->foundation-select-editor<!-- -->>
|
|
24
|
+
|
|
@@ -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
|
+
foundationDateEditor: (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").DateEditor, 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").DateEditor, any>;
|
|
102
|
+
}, typeof import("./cell-editors").DateEditor>;
|
|
94
103
|
foundationMultiselectEditor: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
|
|
95
104
|
baseName: string;
|
|
96
105
|
styles: import("@microsoft/fast-element").ElementStyles;
|
|
@@ -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) > [getDateEditorTemplate](./grid-pro.getdateeditortemplate.md)
|
|
4
|
+
|
|
5
|
+
## getDateEditorTemplate variable
|
|
6
|
+
|
|
7
|
+
Get a Design System prefixed Select template.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getDateEditorTemplate: (prefix?: string) => import("@microsoft/fast-element").ViewTemplate<DateEditor, any>
|
|
13
|
+
```
|
|
@@ -19,6 +19,7 @@ export declare enum GridProRendererTypes
|
|
|
19
19
|
| action | <code>"action"</code> | |
|
|
20
20
|
| actionsMenu | <code>"actionsMenu"</code> | |
|
|
21
21
|
| boolean | <code>"boolean"</code> | |
|
|
22
|
+
| dateEditor | <code>"dateEditor"</code> | |
|
|
22
23
|
| multiselectEditor | <code>"multiselectEditor"</code> | |
|
|
23
24
|
| numberEditor | <code>"numberEditor"</code> | |
|
|
24
25
|
| select | <code>"select"</code> | |
|
package/docs/api/grid-pro.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| [AgTextFieldRenderer](./grid-pro.agtextfieldrenderer.md) | The AG Text Field Renderer element. |
|
|
14
14
|
| [AgTextRenderer](./grid-pro.agtextrenderer.md) | |
|
|
15
15
|
| [BooleanRenderer](./grid-pro.booleanrenderer.md) | The AG Boolean Renderer element. |
|
|
16
|
+
| [DateEditor](./grid-pro.dateeditor.md) | The AG Date Editor element. |
|
|
16
17
|
| [GridPro](./grid-pro.gridpro.md) | The Grid Pro element. |
|
|
17
18
|
| [GridProCell](./grid-pro.gridprocell.md) | The Grid Pro Cell element. |
|
|
18
19
|
| [GridProClientSideDatasource](./grid-pro.gridproclientsidedatasource.md) | The Genesis Datasource element, for client-side \| CSRM-compatible data fetching and used exclusively by the GridPro element. |
|
|
@@ -44,6 +45,7 @@
|
|
|
44
45
|
|
|
45
46
|
| Interface | Description |
|
|
46
47
|
| --- | --- |
|
|
48
|
+
| [DateEditorParams](./grid-pro.dateeditorparams.md) | Parameters used to configure [SelectEditor](./grid-pro.selecteditor.md) |
|
|
47
49
|
| [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) | Parameters used to configure [MultiselectEditor](./grid-pro.multiselecteditor.md) |
|
|
48
50
|
| [NumberEditorParams](./grid-pro.numbereditorparams.md) | Parameters used to configure [NumberEditor](./grid-pro.numbereditor.md) |
|
|
49
51
|
| [SelectEditorParams](./grid-pro.selecteditorparams.md) | Parameters used to configure [SelectEditor](./grid-pro.selecteditor.md) |
|
|
@@ -55,6 +57,7 @@
|
|
|
55
57
|
| [actionHeightMultiplier](./grid-pro.actionheightmultiplier.md) | The base height multiplier for the action renderer. |
|
|
56
58
|
| [agActionRendererStyles](./grid-pro.agactionrendererstyles.md) | The AG Action Renderer Styles. |
|
|
57
59
|
| [agBooleanRendererStyles](./grid-pro.agbooleanrendererstyles.md) | The AG Boolean Renderer Styles. |
|
|
60
|
+
| [agDateEditorStyles](./grid-pro.agdateeditorstyles.md) | The AG Select Renderer Styles. |
|
|
58
61
|
| [agExternalStockStyles](./grid-pro.agexternalstockstyles.md) | All External AG Grid Stock in one CSS. |
|
|
59
62
|
| [agGridAlpineFontFace](./grid-pro.aggridalpinefontface.md) | The AG Alpine font face used on ag-theme-alpine/ag-theme-alpine-dark Grid Pro themes. |
|
|
60
63
|
| [agGridBalhamFontFace](./grid-pro.aggridbalhamfontface.md) | The AG Balham font face used on ag-theme-balham/ag-theme-balham-dark Grid Pro themes. |
|
|
@@ -81,6 +84,7 @@
|
|
|
81
84
|
| [foundationAgSelectRenderer](./grid-pro.foundationagselectrenderer.md) | A function that returns a Foundation Select Renderer registration for configuring the component with a DesignSystem. |
|
|
82
85
|
| [foundationAgTextFieldRenderer](./grid-pro.foundationagtextfieldrenderer.md) | A function that returns a Foundation Text Field Renderer registration for configuring the component with a DesignSystem. |
|
|
83
86
|
| [foundationAgTextRenderer](./grid-pro.foundationagtextrenderer.md) | A function that returns a Foundation Text Renderer registration for configuring the component with a DesignSystem. |
|
|
87
|
+
| [foundationDateEditor](./grid-pro.foundationdateeditor.md) | |
|
|
84
88
|
| [foundationGridComponents](./grid-pro.foundationgridcomponents.md) | The Grid Pro Components. |
|
|
85
89
|
| [foundationGridPro](./grid-pro.foundationgridpro.md) | A function that returns a Foundation Grid Pro registration for configuring the component with a DesignSystem. |
|
|
86
90
|
| [foundationGridProActionRenderer](./grid-pro.foundationgridproactionrenderer.md) | A function that returns a Foundation Action Renderer for configuring the component with a DesignSystem. |
|
|
@@ -92,6 +96,7 @@
|
|
|
92
96
|
| [foundationSelectEditor](./grid-pro.foundationselecteditor.md) | |
|
|
93
97
|
| [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). |
|
|
94
98
|
| [getAgBooleanRendererTemplate](./grid-pro.getagbooleanrenderertemplate.md) | Get a Design System prefixed Checkbox template. |
|
|
99
|
+
| [getDateEditorTemplate](./grid-pro.getdateeditortemplate.md) | Get a Design System prefixed Select template. |
|
|
95
100
|
| [getMultiselectEditorTemplate](./grid-pro.getmultiselecteditortemplate.md) | Get a Design System prefixed Select template. |
|
|
96
101
|
| [getNumberEditorTemplate](./grid-pro.getnumbereditortemplate.md) | Get a Design System prefixed Select template. |
|
|
97
102
|
| [getSelectEditorTemplate](./grid-pro.getselecteditortemplate.md) | Get a Design System prefixed Select template. |
|
|
@@ -29,8 +29,6 @@ export declare class NumberEditor extends FoundationElement implements ICellEdit
|
|
|
29
29
|
| --- | --- | --- |
|
|
30
30
|
| [afterGuiAttached()](./grid-pro.numbereditor.afterguiattached.md) | | |
|
|
31
31
|
| [changeHandler(event)](./grid-pro.numbereditor.changehandler.md) | | |
|
|
32
|
-
| [destroy()](./grid-pro.numbereditor.destroy.md) | | |
|
|
33
|
-
| [focus()](./grid-pro.numbereditor.focus.md) | | |
|
|
34
32
|
| [getGui()](./grid-pro.numbereditor.getgui.md) | | |
|
|
35
33
|
| [getValue()](./grid-pro.numbereditor.getvalue.md) | | |
|
|
36
34
|
| [init(params)](./grid-pro.numbereditor.init.md) | | |
|
package/docs/api-report.md
CHANGED
|
@@ -97,6 +97,9 @@ export const agActionRendererStyles: ElementStyles;
|
|
|
97
97
|
// @public
|
|
98
98
|
export const agBooleanRendererStyles: ElementStyles;
|
|
99
99
|
|
|
100
|
+
// @public
|
|
101
|
+
export const agDateEditorStyles: ElementStyles;
|
|
102
|
+
|
|
100
103
|
// @public
|
|
101
104
|
export const agExternalStockStyles: ElementStyles;
|
|
102
105
|
|
|
@@ -324,6 +327,34 @@ export const ColumnTemplate: ViewTemplate<GridProColumn, any>;
|
|
|
324
327
|
// @public
|
|
325
328
|
export const convertToKebabCase: (value: string) => string;
|
|
326
329
|
|
|
330
|
+
// @public
|
|
331
|
+
export class DateEditor extends FoundationElement implements ICellEditorComp {
|
|
332
|
+
// (undocumented)
|
|
333
|
+
changeHandler(event: any): void;
|
|
334
|
+
// (undocumented)
|
|
335
|
+
dateFormat: string;
|
|
336
|
+
// (undocumented)
|
|
337
|
+
getGui(): HTMLElement;
|
|
338
|
+
// (undocumented)
|
|
339
|
+
getValue(): number;
|
|
340
|
+
// (undocumented)
|
|
341
|
+
init(params: DateEditorParams): void;
|
|
342
|
+
// (undocumented)
|
|
343
|
+
inputType: 'datetime-local' | 'date';
|
|
344
|
+
// (undocumented)
|
|
345
|
+
isPopup(): boolean;
|
|
346
|
+
// (undocumented)
|
|
347
|
+
refresh(params: DateEditorParams): boolean;
|
|
348
|
+
// (undocumented)
|
|
349
|
+
value: number;
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
// @public
|
|
353
|
+
export interface DateEditorParams extends ICellEditorParams {
|
|
354
|
+
// (undocumented)
|
|
355
|
+
withTime: boolean;
|
|
356
|
+
}
|
|
357
|
+
|
|
327
358
|
// @public
|
|
328
359
|
export function dateTimeValueFormatter({ value }: ValueFormatterParams): any;
|
|
329
360
|
|
|
@@ -395,6 +426,17 @@ styles: ElementStyles;
|
|
|
395
426
|
template: ViewTemplate<AgTextFieldRenderer, any>;
|
|
396
427
|
}, typeof AgTextRenderer>;
|
|
397
428
|
|
|
429
|
+
// @public (undocumented)
|
|
430
|
+
export const foundationDateEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
431
|
+
baseName: string;
|
|
432
|
+
styles: ElementStyles;
|
|
433
|
+
template: ViewTemplate<DateEditor, any>;
|
|
434
|
+
}>) => FoundationElementRegistry< {
|
|
435
|
+
baseName: string;
|
|
436
|
+
styles: ElementStyles;
|
|
437
|
+
template: ViewTemplate<DateEditor, any>;
|
|
438
|
+
}, typeof DateEditor>;
|
|
439
|
+
|
|
398
440
|
// @public
|
|
399
441
|
export const foundationGridComponents: {
|
|
400
442
|
foundationGridProActionRenderer: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
@@ -478,6 +520,15 @@ export const foundationGridComponents: {
|
|
|
478
520
|
styles: ElementStyles;
|
|
479
521
|
template: ViewTemplate<NumberEditor, any>;
|
|
480
522
|
}, NumberEditor>;
|
|
523
|
+
foundationDateEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
524
|
+
baseName: string;
|
|
525
|
+
styles: ElementStyles;
|
|
526
|
+
template: ViewTemplate<DateEditor, any>;
|
|
527
|
+
}>) => FoundationElementRegistry< {
|
|
528
|
+
baseName: string;
|
|
529
|
+
styles: ElementStyles;
|
|
530
|
+
template: ViewTemplate<DateEditor, any>;
|
|
531
|
+
}, DateEditor>;
|
|
481
532
|
foundationMultiselectEditor: (overrideDefinition?: OverrideFoundationElementDefinition< {
|
|
482
533
|
baseName: string;
|
|
483
534
|
styles: ElementStyles;
|
|
@@ -571,6 +622,9 @@ export const getAgBooleanRendererTemplate: (designSystem?: string) => ViewTempla
|
|
|
571
622
|
// @alpha
|
|
572
623
|
export function getColumnType(metadataType: string): string;
|
|
573
624
|
|
|
625
|
+
// @public
|
|
626
|
+
export const getDateEditorTemplate: (prefix?: string) => ViewTemplate<DateEditor, any>;
|
|
627
|
+
|
|
574
628
|
// @alpha
|
|
575
629
|
export function getFilterByFieldType(type: string): string;
|
|
576
630
|
|
|
@@ -773,6 +827,8 @@ export enum GridProRendererTypes {
|
|
|
773
827
|
// (undocumented)
|
|
774
828
|
boolean = "boolean",
|
|
775
829
|
// (undocumented)
|
|
830
|
+
dateEditor = "dateEditor",
|
|
831
|
+
// (undocumented)
|
|
776
832
|
multiselectEditor = "multiselectEditor",
|
|
777
833
|
// (undocumented)
|
|
778
834
|
numberEditor = "numberEditor",
|
|
@@ -868,10 +924,6 @@ export class NumberEditor extends FoundationElement implements ICellEditorComp {
|
|
|
868
924
|
// (undocumented)
|
|
869
925
|
changeHandler(event: any): void;
|
|
870
926
|
// (undocumented)
|
|
871
|
-
destroy(): void;
|
|
872
|
-
// (undocumented)
|
|
873
|
-
focus(): void;
|
|
874
|
-
// (undocumented)
|
|
875
927
|
getGui(): HTMLElement;
|
|
876
928
|
// (undocumented)
|
|
877
929
|
getValue(): number;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/grid-pro",
|
|
3
3
|
"description": "Genesis Foundation AG Grid",
|
|
4
|
-
"version": "14.
|
|
4
|
+
"version": "14.107.0",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -30,20 +30,21 @@
|
|
|
30
30
|
"test:debug": "genx test --debug"
|
|
31
31
|
},
|
|
32
32
|
"devDependencies": {
|
|
33
|
-
"@genesislcap/foundation-testing": "14.
|
|
34
|
-
"@genesislcap/genx": "14.
|
|
33
|
+
"@genesislcap/foundation-testing": "14.107.0",
|
|
34
|
+
"@genesislcap/genx": "14.107.0",
|
|
35
35
|
"rimraf": "^3.0.2"
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@genesislcap/foundation-comms": "14.
|
|
39
|
-
"@genesislcap/foundation-logger": "14.
|
|
40
|
-
"@genesislcap/foundation-ui": "14.
|
|
41
|
-
"@genesislcap/foundation-utils": "14.
|
|
38
|
+
"@genesislcap/foundation-comms": "14.107.0",
|
|
39
|
+
"@genesislcap/foundation-logger": "14.107.0",
|
|
40
|
+
"@genesislcap/foundation-ui": "14.107.0",
|
|
41
|
+
"@genesislcap/foundation-utils": "14.107.0",
|
|
42
42
|
"@microsoft/fast-colors": "^5.1.4",
|
|
43
43
|
"@microsoft/fast-components": "^2.21.3",
|
|
44
44
|
"@microsoft/fast-element": "^1.7.0",
|
|
45
45
|
"@microsoft/fast-foundation": "^2.33.2",
|
|
46
46
|
"@microsoft/fast-web-utilities": "^5.0.2",
|
|
47
|
+
"dayjs": "^1.11.7",
|
|
47
48
|
"rxjs": "^7.5.4",
|
|
48
49
|
"tslib": "^2.3.1"
|
|
49
50
|
},
|
|
@@ -61,5 +62,5 @@
|
|
|
61
62
|
"access": "public"
|
|
62
63
|
},
|
|
63
64
|
"customElements": "dist/custom-elements.json",
|
|
64
|
-
"gitHead": "
|
|
65
|
+
"gitHead": "688b8fadf0d82d432478cbac8762c93d649c1580"
|
|
65
66
|
}
|