decimals? |
number |
Most decimal places allowed; for percents, of the percentage (12.5% has 1). |
FieldSchema.decimals |
description? |
Localized |
Shown in the formula bar when a cell of this field is selected; in one language or several. |
FieldSchema.description |
formula? |
"allow" | "forbid" | "require" |
Whether cells may, must or must not hold formulas. Default “allow”. |
FieldSchema.formula |
key |
string |
Stable name used in code and rules. |
FieldSchema.key |
label? |
object |
A fixed label that must sit in another cell, e.g. { ref: “A8”, text: “Approved by” }. |
- |
label.ref |
string |
- |
- |
label.text |
TextMatch |
- |
- |
max? |
string | number |
- |
FieldSchema.max |
maxLength? |
number |
- |
FieldSchema.maxLength |
min? |
string | number |
Inclusive bounds: numbers (percents as fractions) or ISO dates for date fields. |
FieldSchema.min |
minLength? |
number |
Bounds on the length of text values. |
FieldSchema.minLength |
pattern? |
string |
Regular expression the text form of the value must match. |
FieldSchema.pattern |
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. |
FieldSchema.patternHint |
readOnly? |
boolean |
- |
FieldSchema.readOnly |
ref |
string |
Where the value lives, e.g. “B8”. |
- |
required? |
boolean |
- |
FieldSchema.required |
type |
FieldType |
- |
FieldSchema.type |
unique? |
boolean |
No two records may share a value. |
FieldSchema.unique |
validate? |
(value, ctx) => | CheckResult | Promise<CheckResult> |
Code hook: extra check, sync or async. Async checks re-run only when the value changes. |
FieldSchema.validate |
values? |
string[] |
Allowed values for “enum” fields; typed input is matched ignoring case. |
FieldSchema.values |
