Skip to content
Sheetwrite

Sheetwrite / Documentation

ColumnFilter@sheetwrite/core

One column's filter predicate.
@sheetwrite/coretype

One column's filter predicate. All active column filters AND together; matching is against the cell's resolved value (text or number).

Package
@sheetwrite/core
Source
packages/core/src/types/document.ts#L60

Variants 5

{ kind: "values"; values: readonly CellScalar[] }
{ kind: "contains"; text: string; matchCase?: boolean }
{
  kind: "compare";
  op: "gt" | "gte" | "lt" | "lte" | "eq" | "neq";
  value: number;
}
{ kind: "empty" }
{ kind: "nonEmpty" }

Declaration

View full TypeScript declaration 
export type ColumnFilter =
  | {
      kind: "values";
      values: readonly CellScalar[];
    }
  | {
      kind: "contains";
      text: string;
      matchCase?: boolean;
    }
  | {
      kind: "compare";
      op: "gt" | "gte" | "lt" | "lte" | "eq" | "neq";
      value: number;
    }
  | {
      kind: "empty";
    }
  | {
      kind: "nonEmpty";
    };