Creates a new page and adds it to a survey. Generates a new name if the name parameter is not specified.

Adds an existing page to the survey.

Gets or sets whether a survey is automatically completed when goNextPageAutomatic = true. Set it to false if you do not want to submit survey automatically on completing the last survey page.

Gets or sets a list of calculated values in the survey.

Cancels preview and switches back to the "running" state.

Details: Preview State

Gets or sets a value that specifies how the survey validates the question answers.

The following options are available:

• onNextPage (default) - check errors on navigating to the next page or on completing the survey.
• onValueChanged - check errors on every question value (i.e., answer) changing.
• onValueChanging - check errors before setting value into survey. If there is an error, then survey data is not changed, but question value will be keeped.
• onComplete - to validate all visible questions on complete button click. If there are errors on previous pages, then the page with the first error becomes the current.

Clears the survey data and state. If the survey has a completed state, it will get a running state.

Clears files from server.

Call this function to remove all question values from the survey, that end-user will not be able to enter. For example the value that doesn't exists in a radiogroup/dropdown/checkbox choices or matrix rows/columns. Please note, this function doesn't clear values for invisible questions or values that doesn't associated with questions. In fact this function just call clearIncorrectValues function of all questions in the survey

Gets or sets a value that specifies how the invisible data is included in survey data.

The following options are available:

• none - include the invisible values into the survey data.
• 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.
• onHiddenContainer - clear the question value when it or its parent (page or panel) becomes invisible. If a question has value and it was invisible initially then survey clears the value on completing.
• onComplete (default) - clear invisible question values on survey complete. In this case, the invisible questions will not be stored on the server.

Removes a value from the survey results.

Gets or sets whether to clear value on disable items in checkbox, dropdown and radiogroup questions. By default, values are not cleared on disabled the corresponded items. This property is not persisted in survey JSON and you have to set it in code.

Gets or sets user's identifier (e.g., e-mail or unique customer id) in your web application. If you load survey or post survey results from/to api.surveyjs.io service, then the library do not allow users to run the same survey the second time. On the second run, the user will see the survey complete page.

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

You can display an additional field (comment field) for the most of questions; users can enter additional comments to their response. The comment field input is saved as 'question name' + 'commentPrefix'.

Returns all comments from the data.

The HTML content displayed to an end user that has already completed the survey.

Gets or sets the HTML content displayed on the complete page. Use this property to change the default complete page text.

The list of HTML condition items. If the expression of this item returns true, then a survey will use this item HTML instead of completedHtml.

Completes the survey, if the current page is the last one. It returns false if the last page has errors. If the last page has no errors, completeLastPage calls doComplete and returns true.

Gets or sets the 'Complete' button caption.

Gets or sets a cookie name used to save information about completing the survey. If the property is not empty, before starting the survey, the Survey library checks if the cookie with this name exists. If it is true, the survey goes to complete mode and a user sees the survey complete page. On completing the survey the cookie with this name is created.

Creates and returns a new page, but do not add it into the survey. You can use addPage(page) function to add it into survey later.

Gets or sets the current survey page. If a survey is rendered, then this property returns a page that a user can see/edit.

The zero-based index of the current page in the visible pages array.

Gets or sets an object that stores the survey results/data. You can set it directly as { 'question name': questionValue, ... }

If you set the data property after creating the survey, you may need to set the currentPageNo to 0, if you are using visibleIf properties for questions/pages/panels to ensure that you are starting from the first page.

Deletes the cookie with cookieName from the browser.

Gets or sets a survey description. The survey description is displayed under a survey title.

Use this method to dispose survey model properly.

Completes the survey.

Calling this function performs the following tasks:

• writes cookie if the cookieName property is not empty
• sets the survey into completed state
• fires the onComplete event
• calls sendResult function.

Calling the doComplete function does not perform any validation, unlike the completeLastPage function. It calls navigateToUrl after calling onComplete event. In case calling options.showDataSaving callback in the onComplete event, navigateToUrl is used on calling options.showDataSavingSuccess callback.

Downloads a file from server

Gets or sets the 'Edit' button caption.

Returns the text that is displayed when there are no any visible pages and questiona.

Checks whether survey elements (pages, panels, and questions) have unique question names. You can check for unique names for individual page and panel (and all their elements) or a question. If the parameter is not specified, then a survey checks that all its elements have unique names.

Gets or sets whether the first survey page is a start page. Set this property to true, to make the first page a starting page. An end user cannot navigate to the start page and the start page does not affect a survey progress.

Sets the input focus to the first question with the input field.

Gets or sets whether the first input is focused on showing a next or a previous page.

Gets or sets whether the first input is focused if the current page has errors. Set this property to false (the default value is true) if you do not want to bring the focus to the first question that has error on the page.

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

Returns a list of all survey's panels.

Returns a list of all questions in a survey.

Returns the comment value.

Returns an amount of corrected quiz answers.

Returns an amount of incorrect quiz answers.

Returns a page on which an element (question or panel) is placed.

Returns a page by it's name.

Returns a page on which a question is located.

Returns a list of pages by their names.

Returns a panel by its name.

Returns survey result data as an array of plain objects: 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 progress that a user made while going through the survey. It depends from progressBarType property

Returns the property value by name

Returns a question by its name.

Returns a question by its value name

Gets a list of questions by their names.

Returns all questions by their valueName. name property is used if valueName property is empty.

Returns quiz question number. It may be different from getQuizQuestions.length because some widgets like matrix may have several questions.

Returns quiz questions. All visible questions that has input(s) widgets.

Calls the api.surveyjs.io service and, on callback, fires the onGetResult event with all answers that your users made for a question.

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

Returns the type of the object as a string as it represents in the json. It should be in lowcase.

Returns an array of locales that are used in the survey's translation.

Returns a question value (answer) by a question's name.

Returns a variable value. Variable, unlike values, are not stored in the survey results.

Returns all variables in the survey. Use setVariable function to create a new variable.

Gets or ses whether a user can navigate the next page automatically after answering all the questions on a page without pressing the "Next" button. The available options:

• true - navigate the next page and submit survey data automatically.
• autogonext - navigate the next page automatically but do not submit survey data.
• false - do not navigate the next page and do not submit survey data automatically.

Returns true, if a user has already completed the survey in this browser and there is a cookie about it. Survey goes to completed state if the function returns true.

Returns true, if the current page contains any error. If there is an async function in an expression, then the function will return undefined value. In this case, you should use onAsyncValidation parameter, which is a callback function: (hasErrors: boolean) => void

Returns true, if any of the survey pages contains errors. If there is an async function in an expression, then the function will return undefined value. In this case, you should use the third onAsyncValidation parameter, which is a callback function: (hasErrors: boolean) => void

Returns true, if a page contains an error. If there is an async function in an expression, then the function will return undefined value. In this case, you should use the second onAsyncValidation parameter, which is a callback function: (hasErrors: boolean) => void

Gets or sets whether to hide all required errors.

Gets or sets whether the survey must ignore validation like required questions and others, on nextPage and completeLastPage function calls. The default is false.

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

Returns true, if the current page contains errors, for example, the required question is empty or a question validation is failed.

Returns true if the survey is in design mode. It is used by SurveyJS Editor.

Returns true if the survey is in display mode or in preview mode.

Returns true if the survey is in edit mode.

Returns true if the survey contains no pages. The survey is empty.

Gets whether the current page is the first one.

Gets whether the current page is the last one.

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

Returns the navigation buttons (i.e., 'Prev', 'Next', or 'Complete' and 'Preview') position.

Returns true if the navigation buttons (i.e., 'Prev', 'Next', or 'Complete' and 'Preview') are shows on bottom.

Returns true if the navigation buttons (i.e., 'Prev', 'Next', or 'Complete' and 'Preview') are shows on top.

Obsolete. Use the questionsOnPageMode property instead.

Gets whether the question values on the current page are validating on the server at the current moment.

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

The list of errors on loading survey JSON. If the list is empty after loading a JSON, then the JSON is correct and has no errors.

By default all rows are rendered no matters if they are visible or not. Set it true, and survey markup rows will be rendered only if they are visible in viewport. This feature is experimantal and might do not support all the use cases.

The HTML that shows on loading survey Json from the api.surveyjs.io service.

Loads the survey JSON from the api.surveyjs.io service. If clientId is not null and a user had completed a survey before, the survey switches to completedbefore state.

Gets or sets the survey locale. The default value it is empty, this means the 'en' locale is used. You can set it to 'de' - German, 'fr' - French and so on. The library has built-in localization for several languages. The library has a multi-language support as well.

Gets or sets a survey logo.

The logo fit mode.

Gets or sets a survey logo height.

Gets or sets a survey logo position.

Gets or sets a survey logo width.

Gets or sets the default maximum length for question comments and others

The default value is 0, that means that the question comments have the same max length as the standard HTML input - 524288 characters: https://www.w3schools.com/tags/att_input_maxlength.asp.

Specifies the default maximum length for questions like text and comment, including matrix cell questions.

The default value is 0, that means that the text and comment have the same max length as the standard HTML input - 524288 characters: https://www.w3schools.com/tags/att_input_maxlength.asp.

Gets or sets the maximum time in seconds that end user has to complete a survey. If the value is 0 or less, an end user has no time limit to finish a survey.

Gets or sets the maximum time in seconds that end user has to complete a page in the survey. If the value is 0 or less, an end user has no time limit.

You may override this value for every page.

Merge the values into survey.data. It works as survey.data, except it doesn't clean the existing data, but overrides them.

Gets or sets the survey edit mode.

The following options are available:

• edit (default) - make a survey editable,
• display - make a survey read-only.

Set this property to a url you want to navigate after a user completing the survey. By default it uses after calling onComplete event. In case calling options.showDataSaving callback in onComplete event, navigateToUrl will be used on calling options.showDataSavingSuccess callback.

Gets or sets a list of URL condition items. If the expression of this item returns true, then survey will navigate to the item URL.

Navigates user to the next page.

Returns false in the following cases:

• if the current page is the last page.
• if the current page contains errors (for example, a required question is empty).

The event is fired right after a page is rendered in DOM. Use it to modify HTML elements.
sender - the survey object that fires the event.
options.htmlElement - an HTML element bound to the survey header object.

The event is fired right after a page is rendered in DOM. Use it to modify HTML elements.
sender - the survey object that fires the event.
options.page - a page object for which the event is fired. Typically the current/active page.
options.htmlElement - an HTML element bound to the page object.

The event is fired right after a panel is rendered in DOM. Use it to modify HTML elements.
sender - the survey object that fires the event
options.panel - a panel object for which the event is fired
options.htmlElement - an HTML element bound to the panel object

The event is fired right after a question is rendered in DOM. Use it to modify HTML elements.
sender - the survey object that fires the event.
options.question - a question object for which the event is fired.
options.htmlElement - an HTML element bound to the question object.

The event is fired right after a non-composite question (text, comment, dropdown, radiogroup, checkbox) is rendered in DOM. Use it to modify HTML elements. This event is not fired for matrices, panels, multiple text and image picker.
sender - the survey object that fires the event.
options.question - a question object for which the event is fired.
options.htmlElement - an HTML element bound to the question object.

The event is fired right after survey is rendered in DOM.
sender - the survey object that fires the event.
options.htmlElement - a root HTML element bound to the survey object.

This event is fired on clearing the value in a QuestionFile. Use this event to remove files stored on your server.
sender - the survey object that fires the event.
question - the question instance.
options.name - the question name.
options.value - the question value.
options.fileName - a removed file's name, set it to null to clear all files.
options.callback - a callback function to get the operation status.

The event is fired after a user clicks the 'Complete' button and finishes a survey. Use this event to send the survey data to your web server.
sender - the survey object that fires the event.
options.showDataSaving(text) - call this method to show that the survey is saving survey data on your server. The text is an optional parameter to show a custom message instead of default.
options.showDataSavingError(text) - call this method to show that an error occurred while saving the data on your server. If you want to show a custom error, use an optional text parameter.
options.showDataSavingSuccess(text) - call this method to show that the data was successfully saved on the server.
options.showDataSavingClear - call this method to hide the text about the saving progress.
options.isCompleteOnTrigger - returns true if the survey is completed on "complete" trigger.

The event is fired before the survey is completed and the onComplete event is fired. You can prevent the survey from completing by setting options.allowComplete to false
sender - the survey object that fires the event.
options.allowComplete - Specifies whether a user can complete a survey. Set this property to false to prevent the survey from completing. The default value is true.
options.isCompleteOnTrigger - returns true if the survey is completing on "complete" trigger.

The event is fired when the current page has been changed to another page. Typically it happens when a user click on 'Next' or 'Prev' buttons.
sender - the survey object that fires the event.
option.oldCurrentPage - a previous current/active page.
option.newCurrentPage - a new current/active page.
option.isNextPage - commonly means, that end-user press the next page button. In general, it means that options.newCurrentPage is the next page after options.oldCurrentPage
option.isPrevPage - commonly means, that end-user press the previous page button. In general, it means that options.newCurrentPage is the previous page before options.oldCurrentPage

The event is fired before the current page changes to another page. Typically it happens when a user click the 'Next' or 'Prev' buttons.
sender - the survey object that fires the event.
option.oldCurrentPage - the previous current/active page.
option.newCurrentPage - a new current/active page.
option.allowChanging - set it to false to disable the current page changing. It is true by default.
option.isNextPage - commonly means, that end-user press the next page button. In general, it means that options.newCurrentPage is the next page after options.oldCurrentPage
option.isPrevPage - commonly means, that end-user press the previous page button. In general, it means that options.newCurrentPage is the previous page before options.oldCurrentPage

The event is fired on downloading a file in QuestionFile. Use this event to pass the file to a preview.
sender - the survey object that fires the event.
options.name - the question name.
options.content - the file content.
options.fileValue - single file question value.
options.callback - a callback function to get the file downloading status and the downloaded file content.

Use this event to control drag&drop operations during design mode.
sender - the survey object that fires the event.
options.allow - set it to false to disable dragging.
options.target - a target element that is dragged.
options.source - a source element. It can be null, if it is a new element, dragging from toolbox.
options.parent - a page or panel where target element is dragging.
options.insertBefore - an element before the target element is dragging. It can be null if parent container (page or panel) is empty or dragging an element after the last element in a container.
options.insertAfter - an element after the target element is dragging. It can be null if parent container (page or panel) is empty or dragging element to the first position within the parent container.

The event is fired on adding a new panel in Panel Dynamic question.
sender - the survey object that fires the event.
options.question - a panel question.
options.panel - an added panel.

The event is fired when item value is changed in Panel Dynamic question.
sender - the survey object that fires the event.
options.question - the panel question.
options.panel - the dynamic panel item.
options.name - the item name.
options.value - a new value.
options.itemIndex - the panel item index.
options.itemValue - the panel item object.

The event is fired on removing a panel from Panel Dynamic question.
sender - the survey object that fires the event.
options.question - a panel question.
options.panelIndex - a removed panel index.
options.panel - a removed panel.

The event is fired after the survey element content was collapsed or expanded.
sender - the survey object that fires the event.
options.element - Specifies which survey element content was collapsed or expanded.

Use the event to change the default error text.
sender - the survey object that fires the event.
options.text - an error text.
options.error - an instance of the SurveyError object.
options.name - the error name. The following error names are available: required, requireoneanswer, requirenumeric, exceedsize, webrequest, webrequestempty, otherempty, uploadingfile, requiredinallrowserror, minrowcounterror, keyduplicationerror, custom

Use this event to create/customize actions to be displayed in a matrix question's row.
sender - A survey object that fires the event.
options.question - A matrix question (QuestionMatrixBaseModel object) for which the event is fired.
options.row - A matrix row for which the event is fired.
options.actions - A list of actions (IActionBarItem objects) associated with the processed matrix question and row.

Use this event to create/customize actions to be displayed in a page's title.
sender - A survey object that fires the event.
options.page - A page (PageModel object) for which the event is fired.
options.actions - A list of actions (IActionBarItem objects) associated with the processed page.

Use this event to create/customize actions to be displayed in a panel's title.
sender - A survey object that fires the event.
options.panel - A panel (PanelModel object) for which the event is fired.
options.actions - A list of actions (IActionBarItem objects) associated with the processed panel.

Use this event to change the question no in code. If you want to remove question numbering then set showQuestionNumbers to "off".
sender - the survey object that fires the event.
options.no - a calculated question no, based on question visibleIndex, survey .questionStartIndex properties. You can change it.
options.question - a question object.

Use this event to change the question title in code. If you want to remove question numbering then set showQuestionNumbers to "off".
sender - the survey object that fires the event.
options.title - a calculated question title, based on question title, name.
options.question - a question object.

Use this event to create/customize actions to be displayed in a question's title.
sender - A Survey object that fires the event.
options.question - A Question object for which the event is fired.
options.actions - A list of actions (IActionBarItem objects) associated with the processed question.

Use it to get results after calling the getResult method. It returns a simple analytics from api.surveyjs.io service.
sender - the survey object that fires the event.
options.success - it is true if the results were got from the service successfully.
options.data - the object {AnswersCount, QuestionResult : {} }. AnswersCount is the number of posted survey results. QuestionResult is an object with all possible unique answers to the question and number of these answers.
options.dataList - an array of objects {name, value}, where name is a unique value/answer to the question and value is a number/count of such answers.
options.response - the server response.

Use this event to define, whether an answer to a question is correct or not.
sender - the survey object that fires the event.
options.question - a question on which you have to decide if the answer is correct or not.
options.result - returns true, if an answer is correct, or false, if the answer is not correct. Use questions' value and correctAnswer properties to return the correct value.
options.correctAnswers - you may change the default number of correct or incorrect answers in the question, for example for matrix, where each row is a quiz question.

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

The event is fired after choices for radiogroup, checkbox, and dropdown has been loaded from a RESTful service and before they are assigned to a question. You may change the choices, before they are assigned or disable/enabled make visible/invisible question, based on loaded results.
sender - the survey object that fires the event.
question - the question where loaded choices are going to be assigned.
choices - the loaded choices. You can change the loaded choices to before they are assigned to question.
serverResult - a result that comes from the server as it is.

The event is fired after survey is loaded from api.surveyjs.io service. You can use this event to perform manipulation with the survey model after it was loaded from the web service.
sender - the survey object that fires the event.

The event is fired for every cell after is has been rendered in DOM.
sender - the survey object that fires the event.
options.question - the matrix question.
options.cell - the matrix cell.
options.cellQuestion - the question/editor in the cell.
options.htmlElement - an HTML element bound to the cellQuestion object.
options.column - the matrix column object.
options.row - the matrix row object.

The event is fired before rendering "Remove" button for removing a row from Matrix Dynamic question.
sender - the survey object that fires the event
options.question - a matrix question.
options.rowIndex - a row index.
options.row - a row object.
options.allow - a boolean property. Set it to false to disable the row removing.

The event is fired before adding a new row in Matrix Dynamic question.
sender - the survey object that fires the event
options.question - a matrix question.
options.canAddRow - specifies whether a new row can be added

The event is fired for every cell created in Matrix Dynamic and Matrix Dropdown questions.
sender - the survey object that fires the event.
options.question - the matrix question.
options.cell - the matrix cell.
options.cellQuestion - the question/editor in the cell. You may customize it, change it's properties, like choices or visible.
options.rowValue - the value of the current row. To access a particular column's value within the current row, use: options.rowValue["columnValue"].
options.column - the matrix column object.
options.columnName - the matrix column name.
options.row - the matrix row object.

The event is fired when Matrix Dynamic and Matrix Dropdown questions validate the cell value.
sender - the survey object that fires the event.
options.error - an error string. It is empty by default.
options.question - the matrix question.
options.columnName - the matrix column name.
options.value - a cell value.
options.row - the matrix row object.
options.getCellQuestion(columnName) - the function that returns the cell question by column name.

The event is fired when cell value is changed in Matrix Dynamic and Matrix Dropdown questions.
sender - the survey object that fires the event.
options.question - the matrix question.
options.columnName - the matrix column name.
options.value - a new value.
options.row - the matrix row object.
options.getCellQuestion(columnName) - the function that returns the cell question by column name.

The event is fired on changing cell value in Matrix Dynamic and Matrix Dropdown questions. You may change the options.value property to change a cell value.
sender - the survey object that fires the event.
options.question - the matrix question.
options.columnName - the matrix column name.
options.value - a new value.
options.oldValue - the old value.
options.row - the matrix row object.
options.getCellQuestion(columnName) - the function that returns a cell question by column name.

The event is fired on adding a new row in Matrix Dynamic question.
sender - the survey object that fires the event
options.question - a matrix question.
options.row - a new added row.

The event is fired on removing a row from Matrix Dynamic question.
sender - the survey object that fires the event
options.question - a matrix question
options.rowIndex - a removed row index
options.row - a removed row object

The event is fired before removing a row from Matrix Dynamic question. You can disable removing and clear the data instead.
sender - the survey object that fires the event
options.question - a matrix question.
options.rowIndex - a row index.
options.row - a row object.
options.allow - a boolean property. Set it to false to disable the row removing.

The event is fired after a user clicks the 'Complete' button. The event allows you to specify the URL opened after completing a survey. Specify the navigateToUrl property to make survey navigate to another url.
sender - the survey object that fires the event.
options.url - Specifies a URL opened after completing a survey. Set this property to an empty string to cancel the navigation and show the completed survey page.

The event is fired on adding a page into survey.
sender - the survey object that fires the event.
options.page - a newly added panel object.

The event is fired on changing a page visibility.
sender - the survey object that fires the event.
options.page - a page which visibility has been changed.
options.visible - a page visible boolean value.

The event is fired on adding a panel into survey.
sender - the survey object that fires the event.
options.panel - a newly added panel object.
options.name - a panel name.
options.index - an index of the panel in the container (a page or panel).
options.parentPanel - a container (a page or panel) where a new panel is located.
options.rootPanel - a root container, typically it is a page.

The event is fired on removing a panel from survey.
sender - the survey object that fires the event.
options.panel - a removed panel object.
options.name - a panel name.

The event is fired on changing a panel visibility.
sender - the survey object that fires the event.
options.panel - a panel which visibility has been changed.
options.visible - a panel visible boolean value.

The event is fired on clicking the 'Next' button if the sendResultOnPageNext is set to true. You can use it to save the intermediate results, for example, if your survey is large enough.
sender - the survey object that fires the event.

Use this event to modify the HTML content before rendering, for example completeHtml or loadingHtml. options.html - specifies the modified HTML content.

The event is fired on processing the text when it finds a text in brackets: {somevalue}. By default, it uses the value of survey question values and variables. For example, you may use the text processing in loading choices from the web. If your choicesByUrl.url equals to "UrlToServiceToGetAllCities//", you may set on this event options.value to "all" or empty string when the "state" value/question is non selected by a user.
sender - the survey object that fires the event.
options.name - the name of the processing value, for example, "state" in our example.
options.value - the value of the processing text.
options.isExists - a boolean value. Set it to true if you want to use the value and set it to false if you don't.

Use this event to change the progress text in code.
sender - the survey object that fires the event.
options.text - a progress text, that SurveyJS will render in progress bar.
options.questionCount - a number of questions that have input(s). We do not count html or expression questions
options.answeredQuestionCount - a number of questions that have input(s) and an user has answered.
options.requiredQuestionCount - a number of required questions that have input(s). We do not count html or expression questions
options.requiredAnsweredQuestionCount - a number of required questions that have input(s) and an user has answered.

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 on adding a new question into survey.
sender - the survey object that fires the event.
options.question - a newly added question object.
options.name - a question name.
options.index - an index of the question in the container (page or panel).
options.parentPanel - a container where a new question is located. It can be a page or panel.
options.rootPanel - typically, it is a page.

The event is fired on creating a new question. Unlike the onQuestionAdded event, this event calls for all question created in survey including inside: a page, panel, matrix cell, dynamic panel and multiple text. or inside a matrix cell or it can be a text question in multiple text items or inside a panel of a panel dynamic. You can use this event to set up properties to a question based on it's type for all questions, regardless where they are located, on the page or inside a matrix cell. Please note: If you want to use this event for questions loaded from JSON then you have to create survey with empty/null JSON parameter, assign the event and call survey.fromJSON(yourJSON) function.
sender - the survey object that fires the event.
options.question - a newly created question object.

The event is fired on removing a question from survey.
sender - the survey object that fires the event.
options.question - a removed question object.
options.name - a question name.

Use this event to control scrolling element to top. You can cancel the default behavior by setting options.cancel property to true.
sender - the survey object that fires the event.
options.element - an element that is going to be scrolled on top.
options.question - a question that is going to be scrolled on top. It can be null if options.page is not null.
options.page - a page that is going to be scrolled on top. It can be null if options.question is not null.
options.elementId - the unique element DOM Id.
options.cancel - set this property to true to cancel the default scrolling.

The event fires when it gets response from the api.surveyjs.io service on saving survey results. Use it to find out if the results have been saved successfully.
sender - the survey object that fires the event.
options.success - it is true if the results has been sent to the service successfully.
options.response - a response from the service.

Use this event to validate data on your server.
sender - the survey object that fires the event.
options.data - the values of all non-empty questions on the current page. You can get a question value as options.data["myQuestionName"].
options.errors - set your errors to this object as: options.errors["myQuestionName"] = "Error text";. It will be shown as a question error.
options.complete() - call this function to tell survey that your server callback has been processed.

The event is fired before errors are assigned to a question. You may add/remove/modify errors for a question.
sender - the survey object that fires the event.
options.question - a validated question.
options.errors - the list of errors. The list is empty by default and remains empty if a validated question has no errors.

The event is fired after the survey changed it's state from "starting" to "running". The "starting" state means that survey shows the started page. The firstPageIsStarted property should be set to true, if you want to display a start page in your survey. In this case, an end user should click the "Start" button to start the survey.

Use this event to process the markdown text.
sender - the survey object that fires the event.
options.element - SurveyJS element (a question, panel, page, or survey) where the string is going to be rendered.
options.name - a property name is going to be rendered.
options.text - a text that is going to be rendered.
options.html - an HTML content. It is null by default. Use this property to specify the HTML content rendered instead of options.text.

Use this event to specity render component name used for text rendering.
sender - the survey object that fires the event.
options.element - SurveyJS element (a question, panel, page, or survey) where the string is going to be rendered.
options.name - a property name is going to be rendered.
options.renderAs - a component name used for text rendering.

The event is fired every second if the method startTimer has been called.

The event is fired before displaying a new information in the Timer Panel. Use it to change the default text.
sender - the survey object that fires the event.
options.text - the timer panel info text.

The event is fired before rendering a page. Use it to override the default page CSS classes.
sender - the survey object that fires the event.
options.page - a page for which you can change the CSS classes.
options.cssClasses - an object with CSS classes. For example {title: "sv_p_title", description: "small"}. You can change them to your own CSS classes.

The event is fired before rendering a panel. Use it to override the default panel CSS classes.
sender - the survey object that fires the event.
options.panel - a panel for which you can change the CSS classes.
options.cssClasses - an object with CSS classes. For example {title: "sv_p_title", description: "small"}. You can change them to your own CSS classes.

The event is fired before rendering a question. Use it to override the default question CSS classes.
sender - the survey object that fires the event.
options.question - a question for which you can change the CSS classes.
options.cssClasses - an object with CSS classes. For example {root: "table", button: "button"}. You can change them to your own CSS classes.

The event is fired on uploading the file in QuestionFile when storeDataAsText is set to false. Use this event to change the uploaded file name or to prevent a particular file from being uploaded.
sender - the survey object that fires the event.
options.question - the file question instance.
options.name - the question name.
options.files - the Javascript File objects array to upload.
options.callback - a callback function to get the file upload status and the updloaded file content.

Use the this event to be notified when the survey finished validate questions on the current page. It commonly happens when a user try to go to the next page or complete the survey options.questions - the list of questions that have errors options.errors - the list of errors options.page - the page where question(s) are located

The event is fired on validating a panel. Set your error to options.error and survey will show the error for the panel and block completing the survey or going to the next page.
sender - the survey object that fires the event.
options.name - a panel name.
options.error - an error string. It is empty by default.

The event is fired on validating value in a question. You can specify a custom error message using options.error. The survey blocks completing the survey or going to the next page when the error messages are displayed.
sender - the survey object that fires the event.
options.question - a validated question.
options.name - a question name.
options.value - the current question value (answer).
options.error - an error string. It is empty by default.

The event is fired when the question value (i.e., answer) has been changed. The question value can be changed in UI (by a user) or programmatically (on calling setValue method). Use the onDynamicPanelItemValueChanged and onMatrixCellValueChanged events to handle changes in a question in the Panel Dynamic and a cell question in matrices.
sender - the survey object that fires the event.
options.name - the value name that has been changed.
options.question - a question which question.name equals to the value name. If there are several questions with the same name, the first question is used. If there is no such questions, the options.question is null.
options.value - a new value.

The event is fired before the question value (answer) is changed. It can be done via UI by a user or programmatically on calling the setValue method.
sender - the survey object that fires the event.
options.name - the value name that has being changed.
options.question - a question which question.name equals to the value name. If there are several questions with the same name, the first question is used. If there is no such questions, the options.question is null.
options.oldValue - an old, previous value.
options.value - a new value. You can change it.

The event is fired when a question visibility has been changed.
sender - the survey object that fires the event.
options.question - a question which visibility has been changed.
options.name - a question name.
options.visible - a question visible boolean value.

Returns the survey page count.

Gets or sets the 'Next' button caption.

Gets or sets the 'Prev' button caption.

Returns a list of all pages in the survey, including invisible pages.

Gets or sets the 'Preview' button caption.

Navigates user to a previous page. If the current page is the first page, prevPage returns false. prevPage does not perform any checks, required questions can be empty.

Returns the HTML content, that is shown to a user that had completed the survey before.

Returns the HTML content for the complete page.

Returns the HTML content, that is shows when a survey loads the survey JSON.

Returns the text/HTML that is rendered as a survey title.

Gets or sets the type of info in the progress bar.

The following options are available:

• pages (default),
• questions,
• requiredQuestions,
• correctQuestions,
• buttons

Returns the text for the current progress.

Returns the progress that a user made while going through the survey. It depends from progressBarType property

Gets or sets the question description position. The default value is underTitle.

The following options are available:

• underTitle - show question description under the question title,
• underInput - show question description under the question input instead of question title.

Gets or sets the error message position.

The following options are available:

• top - to show question error(s) over the question,
• bottom - to show question error(s) under the question.

Gets or sets a value that specifies how the survey combines questions, panels, and pages.

The following options are available:

• singlePage - combine all survey pages in a single page. Pages will be converted to panels.
• questionPerPage - show one question per page. Survey will create a separate page for every question.

Gets or sets the question display order. Use this property to randomize questions. You can randomize questions on a specific page.

The following options are available:

• random - randomize questions
• initial - keep questions in the same order, as in a survey model.

Gets or sets the first question index. The first question index is '1' by default. You may start it from '100' or from 'A', by setting '100' or 'A' to this property. You can set the start index to "(1)" or "# A)" or "a)" to render question number as (1), # A) and a) accordingly.

Gets or sets the question title location.

The following options are available:

• bottom - show a question title to bottom
• left - show a question title to left
• top - show a question title to top.

Some questions, for example matrixes, do not support 'left' value. The title for them will be displayed to the top.

Set the pattern for question title. Default is "numTitleRequire", 1. What is your name? *, You can set it to numRequireTitle: 1. * What is your name? You can set it to requireNumTitle: * 1. What is your name? You can set it to numTitle (remove require symbol completely): 1. What is your name?

Gets or sets a question title template. Obsolete, please use questionTitlePattern

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.

Removes a page from a survey.

Gets or sets the required question mark. The required question mark is a char or string that is rendered in the required questions' titles.

Calculates a given expression and returns true or false.

Calculates a given expression and returns a result value.

Run all triggers that performs on value changed and not on moving to the next page.

Sends a survey result to the api.surveyjs.io service.

Gets or sets whether to save survey results on completing every page. If the property value is set to true, the onPartialSend event is fired.

Sets a comment value.

Set the cookie with cookieName in user's browser. It is done automatically on survey complete if the cookieName property value is not empty.

Sets the survey into design mode.

set property value

Sets a question value (answer). It runs all triggers and conditions (visibleIf properties).

Goes to the next page if goNextPageAutomatic is true and all questions on the current page are answered correctly.

Sets a variable value. Variable, unlike values, are not stored in the survey results.

On finishing the survey the complete page is shown. Set the property to false, to hide the complete page.

Gets or sets whether to show all elements in the survey, regardless their visibility. The default value is false.

Gets or sets the navigation buttons position. Possible values: 'bottom' (default), 'top', 'both' and 'none'. Set it to 'none' to hide 'Prev', 'Next' and 'Complete' buttons. It makes sense if you are going to create a custom navigation, have only a single page, or the goNextPageAutomatic property is set to true.

Gets or sets whether the survey displays page numbers on pages titles.

Gets or sets whether the Survey displays page titles. Set it to false to hide page titles.

Gets or sets whether the Survey displays "Prev" button in its pages. Set it to false to prevent end-users from going back to their answers.

Shows preview for the survey. Switches the survey to the "preview" state.

Details: Preview State

Set this property to "showAllQuestions" or "showAnsweredQuestions" to allow respondents to preview answers before submitting the survey results.

Details: Preview State Example: Show Preview Before Complete

Gets or sets the survey progress bar position.

The following options are available:

• off (default) - don't show progress bar
• top - show progress bar in the top
• bottom - show progress bar in the bottom
• both - show progress bar in both sides: top and bottom.

Gets or sets a value that specifies how the question numbers are displayed.

The following options are available:

• on - display question numbers
• onpage - display question numbers, start numbering on every page
• off - turn off the numbering for questions titles

Gets or sets a timer panel position. The timer panel displays information about how much time an end user spends on a survey/page.

The available options:

• top - display timer panel in the top.
• bottom - display timer panel in the bottom.
• none - do not display a timer panel.

If the value is not equal to 'none', the survey calls the startTimer() method on survey rendering.

Gets or set a value that specifies whether the timer displays information for the page or for the entire survey.

The available options:

• page - show timer information for page
• survey - show timer information for survey

Use the onTimerPanelInfoText event to change the default text.