SheetXL - v0.3.20
    Preparing search index...

    Interface ConstructorOptions

    Options for creating an ICalculation.

    interface ConstructorOptions {
        createDescription?: string;
        getFunction?: (name: string) => IFunction;
        getNamed?: (name: string, scope?: string) => IRange.FixableCoords[];
        isDate1904?: () => boolean;
        json?: JSON;
        maxIterations?: number;
        transactions?: IStore;
        type?: string;
        deleteFromContainer(options?: OperationOptions): void;
        isReadOnly(): boolean;
        setContainerReadOnlyCallback(callback: ReadOnlyCallback): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createDescription? getFunction? getNamed? isDate1904? json? maxIterations? transactions? type?

    Methods

    deleteFromContainer? isReadOnly? setContainerReadOnlyCallback?

    Properties

    createDescription?: string

    Use for the creation transaction description.

    getFunction?: (name: string) => IFunction

    Hook to provide custom functions.

    Type declaration

      • (name: string): IFunction

      • Parameters

        • name: string

          name of the function

        Returns IFunction

        IFunction

    Names will always be passed as the user input them but are generally treated as case insensitive

    getNamed?: (name: string, scope?: string) => IRange.FixableCoords[]

    Hook to provide custom names.

    Type declaration

    Names will always be passed as the user input them but are generally treated as case insensitive

    isDate1904?: () => boolean

    Callback that determines if dates are 1904.

    json?: JSON

    JSON state to load.

    maxIterations?: number

    The maximum number of iterations to perform when calculating.

    transactions?: IStore

    A transaction store that can be used to undo/redo changes to the model.

    type?: string

    The type of the model.

    Methods

    • Delete from the container.

      Parameters

      Returns void

    • If the item is readonly.

      Returns boolean

    • Notify if the readonly has been updated from the container.

      Parameters

      • callback: ReadOnlyCallback

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods