ChoiceField
Extends
Section titled “Extends”FieldBase
Properties
Section titled “Properties”choiceType
Section titled “choiceType”choiceType:
ChoiceType
fieldType
Section titled “fieldType”fieldType:
"Choice"
label:
string
Inherited from
Section titled “Inherited from”FieldBase.label
maxResults?
Section titled “maxResults?”
optionalmaxResults?:number
Lookup only: the most options one search shows. Absent means 8.
minQueryLength?
Section titled “minQueryLength?”
optionalminQueryLength?:number
Lookup only: how many characters to type before searching. Absent means 2.
name:
string
nodeType
Section titled “nodeType”nodeType:
"Field"
Inherited from
Section titled “Inherited from”FieldBase.nodeType
options
Section titled “options”options:
ChoiceOption[]
Always a plain array — the server resolves data-set- and plugin-backed options before sending. Empty for a Lookup, whose options are searched instead.
required
Section titled “required”required:
boolean
submissionKey?
Section titled “submissionKey?”
optionalsubmissionKey?:string
The key this field’s answer is submitted under. Absent on buttons, which carry no value.
Deliberately not the same as name: a field placed by reference to a shared Field is keyed
by that Field’s external id instead. Always submit under this value — deriving a key any other
way silently breaks plugin field mapping on the server.
Inherited from
Section titled “Inherited from”FieldBase.submissionKey