@genesislcap/foundation-forms 14.407.0 → 14.408.0-icon-renderer.3
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/README.md +6 -818
- package/package.json +15 -15
- package/docs/api/foundation-forms.arrayrendereroptions.md +0 -23
- package/docs/api/foundation-forms.bulkrowstatus.md +0 -22
- package/docs/api/foundation-forms.bulkrowsubmitstatus.md +0 -13
- package/docs/api/foundation-forms.bulksubmitfaileditem.md +0 -20
- package/docs/api/foundation-forms.bulksubmitresult.md +0 -18
- package/docs/api/foundation-forms.bulksubmitsuccessitem.md +0 -17
- package/docs/api/foundation-forms.categorizationrendereroptions.md +0 -17
- package/docs/api/foundation-forms.childuischemaresolver.md +0 -15
- package/docs/api/foundation-forms.connectedrenderersoptions.md +0 -23
- package/docs/api/foundation-forms.csvmappingresult.mappedrows.md +0 -13
- package/docs/api/foundation-forms.csvmappingresult.md +0 -77
- package/docs/api/foundation-forms.csvmappingresult.unmappedcolumns.md +0 -13
- package/docs/api/foundation-forms.csvparseresult.errors.md +0 -13
- package/docs/api/foundation-forms.csvparseresult.headers.md +0 -13
- package/docs/api/foundation-forms.csvparseresult.md +0 -96
- package/docs/api/foundation-forms.csvparseresult.rows.md +0 -13
- package/docs/api/foundation-forms.downloadcsvtemplate.md +0 -74
- package/docs/api/foundation-forms.filters.allsavedfilters.md +0 -11
- package/docs/api/foundation-forms.filters.connectedcallback.md +0 -15
- package/docs/api/foundation-forms.filters.data.md +0 -13
- package/docs/api/foundation-forms.filters.deletefilter.md +0 -15
- package/docs/api/foundation-forms.filters.filtername.md +0 -11
- package/docs/api/foundation-forms.filters.filternamechanged.md +0 -64
- package/docs/api/foundation-forms.filters.jsonschema.md +0 -18
- package/docs/api/foundation-forms.filters.kvstorage.md +0 -11
- package/docs/api/foundation-forms.filters.loadallsavedfilters.md +0 -15
- package/docs/api/foundation-forms.filters.loadfilterdata.md +0 -50
- package/docs/api/foundation-forms.filters.md +0 -335
- package/docs/api/foundation-forms.filters.prefix.md +0 -13
- package/docs/api/foundation-forms.filters.renderers.md +0 -13
- package/docs/api/foundation-forms.filters.resourcename.md +0 -13
- package/docs/api/foundation-forms.filters.savefilter.md +0 -15
- package/docs/api/foundation-forms.filters.showfilterpersistencecontrols.md +0 -13
- package/docs/api/foundation-forms.filters.uischema.md +0 -50
- package/docs/api/foundation-forms.filters.value.md +0 -13
- package/docs/api/foundation-forms.filtersrenderers.md +0 -13
- package/docs/api/foundation-forms.form.additionalrenderers.md +0 -13
- package/docs/api/foundation-forms.form.approvalmessagelabel.md +0 -13
- package/docs/api/foundation-forms.form.bulkinsert.md +0 -13
- package/docs/api/foundation-forms.form.bulkinsertmaxitems.md +0 -13
- package/docs/api/foundation-forms.form.bulkinsertminitems.md +0 -13
- package/docs/api/foundation-forms.form.clearrowsubmitstatuses.md +0 -17
- package/docs/api/foundation-forms.form.confirmationmessage.md +0 -13
- package/docs/api/foundation-forms.form.data.md +0 -13
- package/docs/api/foundation-forms.form.downloadcsvtemplate.md +0 -17
- package/docs/api/foundation-forms.form.handlecsvfileselected.md +0 -54
- package/docs/api/foundation-forms.form.hidesubmit.md +0 -13
- package/docs/api/foundation-forms.form.jsonschema.md +0 -18
- package/docs/api/foundation-forms.form.md +0 -434
- package/docs/api/foundation-forms.form.prefix.md +0 -13
- package/docs/api/foundation-forms.form.readonly.md +0 -13
- package/docs/api/foundation-forms.form.renderers.md +0 -13
- package/docs/api/foundation-forms.form.reset.md +0 -54
- package/docs/api/foundation-forms.form.resourcename.md +0 -13
- package/docs/api/foundation-forms.form.rowsubmitstatuses.md +0 -13
- package/docs/api/foundation-forms.form.setapprovalmessage.md +0 -13
- package/docs/api/foundation-forms.form.submitsinglerow.md +0 -56
- package/docs/api/foundation-forms.form.uischema.md +0 -50
- package/docs/api/foundation-forms.generatecsvtemplate.md +0 -104
- package/docs/api/foundation-forms.getanyoferrormessage.md +0 -96
- package/docs/api/foundation-forms.grouprendereroptions.md +0 -15
- package/docs/api/foundation-forms.labelplacementoptions.md +0 -17
- package/docs/api/foundation-forms.labelplacementtype.md +0 -13
- package/docs/api/foundation-forms.mapcsvtoschema.md +0 -88
- package/docs/api/foundation-forms.md +0 -516
- package/docs/api/foundation-forms.multicolumndropdowncontrolrendererentry.md +0 -15
- package/docs/api/foundation-forms.multicolumndropdowncontrolrenderertemplate.md +0 -82
- package/docs/api/foundation-forms.multicolumndropdownrendereroptions.md +0 -25
- package/docs/api/foundation-forms.mustmatch.md +0 -62
- package/docs/api/foundation-forms.numberrendereroptions.md +0 -17
- package/docs/api/foundation-forms.parsecsv.md +0 -56
- package/docs/api/foundation-forms.rendererentry.md +0 -30
- package/docs/api/foundation-forms.renderers.md +0 -13
- package/docs/api/foundation-forms.standardrendereroptions.md +0 -22
- package/docs/api/foundation-forms.stepperorientationoptions.md +0 -17
- package/docs/api/foundation-forms.stepperorientationtype.md +0 -13
- package/docs/api/foundation-forms.stepperrendereroptions.md +0 -15
- package/docs/api/foundation-forms.stringrendereroptions.md +0 -17
- package/docs/api/foundation-forms.uischema.md +0 -19
- package/docs/api/foundation-forms.uischemaelement.md +0 -22
- package/docs/api/foundation-forms.uischemaelementoptions.md +0 -15
- package/docs/api/foundation-forms.uischemaelementtype.md +0 -13
- package/docs/api/foundation-forms.uischemaoptions.md +0 -15
- package/docs/api/index.md +0 -30
- package/docs/api-report.md.api.md +0 -440
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/foundation-forms",
|
|
3
3
|
"description": "Genesis Foundation Forms",
|
|
4
|
-
"version": "14.
|
|
4
|
+
"version": "14.408.0-icon-renderer.3",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -50,23 +50,23 @@
|
|
|
50
50
|
}
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
|
-
"@genesislcap/foundation-testing": "14.
|
|
54
|
-
"@genesislcap/genx": "14.
|
|
55
|
-
"@genesislcap/rollup-builder": "14.
|
|
56
|
-
"@genesislcap/ts-builder": "14.
|
|
57
|
-
"@genesislcap/uvu-playwright-builder": "14.
|
|
58
|
-
"@genesislcap/vite-builder": "14.
|
|
59
|
-
"@genesislcap/webpack-builder": "14.
|
|
53
|
+
"@genesislcap/foundation-testing": "14.408.0-icon-renderer.3",
|
|
54
|
+
"@genesislcap/genx": "14.408.0-icon-renderer.3",
|
|
55
|
+
"@genesislcap/rollup-builder": "14.408.0-icon-renderer.3",
|
|
56
|
+
"@genesislcap/ts-builder": "14.408.0-icon-renderer.3",
|
|
57
|
+
"@genesislcap/uvu-playwright-builder": "14.408.0-icon-renderer.3",
|
|
58
|
+
"@genesislcap/vite-builder": "14.408.0-icon-renderer.3",
|
|
59
|
+
"@genesislcap/webpack-builder": "14.408.0-icon-renderer.3",
|
|
60
60
|
"@types/json-schema": "^7.0.11",
|
|
61
61
|
"@types/papaparse": "^5.3.14"
|
|
62
62
|
},
|
|
63
63
|
"dependencies": {
|
|
64
|
-
"@genesislcap/foundation-comms": "14.
|
|
65
|
-
"@genesislcap/foundation-criteria": "14.
|
|
66
|
-
"@genesislcap/foundation-logger": "14.
|
|
67
|
-
"@genesislcap/foundation-notifications": "14.
|
|
68
|
-
"@genesislcap/foundation-ui": "14.
|
|
69
|
-
"@genesislcap/foundation-utils": "14.
|
|
64
|
+
"@genesislcap/foundation-comms": "14.408.0-icon-renderer.3",
|
|
65
|
+
"@genesislcap/foundation-criteria": "14.408.0-icon-renderer.3",
|
|
66
|
+
"@genesislcap/foundation-logger": "14.408.0-icon-renderer.3",
|
|
67
|
+
"@genesislcap/foundation-notifications": "14.408.0-icon-renderer.3",
|
|
68
|
+
"@genesislcap/foundation-ui": "14.408.0-icon-renderer.3",
|
|
69
|
+
"@genesislcap/foundation-utils": "14.408.0-icon-renderer.3",
|
|
70
70
|
"@json-schema-tools/dereferencer": "^1.6.1",
|
|
71
71
|
"@jsonforms/core": "^3.2.1",
|
|
72
72
|
"@microsoft/fast-components": "2.30.6",
|
|
@@ -88,5 +88,5 @@
|
|
|
88
88
|
"access": "public"
|
|
89
89
|
},
|
|
90
90
|
"customElements": "dist/custom-elements.json",
|
|
91
|
-
"gitHead": "
|
|
91
|
+
"gitHead": "81f085b26288c4eae01e17a47174d1e389c3a188"
|
|
92
92
|
}
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [ArrayRendererOptions](./foundation-forms.arrayrendereroptions.md)
|
|
4
|
-
|
|
5
|
-
## ArrayRendererOptions type
|
|
6
|
-
|
|
7
|
-
Configuration options available for array renderer.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export type ArrayRendererOptions = {
|
|
13
|
-
childUiSchema?: UiSchema | ChildUiSchemaResolver;
|
|
14
|
-
addLabel?: string;
|
|
15
|
-
deleteLabel?: string;
|
|
16
|
-
border?: boolean;
|
|
17
|
-
canDelete?: (item: any) => boolean;
|
|
18
|
-
canAdd?: boolean | ((array: any[]) => boolean);
|
|
19
|
-
gridView?: boolean;
|
|
20
|
-
};
|
|
21
|
-
```
|
|
22
|
-
**References:** [UiSchema](./foundation-forms.uischema.md)<!-- -->, [ChildUiSchemaResolver](./foundation-forms.childuischemaresolver.md)
|
|
23
|
-
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [BulkRowStatus](./foundation-forms.bulkrowstatus.md)
|
|
4
|
-
|
|
5
|
-
## BulkRowStatus type
|
|
6
|
-
|
|
7
|
-
Tracks the submission status and result for a single row in bulk insert mode.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export type BulkRowStatus = {
|
|
13
|
-
status: BulkRowSubmitStatus;
|
|
14
|
-
errors?: Array<{
|
|
15
|
-
CODE: string;
|
|
16
|
-
TEXT: string;
|
|
17
|
-
}>;
|
|
18
|
-
response?: any;
|
|
19
|
-
};
|
|
20
|
-
```
|
|
21
|
-
**References:** [BulkRowSubmitStatus](./foundation-forms.bulkrowsubmitstatus.md)
|
|
22
|
-
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [BulkRowSubmitStatus](./foundation-forms.bulkrowsubmitstatus.md)
|
|
4
|
-
|
|
5
|
-
## BulkRowSubmitStatus type
|
|
6
|
-
|
|
7
|
-
Possible submission status values for a row in bulk insert mode.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export type BulkRowSubmitStatus = 'pending' | 'submitting' | 'success' | 'failed';
|
|
13
|
-
```
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [BulkSubmitFailedItem](./foundation-forms.bulksubmitfaileditem.md)
|
|
4
|
-
|
|
5
|
-
## BulkSubmitFailedItem type
|
|
6
|
-
|
|
7
|
-
Represents a failed bulk insert item result.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export type BulkSubmitFailedItem = {
|
|
13
|
-
item: any;
|
|
14
|
-
index: number;
|
|
15
|
-
errors: Array<{
|
|
16
|
-
CODE: string;
|
|
17
|
-
TEXT: string;
|
|
18
|
-
}>;
|
|
19
|
-
};
|
|
20
|
-
```
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [BulkSubmitResult](./foundation-forms.bulksubmitresult.md)
|
|
4
|
-
|
|
5
|
-
## BulkSubmitResult type
|
|
6
|
-
|
|
7
|
-
Result of a bulk insert submission containing successful and failed items.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export type BulkSubmitResult = {
|
|
13
|
-
successful: BulkSubmitSuccessItem[];
|
|
14
|
-
failed: BulkSubmitFailedItem[];
|
|
15
|
-
};
|
|
16
|
-
```
|
|
17
|
-
**References:** [BulkSubmitSuccessItem](./foundation-forms.bulksubmitsuccessitem.md)<!-- -->, [BulkSubmitFailedItem](./foundation-forms.bulksubmitfaileditem.md)
|
|
18
|
-
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [BulkSubmitSuccessItem](./foundation-forms.bulksubmitsuccessitem.md)
|
|
4
|
-
|
|
5
|
-
## BulkSubmitSuccessItem type
|
|
6
|
-
|
|
7
|
-
Represents a successful bulk insert item result.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export type BulkSubmitSuccessItem = {
|
|
13
|
-
item: any;
|
|
14
|
-
index: number;
|
|
15
|
-
response: any;
|
|
16
|
-
};
|
|
17
|
-
```
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [CategorizationRendererOptions](./foundation-forms.categorizationrendereroptions.md)
|
|
4
|
-
|
|
5
|
-
## CategorizationRendererOptions type
|
|
6
|
-
|
|
7
|
-
Configuration options available for categorization renderer.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export type CategorizationRendererOptions = {
|
|
13
|
-
childElements?: UiSchema[];
|
|
14
|
-
};
|
|
15
|
-
```
|
|
16
|
-
**References:** [UiSchema](./foundation-forms.uischema.md)
|
|
17
|
-
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [ChildUiSchemaResolver](./foundation-forms.childuischemaresolver.md)
|
|
4
|
-
|
|
5
|
-
## ChildUiSchemaResolver type
|
|
6
|
-
|
|
7
|
-
Resolver for dynamic per-row UI schema in array/bulk-insert mode. Receives the row index, that row's data, and the full form data.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export type ChildUiSchemaResolver = (index: number, rowData: any, formData: any) => UiSchema;
|
|
13
|
-
```
|
|
14
|
-
**References:** [UiSchema](./foundation-forms.uischema.md)
|
|
15
|
-
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [ConnectedRenderersOptions](./foundation-forms.connectedrenderersoptions.md)
|
|
4
|
-
|
|
5
|
-
## ConnectedRenderersOptions type
|
|
6
|
-
|
|
7
|
-
Available configuration options for connected combobox/multiselect.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export type ConnectedRenderersOptions = {
|
|
13
|
-
async?: boolean;
|
|
14
|
-
allOptionsResourceName?: string;
|
|
15
|
-
datasourceConfig?: DatasourceOptions;
|
|
16
|
-
valueField?: string;
|
|
17
|
-
labelField?: string;
|
|
18
|
-
data?: any[];
|
|
19
|
-
allowCustomOptions?: boolean;
|
|
20
|
-
filterMode?: FilterMode;
|
|
21
|
-
labelRowFormatter?: (any: any) => string;
|
|
22
|
-
};
|
|
23
|
-
```
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [CsvMappingResult](./foundation-forms.csvmappingresult.md) > [mappedRows](./foundation-forms.csvmappingresult.mappedrows.md)
|
|
4
|
-
|
|
5
|
-
## CsvMappingResult.mappedRows property
|
|
6
|
-
|
|
7
|
-
The mapped rows with values converted to appropriate types.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
mappedRows: Record<string, any>[];
|
|
13
|
-
```
|
|
@@ -1,77 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [CsvMappingResult](./foundation-forms.csvmappingresult.md)
|
|
4
|
-
|
|
5
|
-
## CsvMappingResult interface
|
|
6
|
-
|
|
7
|
-
Result of mapping CSV data to schema fields.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export interface CsvMappingResult
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Properties
|
|
16
|
-
|
|
17
|
-
<table><thead><tr><th>
|
|
18
|
-
|
|
19
|
-
Property
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
</th><th>
|
|
23
|
-
|
|
24
|
-
Modifiers
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Type
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th><th>
|
|
33
|
-
|
|
34
|
-
Description
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
</th></tr></thead>
|
|
38
|
-
<tbody><tr><td>
|
|
39
|
-
|
|
40
|
-
[mappedRows](./foundation-forms.csvmappingresult.mappedrows.md)
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
</td><td>
|
|
47
|
-
|
|
48
|
-
Record<string, any>\[\]
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
</td><td>
|
|
52
|
-
|
|
53
|
-
The mapped rows with values converted to appropriate types.
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
</td></tr>
|
|
57
|
-
<tr><td>
|
|
58
|
-
|
|
59
|
-
[unmappedColumns](./foundation-forms.csvmappingresult.unmappedcolumns.md)
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
</td><td>
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
</td><td>
|
|
66
|
-
|
|
67
|
-
string\[\]
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
</td><td>
|
|
71
|
-
|
|
72
|
-
CSV columns that could not be matched to schema fields.
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
</td></tr>
|
|
76
|
-
</tbody></table>
|
|
77
|
-
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [CsvMappingResult](./foundation-forms.csvmappingresult.md) > [unmappedColumns](./foundation-forms.csvmappingresult.unmappedcolumns.md)
|
|
4
|
-
|
|
5
|
-
## CsvMappingResult.unmappedColumns property
|
|
6
|
-
|
|
7
|
-
CSV columns that could not be matched to schema fields.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
unmappedColumns: string[];
|
|
13
|
-
```
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [CsvParseResult](./foundation-forms.csvparseresult.md) > [errors](./foundation-forms.csvparseresult.errors.md)
|
|
4
|
-
|
|
5
|
-
## CsvParseResult.errors property
|
|
6
|
-
|
|
7
|
-
Any errors encountered during parsing.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
errors: string[];
|
|
13
|
-
```
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [CsvParseResult](./foundation-forms.csvparseresult.md) > [headers](./foundation-forms.csvparseresult.headers.md)
|
|
4
|
-
|
|
5
|
-
## CsvParseResult.headers property
|
|
6
|
-
|
|
7
|
-
The header names from the first row of the CSV.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
headers: string[];
|
|
13
|
-
```
|
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [CsvParseResult](./foundation-forms.csvparseresult.md)
|
|
4
|
-
|
|
5
|
-
## CsvParseResult interface
|
|
6
|
-
|
|
7
|
-
Result of parsing a CSV file.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export interface CsvParseResult
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Properties
|
|
16
|
-
|
|
17
|
-
<table><thead><tr><th>
|
|
18
|
-
|
|
19
|
-
Property
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
</th><th>
|
|
23
|
-
|
|
24
|
-
Modifiers
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Type
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th><th>
|
|
33
|
-
|
|
34
|
-
Description
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
</th></tr></thead>
|
|
38
|
-
<tbody><tr><td>
|
|
39
|
-
|
|
40
|
-
[errors](./foundation-forms.csvparseresult.errors.md)
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
</td><td>
|
|
47
|
-
|
|
48
|
-
string\[\]
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
</td><td>
|
|
52
|
-
|
|
53
|
-
Any errors encountered during parsing.
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
</td></tr>
|
|
57
|
-
<tr><td>
|
|
58
|
-
|
|
59
|
-
[headers](./foundation-forms.csvparseresult.headers.md)
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
</td><td>
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
</td><td>
|
|
66
|
-
|
|
67
|
-
string\[\]
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
</td><td>
|
|
71
|
-
|
|
72
|
-
The header names from the first row of the CSV.
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
</td></tr>
|
|
76
|
-
<tr><td>
|
|
77
|
-
|
|
78
|
-
[rows](./foundation-forms.csvparseresult.rows.md)
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
</td><td>
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
</td><td>
|
|
85
|
-
|
|
86
|
-
Record<string, string>\[\]
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
</td><td>
|
|
90
|
-
|
|
91
|
-
The parsed data rows as key-value objects.
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
</td></tr>
|
|
95
|
-
</tbody></table>
|
|
96
|
-
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [CsvParseResult](./foundation-forms.csvparseresult.md) > [rows](./foundation-forms.csvparseresult.rows.md)
|
|
4
|
-
|
|
5
|
-
## CsvParseResult.rows property
|
|
6
|
-
|
|
7
|
-
The parsed data rows as key-value objects.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
rows: Record<string, string>[];
|
|
13
|
-
```
|
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [downloadCsvTemplate](./foundation-forms.downloadcsvtemplate.md)
|
|
4
|
-
|
|
5
|
-
## downloadCsvTemplate() function
|
|
6
|
-
|
|
7
|
-
Triggers a download of the CSV template file in the browser.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export declare function downloadCsvTemplate(csvContent: string, fileName?: string): void;
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
<table><thead><tr><th>
|
|
18
|
-
|
|
19
|
-
Parameter
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
</th><th>
|
|
23
|
-
|
|
24
|
-
Type
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Description
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th></tr></thead>
|
|
33
|
-
<tbody><tr><td>
|
|
34
|
-
|
|
35
|
-
csvContent
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
</td><td>
|
|
39
|
-
|
|
40
|
-
string
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
The CSV content to download
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
</td></tr>
|
|
49
|
-
<tr><td>
|
|
50
|
-
|
|
51
|
-
fileName
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
</td><td>
|
|
55
|
-
|
|
56
|
-
string
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
</td><td>
|
|
60
|
-
|
|
61
|
-
_(Optional)_ The name for the downloaded file (default: 'template.csv')
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
</td></tr>
|
|
65
|
-
</tbody></table>
|
|
66
|
-
|
|
67
|
-
**Returns:**
|
|
68
|
-
|
|
69
|
-
void
|
|
70
|
-
|
|
71
|
-
## Remarks
|
|
72
|
-
|
|
73
|
-
Browser-only; uses document and URL.createObjectURL. Will throw in Node.js.
|
|
74
|
-
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [Filters](./foundation-forms.filters.md) > [allSavedFilters](./foundation-forms.filters.allsavedfilters.md)
|
|
4
|
-
|
|
5
|
-
## Filters.allSavedFilters property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
allSavedFilters: any[];
|
|
11
|
-
```
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [Filters](./foundation-forms.filters.md) > [connectedCallback](./foundation-forms.filters.connectedcallback.md)
|
|
4
|
-
|
|
5
|
-
## Filters.connectedCallback() method
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
connectedCallback(): Promise<void>;
|
|
11
|
-
```
|
|
12
|
-
**Returns:**
|
|
13
|
-
|
|
14
|
-
Promise<void>
|
|
15
|
-
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [Filters](./foundation-forms.filters.md) > [data](./foundation-forms.filters.data.md)
|
|
4
|
-
|
|
5
|
-
## Filters.data property
|
|
6
|
-
|
|
7
|
-
Initial data for the filters.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
data: any;
|
|
13
|
-
```
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [Filters](./foundation-forms.filters.md) > [deleteFilter](./foundation-forms.filters.deletefilter.md)
|
|
4
|
-
|
|
5
|
-
## Filters.deleteFilter() method
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
deleteFilter(): Promise<void>;
|
|
11
|
-
```
|
|
12
|
-
**Returns:**
|
|
13
|
-
|
|
14
|
-
Promise<void>
|
|
15
|
-
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-forms](./foundation-forms.md) > [Filters](./foundation-forms.filters.md) > [filterName](./foundation-forms.filters.filtername.md)
|
|
4
|
-
|
|
5
|
-
## Filters.filterName property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
filterName: string;
|
|
11
|
-
```
|