Class IORegistry

Constructors

constructor

Methods

exportToFile getAllInputTypeAsString getExportTypeForExt getExportTypes getImportTypeForExt getImportTypeForKey getImportTypeForMimeType getImportTypes importFromArrayBuffer importFromFetch importFromFile

Constructors

constructor

  • new IORegistry(importTypes?, exportTypes?): IORegistry

  • Parameters

    • importTypes: ImportType<ImportWorkbookOptions>[] = DEFAULT_IMPORT_TYPES
    • exportTypes: ExportType<ExportWorkbookOptions>[] = DEFAULT_EXPORT_TYPES

    Returns IORegistry

Methods

exportToFile

  • exportToFile(workbookModel, fileName, exportType?): Promise<boolean>

  • Exports to the local file system attempting to use the fileName provided. This will use the exportType to determine the export handler to use.

    Parameters

    Returns Promise<boolean>

    a Promise indicating success or failure.

getAllInputTypeAsString

  • getAllInputTypeAsString(): string[]

  • A string array of all the mimeTYpes. Used for the input accept attribute.

    Returns string[]

getExportTypeForExt

  • getExportTypeForExt(ext): ExportType<ExportWorkbookOptions>

  • Parameters

    • ext: string

    Returns ExportType<ExportWorkbookOptions>

getExportTypes

  • getExportTypes(): readonly ExportType<ExportWorkbookOptions>[]

  • Returns readonly ExportType<ExportWorkbookOptions>[]

getImportTypeForExt

  • getImportTypeForExt(ext): ImportType<ImportWorkbookOptions>

  • Parameters

    • ext: string

    Returns ImportType<ImportWorkbookOptions>

getImportTypeForKey

  • getImportTypeForKey(key): ImportType<ImportWorkbookOptions>

  • Parameters

    • key: string

    Returns ImportType<ImportWorkbookOptions>

getImportTypeForMimeType

  • getImportTypeForMimeType(mimeType): ImportType<ImportWorkbookOptions>

  • Parameters

    • mimeType: string

    Returns ImportType<ImportWorkbookOptions>

getImportTypes

  • getImportTypes(): readonly ImportType<ImportWorkbookOptions>[]

  • Returns readonly ImportType<ImportWorkbookOptions>[]

importFromArrayBuffer

importFromFetch

importFromFile

  • importFromFile(input?, options?, notifier?): Promise<ImportResults>

  • Will try to read from local file system using available IO handlers. The input can be either a File, a Promise, or a string. If a string is provided, if should be either an extension or a mimetype that will be passed to the accept attribute of an input:

    Parameters

    Returns Promise<ImportResults>

    a promise that resolves to an ImportResults object.

    See

    https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept.

    Remarks

    This is just a wrapper around CommonUtils.openFile, importFromArrayBuffer, that .

Settings

Member Visibility

Theme

On This Page

constructorexportToFilegetAllInputTypeAsStringgetExportTypeForExtgetExportTypesgetImportTypeForExtgetImportTypeForKeygetImportTypeForMimeTypegetImportTypesimportFromArrayBufferimportFromFetchimportFromFile