ReferenceSDK neutral
Definition properties
Canonical property entries with declarations, defaults, flags, and type availability.
A property has one stable URL even when several definition types declare it with distinct defaults or descriptions.
acceptedTypesAn `accept` list — image/*, .pdf — offered to the picker and enforced.addPanelTextAvailable on 1 typesaddRowTextAvailable on 1 typesallowAddPanelAvailable on 1 typesallowAddRowsAvailable on 1 typesallowCameraCaptureOffer the camera as well as the filesystem, where the platform has one.allowDigitsSet false to reject an answer containing any digit.allowMultipleAvailable on 1 typesallowRemovePanelAvailable on 1 typesallowRemoveRowsAvailable on 1 typesallowResizeWhether the respondent may drag the field taller.alternateRowsShade alternate rows. Presentation only.altTextFalls back to the title, then to empty — a decorative image.autoFocusFirstQuestionGive the first question on each page focus as the page arrives.autoGrowGrow to fit the answer rather than scrolling.backgroundColorEmpty is transparent, which is what a signature on a form usually wants.blankSizeDefault blank width in characters. A blank size wins.caseSensitiveRequire matching case when marking by text. Off by default: an assessment marking "paris" wrong is measuring typing rather than the subject.checkErrorsModeonNextPage, onValueChanged or onComplete.choicesByUrlURL to load choices from; may interpolate {question} placeholders.choicesFromQuestionName of a select question whose choices are carried forward.choicesFromQuestionModeall, selected or unselected.choicesLazyLoadEnabledThe list arrives a page at a time from the host loader.choicesLazyLoadPageSizeHow many choices one page asks for.choicesOrdernone, asc or desc.choicesPathDotted path to the array inside the response.choicesTitleNameAvailable on 8 typeschoicesValueNameAvailable on 8 typesclearInvisibleValuesnone, onHidden or onComplete. What happens to an unreachable answer.colCountHow many columns the elements flow into.columnThe column summarised.completedHtmlMarkup shown once the survey is finished. {name} resolves to an answer.confirmDeleteRemoving a row asks first. A row can hold a lot of typing.confirmDeleteTextAvailable on 2 typescontentModeimage or video.correctAnswerThe answer that scores. A question without one is not part of the quiz. Never shown.currencyAvailable on 1 typesdefaultPanelValueAnswers a new instance starts with, keyed by question name.defaultRowValueAnswers a new row starts with, keyed by column name.defaultValueExpressionExpression supplying a value while the question is unanswered.defaultValueFromLastRowA new row starts as a copy of the one before it. Wins over defaultRowValue.descriptionAvailable on 2 typesdetailPanelModenone, underRow, or underRowSingle (one row open at a time).displayModeauto, buttons or dropdown. auto collapses a long scale.displayStylenone, decimal, currency, percent or date.eachRowUniqueNo two rows may be answered with the same column.emptyHtmlMarkup shown when no page is visible, so there is nothing to answer.enableIfExpression; the element is editable only while it evaluates truthy.expressionComputed from the answers. The respondent does not supply it.formatTemplate around the result, with {0} standing for it.fromNameAvailable on 1 typesgoNextPageAutomaticTurn the page once every question on it has a one-step answer.gotoNamePage name, or a question name whose page is navigated to.htmlMarkup, rendered as markup. See HtmlElement on the trust boundary.imageFitnone, contain, cover or fill. Mirrors CSS object-fit.imageHeightAvailable on 2 typesimageLinkPicture or video for this choice. Only an imagepicker draws it.imageWidthCSS pixels. 0 lets layout decide.includeIntoResultWhether the computed value joins the survey answers.inputTypetext, number, email, date, datetime-local, time, tel, url, color, range or password.isAllRowRequiredEvery visible row demands an answer, not just the question as a whole.isRequiredAvailable on 23 typesitemSizeDefault field width in characters. An item size wins.kindsum, count, min, max or avg.labelFalseAvailable on 1 typeslabelTrueAvailable on 1 typesloadingHtmlMarkup shown while the host reports the survey as loading.localeBCP-47 tag the survey opens in. Which one a respondent switches to afterwards is not part of the definition.maxUpper bound, read the same way as min.maxCountAvailable on 1 typesmaxFileCount0 means no limit.maximumFractionDigits0 leaves it to the style.maxLengthLength budget. 0 means none, which also hides the counter.maxPanelCount0 means no limit.maxRateDescriptionAvailable on 1 typesmaxRowCount0 means no limit.maxSelectedChoices0 means no limit.maxSizeBytes. 0 means no limit.maxTimeToFinishSeconds allowed for this page. 0 falls back to the survey's default.maxTimeToFinishPageSeconds allowed for a page that does not state its own. 0 means untimed.maxValueOmit for no upper bound.minLower bound. A number for numeric types, an ISO string for date ones.minCountAvailable on 1 typesminLengthAvailable on 1 typesminPanelCountInstances shown before the respondent adds any, and the floor on removal.minRateDescriptionAvailable on 1 typesminRowCountRows shown before the respondent adds any, and the floor on removal.minValueOmit for no lower bound.minWidthCSS length.mobileModeauto, table or list. auto turns the table into a list on a narrow screen.multiSelectThe one select type whose arity is a property rather than its type.nameThe name this value is referenced by in expressions.noneTextAvailable on 8 typesotherTextAvailable on 8 typespanelTitleFormatInstance heading template, with {0} as its number.penColorAvailable on 1 typesplaceholderAvailable on 11 typesprecisionDecimal places shown.progressBarTypepages, questions or requiredQuestions.questionErrorLocationWhether a question draws its errors above its input or below it.questionsOnPageModestandard, singlePage or questionPerPage.rateMaxAvailable on 1 typesrateMinAvailable on 1 typesrateStepAvailable on 1 typesrateTypelabels, stars or smileys.readOnlyThe answer is shown but cannot be changed by the respondent.regexPattern the answer must match. Applied with the unicode flag.removePanelTextAvailable on 1 typesremoveRowTextAvailable on 1 typesrenderAsswitch or radio.renderModelist shows every instance; tab and progress show one at a time.requiredErrorTextReplaces the built-in message shown when a required answer is missing.requiredIfExpression; when present it overrides isRequired.resetValueIfExpression; while truthy the answer is cleared. Wins over the others.rowsVisible height, in lines.rowTitleFormatRow header template, with {0} as the row number.runExpressionAvailable on 1 typessearchEnabledWhether a long list may be narrowed by typing.selectAllTextAvailable on 4 typesselectToRankAreasLayouthorizontal or vertical. Where the pool sits relative to the ranking.selectToRankEnabledChoices start in a pool and are ranked only once placed.setToNameAvailable on 3 typessetValueLiteral written to setToName.setValueExpressionAvailable on 22 typessetValueIfExpression; while truthy, setValueExpression drives the answer.showClearButtonAvailable on 1 typesshowLabelWhether the choice text is shown. It is the tile name either way.showNoneItemAvailable on 8 typesshowOtherItemAvailable on 8 typesshowPreviewAvailable on 1 typesshowPreviewBeforeCompletenoPreview, showAllQuestions or showAnsweredQuestions.showProgressBaroff, top, bottom or both.showSelectAllItemAvailable on 4 typesshowTimerPanelnone, top or bottom.showTimerPanelModepage, survey or all. Which clocks the panel shows.showTOCOffer a list of pages the respondent can jump between.signatureFormatpng, jpeg or svg.signatureHeightAvailable on 1 typessignatureWidthAvailable on 1 typessizeWidth in characters. 0 uses itemSize.startWithNewLineBreak onto a fresh row rather than flowing into the columns beside it.statedefault, expanded or collapsed. Collapsed panels start closed.step0 lets the browser choose.storeDataAsTextThe content travels inside the response instead of being uploaded.templateProse with [[name]] marking each blank. Translators may move a marker.textDisplay text; falls back to the value.textDirectionauto, ltr or rtl. auto reads the direction off the locale.titleDisplay label; falls back to name.titleLocationdefault, top, left or hidden. Hidden is visual only; it is still announced.trimIgnore surrounding whitespace when marking by text.validationEnabledSet false to stop validation blocking navigation or completion.valueAvailable on 1 typesvalueFalseAvailable on 1 typesvalueNameAnswer key, when it should differ from the name. Shared keys share an answer.valueTrueWhat is stored for yes. Anything the host backend expects.visibleIfExpression; the choice is offered only while truthy.widthCSS length. Empty fills its column.