survey-creator-core 1.9.38 → 1.9.41

package/survey-creator-core.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.38
+* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.41
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: https://surveyjs.io/Licenses#SurveyCreator
 */
@@ -7,11 +7,11 @@ import { Base, JsonObjectProperty, Question, SurveyModel, ItemValue } from "surv
 import { MatrixDropdownColumn, IAction, Action, ActionContainer, DragDropSurveyElements } from "survey-core";
 import { DragDropChoices, Event, AdaptiveActionContainer, PageModel, IElement } from "survey-core";
 import { IPanel, ISurveyElement, SurveyElement, QuestionSelectBase, QuestionRowModel } from "survey-core";
-import { LocalizableString, DragOrClickHelper, PanelModel, QuestionDropdownModel, ListModel } from "survey-core";
-import { PopupModel, EventBase, PanelModelBase, QuestionNonValue, SurveyTemplateRendererTemplateData } from "survey-core";
-import { QuestionRatingModel, ComputedUpdater, QuestionCheckboxModel, ILocalizableString, ArrayChanges } from "survey-core";
-import { ImageItemValue, HashTable, QuestionMatrixDynamicModel, QuestionMatrixModel, QuestionMatrixDropdownModel } from "survey-core";
-import { QuestionPanelDynamicModel, QuestionCommentModel, MatrixDynamicRowModel } from "survey-core";
+import { LocalizableString, Operand, DragOrClickHelper, PanelModel, QuestionDropdownModel } from "survey-core";
+import { ListModel, PopupModel, EventBase, PanelModelBase, QuestionNonValue } from "survey-core";
+import { SurveyTemplateRendererTemplateData, QuestionRatingModel, ComputedUpdater, QuestionCheckboxModel, ILocalizableString } from "survey-core";
+import { ArrayChanges, ImageItemValue, HashTable, QuestionMatrixDynamicModel, QuestionMatrixModel } from "survey-core";
+import { QuestionMatrixDropdownModel, QuestionPanelDynamicModel, QuestionCommentModel, MatrixDynamicRowModel } from "survey-core";
 
 export { editorLocalization as localization };
 
@@ -62,6 +62,7 @@ export interface ISurveyCreatorOptions {
   createSurvey(json: any, reason: string, surveyType?: any): any;
   onConditionQuestionsGetListCallback(propertyName: string, obj: Base, editor: any, list: any): any;
   onConditionGetTitleCallback(expression: string, title: string): string;
+  onLogicGetTitleCallback(expression: string, displayExpression: string, text: string, logicItem: any): string;
 }
 /*
 * Survey Creator configuration. Pass it as an argument to the `SurveyCreator` constructor:
@@ -192,13 +193,13 @@ export interface ICreatorOptions {
   * 
   * Accepted values:
   * 
-  * - `"auto"` (default)      
-  * Display the language selector only if the survey is translated to more than one language.
+  * - `"auto"` (default)     
+  * Display the language selector only if the survey is translated into more than one language.
   * 
-  * - `true`        
+  * - `true`     
   * Always display the language selector regardless of how many languages are used in the survey.
-  *  
-  * - `false`        
+  * 
+  * - `false`      
   * Never display the language selector.
   * 
   * - `"all"`        
@@ -220,6 +221,14 @@ export interface ICreatorOptions {
   */
   showObjectTitles?: boolean;
   /*
+  * Limits the number of visible choices. Users can click "Show more..." to view hidden choices.
+  * 
+  * Specify this property if questions with many choices occupy much vertical space on the design surface.
+  * 
+  * Default value: -1 (unlimited)
+  */
+  maxVisibleChoices?: number;
+  /*
   * Specifies whether the design surface displays the survey title and description when the survey does not contain any elements.
   * 
   * Default value: `false`
@@ -269,6 +278,27 @@ export interface ICreatorOptions {
   * [View the "Switch Between Themes" demo](https://surveyjs.io/Examples/Creator?id=theme-switcher)
   */
   allowChangeThemeInPreview?: boolean;
+  /*
+  * Limits question and panels types available in the Toolbox and Add Question menu.
+  * 
+  * Refer to the [Limit Available Question and Panel Types](https://surveyjs.io/Documentation/Survey-Creator?id=toolbox#limit-available-question-and-panel-types) help topic for more information.
+  */
+  questionTypes?: any;
+  /*
+  * 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.
+  */
+  pageEditMode?: "standard" | "single" | "bypage";
 }
 /*
 * The Toolbox item description.
@@ -421,6 +451,7 @@ export interface ICreatorPlugin {
   update?: any;
   deactivate?: any;
   dispose?: any;
+  onDesignerSurveyPropertyChanged?: (obj: Base, propName: string) => void;
   model: Base;
 }
 export interface ICreatorAction extends IAction {
@@ -558,8 +589,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   footerToolbar: any;
   pageEditModeValue: "standard" | "single" | "bypage";
   /*
-  * Set pageEditMode option to "single" to use creator in a single page mode. By default value is "standard".
-  * You can set this option in creator constructor only
+  * Contains the value of the [`pageEditMode`](https://surveyjs.io/Documentation/Survey-Creator?id=ICreatorOptions#pageEditMode) property specified in the constructor.
   */
   get pageEditMode(): "standard" | "single" | "bypage";
   set pageEditMode(val: "standard" | "single" | "bypage");
@@ -834,6 +864,18 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   onConditionGetTitle: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
+  * Use this event to modify the display text of a logic item in the Logic tab.
+  * 
+  * The event handler accepts the following arguments:
+  * 
+  * - `sender` - A Survey Creator instance that raised the event.
+  * - `options.expression` - A logical expression associated with the logic item. 
+  * - `options.expressionText` - The same expression in a user-friendly format. It may contain question titles instead of question names.
+  * - `options.logicItem` - A logic item object. Contains an array of actions and other properties.
+  * - `options.text` - The expression and actions in a user-friendly format. Redefine this property if you want to change the display text.
+  */
+  onLogicItemDisplayText: Event<(sender: CreatorBase, options: any) => any, any>;
+  /*
   * The event is called when a survey is changed in the designer. A new page/question/page is added or existing is removed, a property is changed and so on.
   * - sender the survey creator object that fires the event
   * options object contains the information about certain modifications
@@ -999,22 +1041,6 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   onDragDropAllow: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
-  * Use this event to override/disable element adorners - wrapping component name.
-  * - sender the survey creator object that fires the event.
-  * - options.element a survey object to be wrapped.
-  * - options.reason why we need to wrap an element.
-  * - options.conponentName component wrapper name.
-  */
-  onGetElementWrapperComponentName: Event<(sender: CreatorBase, options: any) => any, any>;
-  /*
-  * Use this event to override/disable element adorners - wrapping component data.
-  * - sender the survey creator object that fires the event.
-  * - options.element a survey object to be wrapped.
-  * - options.reason why we need to wrap an element.
-  * - options.conponentData component wrapper data.
-  */
-  onGetElementWrapperComponentData: Event<(sender: CreatorBase, options: any) => any, any>;
-  /*
   * This callback is used internally for providing survey JSON text.
   */
   getSurveyJSONTextCallback: any;
@@ -1035,6 +1061,14 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   showObjectTitles: boolean;
   /*
+  * Limits the number of visible choices. Users can click "Show more..." to view hidden choices.
+  * 
+  * Specify this property if questions with many choices occupy much vertical space on the design surface.
+  * 
+  * Default value: -1 (unlimited)
+  */
+  maxVisibleChoices: number;
+  /*
   * Specifies whether to display question titles instead of names when users edit logical expressions.
   * 
   * Default value: `false`
@@ -1102,12 +1136,14 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   * Default value: `"defaultV2"`
   */
   themeForPreview: string;
+  _allowModifyPages: boolean;
   /*
   * Specifies whether users can add, edit, and delete survey pages.
   * 
   * Default value: `true`
   */
-  allowModifyPages: boolean;
+  get allowModifyPages(): boolean;
+  set allowModifyPages(val: boolean);
   /*
   * Obsolete. Use the [`showDefaultLanguageInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showDefaultLanguageInPreviewTab) property instead.
   */
@@ -1117,16 +1153,16 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   * 
   * Accepted values:
   * 
-  * - `"auto"` (default)
-  * Display the language selector only if the survey is translated to more than one language.
+  * - `"auto"` (default)       
+  * Display the language selector only if the survey is translated into more than one language.
   * 
-  * - `true`
+  * - `true`       
   * Always display the language selector regardless of how many languages are used in the survey.
   * 
-  * - `false`
+  * - `false`        
   * Never display the language selector.
   * 
-  * - `"all"`
+  * - `"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)
@@ -1294,7 +1330,10 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   onBeforeDrop: Event<() => any, any>;
   onAfterDrop: Event<() => any, any>;
   updateElementsOnLocaleChanged(obj: Base, propertyName: string): void;
-  updateConditionsOnQuestionNameChanged(obj: Base, propertyName: string, oldValue: any): void;
+  updateConditionsOnNameChanged(obj: Base, propertyName: string, oldValue: any): void;
+  surveyLogicForUpdate: SurveyLogic;
+  surveyLogicRenaming: boolean;
+  protected createSurveyLogicForUpdate(): SurveyLogic;
   isObjQuestion(obj: Base): boolean;
   isObjPage(obj: Base): boolean;
   protected setSurvey(survey: SurveyModel): void;
@@ -1438,6 +1477,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   onGetElementEditorTitleCallback(obj: Base, title: string): string;
   onConditionQuestionsGetListCallback(propertyName: string, obj: Base, editor: any, list: any): void;
   onConditionGetTitleCallback(expression: string, title: string): string;
+  onLogicGetTitleCallback(expression: string, expressionText: string, text: string, logicItem: any): string;
   /*
   * 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.
@@ -1563,6 +1603,7 @@ export declare class ExpressionToDisplayText {
   currentQuestion: Question;
   showTitles: boolean;
   toDisplayText(expression: string): string;
+  toExpression(node: Operand): string;
   static operatorText: any;
 }
 export declare class ItemValueWrapperViewModel extends Base {
@@ -1627,6 +1668,7 @@ export declare class LogoImageViewModel extends Base {
   constructor(creator: CreatorBase, root: any);
   root: any;
   get allowEdit(): boolean;
+  get containerCss(): string;
   get survey(): SurveyModel;
   chooseFile(model: LogoImageViewModel): void;
   remove(model: LogoImageViewModel): void;
@@ -2056,6 +2098,7 @@ export declare class StringEditorViewModelBase extends Base {
   onClick(event: any): void;
   onFocus(event: any): void;
   onInput(event: any): void;
+  onBlur(event: any): void;
   done(event: any): void;
   onKeyDown(event: any): boolean;
   onKeyUp(event: any): boolean;
@@ -2202,6 +2245,9 @@ export declare class SurveyLogic extends Base implements ISurveyLogicItemOwner {
   protected onEditableItemApply(): void;
   protected onItemChanged(item: SurveyLogicItem, changeType: string): void;
   renameQuestion(oldName: string, newName: string): void;
+  renameItemValue(item: ItemValue, oldValue: any): void;
+  renameRowValue(item: ItemValue, oldValue: any): void;
+  renameColumn(column: MatrixDropdownColumn, oldName: string): void;
   removeQuestion(name: string): void;
   hasError(): boolean;
   getUsedQuestions(): Array<Question>;
@@ -2249,6 +2295,15 @@ export declare class SurveyLogicAction {
   addQuestionNames(names: any): void;
   get elementName(): string;
 }
+export declare class SurveyLogicExpressionUpdater {
+  constructor(expresion: string);
+  operand: Operand;
+  constChanges: any;
+  update(varName: string, oldValue: any, newValue: any): void;
+  get isModified(): boolean;
+  toString(): string;
+  static operatorText: any;
+}
 export declare class SurveyLogicItem {
   constructor(owner: ISurveyLogicItemOwner, expression?: string);
   expression: string;
@@ -2276,6 +2331,9 @@ export declare class SurveyLogicItem {
   equals(item: SurveyLogicItem): boolean;
   apply(expression: string): void;
   renameQuestion(oldName: string, newName: string): void;
+  renameColumn(question: Question, column: MatrixDropdownColumn, oldName: string): void;
+  renameItemValue(question: Question, item: ItemValue, oldValue: any): void;
+  renameRowValue(question: Question, item: ItemValue, oldValue: any): void;
   removeQuestion(name: string): void;
   getQuestionNames(): Array<any>;
   getActionTypes(): Array<any>;
@@ -2424,9 +2482,6 @@ export declare class SurveyTextWorker {
 export declare class TabDesignerViewModel extends Base {
   constructor(creator: CreatorBase);
   widthUpdater: any;
-  checkNewPageHandler: (sender: SurveyModel, options: any) => void;
-  checkRemovePageHandler: (sender: SurveyModel, options: any) => void;
-  surveyOnPropertyChanged: (sender: SurveyModel, options: any) => void;
   pagesControllerValue: PagesController;
   newPage: PageModel;
   showNewPage: boolean;
@@ -2438,8 +2493,9 @@ export declare class TabDesignerViewModel extends Base {
   get pagesController(): PagesController;
   get isToolboxVisible(): boolean;
   get placeholderText(): string;
+  isUpdatingNewPage: boolean;
+  onDesignerSurveyPropertyChanged(obj: Base, propName: string): void;
   initSurvey(): void;
-  dispose(): void;
   clickDesigner(): void;
   getDesignerCss(): string;
   getRootCss(): string;
@@ -2585,6 +2641,7 @@ export declare class UndoRedoController extends Base {
   undoAction: Action;
   redoAction: Action;
   undoRedoManager: UndoRedoManager;
+  updateSurvey(): void;
   undo(): void;
   redo(): void;
   startTransaction(name?: string): void;
@@ -2679,6 +2736,7 @@ export declare class EmptySurveyCreatorOptions implements ISurveyCreatorOptions
   createSurvey(json: any, reason: string, surveyType?: any): SurveyModel;
   onConditionQuestionsGetListCallback(propertyName: string, obj: Base, editor: any, list: any): void;
   onConditionGetTitleCallback(expression: string, title: string): string;
+  onLogicGetTitleCallback(expression: string, displayExpression: string, text: string, logicItem: any): string;
 }
 export declare class ImageItemValueWrapperViewModel extends ItemValueWrapperViewModel {
   constructor(creator: CreatorBase, question: QuestionSelectBase, item: ImageItemValue, templateData: any, itemsRoot: any);
@@ -2852,6 +2910,7 @@ export declare class TabDesignerPlugin implements ICreatorPlugin {
   previewAction: Action;
   activate(): void;
   deactivate(): boolean;
+  onDesignerSurveyPropertyChanged(obj: Base, propName: string): void;
   update(): void;
   createActions(): any;
   selectSurvey(): void;
@@ -3212,6 +3271,20 @@ export declare class PropertyGridValueEditorBase extends PropertyGridEditor {
   protected isValueEmpty(val: any): boolean;
   isSupportGrouping(): boolean;
 }
+export declare class QuestionDropdownAdornerViewModel extends QuestionAdornerViewModel {
+  constructor(creator: CreatorBase, surveyElement: SurveyElement, templateData: SurveyTemplateRendererTemplateData);
+  isCollapsed: boolean;
+  visibleCount: number;
+  get question(): QuestionDropdownModel;
+  get needToCollapse(): boolean;
+  get isCollapseView(): boolean;
+  leftFocus(): void;
+  getChoiceCss(): string;
+  getRenderedItems(): any;
+  getButtonText(): string;
+  switchCollapse: any;
+  dispose(): void;
+}
 export declare class QuestionImageAdornerViewModel extends QuestionAdornerViewModel {
   constructor(creator: CreatorBase, surveyElement: SurveyElement, templateData: SurveyTemplateRendererTemplateData, questionRoot: any);
   questionRoot: any;
@@ -3449,6 +3522,7 @@ export declare function assignDefaultV2Classes(destination: any, questionType: s
 export declare function wrapTextByCurlyBraces(text: string): string;
 export declare function capitalize(str: string): string;
 export declare function getLocString(strName: string, locale?: string): string;
+export declare function updateLogicExpression(expression: string, varName: string, oldValue: any, newValue: any): string;
 export declare function getLogicString(name: string): string;
 export declare function parsePropertyDescription(text: string): string;
 export declare function setSurveyJSONForPropertyGrid(json: any, updateOnTyping?: boolean, titleLocationLeft?: boolean): void;
@@ -3508,6 +3582,14 @@ export declare var settings: {
     logicItemTitleMaxChars: number,
     openBracket: string,
     closeBracket: string,
+    /*
+    * Set these properties to false if you don't want to update expressions on changing question and column names and on changing choices values
+    */
+    updateExpressionsOnChanging: {
+      questionName: boolean,
+      columnName: boolean,
+      choiceValue: boolean,
+    },
   },
   /*
   * Determines which types of questions the conversion will be available for.
@@ -3810,6 +3892,7 @@ export declare var propertyGridCss: {
     dragElementDecorator: string,
     iconDragElement: string,
     iconDrag: string,
+    footer: string,
     dragDropGhostPositionTop: string,
     dragDropGhostPositionBottom: string,
     emptyRowsSection: string,