ColumnFilter | @sheetwrite/core

@sheetwrite/coretype

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

Source: packages/core/src/types/document.ts#L92

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";
    };

Referenced by

Workspace packages depending on @sheetwrite/core

@sheetwrite/benchdependency
@sheetwrite/docs-startdependency
@sheetwrite/reactdependency
@sheetwrite/sveltedependency
@sheetwrite/vuedependency
@sheetwrite/xlsxdependency

Public exports naming ColumnFilter

DocumentOp@sheetwrite/core
Grid@sheetwrite/core
Sheet@sheetwrite/core
SheetSnapshot@sheetwrite/core
SheetwriteStore@sheetwrite/core
Grid@sheetwrite/react
Grid@sheetwrite/svelte
Grid@sheetwrite/vue

Loading documentation…