Gets or sets choice items. This property accepts an array of objects with the following structure:

{
  "value": any, // A unique value to be saved in the survey results.
  "text": String, // A display text. This property supports Markdown. When `text` is undefined, `value` is used.
  "imageLink": String // A link to the image or video that represents this choice value. Applies only to Image Picker questions.
  "customProperty": any // Any property that you find useful.
}

To enable Markdown support for the text property, implement Markdown-to-HTML conversion in the onTextMarkdown event handler. For an example, refer to the following demo: Convert Markdown to HTML with Showdown.

If you add custom properties, refer to the following help topic to learn how to serialize them into JSON: Add Custom Properties to Property Grid.

If you need to specify only the value property, you can set the choices property to an array of primitive values, for example, [ "item1", "item2", "item3" ]. These values are both saved in survey results and used as display text.

Configures access to a RESTful service that returns choice items. Refer to the ChoicesRestful class description for more information.

View Demo

A Boolean expression that is evaluated against each choice item. If the expression evaluates to false, the choice item becomes read-only.

A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.

Use the {item} placeholder to reference the current choice item in the expression.

Refer to the following help topic for more information: Conditional Visibility.

Inherits choice items from a specified question. Accepts a question name.

If you specify this property, the choices, choicesVisibleIf, choicesEnableIf, and choicesOrder properties do not apply because their values are inherited.

In addition, you can specify the choicesFromQuestionMode property if you do not want to inherit all choice items.

Specifies which choice items to inherit from another question. Applies only when the choicesFromQuestion property is specified.

Possible values:

• "all" (default) - Inherits all choice items.
• "selected" - Inherits only selected choice items.
• "unselected" - Inherits only unselected choice items.

Use the visibleChoices property to access inherited choice items.

Specifies the sort order of choice items.

Possible values:

• "none" (default) - Preserves the original order of choice items.
• "asc"- Sorts choice items in ascending order.
• "desc"- Sorts choice items in ascending order.
• "random" - Displays choice items in random order.

A Boolean expression that is evaluated against each choice item. If the expression evaluates to false, the choice item becomes hidden.

A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.

Use the {item} placeholder to reference the current choice item in the expression.

Refer to the following help topic for more information: Conditional Visibility.

Empties the errors array.

Specifies when to clear the question value if the question becomes invisible.

Possible values:

• "default" (default) - Inherits the setting from the Survey's clearInvisibleValues property.
• "onHidden" - Clears the value when the question becomes invisible. If a question is invisible on startup and has an initial value, this value will be cleared when the survey is complete.
• "onComplete" - Clears the value when the survey is complete.
• "none" - Never clears the value of an invisible question.

Removes values that cannot be assigned to this question, for example, choices unlisted in the choices array.

Call this method after you assign new question values in code to ensure that they are acceptable.

This method does not remove values that do not pass validation. Call the validate() method to validate newly assigned values.

If the clearIncorrectValuesCallback is set, it is used to clear incorrect values instead of default behaviour.

Sets the question's value and comment properties to undefined.

Creates a new object that has the same type and properties as the current SurveyJS object.

Get or sets the number of columns used to arrange choice items.

Set this property to 0 if you want to display all items in one line. The default value depends on the available width.

Collapses the survey element.

In collapsed state, the element displays only title and description.

A comment to the selected question value. Enable the showCommentArea property to allow users to leave comments.

A placeholder for the comment area. Applies when the showCommentArea property is true.

Specifies a caption displayed above the comment area. Applies when the showCommentArea property is true.

Returns true if the survey element or its child elements have validation errors.

This property contains the result of the most recent validation. This result may be outdated. Call the validate method to get an up-to-date value.

Specifies the type of content that choice items display.

Possible values:

• "image" - Images in one of the following formats: JPEG, GIF, PNG, APNG, SVG, BMP, ICO.
• "video" - Videos in one of the following formats: MP4, MOV, WMV, FLV, AVI, MKV.
• "youtube" - Links to YouTube videos.
• "auto" (default) - Selects one of the above based on the imageLink property value of each choice item.

A correct answer to this question. Specify this property if you want to create a quiz.

Returns an object in which keys are UI elements and values are CSS classes applied to them.

Use the following events of the SurveyModel object to override CSS classes:

• onUpdatePageCssClasses
• onUpdatePanelCssClasses
• onUpdateQuestionCssClasses

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: Built-In Functions.

Explanatory text displayed under the title.

Specifies where to display a question description.

Possible values:

• "default" (default) - Inherits the setting from the Survey's questionDescriptionLocation property.
• "underTitle" - Displays the description under the question title.
• "underInput" - Displays the description under the interactive area.

An array of choice items with which users can interact. Includes the "Select All", "Other", and "None" choice items if they are not disabled. Items are sorted according to the choicesOrder value.

A Boolean expression. If it evaluates to false, this question becomes read-only.

A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.

Refer to the following help topic for more information: Conditional Visibility

Validation errors. Call the validate() method to validate survey element data.

Expands the survey element.

Moves focus to the input field of this question.

Assigns a new configuration to the current SurveyJS object. This configuration is taken from a passed JSON object.

The JSON object should contain only serializable properties of this SurveyJS object. Event handlers and properties that do not belong to the SurveyJS object are ignored.

Returns a display text that corresponds to the question value. For example, if you call this method for a Dropdown question, it returns an item text instead of an item value.

Returns the survey's locale.

If a default locale is used, this method returns an empty string. To get the applied locale in this case, use the following code:

import { surveyLocalization } from 'survey-core';
const defaultLocale = surveyLocalization.defaultLocale;

Returns the question value as an object in which the question name, title, value, and other parameters are stored as individual properties.

If the question can have more than one value (Matrix, Multiple Text), the object enables the isNode flag and stores information about these values in the data property. Refer to the following help topic for more information: Access Full Survey Results.

Pass an object with the includeEmpty property set to false if you want to skip empty answers.

Returns a JsonObjectProperty object with metadata about a serializable property that belongs to the current SurveyJS object.

If the property is not found, this method returns null.

Returns the value of a property with a specified name.

If the property is not found or does not have a value, this method returns either undefined, defaultValue specified in the property configuration, or a value passed as the defaultValue parameter.

Returns title location calculated based on the question's titleLocation property and the questionTitleLocation property of the question's containers (survey, page, or panel).

Returns the question type. Possible values:

• "boolean"
• "checkbox"
• "comment"
• "dropdown"
• "tagbox"
• "expression"
• "file"
• "html"
• "image"
• "imagepicker"
• "matrix"
• "matrixdropdown"
• "matrixdynamic"
• "multipletext"
• "panel"
• "paneldynamic"
• "radiogroup"
• "rating"
• "ranking"
• "signaturepad"
• "text"

Returns true if the survey element has a description.

Returns false if the question has no input fields (HTML, Image, and similar question types).

Returns false if the question has no input fields (HTML, Image) or has multiple input fields (Matrix, Multiple Text).

Returns false if the titleLocation property is set to "hidden" or if the question cannot have a title (for example, an HTML question).

If the title property is undefined or set to an empty string, the hasTitle property returns true, because the question uses its name as a title in this case.

Specifies whether to hide the question if no choice items are visible.

This property is useful if you show or hide choice items at runtime based on a condition.

Hides the question number from the title and excludes the question from numbering.

If you want to disable question numbering in the entire survey, set SurveyModel's showQuestionNumbers property to false.

A value to assign to the id attribute of the rendered HTML element. A default id is generated automatically.

Specifies how to resize images or videos to fit them into their containers.

Refer to the object-fit CSS property description for information on accepted values.

Specifies the height of containers for images or videos. Accepts positive numbers and CSS values.

Default value: undefined

Use the imageFit property to specify how to fit the images or videos into their containers.

Specifies the width of containers for images or videos. Accepts positive numbers and CSS values.

Default value: 200

Use the imageFit property to specify how to fit the images or videos into their containers.

Increases or decreases an indent of survey element content from the left edge. Accepts positive integer values and 0. Does not apply in the Default V2 theme.

Returns true if the object is included in a survey.

This property may return false, for example, when you create a survey model dynamically.

Returns true if the question can display its title to the left of the input field.

Returns true if a question answer matches the correctAnswer property value.

View Demo

Returns true if the survey element is collapsed.

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

Returns true if the survey is being designed in Survey Creator.

Returns true if the question value is an empty string, array, or object or if it equals undefined or null.

Returns true if the survey element is expanded.

Returns true if a passed choice item is selected.

To obtain a choice item to check, use the noneItem or otherItem property or the choices array.

Returns true if the object configuration is being loaded from JSON.

Returns true if the "Other" choice item is selected.

Returns true if the survey element is a page.

Returns true if the survey element is a panel.

Returns true if a parent element (page or panel) is visible.

Returns true if the survey element is a question.

Returns true if the survey element or its parent element is read-only.

If you want to switch a survey element to the read-only state based on a condition, specify the enableIf property. Refer to the following help topic for information: Conditional Visibility.

Makes the question required. If a respondent skips a required question, the survey displays a validation error.

Returns true if a passed value is an empty string, array, or object or if it equals to undefined or null.

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

If you want to display or hide a question based on a condition, specify the visibleIf property. Refer to the following help topic for information: Conditional Visibility.

The name of a component used to render items.

Specifies whether to keep values that cannot be assigned to this question, for example, choices unlisted in the choices array.

This property cannot be specified in the survey JSON schema. Use dot notation to specify it.

Gets or sets maximum survey element width in CSS values.

Default value: "100%" (taken from settings.maxWidth)

Gets or sets minimum survey element width in CSS values.

Default value: "300px" (taken from settings.minWidth)

Specifies whether users can select multiple images or videos.

Default value: false

A survey element identifier.

Question names must be unique.

A question number or letter (depends on the questionStartIndex property of the question container (panel, page, or survey)).

When the question number, title, or the entire question is invisible, this property returns an empty string.

Returns the "None" choice item. Use this property to change the item's value or text.

Gets or sets a caption for the "None" choice item.

An event that is raised when an ItemValue property is changed.

Parameters:

• sender: this
  A SurveyJS object whose property contains an array of ItemValue objects.
• options.obj: ItemValue
  An ItemValue object.
• options.propertyName: String
  The name of the property to which an array of ItemValue objects is assigned (for example, "choices" or "rows").
• options.name: "text" | "value"
  The name of the changed property.
• options.newValue: any
  A new value for the property.

An event that is raised when a property of this SurveyJS object has changed.

Parameters:

• sender: this
  A SurveyJS object whose property has changed.
• options.name: String
  The name of the changed property.
• options.newValue: any
  A new value for the property.
• options.oldValue: any
  An old value of the property. If the property is an array, oldValue contains the same array as newValue does.

An event that is raised when the question's ready state has changed (expressions are evaluated, choices are loaded from a web resource specified by the choicesByUrl property, etc.).

Parameters:

• sender: SurveyModel
  A survey instance that contains the question whose ready state has changed.
• options.isReady: Boolean
  Indicates whether the question is ready.
• options.oldIsReady: Boolean
  Indicates the previous ready state.

Get or sets an error message displayed when users select the "Other" choice item but leave the comment area empty.

Returns the "Other" choice item. Use this property to change the item's value or text.

A placeholder for the comment area. Applies when the showOtherItem or showCommentArea property is true.

Gets or sets a caption for the "Other" choice item.

Returns a page to which the question belongs and allows you to move this question to a different page.

Returns a survey element (panel or page) that contains the question and allows you to move this question to a different survey element.

A Dynamic Panel, Dynamic Matrix, or Dropdown Matrix that includes the current question.

This property is null for standalone questions.

The number of quiz questions. A question counts if it is visible, has an input field, and specifies correctAnswer.

Makes the survey element read-only.

If you want to switch a survey element to the read-only state based on a condition, specify the enableIf property. Refer to the following help topic for information: Conditional Visibility.

Registers a function to call when a property value changes.

Returns a calculated width of the rendered survey element in CSS values.

Specifies a custom error message for a required form field.

A Boolean expression. If it evaluates to true, this question becomes required.

A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.

Refer to the following help topic for more information: Conditional Visibility

Returns a character or text string that indicates a required question.

Increases or decreases an indent of survey element content from the right edge. Accepts positive integer values and 0. Does not apply in the Default V2 theme.

Displays the "Select All", "None", and "Other" choices on individual rows.

Assigns a new value to a specified property.

Specifies whether to display a comment area. Incompatible with the showOtherItem property.

Specifies whether to display labels under images or videos. Labels text are taken from the text property of each object in the choices array.

Specifies whether to display the "None" choice item.

When users select the "None" item in multi-select questions, all other items become unselected.

Specifies whether to display the "Other" choice item. Incompatible with the showCommentArea property.

Disable this property if you want to render the current question on the same line or row with the previous question or panel.

Gets and sets the survey element's expand state.

Possible values:

• "default" (default) - The survey element is displayed in full and cannot be collapsed in the UI.
• "expanded" - The survey element is displayed in full and can be collapsed in the UI.
• "collapsed" - The survey element displays only title and description and can be expanded in the UI.

Returns the survey object.

A title for the survey element. If title is undefined, the name property value is displayed instead.

Empty pages and panels do not display their titles or names.

Sets question title location relative to the input field. Overrides the questionTitleLocation property specified for the question's container (survey, page, or panel).

Possible values:

• "default" (default) - Inherits the setting from the questionTitleLocation property specified for the question's container.
• "top" - Displays the title above the input field.
• "bottom" - Displays the title below the input field.
• "left" - Displays the title to the left of the input field.
• "hidden" - Hides the question title.

Certain question types (Matrix, Multiple Text) do not support the "left" value. For them, the "top" value is used.

Toggles the survey element's state between collapsed and expanded.

Returns a JSON object that corresponds to the current SurveyJS object.

Unregisters value change event handlers for the specified properties.

Specifies whether to use display names for question values in placeholders.

Default value: true

This property applies to questions whose values are defined as objects with the value and text properties (for example, choice items in Radiogroup, Checkbox, and Dropdown questions).

You can use question values as placeholders in the following places:

• Survey element titles and descriptions
• The html property of the HTML question

To use a question value as a placeholder, specify the question name in curly brackets: {questionName}. Refer to the following help topic for more information: Dynamic Texts - Question Values.

Validates this question and returns false if the validation fails.

Question validators.

Gets or sets the question value.

Specifies an object property that should store the question value.

Refer to the Merge Question Values help topic for more information.

Gets or sets question visibility.

If you want to display or hide a question based on a condition, specify the visibleIf property. Refer to the following help topic for information: Conditional Visibility.

An array of visible choice items. Includes the "Select All", "Other", and "None" choice items if they are visible. Items are sorted according to the choicesOrder value.

A Boolean expression. If it evaluates to false, this question becomes hidden.

A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.

Refer to the following help topic for more information: Conditional Visibility

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

Sets survey element width in CSS values.

Default value: ""