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.

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

Variants 5

{
  kind: "list";
  values: readonly CellScalartype CellScalar = string | number | boolean | null;type CellScalar = string | number | boolean | null;type CellScalar =
  | string
  | number
  | boolean
  | null;A scalar that can be displayed directly.API reference →[];
  allowCustom?: boolean;
}

{
  kind: "number";
  min?: number;
  max?: number;
  integer?: boolean;
  comparison?: DataValidationComparisontype DataValidationComparison =
  | { operator: "between" | "notBetween"; min: number; max: number }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };type DataValidationComparison =
  | { operator: "between" | "notBetween"; min: number; max: number }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };type DataValidationComparison =
  | {
      operator:
        "between" | "notBetween";
      min: number;
      max: number;
    }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };Native comparison semantics for numeric, date-serial, and text-length validation. Interval operands are inclusive; notBetween accepts values outside that interval.API reference →;
}

{
  kind: "date";
  min?: number;
  max?: number;
  comparison?: DataValidationComparisontype DataValidationComparison =
  | { operator: "between" | "notBetween"; min: number; max: number }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };type DataValidationComparison =
  | { operator: "between" | "notBetween"; min: number; max: number }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };type DataValidationComparison =
  | {
      operator:
        "between" | "notBetween";
      min: number;
      max: number;
    }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };Native comparison semantics for numeric, date-serial, and text-length validation. Interval operands are inclusive; notBetween accepts values outside that interval.API reference →;
}

{
  kind: "textLength";
  min?: number;
  max?: number;
  comparison?: DataValidationComparisontype DataValidationComparison =
  | { operator: "between" | "notBetween"; min: number; max: number }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };type DataValidationComparison =
  | { operator: "between" | "notBetween"; min: number; max: number }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };type DataValidationComparison =
  | {
      operator:
        "between" | "notBetween";
      min: number;
      max: number;
    }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };Native comparison semantics for numeric, date-serial, and text-length validation. Interval operands are inclusive; notBetween accepts values outside that interval.API reference →;
}

{
  kind: "checkbox";
  checkedValue?: CellScalartype CellScalar = string | number | boolean | null;type CellScalar = string | number | boolean | null;type CellScalar =
  | string
  | number
  | boolean
  | null;A scalar that can be displayed directly.API reference →;
  uncheckedValue?: CellScalartype CellScalar = string | number | boolean | null;type CellScalar = string | number | boolean | null;type CellScalar =
  | string
  | number
  | boolean
  | null;A scalar that can be displayed directly.API reference →;
}

Declaration

View full TypeScript declaration

export type DataValidationCondition =
  | {
      kind: "list";
      values: readonly CellScalartype CellScalar = string | number | boolean | null;type CellScalar = string | number | boolean | null;type CellScalar =
  | string
  | number
  | boolean
  | null;A scalar that can be displayed directly.API reference →[];
      allowCustom?: boolean;
    }
  | {
      kind: "number";
      min?: number;
      max?: number;
      integer?: boolean;
      comparison?: DataValidationComparisontype DataValidationComparison =
  | { operator: "between" | "notBetween"; min: number; max: number }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };type DataValidationComparison =
  | { operator: "between" | "notBetween"; min: number; max: number }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };type DataValidationComparison =
  | {
      operator:
        "between" | "notBetween";
      min: number;
      max: number;
    }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };Native comparison semantics for numeric, date-serial, and text-length validation. Interval operands are inclusive; notBetween accepts values outside that interval.API reference →;
    }
  | {
      kind: "date";
      min?: number;
      max?: number;
      comparison?: DataValidationComparisontype DataValidationComparison =
  | { operator: "between" | "notBetween"; min: number; max: number }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };type DataValidationComparison =
  | { operator: "between" | "notBetween"; min: number; max: number }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };type DataValidationComparison =
  | {
      operator:
        "between" | "notBetween";
      min: number;
      max: number;
    }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };Native comparison semantics for numeric, date-serial, and text-length validation. Interval operands are inclusive; notBetween accepts values outside that interval.API reference →;
    }
  | {
      kind: "textLength";
      min?: number;
      max?: number;
      comparison?: DataValidationComparisontype DataValidationComparison =
  | { operator: "between" | "notBetween"; min: number; max: number }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };type DataValidationComparison =
  | { operator: "between" | "notBetween"; min: number; max: number }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };type DataValidationComparison =
  | {
      operator:
        "between" | "notBetween";
      min: number;
      max: number;
    }
  | {
      operator:
        | "equal"
        | "notEqual"
        | "greaterThan"
        | "lessThan"
        | "greaterThanOrEqual"
        | "lessThanOrEqual";
      value: number;
    };Native comparison semantics for numeric, date-serial, and text-length validation. Interval operands are inclusive; notBetween accepts values outside that interval.API reference →;
    }
  | {
      kind: "checkbox";
      checkedValue?: CellScalartype CellScalar = string | number | boolean | null;type CellScalar = string | number | boolean | null;type CellScalar =
  | string
  | number
  | boolean
  | null;A scalar that can be displayed directly.API reference →;
      uncheckedValue?: CellScalartype CellScalar = string | number | boolean | null;type CellScalar = string | number | boolean | null;type CellScalar =
  | string
  | number
  | boolean
  | null;A scalar that can be displayed directly.API reference →;
    };