Interface CsvImportOptions

interface CsvImportOptions {
    isDate1904System?: boolean;
    maxColumns?: number;
    maxRows?: number;
    onGetCellAt?: ((sheetName, key, cell) => void);
    papaParseConfig?: ParseConfig<any, undefined>;
    setCellOptions?: SetCellOptions;
    sharedResources?: ISharedResourceCollection;
    sheetCreator?: ((name, initialState?, options?) => ISheetModel);
    sheetNameCreator?: ((index) => string);
    sheetStyle?: ISheetStyle;
    theme?: IDocTheme;
    transactionStore?: TransactionStore;
}

Hierarchy

  • ImportWorkbookOptions
    • CsvImportOptions

Properties

isDate1904System? maxColumns? maxRows? onGetCellAt? papaParseConfig? setCellOptions? sharedResources? sheetCreator? sheetNameCreator? sheetStyle? theme? transactionStore?

Properties

Optional isDate1904System

isDate1904System?: boolean

Determine if dates should be 1904 instead of 1900 based

Default Value

false

Optional maxColumns

maxColumns?: number

Set the maxRow size

Default Value

16384

Optional maxRows

maxRows?: number

Set the maxRow size

Default Value

1048576

Optional onGetCellAt

onGetCellAt?: ((sheetName, key, cell) => void)

Type declaration

    • (sheetName, key, cell): void

    • Parameters

      Returns void

Optional papaParseConfig

papaParseConfig?: ParseConfig<any, undefined>

configuration for csv import

Remarks

CSV parse delegates to the excellent Papa Parse library. All options are exposes via papParseConfig.

See

https://www.papaparse.com/docs#config

Optional setCellOptions

setCellOptions?: SetCellOptions

Optional sharedResources

sharedResources?: ISharedResourceCollection

collection of shared resources. If not provided then workbook will create it's own.

Optional sheetCreator

sheetCreator?: ((name, initialState?, options?) => ISheetModel)

Hook to allow for custom sheet creation

Type declaration

Returns

ISheetModel

Optional sheetNameCreator

sheetNameCreator?: ((index) => string)

This is a function that will return a sheet name given a 1-based index.

Type declaration

    • (index): string

    • Parameters

      • index: number

      Returns string

Default Value

Sheet${index}

Optional sheetStyle

sheetStyle?: ISheetStyle

collection of shared styles. If not provided then workbook will create it's own.

Optional theme

theme?: IDocTheme

Optional transactionStore

transactionStore?: TransactionStore

The store for all state changes. This is provided to enable versioning, undo/redo, distributed editing, etc.

Default Value

internal

Settings

Member Visibility

Theme

On This Page

isDate1904SystemmaxColumnsmaxRowsonGetCellAtpapaParseConfigsetCellOptionssharedResourcessheetCreatorsheetNameCreatorsheetStylethemetransactionStore