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

    Interface RangeOptions

    Options for applying conditions across multiple spans (rows or columns).

    interface RangeOptions {
        axis?: Axis;
        conditions: Input<any>[];
        hasHeader?: boolean;
        includeHidden?: boolean | Axis;
    }
    Index
    axis?: Axis

    The axis to hide.

    conditions: Input<any>[]

    The conditions, each carrying the column (or row, per axis) it tests through IndexedProperties.index; one that omits it tests its position in the array.

    hasHeader?: boolean

    Indicate if the range has a header. If true the first row/column (per axis) is never evaluated or hidden.

    false
    

    Mirrors ISort.RangeOptions.hasHeader, but unlike sort this never guesses — a filter with no explicit hasHeader evaluates the entire range, header row included.

    includeHidden?: boolean | Axis

    Whether rows/columns already hidden take part.

    For a filter (ICellRange.filter, ITable.filter) the default is true: an apply is a full recompute, so a row hidden by an earlier apply, or by hand, comes back when it matches. false pins the rows already hidden as excluded. Conditional formats and data validations default to false and skip hidden cells.

    true for a filter, false otherwise