SheetXL - v0.3.20
    Preparing search index...

    Interface ConstructorOptions

    Optional values used in the construction of am ISheet.

    Changes to these options will be ignored after construction.

    interface ConstructorOptions {
        calculation?: ICalculation;
        container?: ContainerOptions;
        date1904?: boolean;
        json?: ISheet.JSON;
        maxColumns?: number;
        maxRows?: number;
        names?: INamedCollection;
        resolveRange?: (address?: ICellRange.Address) => ICellRange;
        resources?: IResourceCollection;
        strings?: IStringCollection;
        styles?: IStyleCollection;
        transactions?: IStore;
        uid?: () => string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    calculation? container? date1904? json? maxColumns? maxRows? names? resolveRange? resources? strings? styles? transactions? uid?

    Properties

    calculation?: ICalculation

    Option to provide a custom calculation.

    container?: ContainerOptions

    When adding to another container.

    date1904?: boolean

    Determine if dates should be 1904 or 1900 based.

    false
    json?: ISheet.JSON

    Initial JSON.

    maxColumns?: number

    Set the maxRow size

    16384
    maxRows?: number

    Set the maxRow size

    1048576
    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.

    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.

    uid?: () => string

    A unique identifier used for identifying this sheet during operations (i.e. copy/paste). This must be unique for all in-memory instances of a sheet.

    Type declaration

      • (): string

      • Returns string

        A unique identifier for in memory operations. If not provided a default one will be used.

    This is not saved as part of the ISheet.JSON persisted model.

    Settings

    Member Visibility

    On This Page

    Properties