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

    Interface Items

    What IFilter.getItems answers.

    interface Items {
        blanksChecked: boolean;
        byDisplay: boolean;
        dates?: readonly DateLevel[];
        hasBlanks: boolean;
        items: readonly Item[];
        total: number;
        truncated: boolean;
    }
    Index
    blanksChecked: boolean

    Whether at least one blank row passes the filters.

    byDisplay: boolean

    The mode the list was read in, so a caller writes the items back under the same one: { operator: 'inSet', param: { items, byDisplay } }. A list read by value fed back as texts under byDisplay would match nothing for a number.

    dates?: readonly DateLevel[]

    The date tree over the leading items, one level per entry: year, month and day, then hour, minute and second when a date carries a time. Absent when the column shows no date.

    A date is a number shown under a date format; a time-only format is a number. Every level covers the same items, 0 to the last date, and a finer level's runs nest inside the coarser's. A node's checkbox is the state of its items; a checked node is written as its run's value, in ICondition.InSetOption.dateGroups.

    hasBlanks: boolean

    Whether a listed row is blank: empty, or showing nothing (a "" result, a string of only spaces). The same rows includeBlanks keeps.

    items: readonly Item[]

    The distinct values, or the distinct texts under byDisplay. The dates come first (the tree in dates), newest year first and ascending within a year, as Excel's date tree lists them; the rest follow, ascending by the workbook's comparison of their values. Values that show alike are one item. Blanks are not an item.

    total: number

    The rows read.

    truncated: boolean

    Whether the column has more distinct values than limit; the rest are not listed.