Add error into the question error list.

A11Y properties

Get is question ready to use

Call this function to clear all errors in the question

Gets or sets a value that specifies how invisible question clears the value. By default the behavior is define by Survey "clearInvisibleValues" property.

The following options are available:

• default (default) - Survey "clearInvisibleValues" property defines the behavior.
• none - do not clear invisible value.
• onHidden - clear the question value when it becomes invisible. If a question has value and it was invisible initially then survey clears the value on completing.
• onComplete - clear invisible question value on survey complete.

Call this function to remove values from the current question, that end-user will not be able to enter. For example the value that doesn't exists in a radigroup/dropdown/checkbox choices or matrix rows/columns.

Clear the question value. It clears the question comment as well.

Make a clone of the existing object. Create a new object of the same type and load all properties into it.

Collapse the Element

The question comment value.

Use this property to set the place holder text for comment field .

Use it to get or set the comment value.

Returns true if a question or a container (panel/page) or their chidren have an error. The value can be out of date. hasErrors function should be called to get the correct value.

The correct answer on the question. Set this value if you are doing a quiz. Please note, this property is hidden for question without input, for example html question.

Returns all css classes that used for rendering the question, panel or page. You can use survey.onUpdateQuestionCssClasses event to override css classes for a question, survey.onUpdatePanelCssClasses event for a panel and survey.onUpdatePageCssClasses for a page.

Returns the validation errors count.

The link to the custom widget.

A default value for the question. Ignored for question types that cannot have a value (for example, HTML).

The default value is used as a question value in the following cases:

• While the survey is being loaded from JSON.
• The question is just added to the survey and does not yet have an answer.
• The respondent left the answer empty.

An expression used to calculate the defaultValue.

This expression applies until the question value is specified by an end user or programmatically.

An expression can reference other questions as follows:

• {other_question_name}
• {panel.other_question_name} (to access questions inside the same dynamic panel)
• {row.other_question_name} (to access questions inside the same dynamic matrix or multi-column dropdown)

An expression can also include built-in and custom functions for advanced calculations. For example, if the defaultValue should be today's date, set the defaultValueExpression to "today()", and the corresponding built-in function will be executed each time the survey is loaded. Refer to the following help topic for more information: Use Functions in Expressions.

Question description location. By default, value is "default" and it depends on survey questionDescriptionLocation property You may change it to "underInput" to render it under question input or "underTitle" to rendered it under title.

Specifies whether a Rating question displays the minRateDescription and maxRateDescription property texts as buttons that correspond to the extreme (first and last) rate items. If any of these properties is empty, the corresponding rate item's value/text is used for display.
When the displayRateDescriptionsAsExtremeItems property is disabled, the texts defined through the minRateDescription and maxRateDescription properties are displayed as plain non-clickable texts.

An expression that returns true or false. If it returns false the Question becomes read only and an end-user will not able to answer on the qustion. The library runs the expression on survey start and on changing a question value. If the property is empty then readOnly property is used. Please note, this property is hidden for question without input, for example html question.

The list of errors. It is created by callig hasErrors functions

Expand the Element

Move the focus to the input of this question.

Load object properties and elements. It doesn't reset properties that was changed before and they are not defined in the json parameter.

Returns the title after processing the question template.

Returns a copy of question errors survey. For some questions like matrix and panel dynamic it includes the errors of nested questions.

Return the question value as a display text. For example, for dropdown, it would return the item text instead of item value.

Returns the current survey locale

Returns question answer data as a plain object: with question title, name, value and displayValue. For complex questions (like matrix, etc.) isNode flag is set to true and data contains array of nested objects (rows) set options.includeEmpty to false if you want to skip empty answers

Returns the serializable property that belongs to this instance by property name. It returns null if the property is not exists.

Returns the property value by name

Returns the element template name without prefix. Typically it equals to getType().

Return the title location based on question titleLocation property and QuestionTitleLocation of it's parents

Returns the type of the object as a string as it represents in the json.

Set it to true, to add a comment for the question.

Question, Panel and Page description. It renders under element title by using smaller font. Unlike the question title, description can be empty. Please note, this property is hidden for questions without input, for example html question.

Returns true if there is a validation error(s) in the question.

Returns false if the question doesn't have an input element, for example: QuestionHtmlModel

Returns false if the question doesn't have an input element or have multiple inputs: matrices or panel dynamic

Returns false if the question doesn't have a title property, for example: QuestionHtmlModel, or titleLocation property equals to "hidden"

Set hideNumber to true to stop showing the number for this question. The question will not be counter

The unique identificator. It is generated automatically.

The left indent. Set this property to increase the survey element left indent.

Returns true if the object is inluded into survey, otherwise returns false.

Returns true if the question may have a title located on the left

Returns true if the Element is in the collapsed state

Use this method to find out if the current instance is of the given typeName or inherited from it.

Returns true if the question in design mode right now.

Returns true if the question value is empty

Returns true if the Element is in the expanded state

Returns true if the object is loading from Json at the current moment.

Returns true if it is a page.

Returns true if it is a panel.

Return true if there is a parent (page or panel) and it is visible

Returns true if it is a question.

Returns true if readOnly property is true or survey is in display mode or parent panel/page is readOnly.

Set this property to true, to make the question a required. If a user doesn't answer the question then a validation error will be generated. Please note, this property is hidden for question without input, for example html question.

Returns true if a value undefined, null, empty string or empty array.

Returns true if the question is visible or survey is in design mode right now.

The description of maximum (last) item.

Use it to set the specific maxWidth constraint to the survey element like css style (%, px, em etc).

The description of minimum (first) item.

Use it to set the specific minWidth constraint to the survey element like css style (%, px, em etc).

Move question to a new container Page/Panel. Add as a last element if insertBefore parameter is not used or inserted into the given index, if insert parameter is number, or before the given element, if the insertBefore parameter is a question or panel

This is the identifier of a survey element - question or panel.

The property returns the question number. If question is invisible then it returns empty string. If visibleIndex is 1, then no is 2, or 'B' if survey.questionStartIndex is 'A'.

Event that raised on changing property of the ItemValue object. sender - the object that owns the property options.propertyName - the property name to which ItemValue array is belong. It can be "choices" for dropdown question options.obj - the instance of ItemValue object which property has been changed options.name - the property of ItemObject that has been changed options.oldValue - old value options.newValue - new value

Event that raise on property change of the sender object sender - the object that owns the property options.name - the property name that has been changed options.oldValue - old value. Please note, it equals to options.newValue if property is an array options.newValue - new value.

The event is fired when isReady property of question is changed.
options.question - the question
options.isReady - current value of isReady
options.oldIsReady - old value of isReady

Get/set the page where the question is located.

A parent element. It can be panel or page.

A parent question. It can be a dynamic panel or dynamic/dropdown matrices. If the value is a matrix, it means that question is a cell question. This property is null for a stand alone question.

Returns the rendred question title.

Returns questions count: 1 for the non-matrix questions and all inner visible questions that has input(s) widgets for question of matrix types.

This property is used to generate rate values if rateValues array is empty. It is the last value in the rating. The default value is 5.

This property is used to generate rate values if rateValues array is empty. It is the first value in the rating. The default value is 1.

This property is used to generate rate values if rateValues array is empty. It is the step value. The number of rate values are (rateMax - rateMin) / rateStep. The default value is 1.

The list of rate items. Every item has value and text. If text is empty, the value is rendered. The item text supports markdown. If it is empty the array is generated by using rateMin, rateMax and rateStep properties.

Set it to true to make an element question/panel/page readonly. Please note, this property is hidden for question without input, for example html question.

Register a function that will be called on a property value changed from the names list.

Register a function that will be called on a property value changed.

Remove a particular error from the question error list.

The rendered width of the question.

The custom text that will be shown on required error. Use this property, if you do not want to show the default text. Please note, this property is hidden for question without input, for example html question.

An expression that returns true or false. If it returns true the Question becomes required and an end-user has to answer it. If it returns false the Question then an end-user may not answer it the Question maybe empty. The library runs the expression on survey start and on changing a question value. If the property is empty then isRequired property is used. Please note, this property is hidden for question without input, for example html question.

Returns the char/string for a required question.

The right indent. Set it different from 0 to increase the right padding.

Run visibleIf and enableIf expressions. If visibleIf or/and enabledIf are not empty, then the results of performing the expression (true or false) set to the visible/readOnly properties.

set property value

Click value again to clear.

The Question renders on the new line if the property is true. If the property is false, the question tries to render on the same line/row with a previous question/panel.

Set this property to "collapsed" to render only Panel title and expanded button and to "expanded" to render the collapsed button in the Panel caption

Returns the survey object.

Question, Panel, Page and Survey title. If page and panel is empty then they are not rendered. Question renders question name if the title is empty. Use survey questionTitleTemplate property to change the title question rendering.

Set this property different from "default" to set the specific question title location for this panel/page. Please note, this property is hidden for questions without input, for example html question.

Toggle element's state

Deserialized the current object into JSON

Unregister notification on property value changed for all properties in the names list.

Unregister notification on property value changed

Use it to choose how other question values will be rendered in title if referenced in . Please note, this property is hidden for question without input, for example html question.

The list of question validators. Please note, this property is hidden for question without input, for example html question.

Get/Set the question value.

Use this property if you want to store the question result in the name different from the question name. Question name should be unique in the survey and valueName could be not unique. It allows to share data between several questions with the same valueName. The library set the value automatically if the question.name property is not valid. For example, if it contains the period '.' symbol. In this case if you set the question.name property to 'x.y' then the valueName becomes 'x y'. Please note, this property is hidden for questions without input, for example html question.

Use it to get/set the question visibility.

An expression that returns true or false. If it returns true the Question becomes visible and if it returns false the Question becomes invisible. The library runs the expression on survey start and on changing a question value. If the property is empty then visible property is used.

Returns the visible index of the question in the survey. It can be from 0 to all visible questions count - 1 The visibleIndex is -1 if the title is 'hidden' or hideNumber is true

Use it to set the specific width to the survey element like css style (%, px, em etc).