ICreatorOptions

Survey Creator configuration. Pass it as an argument to the SurveyCreator/SurveyCreatorModel constructor:

const creatorOptions = { ... };
const creator = new SurveyCreator.SurveyCreator(creatorOptions);

// In modular applications:
import { SurveyCreatorModel } from "survey-creator-core";

const creatorOptions = { ... };
const creator = new SurveyCreatorModel(creatorOptions);

addNewQuestionLast allowChangeThemeInPreview allowDragPages allowEditExpressionsInTextEditor allowModifyPages allowZoom autoSaveEnabled clearTranslationsOnSourceTextChange collapseOnDrag collapsePages collapsePanels collapseQuestions expandCollapseButtonVisibility generateValidJSON isAutoSave isRTL logicAllowTextEditExpressions logicMaxItemsInCondition maxChoices maxColumns maximumChoicesCount maximumColumnsCount maximumRateValues maximumRowsCount maxLogicItemsInCondition maxNestedPanels maxRateValues maxRows maxVisibleChoices minChoices minimumChoicesCount pageEditMode previewAllowHiddenElements previewAllowSelectLanguage previewAllowSelectPage previewAllowSelectTheme previewAllowSimulateDevices previewDevice previewOrientation previewTheme propertyGridNavigationMode questionTypes readOnly showCreatorThemeSettings showDefaultLanguageInPreviewTab showDesignerTab showErrorOnFailedSave showHeaderInEmptySurvey showInvisibleElementsInPreviewTab showJSONEditorTab showLogicTab showObjectTitles showPagesInPreviewTab showPreviewTab showSimulatorInPreviewTab showSurveyHeader showSurveyTitle showThemeTab showTitlesInExpressions showTranslationTab themeForPreview useElementTitles

addNewQuestionLast property

Specifies where to add new questions when users click the "Add Question" button.

Accepted values:

true (default) New questions are added to the end of a survey page.
false New questions are added after the currently selected question on the design surface.

Type:: boolean readonly

Implemented in:: ICreatorOptions

allowChangeThemeInPreview property

Obsolete. Survey Creator no longer supports switching between UI themes in the Preview tab.

Type:: boolean readonly

Implemented in:: ICreatorOptions

allowDragPages property

Specifies whether users can drag and drop pages on the design surface.

Default value: true if pageEditMode is "standard"; false otherwise.

Type:: boolean readonly

Implemented in:: ICreatorOptions

See also:: collapseOnDrag

allowEditExpressionsInTextEditor property

Obsolete. Use the logicAllowTextEditExpressions property instead.

Type:: boolean readonly

Implemented in:: ICreatorOptions

allowModifyPages property

Specifies whether users can add, edit, and delete survey pages.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

allowZoom property

Specifies whether the "Zoom In", "Zoom Out", and "Zoom to 100%" buttons are available.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

autoSaveEnabled property

Specifies whether to call the saveSurveyFunc and saveThemeFunc functions each time survey or theme settings are changed.

Default value: false

Type:: boolean readonly

Implemented in:: ICreatorOptions

clearTranslationsOnSourceTextChange property

Specifies whether to clear translations to other languages when a source language translation is changed.

Default value: false

Type:: boolean readonly

Implemented in:: ICreatorOptions

collapseOnDrag property

Specifies whether to collapse pages on the design surface when users start dragging a survey element.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

collapsePages property

Specifies whether survey pages appear collapsed on the design surface by default.

Default value: false

View Demo

This property specifies the expand/collapse state of all survey pages at once. To adjust the state of individual pages, handle the onElementGetExpandCollapseState event.

Type:: boolean readonly

Implemented in:: ICreatorOptions

See also:: expandCollapseButtonVisibility

collapsePanels property

Specifies whether panels appear collapsed on the design surface by default.

Default value: false

View Demo

This property specifies the expand/collapse state of all panels at once. To adjust the state of individual panels, handle the onElementGetExpandCollapseState event.

Type:: boolean readonly

Implemented in:: ICreatorOptions

See also:: expandCollapseButtonVisibility

collapseQuestions property

Specifies whether survey questions appear collapsed on the design surface by default.

Default value: false

View Demo

This property specifies the expand/collapse state of all survey questions at once. To adjust the state of individual questions, handle the onElementGetExpandCollapseState event.

Type:: boolean readonly

Implemented in:: ICreatorOptions

See also:: expandCollapseButtonVisibility

expandCollapseButtonVisibility property

Specifies the visibility of the buttons that expand and collapse survey elements on the design surface.

Accepted values:

"onhover" (default) - Displays an expand/collapse button when a survey element is hovered over or selected.
"always" - Displays the expand/collapse buttons permanently.
"never" - Hides the expand/collapse buttons.

Type:: "never" | "onhover" | "always" readonly

Implemented in:: ICreatorOptions

See also:: SurveyCreatorModel.onElementGetExpandCollapseState , collapseOnDrag

generateValidJSON property

Specifies whether the Survey Creator generates the survey definition as a valid JSON object or JavaScript object.

Default value: true

Refer to the following MDN topic for information on differences between JSON and JavaScript objects: JavaScript and JSON Differences

Type:: boolean readonly

Implemented in:: ICreatorOptions

isAutoSave property

Obsolete. Use the autoSaveEnabled property instead.

Type:: boolean readonly

Implemented in:: ICreatorOptions

isRTL property

Specifies whether to enable support for right-to-left languages.

Default value: false

Type:: boolean readonly

Implemented in:: ICreatorOptions

logicAllowTextEditExpressions property

Specifies whether users can edit expressions in the Logic tab as plain text.

If you set this property to false, users can only use UI elements to edit logical expressions.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

See also:: showLogicTab

logicMaxItemsInCondition property

Limits the number of items in a logical condition.

Default value: -1 (unlimited)

Type:: number readonly

Implemented in:: ICreatorOptions

maxChoices property

Limits the number of choices that users can add to Checkboxes, Dropdown, and Radio Button Group questions.

Default value: 0 (unlimited, taken from settings.propertyGrid.maxChoices)

Type:: number readonly

Implemented in:: ICreatorOptions

maxColumns property

Limits the number of columns that users can add to Single-Select Matrix, Multi-Select Matrix, and Dynamic Matrix questions.

Default value: 0 (unlimited, taken from settings.propertyGrid.maxColumns)

Type:: number readonly

Implemented in:: ICreatorOptions

maximumChoicesCount property

Obsolete. Use the maxChoices property instead.

Type:: number readonly

Implemented in:: ICreatorOptions

maximumColumnsCount property

Obsolete. Use the maxColumns property instead.

Type:: number readonly

Implemented in:: ICreatorOptions

maximumRateValues property

Obsolete. Use the maxRateValues property instead.

Type:: number readonly

Implemented in:: ICreatorOptions

maximumRowsCount property

Obsolete. Use the maxRows property instead.

Type:: number readonly

Implemented in:: ICreatorOptions

maxLogicItemsInCondition property

Obsolete. Use the logicMaxItemsInCondition property instead.

Type:: number readonly

Implemented in:: ICreatorOptions

maxNestedPanels property

Limits the number of nested panels within a Panel element.

Default value: -1 (unlimited)

Type:: number readonly

Implemented in:: ICreatorOptions

maxRateValues property

Limits the number of rate values that users can add to Rating Scale questions.

Default value: 0 (unlimited, taken from settings.propertyGrid.maxRateValues)

Type:: number readonly

Implemented in:: ICreatorOptions

maxRows property

Limits the number of rows that users can add to Single-Select Matrix and Multi-Select Matrix questions.

Default value: 0 (unlimited, taken from settings.propertyGrid.maxRows)

Type:: number readonly

Implemented in:: ICreatorOptions

maxVisibleChoices property

Limits the number of visible choices. Users can click "Show more" to view hidden choices.

Set this property to -1 if you do not want to hide any choices.

Default value: 10

Type:: number readonly

Implemented in:: ICreatorOptions

minChoices property

Limits the minimum number of choices in Checkboxes, Dropdown, and Radio Button Group questions. Set this property if users should not delete choices below the specified limit.

Default value: 0 (unlimited, taken from settings.propertyGrid.minChoices)

Type:: number readonly

Implemented in:: ICreatorOptions

minimumChoicesCount property

Obsolete. Use the minChoices property instead.

Type:: number readonly

Implemented in:: ICreatorOptions

pageEditMode property

Specifies how Survey Creator users edit survey pages.

Accepted values:

"standard" (default) Questions and panels are divided between pages. Users can scroll the design surface to reach a required page.
"single" All questions and panels belong to a single page. Users cannot add or remove pages.
"bypage" Questions and panels are divided between pages. Users can use the page navigator to switch to a required page.

Type:: "standard" | "single" | "bypage" readonly

Implemented in:: ICreatorOptions

previewAllowHiddenElements property

Specifies whether the Preview tab displays a checkbox that allows users to show or hide invisible survey elements.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

previewAllowSelectLanguage property

Specifies whether the Preview tab displays the language selector.

Accepted values:

"auto" (default) Display the language selector only if the survey is translated into more than one language.
true Always display the language selector regardless of how many languages are used in the survey.
false Never display the language selector.
"all" Always display the language selector with all supported languages.

See also: Localization & Globalization

Type:: string | boolean readonly

Implemented in:: ICreatorOptions

previewAllowSelectPage property

Specifies whether to show the page selector at the bottom of the Preview tab.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

previewAllowSelectTheme property

Obsolete. Survey Creator no longer supports switching between UI themes in the Preview tab.

Type:: boolean readonly

Implemented in:: ICreatorOptions

previewAllowSimulateDevices property

Specifies whether the Preview tab displays the Device button that allows users to preview the survey on different device types.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

previewDevice property

Specifies a default device for survey preview in the Preview tab.

Accepted values:

"desktop" (default)
"iPhoneSE"
"iPhone15"
"iPhone15Plus"
"iPad"
"iPadMini"
"androidPhone"
"androidTablet"
"microsoftSurface"

Type:: string readonly

Implemented in:: ICreatorOptions

previewOrientation property

Specifies the orientation of the selected device in the Preview tab.

Accepted values:

"landscape" (default)
"portrait"

Type:: "landscape" | "portrait" readonly

Implemented in:: ICreatorOptions

previewTheme property

Obsolete. Survey Creator no longer supports switching between UI themes in the Preview tab.

Type:: string readonly

Implemented in:: ICreatorOptions

propertyGridNavigationMode property

Specifies how users navigate categories in the Property Grid.

Accepted values:

"accordion" The Property Grid displays a stacked list of categories that users can expand or collapse to reveal nested properties.
"buttons" (default) The Property Grid displays the properties of a currently selected category. Users can switch between categories using buttons on the right side of the Property Grid.

Type:: "buttons" | "accordion" readonly

Implemented in:: ICreatorOptions

questionTypes property

Limits question and panel types available in the Toolbox and Add Question menu.

Refer to the Limit Available Question and Panel Types help topic for more information.

Type:: any readonly

Implemented in:: ICreatorOptions

readOnly property

Enables the read-only mode. If you set this property to true, users cannot change the initial survey configuration.

Default value: false

Type:: boolean readonly

Implemented in:: ICreatorOptions

showCreatorThemeSettings property

Specifies whether users can modify the Survey Creator theme. Applies only if propertyGridNavigationMode is "buttons".

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

showDefaultLanguageInPreviewTab property

Obsolete. Use the previewAllowSelectLanguage property instead.

Type:: string | boolean readonly

Implemented in:: ICreatorOptions

showDesignerTab property

Specifies whether to display the Designer tab.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

showErrorOnFailedSave property

Specifies whether to show an error message if a survey is not saved in the database.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

showHeaderInEmptySurvey property

Specifies whether the design surface displays the survey title and description when the survey does not contain any elements.

Default value: false

Type:: boolean readonly

Implemented in:: ICreatorOptions

showInvisibleElementsInPreviewTab property

Obsolete. Use the previewAllowHiddenElements property instead.

Type:: boolean readonly

Implemented in:: ICreatorOptions

showJSONEditorTab property

Specifies whether to display the JSON Editor tab.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

showLogicTab property

Specifies whether to display the Logic tab.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

showObjectTitles property

Obsolete. Use the useElementTitles property instead.

Type:: boolean readonly

Implemented in:: ICreatorOptions

showPagesInPreviewTab property

Obsolete. Use the previewAllowSelectPage property instead.

Type:: boolean readonly

Implemented in:: ICreatorOptions

showPreviewTab property

Specifies whether to display the Preview tab.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

showSimulatorInPreviewTab property

Obsolete. Use the previewAllowSimulateDevices property instead.

Type:: boolean readonly

Implemented in:: ICreatorOptions

showSurveyHeader property

Specifies whether users can see and edit the survey header and related survey properties.

Default value: true

Type:: boolean readonly

Implemented in:: ICreatorOptions

showSurveyTitle property

Obsolete. Use the showSurveyHeader property instead.

Type:: boolean readonly

Implemented in:: ICreatorOptions

showThemeTab property

Specifies whether to display the Themes tab.

Default value: false

Theme Editor

Type:: boolean readonly

Implemented in:: ICreatorOptions

showTitlesInExpressions property

Obsolete. Use the useElementTitles property instead.

Type:: boolean readonly

Implemented in:: ICreatorOptions

showTranslationTab property

Specifies whether to display the Translation tab.

Default value: false

Type:: boolean readonly

Implemented in:: ICreatorOptions

themeForPreview property

Obsolete. Survey Creator no longer supports switching between UI themes in the Preview tab.

Type:: string readonly

Implemented in:: ICreatorOptions

useElementTitles property

Specifies whether Survey Creator UI elements display survey, page, and question titles instead of their names.

Default value: false

Type:: boolean readonly

Implemented in:: ICreatorOptions

Properties

Methods

Events

Your cookie settings

Your renewal subscription expires soon.

Your renewal subscription has expired.

Your cookie settings

Privacy Overview

Your renewal subscription expires soon.

Your renewal subscription has expired.