Returns the currentPage, unless the started page is showing. In this case returns the started page.

Adds a custom navigation item similar to the Previous Page, Next Page, and Complete buttons. Accepts an object described in the IAction help section.

View Demo

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.

Specifies whether the text area of comment questions/elements automatically expands its height to avoid the vertical scrollbar and to display the entire multi-line contents entered by respondents. Default value is false.

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.

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

Returns all comments from the data.

A suffix added to the name of the property that stores comments.

Default value: "-Comment"

Many question types allow respondents to leave comments. To enable this functionality, set a question's showCommentArea property to true. Comment values are saved in a separate property. The property name is composed of the question name and commentSuffix.

Respondents can also leave a comment when they select "Other" in a single- or multi-select question, such as Dropdown or Checkboxes. The property name for the comment value is composed according to the same rules. However, you can use the question name as a key to store the comment value instead. Disable the storeOthersAsComment property in this case.

View Demo

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.

View Demo

Gets or sets an object with survey results. You can set this property with an object of the following structure:

{
  question1Name: question1Value,
  question2Name: question2Value,
  // ...
}

When you set this property in code, the new object overrides the old object that may contain default question values and entered data. If you want to merge the new and old objects, call the mergeData(newDataObj) method.

If you assign a new object while a respondent takes the survey, set the currentPageNo property to 0 to start the survey from the beginning. This will also cause the survey to re-evaluate the visibleIf, enableIf, and other expressions.

Default value for loadingHtml property

Deletes the cookie with cookieName from the browser.

Explanatory text displayed under the 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. The function can return false, if you set options.allowComplete to false in onCompleting event. Otherwise it returns true. It calls navigateToUrl after calling onComplete event. In case calling options.showSaveInProgress callback in the onComplete event, navigateToUrl is used on calling options.showSaveSuccess callback.

Downloads a file from server

Gets or sets the 'Edit' button caption.

Returns the text displayed when a survey has no visible pages and questions.

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.

Focus question by its name. If needed change the current page on the page where question is located. Function returns false if there is no question with this name or question is invisible, otherwise it returns true.

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 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 results as an array of objects in which the question name, title, value, and other parameters are stored as individual properties.

If a question can have more than one value (Matrix, Multiple Text), its 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.

If you want to skip empty answers, pass an object with the includeEmpty property set to false.

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

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 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 object type as it is used in the JSON schema.

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 user proceeds to the next page without pressing the "Next" button after answering all page questions. The available options:

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

If any of the following questions is answered last, the survey won't be switched to the next page: Checkbox, Boolean (rendered as Checkbox), Comment, Signature Pad, Image Picker (with Multi Select), File, Single-Choice Matrix (not all rows are answered), Dynamic Matrix, Panel Dynamic.

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 survey element has a description.

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 included in a survey.

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

Returns true if the current page does not contain errors.

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 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 configuration is being loaded from JSON.

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.

Survey is showing a page right now. It is in "running", "preview" or starting state.

The started page is showing right now. survey state equals to "starting"

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

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

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.

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

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

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.

View Demo

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.

Merges a specified data object with the object from the data property.

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

Gets or sets the survey edit mode.

The following options are available:

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

View Demo

A URL to which respondents should be navigated after survey completion.

An array of objects that allows you to navigate respondents to different URLs after survey completion.

Each object should include the expression and url properties. When expression evaluates to true, the survey navigates to the corresponding url. Refer to the following help topic for more information about expressions: Expressions.

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).

An event that is raised right after a page is rendered in DOM. Use it to modify HTML elements. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.htmlElement: HTMLElement The rendered HTML element.

An event that is raised right after a page is rendered in DOM. Use it to modify HTML elements.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.htmlElement: HTMLElement The rendered HTML element.
• options.page: PageModel A Page instance for which the event is raised.

View Demo

An event that is raised right after a panel is rendered in DOM. Use it to modify HTML elements. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.htmlElement: HTMLElement The rendered HTML element.
• options.panel: PanelModel A Panel instance for which the event is raised.

An event that is raised right after a question is rendered in DOM. Use it to modify HTML elements.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.htmlElement: HTMLElement The rendered HTML element.

View Demo

An event that is raised 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. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.htmlElement: HTMLElement The rendered HTML element.

An event that is raised right after survey is rendered in DOM. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.htmlElement: HTMLElement The rendered HTML element.
• options.survey: SurveyModel

Use this event to load choice items in Dropdown and Tag Box questions on demand.

This event is raised only for those questions that have the choicesLazyLoadEnabled property set to true.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.setItems: (items: (string | { value: any; text?: String; imageLink?: string; customProperty?: any; })[], totalCount: number) => void A method that you should call to assign loaded items to the question. Item objects should be structured as specified in the choices property description. If their structure is different, map their properties to bring them to the required structure.
• options.filter: string A search string used to filter choices.
• options.take: number The number of choice items to load. You can use the question's choicesLazyLoadPageSize property to change this number.
• options.skip: number The number of choice items to skip.

View Demo

This event is fired on clearing the value in a QuestionFile. Use this event to remove files stored on your server.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionFileModel A File question instance for which the event is raised.
• options.name: string the question name
• options.callback: (status: string, data?: any) => any a callback function to get the operation status
• options.fileName: string a removed file's name, set it to null to clear all files
• options.value: any the question value

View Demo

An event that is raised after the survey is completed. Use this event to send survey results to the server.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.isCompleteOnTrigger: boolean Returns true if survey completion is caused by the "complete" trigger.
• options.clearSaveMessages: (test?: string) => void Call this method to hide the save operation messages.
• options.showSaveSuccess: (text?: string) => void Call this method to indicate that survey results are successfully saved. You can use the text parameter to display a custom message.
• options.showSaveError: (text?: string) => void Call this method to indicate that an error occurred during the save operation. You can use the text parameter to display a custom error message.
• options.showSaveInProgress: (text?: string) => void Call this method to indicate that the save operation is in progress. You can use the text parameter to display a custom message.
• options.showDataSaving: (text?: string) => void
• options.showDataSavingError: (text?: string) => void
• options.showDataSavingSuccess: (text?: string) => void
• options.showDataSavingClear: (text?: string) => void

For an example of how to use the methods described above, refer to the following help topic: Store Survey Results in Your Own Database.

Do not disable the showCompletedPage property if you call one of the options.showSave... methods. This is required because the UI that indicates data saving progress is integrated into the complete page. If you hide the complete page, the UI also becomes invisible.

An event that is raised before the survey is completed. Use this event to prevent survey completion. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.isCompleteOnTrigger: boolean Returns true if survey completion is caused by the "complete" trigger.
• options.allow: boolean Set this property to false if you want to prevent survey completion.
• options.allowComplete: boolean

An event that is raised after the current page is switched. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.isPrevPage: boolean Returns true if the respondent is going backwards, that is, newCurrentPage is earlier in the survey than oldCurrentPage.
• options.isNextPage: boolean Returns true if the respondent is going forward along the survey.
• options.newCurrentPage: PageModel The current page.
• options.oldCurrentPage: PageModel A page that used to be current.

An event that is raised before the current page is switched. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.isPrevPage: boolean Returns true if the respondent is going backwards, that is, newCurrentPage is earlier in the survey than oldCurrentPage.
• options.isNextPage: boolean Returns true if the respondent is going forward along the survey.
• options.newCurrentPage: PageModel The current page.
• options.oldCurrentPage: PageModel A page that used to be current.
• options.allow: boolean Set this property to false if you do not want to switch the current page.
• options.allowChanging: boolean

An event that is raised on downloading a file in QuestionFile. Use this event to pass the file to a preview.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionFileModel A File question instance for which the event is raised.
• options.name: string the question name
• options.callback: (status: string, data?: any) => any a callback function to get the file downloading status and the downloaded file content
• options.fileValue: any single file question value
• options.content: any the file content

View Demo

Use this event to control drag&drop operations during design mode. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.insertAfter: IElement 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
• options.insertBefore: IElement 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.parent: ISurveyElement a page or panel where target element is dragging
• options.source: IElement a source element. It can be null, if it is a new element, dragging from toolbox
• options.target: IElement a target element that is dragged
• options.allow: boolean set it to false to disable dragging

An event that is raised after a new panel is added to a Dynamic Panel question. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionPanelDynamicModel A Dynamic Panel question instance for which the event is raised.
• options.panel: PanelModel A Panel instance for which the event is raised.
• options.panelIndex: number The panel's index within Dynamic Panel.

An event that is raised after an item value is changed in a panel within a Dynamic Panel question. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionPanelDynamicModel A Dynamic Panel question instance for which the event is raised.
• options.panelData: { [index: string]: any; } The panel's data object that includes all item values.
• options.panelIndex: number The panel's index within Dynamic Panel.
• options.value: any The item's new value.
• options.name: string The item's name.
• options.panel: PanelModel A panel that nests the item with a changed value.

An event that is raised after a panel is deleted from a Dynamic Panel question. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionPanelDynamicModel A Dynamic Panel question instance for which the event is raised.
• options.panel: PanelModel A Panel instance for which the event is raised.
• options.panelIndex: number The panel's index within Dynamic Panel.

An event that is raised before a panel is deleted from a Dynamic Panel question. Use this event to cancel the deletion. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionPanelDynamicModel A Dynamic Panel question instance for which the event is raised.
• options.panel: PanelModel A Panel instance for which the event is raised.
• options.panelIndex: number The panel's index within Dynamic Panel.
• options.allow: boolean Set this property to false if you want to cancel the panel deletion.

An event that is raised after the survey element content was collapsed or expanded. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.element: ISurveyElement Specifies which survey element content was collapsed or expanded

Use the event to change the default error text. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.name: string the error name. The following error names are available: required, requireoneanswer, requirenumeric, exceedsize, webrequest, webrequestempty, otherempty, uploadingfile, requiredinallrowserror, minrowcounterror, keyduplicationerror, custom
• options.obj: Question | PanelModel | SurveyModel an instance of Question, Panel or Survey object to where error is located
• options.error: SurveyError an instance of the SurveyError object
• options.text: string an error text

The event occurs when an element within a panel gets focus. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.panel: PanelModel A Panel instance for which the event is raised.

The event occurs when an element within a question gets focus. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.

Use this event to load a display text for the default choice item in Dropdown and Tag Box questions.

If you load choices from a server (use choicesByUrl or onChoicesLazyLoad), display texts become available only when data is loaded, which does not happen until a user opens the drop-down menu. However, a display text for a default choice item is required before that. In this case, you can load data individually for the default item within the onGetChoiceDisplayValue event handler.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.setItems: (displayValues: string[]) => void A method that you should call to assign display texts to the question.
• options.values: any[] An array of one (in Dropdown) or more (in Tag Box) default values.

View Demo

An event that is raised before expression question convert it's value into display value for rendering. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.displayValue: any A question's display text. You can assign a custom value to this parameter.
• options.value: any The question value

Use this event to create/customize actions to be displayed in a matrix question's row. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.actions: IAction[] An array of actions. You can modify the entire array or individual actions within it.
• options.row: any A matrix row for which the event is fired

Use this event to create/customize actions to be displayed in a page's title. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.page: PageModel A Page instance for which the event is raised.
• options.titleActions: IAction[] An array of actions associated with the processed element.

An event that allows you to add, delete, or modify actions in the footer of a Panel. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.actions: IAction[] An array of actions. You can modify the entire array or individual actions within it.
• options.panel: PanelModel A Panel instance for which the event is raised.
• options.question: QuestionPanelDynamicModel A Dynamic Panel to which the Panel belongs. This field is undefined if the Panel does not belong to any Dynamic Panel

Use this event to create/customize actions to be displayed in a panel's title. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.panel: PanelModel A Panel instance for which the event is raised.
• options.titleActions: IAction[] An array of actions associated with the processed element.

Use this event to change a question's display text. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.displayValue: any A question's display text. You can assign a custom value to this parameter.

Use this event to change the question no in code. If you want to remove question numbering then set showQuestionNumbers to "off". Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.no: string a calculated question no, based on question visibleIndex, survey .questionStartIndex properties. You can change it

Use this event to change the question title in code. If you want to remove question numbering then set showQuestionNumbers to "off". Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.title: string a calculated question title, based on question title, name

Use this event to create/customize actions to be displayed in a question's title.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.titleActions: IAction[] An array of actions associated with the processed element.

View Demo

Use it to get results after calling the getResult method. It returns a simple analytics from api.surveyjs.io service. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.response: any the server response
• options.dataList: any[] 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.data: any 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.success: boolean it is true if the results were got from the service successfully

Use this event to change the element title tag name that renders by default. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.tagName: string an element title tagName that are used to render a title. You can change it from the default value
• options.element: Base an element (question, panel, page and survey) that SurveyJS is going to render

Use this event to define, whether an answer to a question is correct or not. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.correctAnswers: number 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
• options.incorrectAnswers: number
• options.result: boolean 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

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 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. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.serverResult: any a result that comes from the server as it is
• options.choices: ItemValue[] the loaded choices. You can change the loaded choices to before they are assigned to question

An event that is raised 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. Parameters:

• sender: SurveyModel A survey instance that raised the event.

Parameters:

• sender: SurveyModel A survey instance that raised the event.

An event that is raised for every cell after is has been rendered in DOM. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.htmlElement: HTMLElement The rendered HTML element.
• options.row: MatrixDropdownRowModelBase the matrix row object
• options.column: MatrixDropdownColumn | MatrixDropdownCell the matrix column object
• options.cellQuestion: Question the question/editor in the cell
• options.cell: MatrixDropdownCell the matrix cell

An event that is raised before rendering "Remove" button for removing a row from Matrix Dynamic question. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionMatrixDynamicModel A Dynamic Matrix question instance for which the event is raised.
• options.allow: boolean a boolean property. Set it to false to disable the row removing
• options.row: any a row object
• options.rowIndex: number a row index

An event that is raised before adding a new row in Matrix Dynamic question. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionMatrixDynamicModel A Dynamic Matrix question instance for which the event is raised.
• options.canAddRow: boolean specifies whether a new row can be added

An event that is raised for every cell created in Matrix Dynamic and Matrix Dropdown questions. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionMatrixDropdownModelBase A Multiple-Choice Matrix question instance for which the event is raised.
• options.row: MatrixDropdownRowModelBase the matrix row object
• options.columnName: string the matrix column name
• options.column: MatrixDropdownColumn the matrix column object
• options.rowValue: any the value of the current row. To access a particular column's value within the current row, use: options.rowValue["columnValue"]
• options.cellQuestion: Question the question/editor in the cell. You may customize it, change it's properties, like choices or visible
• options.cell: MatrixDropdownCell the matrix cell

An event that is raised before creating cell question in the matrix. You can change the cell question type by setting different options.cellType. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionMatrixDropdownModelBase A Multiple-Choice Matrix question instance for which the event is raised.
• options.row: MatrixDropdownRowModelBase the matrix row object
• options.columnName: string the matrix column name
• options.column: MatrixDropdownColumn the matrix column object
• options.rowValue: any the value of the current row. To access a particular column's value within the current row, use: options.rowValue["columnValue"]
• options.cellType: string the cell question type. You can change it

An event that is raised when Matrix Dynamic and Matrix Dropdown questions validate the cell value. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionMatrixDropdownModelBase A Multiple-Choice Matrix question instance for which the event is raised.
• options.getCellQuestion: (columnName: string) => Question the function that returns the cell question by column name
• options.row: MatrixDropdownRowModelBase the matrix row object
• options.value: any a new value
• options.columnName: string the matrix column name
• options.error: string an error string. It is empty by default

An event that is raised when cell value is changed in Matrix Dynamic and Matrix Dropdown questions. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionMatrixDropdownModelBase A Multiple-Choice Matrix question instance for which the event is raised.
• options.getCellQuestion: (columnName: string) => Question the function that returns the cell question by column name
• options.row: MatrixDropdownRowModelBase the matrix row object
• options.value: any a new value
• options.columnName: string the matrix column name

An event that is raised on changing cell value in Matrix Dynamic and Matrix Dropdown questions. You may change the options.value property to change a cell value. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionMatrixDropdownModelBase A Multiple-Choice Matrix question instance for which the event is raised.
• options.getCellQuestion: (columnName: string) => Question the function that returns the cell question by column name
• options.row: MatrixDropdownRowModelBase the matrix row object
• options.value: any a new value
• options.columnName: string the matrix column name
• options.oldValue: any the old value

An event that is raised on adding a new column in Matrix Dynamic or Matrix Dropdown question. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.column: any A new added column.

An event that is raised on adding a new row in Matrix Dynamic question. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionMatrixDynamicModel A Dynamic Matrix question instance for which the event is raised.
• options.row: any a new added row

An event that is raised on removing a row from Matrix Dynamic question. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionMatrixDynamicModel A Dynamic Matrix question instance for which the event is raised.
• options.row: any a removed row object
• options.rowIndex: number a removed row index

An event that is raised before removing a row from Matrix Dynamic question. You can disable removing and clear the data instead. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionMatrixDynamicModel A Dynamic Matrix question instance for which the event is raised.
• options.allow: boolean a boolean property. Set it to false to disable the row removing
• options.row: any a row object
• options.rowIndex: number a row index

An event that is raised on adding a new item in Multiple Text question. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.item: any A new added item.

An event that is raised before the survey navigates to a specified URL. Use this event to change the URL or cancel the navigation. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.allow: boolean Set this property to false if you want to cancel the navigation and show the complete page.
• options.url: string A URL to which respondents should be navigated. You can modify this parameter's value.

An event that is raised when a new page is added to the survey. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.page: PageModel A Page instance for which the event is raised.

An event that is raised after page visibility is changed.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.visible: boolean Indicates whether the element is visible now.
• options.page: PageModel A Page instance for which the event is raised.

Refer to the following help topic for information on how to implement conditional visibility: Conditional Visibility.

An event that is raised when a new panel is added to a page. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.panel: PanelModel A Panel instance for which the event is raised.
• options.page: PanelModelBase A page that nests the added element.
• options.parent: PanelModelBase The parent container (panel or page).
• options.rootPanel: any
• options.parentPanel: any
• options.index: number The element's index within the parent container (panel or page).
• options.name: string The question's name.

An event that is raised after a panel is deleted from the survey. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.panel: PanelModel A Panel instance for which the event is raised.
• options.name: string The element's name.

An event that is raised after page visibility is changed.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.visible: boolean Indicates whether the element is visible now.
• options.panel: PanelModel A Panel instance for which the event is raised.

Refer to the following help topic for information on how to implement conditional visibility: Conditional Visibility.

Use this event to save incomplete survey results. Enable the sendResultOnPageNext property for this event to occur.

Parameters:

• sender: SurveyModel A survey instance that raised the event.

Refer to the following help topic for more information on the use case: Continue an Incomplete Survey.

Use this event to modify the HTML content before rendering, for example completeHtml or loadingHtml. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.html: string an HTML that you may change before text processing and then rendering. specifies the modified HTML content

An event that is raised 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. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.value: any the value of the processing text
• options.isExists: boolean a boolean value. Set it to true if you want to use the value and set it to false if you don't
• options.canProcess: boolean
• options.name: string the name of the processing value, for example, "state" in our example
• options.returnDisplayValue: boolean

Use this event to change the progress text in code. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.requiredAnsweredQuestionCount: number a number of required questions that have input(s) and an user has answered
• options.requiredQuestionCount: number a number of required questions that have input(s). We do not count html or expression questions
• options.answeredQuestionCount: number a number of questions that have input(s) and an user has answered
• options.questionCount: number a number of questions that have input(s). We do not count html or expression questions
• options.text: string a progress text, that SurveyJS will render in progress bar

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 a new question is added to a panel or page.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.page: PanelModelBase A page that nests the added element.
• options.parent: PanelModelBase The parent container (panel or page).
• options.rootPanel: any
• options.parentPanel: any
• options.index: number The element's index within the parent container (panel or page).
• options.name: string The question's name.

To use this event for questions loaded from JSON, create an empty survey model, add an event handler, and only then populate the model from the JSON object:

import { Model } from "survey-core";

const surveyJson = {
   // ...
};
// Create an empty model
const survey = new Model();
// Add an event handler
survey.onQuestionAdded.add((sender, options) => {
  //...
});
// Load the survey JSON schema
survey.fromJSON(surveyJson);

An event that is raised when the survey creates any new object derived from Question.

In a survey, complex elements (Dynamic Matrix, Multiple Text, and Dynamic Panel) are composed of questions. Use this event to customize any question regardless of which survey element it belongs to.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.

To use this event for questions loaded from JSON, create an empty survey model, add an event handler, and only then populate the model from the JSON object:

import { Model } from "survey-core";

const surveyJson = {
   // ...
};
// Create an empty model
const survey = new Model();
// Add an event handler
survey.onQuestionCreated.add((sender, options) => {
  //...
});
// Load the survey JSON schema
survey.fromJSON(surveyJson);

An event that is raised after a question is deleted from the survey. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.name: string The element's name.

An event that is raised after question visibility is changed.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.visible: boolean Indicates whether the element is visible now.
• options.name: string The question's name.

Refer to the following help topic for information on how to implement conditional visibility: Conditional Visibility.

Use this event to control scrolling element to top. You can cancel the default behavior by setting options.cancel property to true. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.element: ISurveyElement an element that is going to be scrolled on top
• options.question: Question a question that is going to be scrolled on top. It can be null if options.page is not null
• options.page: PageModel a page that is going to be scrolled on top. It can be null if options.question is not null
• options.cancel: boolean set this property to true to cancel the default scrolling
• options.elementId: string the unique element DOM Id

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. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.response: any a response from the service
• options.request: any
• options.success: boolean it is true if the results has been sent to the service successfully

Use this event to validate data on your server.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.complete: () => void A method that you should call when a request to the server has completed.
• options.errors: { [index: string]: any; } An object for your error messages. Set error messages as follows: options.errors["questionName"] = "My error message".
• options.data: { [index: string]: any; } Question values. You can get an individual question value as follows: options.data["questionName"].

View Demo

An event that is raised before errors are assigned to a question. You may add/remove/modify errors for a question. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.errors: SurveyError[] An array of errors. The array is empty if the validated question satisfy all validation rules.

Use this event to change the visibility of an individual choice item in Checkbox, Dropdown, Radiogroup, and other similar question types. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.visible: boolean A Boolean value that specifies item visibility. Set it to false to hide the item.
• options.item: ItemValue The choice item as specified in the choices array.

An event that is raised before the survey displays a preview. Use this event to cancel the preview. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.allow: boolean Set this property to false if you want to cancel the preview.
• options.allowShowPreview: boolean

An event that is raised when the survey state changes from "starting" to "running". This occurs only if your survey includes a start page. Parameters:

• sender: SurveyModel A survey instance that raised the event.

Use this event to process the markdown text.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.name: string a property name is going to be rendered
• options.element: Question | PanelModel | PageModel | SurveyModel SurveyJS element (a question, panel, page, or survey) where the string is going to be rendered
• options.html: string an HTML content. It is null by default. Use this property to specify the HTML content rendered instead of options.text
• options.text: string a text that is going to be rendered

View Demo

Use this event to specity render component name used for text rendering. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.name: string a property name is going to be rendered
• options.element: Question | PanelModel | PageModel | SurveyModel SurveyJS element (a question, panel, page, or survey) where the string is going to be rendered
• options.renderAs: string a component name used for text rendering

An event that is raised every second if the method startTimer has been called. Parameters:

• sender: SurveyModel A survey instance that raised the event.

An event that is raised before displaying a new information in the Timer Panel. Use it to change the default text. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.text: string the timer panel info text

An event that is raised after a trigger is executed.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.trigger: Trigger A trigger that has been executed.

For more information about triggers, refer to the following help topic: Conditional Survey Logic (Triggers).

An event that is raised before rendering a choice item in radiogroup, checkbox or dropdown questions. Use it to override the default choice item css. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.css: string a string with css classes divided by space. You can change it
• options.item: ItemValue a choice item of ItemValue type. You can get value or text choice properties as options.item.value or options.choice.text

An event that is raised before rendering a page. Use it to override the default page CSS classes. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.page: PageModel A Page instance for which the event is raised.
• options.cssClasses: any An object with CSS classes applied to the element being rendered, for example, { root: "class1", button: "class2" }. You can modify this object to apply custom CSS classes.

An event that is raised before rendering a panel. Use it to override the default panel CSS classes. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.panel: PanelModel A Panel instance for which the event is raised.
• options.cssClasses: any An object with CSS classes applied to the element being rendered, for example, { root: "class1", button: "class2" }. You can modify this object to apply custom CSS classes.

An event that is raised before rendering a question. Use it to override the default question CSS classes.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.cssClasses: any An object with CSS classes applied to the element being rendered, for example, { root: "class1", button: "class2" }. You can modify this object to apply custom CSS classes.

View Demo

An event that is raised 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.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: QuestionFileModel A File question instance for which the event is raised.
• options.name: string the question name
• options.callback: (status: string, data?: any) => any a callback function to get the file upload status and the updloaded file content
• options.files: any[] the Javascript File objects array to upload

View Demo

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 Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.page: PageModel A Page instance for which the event is raised.
• options.questions: Question[] the list of questions that have errors
• options.errors: SurveyError[] the list of errors

An event that is raised when a panel is being validated. Use this event to specify a custom error message.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.panel: PanelModel A Panel instance for which the event is raised.
• options.error: string An error message that you should specify if validation fails.
• options.name: string The panel's name.

View Demo

An event that is raised when a question value is being validated. Use this event to specify a custom error message.

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.error: string An error message that you should specify if validation fails.
• options.value: any A question value being validated.
• options.name: string The question's name.

View Demo

An event that is raised after a question value is changed

Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.name: string The name of the question whose value is being changed. If you use the valueName property, this parameter contains its value.
• options.value: any A new value.

To handle value changes in matrix cells or panels within a Dynamic Panel, use the onMatrixCellValueChanged or onDynamicPanelItemValueChanged event.

An event that is raised before a question value is changed. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.name: string The name of the question whose value is being changed. If you use the valueName property, this parameter contains its value.
• options.value: any A new value. You can change it if required.
• options.oldValue: any A previous value.

An event that is raised after a variable or calculated value is changed. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.value: any A new value for the variable or calculated value.
• options.name: string The name of the variable or calculated value that has been changed.

Obsolete. Please use onQuestionVisibleChanged event. Parameters:

• sender: SurveyModel A survey instance that raised the event.
• options.question: Question A Question instance for which the event is raised.
• options.visible: boolean Indicates whether the element is visible now.
• options.name: string The question's name.

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.

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

The following options are available:

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

View Demo

Returns the text for the current progress.

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