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);
Properties
Methods
Events
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
Specifies whether users can switch between UI themes in the Preview tab.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
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
Specifies whether users can add, edit, and delete survey pages.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
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
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
Specifies whether to enable support for right-to-left languages.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
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
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
Limits the number of rate values that users can add to Rating questions.
Default value: 0 (unlimited, taken from settings.propertyGrid.maximumRateValues)
- Type:
- number readonly
- Implemented in:
- ICreatorOptions
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
Limits the number of items in a logical expression.
Default value: -1 (unlimited)
- Type:
- number readonly
- Implemented in:
- ICreatorOptions
Limits the number of nested panels within a Panel element.
Default value: -1 (unlimited)
- Type:
- number readonly
- Implemented in:
- ICreatorOptions
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
Limits the minimum number of choices in Checkbox, Dropdown, and Radiogroup questions. Set this property if users should not delete choices below the specified limit.
Default value: 0 (unlimited, taken from settings.propertyGrid.minimumChoicesCount)
- Type:
- number readonly
- Implemented in:
- ICreatorOptions
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
Specifies the orientation of the selected device in the Preview tab.
Possible values:
"landscape"(default)"portrait"
- Type:
- "landscape" | "portrait" readonly
- Implemented in:
- ICreatorOptions
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
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
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
Specifies whether to display the Designer tab.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
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
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
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
Specifies whether to display the JSON Editor tab.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
Specifies whether to display the Logic tab.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
Specifies whether UI elements display survey, page, and question titles instead of their names.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
Specifies whether to show the page selector at the bottom of the Preview tab.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
Specifies whether to display the Preview tab.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
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
Specifies whether users can see and edit the survey title and related survey properties.
Default value: true
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
Specifies whether to display the Themes tab.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
Specifies whether to display question titles instead of names when users edit logical expressions.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
Specifies whether to display the Translation tab.
Default value: false
- Type:
- boolean readonly
- Implemented in:
- ICreatorOptions
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 © 2024 Devsoft Baltic OÜ. All rights reserved.