DataValidationCondition | @sheetwrite/core

Serializable condition enforced by a data-validation rule.

min and max remain inclusive legacy bounds. Use comparison when the operator itself is significant; comparison and legacy bounds are mutually exclusive.

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

Variants 5

{
  kind: "list";
  values: readonly CellScalar[];
  allowCustom?: boolean;
}

{
  kind: "number";
  min?: number;
  max?: number;
  integer?: boolean;
  comparison?: DataValidationComparison;
}

{
  kind: "date";
  min?: number;
  max?: number;
  comparison?: DataValidationComparison;
}

{
  kind: "textLength";
  min?: number;
  max?: number;
  comparison?: DataValidationComparison;
}

{
  kind: "checkbox";
  checkedValue?: CellScalar;
  uncheckedValue?: CellScalar;
}

Declaration

View full TypeScript declaration

export type DataValidationCondition =
  | {
      kind: "list";
      values: readonly CellScalar[];
      allowCustom?: boolean;
    }
  | {
      kind: "number";
      min?: number;
      max?: number;
      integer?: boolean;
      comparison?: DataValidationComparison;
    }
  | {
      kind: "date";
      min?: number;
      max?: number;
      comparison?: DataValidationComparison;
    }
  | {
      kind: "textLength";
      min?: number;
      max?: number;
      comparison?: DataValidationComparison;
    }
  | {
      kind: "checkbox";
      checkedValue?: CellScalar;
      uncheckedValue?: CellScalar;
    };

Referenced by

Workspace packages depending on @sheetwrite/core

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

Public exports naming DataValidationCondition

DataValidationRule@sheetwrite/core

Loading documentation…