SheetXL - v0.3.20
    Preparing search index...

    Class Calculation

    Implementation for ICalculation.

    Hierarchy

    • AbstractModel<State, ICalculation.JSON, CommitView, ICalculation.IListeners>
      • Calculation

    Implements

    Index

    Constructors

    constructor

    Accessors

    isIModel

    Methods

    addListeners beginCommit close delete doBatch getFunctions getRuntime getStatus getType isClosed isDeleted isReadOnly start stop

    Constructors

    Accessors

    • get isIModel(): true

      For runtime type checking.

      Returns true

    Methods

    • Batches all 'transactional' changes until they have all be committed or rolled back.

      Parameters

      • Optionaloptions: string | OperationOptions

        Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.

      Returns ITransaction

      Any changes that are made to this object will be reflected in the local record but not committed to the transactional store until the batch is popped.

      Useful for operations that are longer running but generally not recommended as it keeps a transaction open. doBatch is the preferred option.

    • Close the record and cleans resources. Can't be undone.

      Returns void

    • Provides a mechanism to perform a set of operations in a batch.

      Type Parameters

      • R

      Parameters

      • callback: (commit: ICommit) => R | Promise<R>

        A callback that performs multiple operations all within the same transaction.

      • Optionaloptions: string | OperationOptions

        Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.

      Returns R | Promise<R>

    • For introspecting the current runtime.

      Returns IRuntime

      This is generally used for debugging but the built-in INFO function also makes use of this.

    • Returns an immutable type string.

      Returns string

    • Returns true if no more operations are allowed.

      Returns boolean

    • If the model unable to be modified.

      Returns boolean

    • If the model unable to be modified.

      Returns boolean

    • Starts the ICalculation engine.

      Returns Promise<void>

      • This is required to be called before any calculations can be performed.
      • This will initialize the calculation engine and prepare it for use.
      • Will fire events and return a promise when the calculation is started. (or errors);

    • Stops the ICalculation engine.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods