Documentation Docs
Documentation Docs

ICreatorOptions

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

const creator = new SurveyCreator.SurveyCreator(creatorOptions);
Properties
allowChangeThemeInPreview allowEditExpressionsInTextEditor allowModifyPages generateValidJSON isAutoSave isRTL maximumChoicesCount maximumColumnsCount maximumRateValues maximumRowsCount maxLogicItemsInCondition maxVisibleChoices pageEditMode previewOrientation questionTypes readOnly showDefaultLanguageInPreviewTab showDesignerTab showEmbeddedSurveyTab showErrorOnFailedSave showHeaderInEmptySurvey showInvisibleElementsInPreviewTab showJSONEditorTab showLogicTab showObjectTitles showPagesInPreviewTab showPreviewTab showSimulatorInPreviewTab showSurveyTitle showTitlesInExpressions showTranslationTab themeForPreview
Methods
Events
allowChangeThemeInPreview property

Specifies whether users can switch between UI themes in the Preview tab.

Default value: true

View Demo

Type:
boolean readonly
Implemented in:
ICreatorOptions
allowEditExpressionsInTextEditor 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
allowModifyPages property

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

Default value: true

Type:
boolean readonly
Implemented in:
ICreatorOptions
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

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
isRTL property

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

Default value: false

Type:
boolean readonly
Implemented in:
ICreatorOptions
maximumChoicesCount property

Limits the number of choices that users can add to Checkbox, Dropdown, and Radiogroup questions.

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

Type:
number readonly
Implemented in:
ICreatorOptions
maximumColumnsCount property

Limits the number of columns that users can add to Matrix, Matrix Dynamic, and Matrix Dropdown questions.

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

Type:
number readonly
Implemented in:
ICreatorOptions
maximumRateValues property

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

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

Type:
number readonly
Implemented in:
ICreatorOptions
maximumRowsCount property

Limits the number of rows that users can add to Matrix and Matrix Dropdown questions.

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

Type:
number readonly
Implemented in:
ICreatorOptions
maxLogicItemsInCondition property

Limits the number of items in a logical expression.

Default value: -1 (unlimited)

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
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
previewOrientation property

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

Possible values:

  • "landscape" (default)
  • "portrait"
Type:
"landscape" | "portrait" readonly
Implemented in:
ICreatorOptions
questionTypes property

Limits question and panels 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
showDefaultLanguageInPreviewTab 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
showDesignerTab property

Specifies whether to display the Designer tab.

Default value: true

Type:
boolean readonly
Implemented in:
ICreatorOptions
showEmbeddedSurveyTab property

Specifies whether to display the Embed Survey tab.

Default value: false

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

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

Type:
boolean readonly
Implemented in:
ICreatorOptions
showObjectTitles property

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

Default value: false

Type:
boolean readonly
Implemented in:
ICreatorOptions
showPagesInPreviewTab property

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

Default value: true

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

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
showSurveyTitle property

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

Default value: true

Type:
boolean readonly
Implemented in:
ICreatorOptions
showTitlesInExpressions property

Specifies whether to display question titles instead of names when users edit logical expressions.

Default value: false

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

A UI theme used to display the survey in the Preview tab.

Accepted values: "modern", "default", "defaultV2"

Default value: "defaultV2"

Type:
string readonly
Implemented in:
ICreatorOptions

Copyright © 2023 Devsoft Baltic OÜ. All rights reserved.

Why we use cookies.

This site uses cookies to make your browsing experience more convenient and personal. Cookies store useful information on your computer to help us improve the efficiency and relevance of our site for you. In some cases, they are essential to making the site work properly. By accessing this site, you consent to the use of cookies.

For more information, refer to DevSoft Baltic’ Terms of Use & Privacy Statement.

I Understand

Your renewal subscription expires soon.

Since the license is perpetual, you will still have permanent access to the product versions released within the first 12 month of the original purchase date.

If you wish to continue receiving technical support from our Help Desk specialists and maintain access to the latest product updates, make sure to renew your subscription by clicking the "Renew" button below.

Renew
Later

Your renewal subscription has expired.

Since the license is perpetual, you will still have permanent access to the product versions released within the first 12 month of the original purchase date.

If you wish to continue receiving technical support from our Help Desk specialists and maintain access to the latest product updates, make sure to renew your subscription by clicking the "Renew" button below.

Renew
Later