SheetXL - v0.3.20
    Preparing search index...

    Interface IncrementalUpdater<T>

    A Results builder for creating new Ranges. A builder maintains an ordered structure where major and minor values must always increase, otherwise an error will be thrown.

    interface IncrementalUpdater<T extends Scalar> {
        apply(): IRange;
        pushAt(row: number, col: number, value: T): this;
        pushMultipleAt(row: number, col: number, value: T[]): this;
    }

    Type Parameters

    • T extends Scalar

      The type of values stored within the tuples.

    Index

    Methods

    • Adds a single value associated with a specific major and minor index.

      Parameters

      • row: number

        The row index.

      • col: number

        The column index.

      • value: T

        The value to be added.

      Returns this

      Error If the point is out of order compared to previously added points (within the same row).

      If the value is an Array, it will be treated as a discrete value. If you want to set multiple values along the minor axis, then use pushMultipleAt.

    • Adds multiple values associated with a specific row and column index.

      Parameters

      • row: number

        The row index.

      • col: number

        The column index.

      • value: T[]

        An array of values to be added.

      Returns this

      Error If the point is out of order compared to previously added points (within the same row).