Skip to content

FieldSchema

Property Type Description
decimals? number Most decimal places allowed; for percents, of the percentage (12.5% has 1).
description? Localized Shown in the formula bar when a cell of this field is selected; in one language or several.
formula? "allow" | "forbid" | "require" Whether cells may, must or must not hold formulas. Default “allow”.
key string Stable name used in code and rules.
label TextMatch Header text in the workbook.
max? string | number -
maxLength? number -
min? string | number Inclusive bounds: numbers (percents as fractions) or ISO dates for date fields.
minLength? number Bounds on the length of text values.
pattern? string Regular expression the text form of the value must match.
patternHint? Localized How to describe the pattern to people, e.g. “like SKU-1234”, shown as “Should be like SKU-1234.”; in one language or several.
readOnly? boolean -
required? boolean -
type FieldType -
unique? boolean No two records may share a value.
validate? (value, ctx) => | CheckResult | Promise<CheckResult> Code hook: extra check, sync or async. Async checks re-run only when the value changes.
values? string[] Allowed values for “enum” fields; typed input is matched ignoring case.