SheetXL - v0.3.20
    Preparing search index...

    Interface ConstructorOptions

    Options available when creating an IWorkbook.

    interface ConstructorOptions {
        calculation?: ICalculation;
        createSheetCallback?: CreateSheetCallback;
        createSheetNameCallback?: (index: number) => string;
        date1904?: boolean;
        json?: JSON;
        names?: INamedCollection;
        resolveRange?: (address?: ICellRange.Address) => ICellRange;
        resources?: IResourceCollection;
        strings?: IStringCollection;
        styles?: IStyleCollection;
        theme?: ITheme;
        transactions?: IStore;
    }

    Hierarchy (View Summary)

    Index

    Properties

    calculation? createSheetCallback? createSheetNameCallback? date1904? json? names? resolveRange? resources? strings? styles? theme? transactions?

    Properties

    calculation?: ICalculation

    Option to provide a custom calculation.

    createSheetCallback?: CreateSheetCallback

    Hook to allow for custom sheet creation.

    createSheetNameCallback?: (index: number) => string

    Returns a human readable sheet name given a 0-based index.

    Sheet${index+1}

    date1904?: boolean

    Determine if dates should be 1904 or 1900 based.

    false
    json?: JSON

    Load from JSON.

    names?: INamedCollection

    Option to provide shared names.

    This is not the interface because we want the instance that allows for adding items other than named ranges.

    resolveRange?: (address?: ICellRange.Address) => ICellRange

    Allows for address to be resolved in custom ways.

    • This should return null if unresolvable but only throw and error if it is identified a a parsing error.
    • This is used by INamedCollection to created named ranges.
    resources?: IResourceCollection

    Option to provide shared resources.

    strings?: IStringCollection

    Option to provide shared strings.

    styles?: IStyleCollection

    Option to provide a shared StyleCollection. If not provided then a new StyleCollection with default theming will be used.

    theme?: ITheme

    A theme for the workbook.

    transactions?: IStore

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

    If not specified then an internal ITransaction.IStore will be created.

    Settings

    Member Visibility

    On This Page

    Properties