DataImportOptions

Options for managing the Data Import function

TypeScript

export interface DataImportOptions<T = Record<string,

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

Custom File Handlers to use for Data Import

TypeScript

fileHandlers?: DataImportFileHandler<T>[];

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.

TypeScript

handleImportedData?: (context: HandleImportedDataContext<T>) => Promise<void | HandleImportedDataResolution>;

Handles Importing Data using text

TypeScript

textHandler?: (text: string) => T[] | Promise<T[]>;

(text: string) => T[] | Promise<T[]>

Function to validate the Imported Data

TypeScript

validate?: (context: DataImportValidateContext<T>) => DataImportValidationError[] | undefined;

Function to get the Primary Key value for a data row (defaults to value of the primaryKey column)

It might change in a future version

TypeScript

_getPrimaryKeyValue?: (context: GetPrimaryKeyValueContext<T>) => string | number;

(context:GetPrimaryKeyValueContext<T>) => string | number

Function to pre-process the data before it is imported

It might change in a future version

TypeScript

_preprocessRowData?: (context: PreprocessRowDataContext<T>) => Record<string, any>;

(context:PreprocessRowDataContext<T>) => Record<string, any>