survey-creator-core 1.9.111 → 1.9.113

package/typings/creator-base.d.ts

@@ -72,23 +72,24 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * Specifies whether to display the Designer tab.
      *
      * Default value: `true`
+     * @see activeTab
+     * @see onDesignerSurveyCreated
      */
     showDesignerTab: boolean;
     /**
      * Specifies whether to display the JSON Editor tab.
      *
      * Default value: `true`
+     * @see activeTab
      */
     showJSONEditorTab: boolean;
-    /**
-     * Obsolete. Please use showPreviewTab property
-     * @see showPreviewTab
-     */
     showTestSurveyTab: boolean;
     /**
      * Specifies whether to display the Preview tab.
      *
      * Default value: `true`
+     * @see activeTab
+     * @see onPreviewSurveyCreated
      */
     get showPreviewTab(): boolean;
     set showPreviewTab(val: boolean);
@@ -96,36 +97,39 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * Specifies whether to display the Themes tab.
      *
      * Default value: `false`
+     * @see activeTab
+     * @see saveThemeFunc
      */
     showThemeTab: boolean;
     /**
      * Specifies whether to display the Translation tab.
      *
      * Default value: `false`
+     * @see activeTab
      */
     showTranslationTab: boolean;
     /**
      * Specifies whether to display the Logic tab.
      *
      * Default value: `false`
+     * @see activeTab
      */
     showLogicTab: boolean;
     useTableViewInLogicTab: boolean;
-    /**
-     * Set delay for page hover
-     */
     pageHoverDelay: number;
     /**
-     * You need to set this property to true if you want to inplace edit item values instead of texts.
+     * Allows users to edit choice values instead of choice texts on the design surface.
+     *
+     * Default value: `false` (users edit choice texts)
+     *
+     * If you enable this property, users cannot edit choice texts because the Property Grid hides the Text column for choices, rate values, columns and rows in [Single-Select Matrix](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-question-model), and rows in [Multi-Select Matrix](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-with-dropdown-list) questions.
+     * @see showObjectTitles
      */
     inplaceEditForValues: boolean;
-    /**
-    * Obsolete. Use the [`showSurveyTitle`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showSurveyTitle) property instead.
-    */
     get allowEditSurveyTitle(): boolean;
     set allowEditSurveyTitle(val: boolean);
     /**
-     * Specifies whether users can see and edit the survey title and related survey properties.
+     * Specifies whether users can see and edit the survey header and related survey properties.
      *
      * Default value: `true`
      */
@@ -135,9 +139,11 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     set haveCommercialLicense(val: boolean);
     get licenseText(): string;
     /**
-     * Specifies whether to call the [saveSurveyFunc](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#saveSurveyFunc) each time survey settings are changed.
+     * Specifies whether to automatically save a survey or theme JSON schema each time survey or theme settings are changed.
      *
      * Default value: `false`
+     *
+     * If you enable this property, Survey Creator calls the [`saveSurveyFunc`](#saveSurveyFunc) or [`saveThemeFunc`](#saveThemeFunc) function to save the survey or theme JSON schema. The schemas are saved with a 500-millisecond delay after users change settings. You can specify the [`autoSaveDelay`](#autoSaveDelay) property to increase or descrease the delay.
      */
     isAutoSave: boolean;
     showOptions: boolean;
@@ -163,7 +169,19 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     private changePageModifications;
     private pageEditModeValue;
     /**
-     * Contains the value of the [`pageEditMode`](https://surveyjs.io/Documentation/Survey-Creator?id=ICreatorOptions#pageEditMode) property specified in the constructor.
+     * 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.
+     * @see allowModifyPages
      */
     get pageEditMode(): "standard" | "single" | "bypage";
     set pageEditMode(val: "standard" | "single" | "bypage");
@@ -180,28 +198,12 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     private saveSurveyFuncValue;
     private saveThemeFuncValue;
     viewType: string;
-    /**
-     * Returns the current show view name. The possible returns values are:
-     * "designer", "editor", "test", "embed", "logic" and "translation".
-     * @see showDesigner
-     * @see showPreview
-     * @see showJsonEditor
-     * @see showLogicEditor
-     * @see showTranslationEditor
-     * @see showEmbedEditor
-     */
     get showingViewName(): string;
     get isDesignerShowing(): boolean;
     showDesigner(): void;
     get isTestSurveyShowing(): boolean;
-    /**
-     * Return true if Preview tab is currently active
-     */
     get isPreviewShowing(): boolean;
     showTestSurvey(): void;
-    /**
-     * Show Preview tab
-     */
     showPreview(): void;
     protected plugins: {
         [name: string]: ICreatorPlugin;
@@ -210,11 +212,19 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     addPlugin(name: string, plugin: ICreatorPlugin): void;
     getPlugin<P extends ICreatorPlugin = ICreatorPlugin>(name: string): P;
     /**
-     * The event is called on deleting an element (question/panel/page) from the survey. Typically, when a user click the delete from the element menu.
-     *- sender the survey creator object that fires the event
-     *- options.element an instance of the deleting element
-     *- options.elementType the type of the element: 'question', 'panel' or 'page'.
-     *- options.allowing set it to false to cancel the element deleting
+     * An event that is raised before a survey element (a question, panel, or page) is deleted.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.element`: [`Survey.Base`](https://surveyjs.io/form-library/documentation/api-reference/base)\
+     * A survey element to be deleted.
+     * - `options.elementType`: `"question"` | `"panel"` | `"page"`\
+     * The element type.
+     * - `options.allowing`: `boolean`\
+     * A Boolean property that you can set to `false` if you want to cancel element deletion.
+     * @see deleteElement
      */
     onElementDeleting: CreatorEvent;
     /**
@@ -280,54 +290,72 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      */
     onHtmlToMarkdown: CreatorEvent;
     /**
-     * Use this event to disable user interactions with a question or panel on the design surface.
+     * An event that is raised when Survey Creator obtains permitted operations for a survey element. Use this event to disable user interactions with a question, panel, or page on the design surface.
      *
-     * The event handler accepts the following arguments:
+     * Parameters:
      *
-     * - `sender`- A Survey Creator instance that raised the event.
-     * - `options.obj` - A survey element instance (question or panel) for which you can disable user interactions.
-     * - `options.allowAddToToolbox` - Allows users to save the current survey element configuration in the Toolbox.
-     * - `options.allowChangeRequired` - Allows users to make the survey element required.
-     * - `options.allowChangeType` - Allows users to change the survey element type.
-     * - `options.allowChangeInputType` - Allows users to change the [`inputType`](https://surveyjs.io/form-library/documentation/api-reference/text-entry-question-model#inputType) property of Single-Line Input questions.
-     * - `options.allowCopy` - Allows users to duplicate the survey element.
-     * - `options.allowDelete` - Allows users to delete the survey element.
-     * - `options.allowDragging` - Allows users to drag and drop the survey element.
-     * - `options.allowEdit` - Allows users to edit survey element properties on the design surface. If you disable this property, users can edit the properties only in the Property Grid.
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.obj`: [`Survey.Base`](https://surveyjs.io/form-library/documentation/api-reference/base)\
+     * A survey element (question or panel) for which you can disable user interactions.
+     * - `options.allowChangeRequired`: `boolean`\
+     * Allows users to mark the survey element as required.
+     * - `options.allowChangeType`: `boolean`\
+     * Allows users to change the survey element type.
+     * - `options.allowChangeInputType`: `boolean`\
+     * Allows users to change the [`inputType`](https://surveyjs.io/form-library/documentation/api-reference/text-entry-question-model#inputType) property of Single-Line Input questions.
+     * - `options.allowCopy`: `boolean`\
+     * Allows users to duplicate the survey element.
+     * - `options.allowDelete`: `boolean`\
+     * Allows users to delete the survey element.
+     * - `options.allowDragging`: `boolean`\
+     * Allows users to drag and drop the survey element.
+     * - `options.allowEdit`: `boolean`\
+     * Allows users to edit survey element properties on the design surface. If you disable this property, users can edit the properties only in the Property Grid.
      *
      * To disable a user interaction, set the correponding `allow...` property to `false`.
+     *
+     * [Specify Adorner Visibility](https://surveyjs.io/survey-creator/documentation/customize-survey-creation-process#specify-adorner-availability (linkStyle))
      */
     onElementAllowOperations: CreatorEvent;
     /**
-     * Use this event to add/remove/modify the element (question/panel) menu items.
-     *- sender the survey creator object that fires the event
-     *- options.obj the survey object which property is edited in the Property Editor.
-     *- options.items the list of menu items. It has two required fields: text and onClick: function(obj: Survey.Base) {} and optional name field.
+     * An event that is raised when Survey Creator obtains [adorners](https://surveyjs.io/survey-creator/documentation/customize-survey-creation-process#specify-adorner-availability) for a survey element. Use this event to hide and modify predefined adorners or add a custom adorner.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.obj`: [`Survey.Base`](https://surveyjs.io/form-library/documentation/api-reference/base)\
+     * A survey element (question, panel, or page) whose adorners you can customize.
+     * - `options.items`: [`IAction[]`](https://surveyjs.io/form-library/documentation/api-reference/iaction#title)\
+     * An array of adorner actions. You can add, modify, or remove actions from this array.
+     *
+     * [View Demo](https://surveyjs.io/survey-creator/examples/create-custom-adorners/ (linkStyle))
      * @see onElementAllowOperations
+     * @see onGetPageActions
      */
     onDefineElementMenuItems: CreatorEvent;
     /**
-     * The event is called before showing a property in the Properties Grid or in the Question Editor.
-     *- sender the survey creator object that fires the event
-     *- options.obj the survey object, Survey, Page, Panel or Question
-     *- options.property the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties.
-     *- options.canShow a boolean value. It is true by default. Set it false to hide the property from the Properties Grid and in the Question Editor.
-     *- options.parentObj the parent object. It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is a question (dropdown, radigroup, checkbox, matrices and so on).
-     *- options.parentProperty the parent property (Survey.JsonObjectProperty object). It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is choices, columns, rows, triggers and so on.
+     * An event that is raised when Survey Creator adds properties to a survey element selected on the design surface. Handle this event if you cancel the addition of certain properties and thus [hide them from the Property Grid](https://surveyjs.io/survey-creator/documentation/property-grid-customization#hide-properties-from-the-property-grid).
      *
-     * [Example: Hide a category in the Properties Grid](https://surveyjs.io/Examples/Survey-Creator?id=hidecategoryinpropertiesgrid)
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.property`: `JsonObjectProperty`\
+     * A property being added.
+     * - `options.parentProperty`: `JsonObjectProperty`\
+     * A property that nests `options.property` (`choices` for an item value, `columns` for a matrix column, `rows` for a matrix row etc.). `options.parentProperty` has a value only for nested properties.
+     * - `options.obj`: `any`\
+     * A survey element that contains `options.property`: page, panel, question, the survey itself, item value (choice option), matrix column, etc.
+     * - `options.parentObj`: `any`\
+     * A survey element that contains `options.parentProperty`. `options.parentObj` has a value only for nested properties.
+     * - `options.canShow`: `boolean`\
+     * A Boolean property that you can set to `false` if you do not want to add the property.
+     *
+     * [View Demo](https://surveyjs.io/survey-creator/examples/hide-category-from-property-grid/ (linkStyle))
      */
     onShowingProperty: CreatorEvent;
-    /**
-     * @Deprecated Obsolete, please use onShowingProperty event.
-     * The event is called before showing a property in the Property Grid or in Question Editor.
-     *- sender the survey creator object that fires the event
-     *- options.obj the survey object, Survey, Page, Panel or Question
-     *- options.property the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties.
-     *- options.canShow a boolean value. It is true by default. Set it false to hide the property from the Property Grid or in Question Editor
-     *- options.parentObj the parent object. It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is a question (dropdown, radigroup, checkbox, matrices and so on).
-     *- options.parentProperty the parent property (Survey.JsonObjectProperty object). It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is choices, columns, rows, triggers and so on.
-     */
     onCanShowProperty: CreatorEvent;
     /**
      * The event is called after a survey that represents the Property Grid is created and all its questions (property editors) are setup.
@@ -368,28 +396,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * - `options.popupModel` - A `PopupBaseViewModel` object that describes the pop-up window model. Use `options.popupModel.footerToolbar` to access the actions at the bottom of the window.
      */
     onPropertyGridShowModal: CreatorEvent;
-    /**
-      * The event is called before rendering a delete button in the Property Grid or in Question Editor.
-      * @Deprecated Obsolete, please use onCollectionItemAllowOperations
-      *- sender the survey creator object that fires the event
-      *- options.obj the survey Question
-      *- options.item the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
-      *- options.canDelete a boolean value. It is true by default. Set it false to remove delete button from the Property Grid or in Question Editor
-      * @see onCollectionItemAllowOperations
-      */
     onCanDeleteItem: CreatorEvent;
-    /**
-     * The event is called on deleting a collection item from the Property Editor. For example: column in columns editor or item in choices and so on.
-     * @Deprecated Obsolete, please use onCollectionItemAllowOperations
-     *- sender the survey creator object that fires the event
-     *- options.obj the survey object: Question, Panel, Page or Survey
-     *- options.property the collection property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
-     *- options.propertyName the collection property name
-     *- options.collection the editing collection where deleting item is located. It is can be columns in the matrices or choices in dropdown question and so on.
-     *- options.item the collection item that we are going to delete
-     *- options.allowDelete a boolean value. It is true by default. Set it false to abondome the element removing from the collection
-     * @see onCollectionItemAllowOperations
-     */
     onCollectionItemDeleting: CreatorEvent;
     /**
      * The event is called before rendering a collection item in a property editor. For example: a column in a column editor, or an item in Choices and so on.
@@ -505,7 +512,6 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * - `options.questionName`: `String`\
      * The name of a question for which conditions are displayed.
      * - `options.questionName`: `String`\
-     * The type of a question for which conditions are displayed.
      * The name of a question for which conditions are displayed.
      * - `options.operator`: `"empty"` | `"notempty"` | `"equal"` | `"notequal"` | `"contains"` | `"notcontains"` | `"anyof"` | `"allof"` | `"greater"` | `"less"` | `"greaterorequal"` | `"lessorequal"`\
      * A condition opeator for which the event is raised.
@@ -585,24 +591,50 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
       */
     onModified: CreatorEvent;
     /**
-     * The event is called on adding a new question into the survey. Typically, when a user dropped a Question from the Question Toolbox into designer Survey area.
-     *- sender the survey creator object that fires the event
-     *- options.question a new added survey question. Survey.Question object
-     *- options.page the survey Page object where question has been added.
-     *- options.reason how question has been added via UI: ADDED_FROM_TOOLBOX, ADDED_FROM_PAGEBUTTON, ELEMENT_COPIED.
+     * An event that is raised when users add a question to the survey. Use this event to customize the question.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.question`: [`Question`](https://surveyjs.io/form-library/documentation/api-reference/question)\
+     * The question users added.
+     * - `options.page`: [`PageModel`](https://surveyjs.io/form-library/documentation/api-reference/page-model)\
+     * A page to which the question was added.
+     * - `options.reason`: `"DROPPED_FROM_TOOLBOX"` | `"ADDED_FROM_PAGEBUTTON"` | `"ELEMENT_COPIED"`\
+     * A value that indicates how the question was added: dragged from the [Toolbox](https://surveyjs.io/survey-creator/documentation/toolbox-customization), created using the Add Question button, or duplicated.
+     *
+     * [Customize Survey Elements on Creation](https://surveyjs.io/survey-creator/documentation/customize-survey-creation-process#customize-survey-elements-on-creation (linkStyle))
      */
     onQuestionAdded: CreatorEvent;
     /**
-     * The event is called on adding a new panel into the survey.  Typically, when a user dropped a Panel from the Question Toolbox into designer Survey area.
-     *- sender the survey creator object that fires the event
-     *- options.panel a new added survey panel. Survey.Panel object
-     *- options.page the survey Page object where question has been added.
+     * An event that is raised when users add a [Panel](https://surveyjs.io/form-library/documentation/api-reference/panel-model) element to the survey. Use this event to customize the panel.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.panel`: [`PanelModel`](https://surveyjs.io/form-library/documentation/api-reference/panel-model)\
+     * The panel users added.
+     * - `options.page`: [`PageModel`](https://surveyjs.io/form-library/documentation/api-reference/page-model)\
+     * A page to which the panel was added.
+     * - `options.reason`: `"DROPPED_FROM_TOOLBOX"` | `"ADDED_FROM_PAGEBUTTON"` | `"ELEMENT_COPIED"`\
+     * A value that indicates how the panel was added: dragged from the [Toolbox](https://surveyjs.io/survey-creator/documentation/toolbox-customization), created using the Add Question button, or duplicated.
+     *
+     * [Customize Survey Elements on Creation](https://surveyjs.io/survey-creator/documentation/customize-survey-creation-process#customize-survey-elements-on-creation (linkStyle))
      */
     onPanelAdded: CreatorEvent;
     /**
-     * The event is called on adding a new page into the survey.
-     *- sender the survey creator object that fires the event
-     *- options.page the new survey Page object.
+     * An event that is raised when a new page is added to the survey. Use this event to customize the page.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.page`: [`PageModel`](https://surveyjs.io/form-library/documentation/api-reference/page-model)\
+     * The page users added.
+     *
+     * [Customize Survey Elements on Creation](https://surveyjs.io/survey-creator/documentation/customize-survey-creation-process#customize-survey-elements-on-creation (linkStyle))
      */
     onPageAdded: CreatorEvent;
     /**
@@ -613,29 +645,44 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * - `sender`: `CreatorBase`\
      * A Survey Creator instance that raised the event.
      * - `options.actions`: [`IAction[]`](/form-library/documentation/api-reference/iaction)\
-     * An array of actions. You can add or remove actions from this array.
+     * An array of actions. You can add, modify, or remove actions from this array.
      * - `options.page`: [`PageModel`](/form-library/documentation/api-reference/page-model)\
      * A page for which the event is raised.
      * - `options.addNewQuestion(type)`: Method\
      * Adds a new question of a specified [`type`](/form-library/documentation/api-reference/question#getType) to the page.
+     * @see onDefineElementMenuItems
      */
     onGetPageActions: CreatorEvent;
     /**
-     * The event is fired when the survey creator is initialized and a survey object (Survey.Survey) is created.
-     *- sender the survey creator object that fires the event
-     *- options.survey  the survey object showing in the creator.
+     * An event that is raised when Survey Creator instantiates a survey for the [Designer](https://surveyjs.io/survey-creator/documentation/end-user-guide#designer-tab) tab. Use this event to customize the survey.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.survey`: [`SurveyModel`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model)\
+     * A survey to be displayed in the Designer tab.
+     *
+     * [Design Mode Survey Instance](https://surveyjs.io/survey-creator/documentation/customize-survey-creation-process#design-mode-survey-instance (linkStyle))
+     *
+     * > If you want this event raised at startup, assign a survey JSON schema to the [`JSON`](#JSON) property *after* you add a handler to the event. If the JSON schema should be empty, specify the `JSON` property with an empty object.
      */
     onDesignerSurveyCreated: CreatorEvent;
     /**
-     * The event is fired when the survey creator creates survey in Preview tab for testing.
-     *- sender the survey creator object that fires the event
-     *- options.survey  the survey object showing in the "Preview" tab.
+     * An event that is raised when Survey Creator instantiates a survey for the [Preview](https://surveyjs.io/survey-creator/documentation/end-user-guide#preview-tab) tab. Use this event to customize the survey.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.survey`: [`SurveyModel`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model)\
+     * A survey to be displayed in the Preview tab.
+     *
+     * [Preview Mode Survey Instance](https://surveyjs.io/survey-creator/documentation/customize-survey-creation-process#preview-mode-survey-instance (linkStyle))
+     *
+     * > If you want this event raised at startup, assign a survey JSON schema to the [`JSON`](#JSON) property *after* you add a handler to the event. If the JSON schema should be empty, specify the `JSON` property with an empty object.
      */
     onPreviewSurveyCreated: CreatorEvent;
-    /**
-      * Obsolete. Please use onPreviewSurveyCreated event.
-      * @see onPreviewSurveyCreated
-      */
     onTestSurveyCreated: CreatorEvent;
     /**
      * The event is called in case of UI notifications. By default all notifications are done via built-in alert () function.
@@ -644,13 +691,28 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      */
     onNotify: CreatorEvent;
     /**
-     * The event is called on changing the selected element. You may change the new selected element by changing the property options.newSelectedElement to your own
-     *- options.newSelectedElement the element that is going to be selected in the survey desiger: question, panel, page or survey.
+     * An event that is raised before a survey element (a question, panel, page, or the survey itself) is focused. Use this event to move focus to a different survey element.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.newSelectedElement`: [`Survey.Base`](https://surveyjs.io/form-library/documentation/api-reference/base)\
+     * An element that is going to be focused.
+     * @see onSelectedElementChanged
+     * @see selectedElement
      */
     onSelectedElementChanging: CreatorEvent;
     /**
-     * The event is called after the selected element is changed.
-     *- options.newSelectedElement the new selected element in the survey desiger: question, panel, page or survey.
+     * An event that is raised after a survey element (a question, panel, page, or the survey itself) is focused.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.newSelectedElement`: [`Survey.Base`](https://surveyjs.io/form-library/documentation/api-reference/base)\
+     * The [focused element](#selectedElement).
+     * @see onSelectedElementChanging
      */
     onSelectedElementChanged: CreatorEvent;
     /**
@@ -768,27 +830,34 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      */
     onTranslationItemChanging: CreatorEvent;
     /**
-     * Use this event to control drag&drop operations.
-     *- sender the survey creator object that fires the event.
-     *- options.survey the editing survey object.
-     *- options.allow set it to false to disable dragging.
-     *- options.target a target element that is dragging.
-     *- options.source a source element. It can be null, if it is a new element, dragging from toolbox.
-     *- options.parent a page or panel where target element is dragging.
-     *- options.insertBefore an element before the target element is dragging. It can be null if parent container (page or panel) is empty or dragging an element under the last element of the container.
-     *- options.insertAfter an element after the target element is dragging. It can be null if parent container (page or panel) is empty or dragging element to the top of the parent container.
+     * An event that is raised when users drag and drop survey elements within the design surface. Use this event to control drag and drop operations.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.target`: `IElement`\
+     * A survey element being dragged.
+     * - `options.source`: `IElement`\
+     * A survey element from which `target` is being dragged. This parameter is `null` if `target` is being dragged from the [Toolbox](https://surveyjs.io/survey-creator/documentation/toolbox).
+     * - `options.insertBefore`: `IElement`\
+     * A survey element before which the target element will be placed. This parameter is `null` if the parent container (page or panel) has no elements or if the target element will be placed below all other elements within the container.
+     * - `options.insertAfter`: `IElement`\
+     * A survey element after which `target` will be placed. This parameter is `null` if the parent container (page or panel) has no elements or if `target` will be placed above all other elements within the container.
+     * - `options.parent`: `ISurveyElement`\
+     * A parent container (page or panel) within which `target` will be placed.
+     * - `options.survey`: [`SurveyModel`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model)\
+     * A survey within which the drag and drop operation occured.
+     * - `options.allow`: `boolean`\
+     * A Boolean property that you can set to `false` if you want to cancel the drag and drop operation.
+     * @see onDragStart
+     * @see onDragEnd
      */
     onDragDropAllow: CreatorEvent;
-    /**
-     * This callback is used internally for providing survey JSON text.
-     */
     getSurveyJSONTextCallback: () => {
         text: string;
         isModified: boolean;
     };
-    /**
-     * This callback is used internally for setting survey JSON text.
-     */
     setSurveyJSONTextCallback: (text: string) => void;
     /**
      * Limits the number of items in a logical expression.
@@ -864,23 +933,17 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * Default value: -1 (unlimited)
      */
     maxNestedPanels: number;
-    /**
-     * Obsolete. Use the [`showPagesInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showPagesInPreviewTab) property instead.
-     */
     showPagesInTestSurveyTab: boolean;
     /**
-     * Specifies whether to show the page selector at the bottom of the Preview tab.
+     * Specifies whether to show a page selector at the bottom of the Preview tab.
      *
      * Default value: `true`
      */
     get showPagesInPreviewTab(): boolean;
     set showPagesInPreviewTab(val: boolean);
-    /**
-     * Obsolete. Use the [`showSimulatorInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showSimulatorInPreviewTab) property instead.
-     */
     showSimulatorInTestSurveyTab: boolean;
     /**
-     * Specifies whether the Preview tab displays the Device button that allows users to preview the survey on different device types.
+     * Specifies whether the Preview tab displays a Device button that allows users to preview the survey on different device types.
      *
      * Default value: `true`
      */
@@ -892,28 +955,35 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * Accepted values: `"modern"`, `"default"`, `"defaultV2"`
      *
      * Default value: `"defaultV2"`
+     * @see allowChangeThemeInPreview
      */
     themeForPreview: string;
-    hasPendingThemeChanges: boolean;
-    isThemePristine: boolean;
+    /**
+     * A function that is called each time users click the [Save button](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#showSaveButton) or [auto-save](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#isAutoSave) is triggered to save a theme JSON object.
+     *
+     * For more information, refer to the [Save and Load Custom Themes](/survey-creator/documentation/theme-editor#save-and-load-custom-themes) help topic.
+     * @see showThemeTab
+     * @see saveSurveyFunc
+     */
+    get saveThemeFunc(): any;
+    set saveThemeFunc(value: any);
+    isThemeModified: boolean;
     private _theme;
     get theme(): ITheme;
     set theme(newTheme: ITheme);
-    raiseThemeChanged(): void;
+    doSaveTheme(): void;
     private _allowModifyPages;
     /**
      * Specifies whether users can add, edit, and delete survey pages.
      *
      * Default value: `true`
+     * @see pageEditMode
      */
     get allowModifyPages(): boolean;
     set allowModifyPages(val: boolean);
-    /**
-     * Obsolete. Use the [`showDefaultLanguageInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showDefaultLanguageInPreviewTab) property instead.
-     */
     showDefaultLanguageInTestSurveyTab: boolean | string;
     /**
-     * Specifies whether the Preview tab displays the language selector.
+     * Specifies whether the Preview tab displays a language selector.
      *
      * Accepted values:
      *
@@ -921,7 +991,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * 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.
+     * Always display the language selector regardless of how many languages the survey uses.
      *
      * - `false`
      * Never display the language selector.
@@ -929,16 +999,13 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * - `"all"`
      * Always display the language selector with [all supported languages](https://github.com/surveyjs/survey-creator/tree/master/packages/survey-creator-core/src/localization).
      *
-     * **See also**: [Localization & Globalization](https://surveyjs.io/Documentation/Survey-Creator?id=localization)
+     * [Localization & Globalization](https://surveyjs.io/survey-creator/documentation/survey-localization-translate-surveys-to-different-languages (linkStyle))
      */
     get showDefaultLanguageInPreviewTab(): boolean | string;
     set showDefaultLanguageInPreviewTab(val: boolean | string);
-    /**
-     * Obsolete. Use the [`showInvisibleElementsInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showInvisibleElementsInPreviewTab) property instead.
-     */
     showInvisibleElementsInTestSurveyTab: boolean;
     /**
-     * Specifies whether the Preview tab displays a checkbox that allows users to show or hide invisible survey elements.
+     * Specifies whether the Preview tab displays a toggle that allows users to show or hide invisible survey elements.
      *
      * Default value: `true`
      */
@@ -954,6 +1021,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * Default value: `true`
      *
      * [View Demo](https://surveyjs.io/Examples/Creator?id=theme-switcher (linkStyle))
+     * @see themeForPreview
      */
     allowChangeThemeInPreview: boolean;
     tabbedMenu: AdaptiveActionContainer<TabbedMenuItem>;
@@ -1000,10 +1068,11 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      *
      * - `sender`: `CreatorBase`\
      * A Survey Creator instance that raised the event.
-     * - `options.tabName`: `"designer"` | `"test"` | `"theme"` | `"editor"` | `"embed"` | `"logic"` | `"translation"`\
+     * - `options.tabName`: `"designer"` | `"test"` | `"theme"` | `"editor"` | `"logic"` | `"translation"`\
      * A tab that is going to become active.
      * - `options.allow`: `Boolean`\
      * Specifies whether the active tab can be switched. Set this property to `false` if you want to cancel the switch.
+     * @see makeNewViewActive
      */
     onActiveTabChanging: CreatorEvent;
     /**
@@ -1013,22 +1082,32 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      *
      * - `sender`: `CreatorBase`\
      * A Survey Creator instance that raised the event.
-     * - `options.tabName`: `"designer"` | `"test"` | `"theme"` | `"editor"` | `"embed"` | `"logic"` | `"translation"`\
+     * - `options.tabName`: `"designer"` | `"test"` | `"theme"` | `"editor"` | `"logic"` | `"translation"`\
      * A tab that has become active.
+     * @see makeNewViewActive
      */
     onActiveTabChanged: CreatorEvent;
     /**
-     * Get/set the active tab.
-     * The following values are available: "designer", "editor", "test", "embed", "logic" and "translation".
-     * Please note, not all tabs are visible.
+     * Gets or sets the currently displayed tab.
+     *
+     * Possible values:
+     *
+     * - [`"designer"`](#showDesignerTab)
+     * - [`"test"`](#showPreviewTab)
+     * - [`"theme"`](#showThemeTab)
+     * - [`"editor"`](#showJSONEditorTab)
+     * - [`"logic"`](#showLogicTab)
+     * - [`"translation"`](#showLogicTab)
+     * @see makeNewViewActive
      */
     get activeTab(): string;
     set activeTab(val: string);
     /**
-     * Change the active view/tab. It will return false if it can't change the current tab.
-     * @param viewName name of new active view (tab). The following values are available: "designer", "editor", "test", "embed", "logic" and "translation".
+     * Switches the [active tab](#activeTab). Returns `false` if the tab cannot be switched.
+     * @param tabName A tab that you want to make active: `"designer"`, `"test"`, `"theme"`, `"editor"`, `"logic"`, or `"translation"`.
+     * @returns `false` if the active tab cannot be switched, `true` otherwise.
      */
-    makeNewViewActive(viewName: string): boolean;
+    makeNewViewActive(tabName: string): boolean;
     private switchViewType;
     private canSwitchViewType;
     private activatePlugin;
@@ -1058,45 +1137,53 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     rightContainerActiveItem(name: string): void;
     leftContainerActiveItem(name: string): void;
     /**
-     * The event is called before undo happens.
-     *- options.canUndo a boolean value. It is true by default. Set it false to hide prevent undo operation.
+     * An event that is raised before an undo operation.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.canUndo`: `boolean`\
+     * A Boolean value that you can set to `false` if you want to prevent the undo operation.
+     * @see undo
+     * @see redo
+     * @see onBeforeRedo
      */
     onBeforeUndo: CreatorEvent;
     /**
-     * The event is called before redo happens.
-     *- options.canRedo a boolean value. It is true by default. Set it false to hide prevent redo operation.
+     * An event that is raised before an redo operation.
+     *
+     * Parameters:
+     *
+     * - `sender`: `CreatorBase`\
+     * A Survey Creator instance that raised the event.
+     * - `options.canRedo`: `boolean`\
+     * A Boolean value that you can set to `false` if you want to prevent the redo operation.
+     * @see redo
+     * @see undo
+     * @see onBeforeUndo
      */
     onBeforeRedo: CreatorEvent;
-    /**
-     * The event is called after undo happens.
-     *- options.state is an undo/redo item.
-     */
-    onAfterUndo: CreatorEvent;
-    /**
-     * The event is called after redo happens.
-     *- options.state is an undo/redo item.
-     */
-    onAfterRedo: CreatorEvent;
     get undoRedoManager(): UndoRedoManager;
     get undoRedoController(): UndoRedoController;
-    /**
-     * This method starts undo/redo transaction: all changes will be stored as one undo/redo item.
-     */
     startUndoRedoTransaction(name?: string): void;
-    /**
-     * This method stops undo/redo transaction.
-     */
     stopUndoRedoTransaction(): void;
     /**
-     * Returns true if Creator is currently doing undo or redo opertaions
+     * Returns `true` if an undo or redo operation is in progress.
+     * @see undo
+     * @see redo
      */
     get isProcessingUndoRedo(): boolean;
     /**
-     * This method performs undo uperation if possible.
+     * Cancels the last change if possible.
+     * @see redo
+     * @see onBeforeUndo
      */
     undo(): void;
     /**
-     * This method performs redo uperation if possible.
+     * Repeats the last undone action if possible.
+     * @see undo
+     * @see onBeforeRedo
      */
     redo(): void;
     get selectionHistoryController(): SelectionHistory;
@@ -1155,6 +1242,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * - `options.toElement`: `any`\
      * A survey element to which `draggedElement` is being dragged.
      * @see onDragEnd
+     * @see onDragDropAllow
      */
     onDragStart: Event<() => any, any, any>;
     onBeforeDrop: Event<() => any, any, any>;
@@ -1171,6 +1259,8 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * A survey element from which `draggedElement` was dragged.
      * - `options.toElement`: `any`\
      * A survey element to which `draggedElement` was dragged.
+     * @see onDragStart
+     * @see onDragDropAllow
      */
     onDragEnd: Event<() => any, any, any>;
     onAfterDrop: Event<() => any, any, any>;
@@ -1265,22 +1355,20 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      */
     fastCopyQuestion(question: Base): IElement;
     /**
-     * Get or set the current selected object in the Creator. It can be a question, panel, page or survey itself.
+     * Gets or sets the focused survey element: a question, panel, page, or the survey itself.
+     * @see onSelectedElementChanging
+     * @see onSelectedElementChanged
      */
     get selectedElement(): Base;
     set selectedElement(val: Base);
-    /**
-     * @Deprecated Obsolete. Please use deleteCurrentElement.
-     * @see deleteCurrentElement
-     */
     deleteCurrentObject(): void;
-    /**
-     * Delete a currently selected element in the survey. It can be a question, a panel or a page.
-     */
     deleteCurrentElement(): void;
     /**
-     * Delete an element in the survey. It can be a question, a panel or a page.
-     * @param element a survey element.
+     * Deletes a survey element: a question, panel, or page.
+     *
+     * If you want to delete the focused element, pass the [`selectedElement`](#selectedElement) property value to this method.
+     * @param element A survey element to delete.
+     * @see onElementDeleting
      */
     deleteElement(element: Base): void;
     /**
@@ -1300,61 +1388,36 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     protected get designerPropertyGrid(): PropertyGridModel;
     get propertyGrid(): SurveyModel;
     /**
-     * Collapse certain property editor tab (category) in properties panel/grid
-     * name - tab category name
-     * @see collapseAllPropertyGridCategories
+     * Collapses a specified category in Property Grid.
+     * @param name A [category name](https://surveyjs.io/survey-creator/documentation/property-grid-customization#category).
      * @see expandPropertyGridCategory
-     * @see expandAllPropertyGridCategories
      */
     collapsePropertyGridCategory(name: string): void;
     /**
-     * Expand certain property editor tab (category) in properties panel/grid
-     * name - tab category name
+     * Expands a specified category in Property Grid.
+     * @param name A [category name](https://surveyjs.io/survey-creator/documentation/property-grid-customization#category).
      * @see collapsePropertyGridCategory
-     * @see collapseAllPropertyGridCategories
-     * @see expandAllPropertyGridCategories
      */
     expandPropertyGridCategory(name: string): void;
     /**
-     * Expand all property editor tabs (categories) in properties panel/grid
-     * @see collapsePropertyGridCategory
-     * @see expandPropertyGridCategory
+     * Collapses all categories in Property Grid.
      * @see expandAllPropertyGridCategories
      */
     collapseAllPropertyGridCategories(): void;
     /**
-     * Expand all property editor tabs (categories) in properties panel/grid
-     * @see collapsePropertyGridCategory
+     * Expands all categories in Property Grid.
      * @see collapseAllPropertyGridCategories
-     * @see expandPropertyGridCategory
      */
     expandAllPropertyGridCategories(): void;
-    /**
-     * @Deprecated Obsolete. Collapse all property editor tabs (categories) in properties panel/grid
-     * @see collapseAllPropertyGridCategories
-     *
-     */
     collapseAllPropertyTabs(): void;
-    /**
-     * @Deprecated Obsolete. Expand all property editor tabs (categories) in properties panel/grid
-     * @see expandAllPropertyGridCategories
-     */
     expandAllPropertyTabs(): void;
-    /**
-     * @Deprecated Obsolete. Expand certain property editor tab (category) in properties panel/grid
-     * name - tab category name
-     * @see expandPropertyGridCategory
-     */
     expandPropertyTab(name: string): void;
-    /**
-     * @Deprecated Obsolete. Collapse certain property editor tab (category) in properties panel/grid
-     * name - tab category name
-     * @see collapsePropertyGridCategory
-     */
     collapsePropertyTab(name: string): void;
     /**
-     * Check for errors in property grid and adorners of the selected elements.
-     * Returns true if selected element is null or there is no errors.
+     * Validates the property values of the [focused element](#selectedElement).
+     * @returns `true` if all property values of the focused element are valid or if no element is focused, `false` otherwise.
+     * @see onSelectedElementChanging
+     * @see onSelectedElementChanged
      */
     validateSelectedElement(): boolean;
     /**
@@ -1423,25 +1486,17 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     getHasMachineTranslation(): boolean;
     doMachineTranslation(fromLocale: string, toLocale: string, strings: Array<string>, callback: (translated: Array<string>) => void): void;
     /**
-     * The delay on saving survey JSON on autoSave in ms. It is 500 ms by default.
-     * If during this period of time an end-user modify survey, then the last version will be saved only. Set to 0 to save immediately.
-     * @see isAutoSave
+     * A delay between changing survey settings and saving the survey JSON schema, measured in milliseconds. Applies only when the [`isAutoSave`](#isAutoSave) property is `true`.
+     *
+     * Default value: 500 (taken from `settings.autoSave.delay`)
+     *
+     * If a user changes the settings once again during the delay, only the latest version will be saved.
      */
     autoSaveDelay: number;
     private autoSaveTimerId;
-    protected doAutoSave(saveFunc?: () => void): void;
+    protected doAutoSave(): void;
     saveNo: number;
     doSave(): void;
-    doSaveTheme(): void;
-    /**
-     * A function that is called each time users click the [Save button](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#showSaveButton) or [auto-save](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#isAutoSave) is triggered to save a theme JSON object.
-     *
-     * For more information, refer to the [Save and Load Custom Themes](/survey-creator/documentation/theme-editor#save-and-load-custom-themes) help topic.
-     * @see showThemeTab
-     * @see saveSurveyFunc
-     */
-    get saveThemeFunc(): any;
-    set saveThemeFunc(value: any);
     /**
      * Specifies whether to display a button that saves the survey or theme (executes the [`saveSurveyFunc`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#saveSurveyFunc) or [`saveThemeFunc`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#saveThemeFunc) function).
      * @see isAutoSave