SheetXL - v0.3.20
    Preparing search index...

    Interface ListOptions

    ListFill implements IAutoFill.Filler to work with lists.

    interface ListOptions {
        customLists?: readonly string[][];
        hasDifferentAdjacentFill?: boolean;
        hasSameTypeAdjacentFill?: boolean;
        multiFill?: boolean;
        reverse?: boolean;
        stepValue?: number;
        stopValue?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    customLists? hasDifferentAdjacentFill? hasSameTypeAdjacentFill? multiFill? reverse? stepValue? stopValue?

    Properties

    customLists?: readonly string[][]

    A custom set of lists

    hasDifferentAdjacentFill?: boolean

    Indicates whether there is adjacent span with a different fill type.

    • Purpose: This flag allows Fillers to adjust their behavior based on the presence of adjacent fills. For instance, a numeric Filler might increment by 1 when there's an adjacent fill, but simply copy the value otherwise.
    hasSameTypeAdjacentFill?: boolean

    Indicates whether there is adjacent span with the same fill type.

    hasDifferentAdjacentFill

    multiFill?: boolean

    Indicates whether there is another fill operation being performed in the same series.

    reverse?: boolean

    Indicates whether the fill operation is in reverse order.

    If in reverse order the createFill fill be given values in reverse order. This flag is only needed if there is a single value.

    stepValue?: number

    Override the default increment or step value used when generating a fill.

    • The default it to use the existing values to determine.

    NOT IMPLEMENTED

    For `AutoFill.LinearFill` customize the increment between consecutive numbers
    in a series (e.g., 1, 3, 5 with `stepValue: 2`).
    stopValue?: number

    The stopping value for autofill operations that generate a fill.

    NOT IMPLEMENTED

    • Allow users to specify the maximum value up to which the autofill series should continue.

    Settings

    Member Visibility

    On This Page

    Properties