SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Class List

    The List Filler uses a list of strings in a repeating pattern.

    This the default Filler when non is specified or no filler accepts the values being provided.

    Implements

    Index
    constructor
    id type
    createFillAt matches
    id: string = 'list'

    Identifies the filler. Must be unique among the fillers in use.

    This is what names the fill in a menu, survives into a transaction's ITransaction.Operation.params, and lets a script ask for a fill type by name — so it is a stable key, not a display label.

    type: InteropScalarType = InteropScalarType.String

    The value type this filler reads.

    • The filler is only ever offered values of this type — a claim that runs past the type is trimmed back, so matches does not have to re-check what the caller already knows. Blanks carry no type and never split a series.
    • Leave it undefined to be offered a segment of ANY type (still one type at a time).
    • Dates are InteropScalarType.Date: cell values are serial numbers, and it is the cell's number format — not the runtime type — that makes one a date.
    • A filler that reads more than one type registers once per type; where it sits in each Composite's list is its priority for that type.

    • Create a IAutoFill.FillAt function using the provided values and options.

      Parameters

      Returns FillAt<string> | null

      • The first elements in the values is guaranteed to never be null.
      • Return null if the autofill is unable to fill.

    • Claims the leading run whose values all belong to ONE list. A value can sit in several (May is in both the long and the short months), so the claim narrows the candidate lists as it goes and stops at the first value that leaves none.

      Parameters

      • values: readonly string[]
      • from: number = 0

      Returns number

      IAutoFill.Filler.matches

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods