Import Technical Reference
Summary
- Importing is set through Options
- The Data Import API contains functions to manage exporting and reports programmatically
- Import Event
- There is no Initial Adaptable State associated with Data Import
Data Import Options
The Data Import Options section of Adaptable Options contains these properties:
| Property | Type | Description |
|---|---|---|
| fileHandlers | DataImportFileHandler<T>[] | Custom File Handlers to use for Data Import |
| handleImportedData | (context:HandleImportedDataContext<T>) => Promise<void |HandleImportedDataResolution> | Function to handle the Imported Data and apply it to the Grid. If not provided then the Data will be applied to the Grid automatically. |
| textHandler | (text: string) => T[] | Promise<T[]> | Handles Importing Data using text |
| validate | (context:DataImportValidateContext<T>) =>DataImportValidationError[] | undefined | Function to validate the Imported Data |
| _getPrimaryKeyValue | (context:GetPrimaryKeyValueContext<T>) => string | number | Function to get the Primary Key value for a data row (defaults to value of the primaryKey column) |
| _preprocessRowData | (context:PreprocessRowDataContext<T>) => Record<string, any> | Function to pre-process the data before it is imported |
Data Import API
The Data Import API section of Adaptable API contains just one function which starts the Data Import Wizard:
| Method | Returns | Description |
|---|---|---|
| openImportWizard() | void | Opens the Data Import Wizard |
Data Imported Event
The Data Imported Event is published whenever data has been imported.
DataImportedInfo
The DataImportedInfo object returned by the Event contains details of the rows which have been added and / or updated by the Import.
| Property | Type | Description |
|---|---|---|
| addedRows | IRowNode[] | Rows that were added |
| importData | any[] | Raw data that was imported |
| updatedRows | IRowNode[] | Rows that were updated |
| adaptableContext | any | Custom application Context provided in AdaptableOptions.adaptableContext |
Event Subscription
Subscribing to the Event is done the same way as with all Adaptable Events:
api.eventApi.on('DataImported', (eventInfo: DataImportedInfo) => {
// do something with the info
});