survey-creator-core 1.9.20 → 1.9.23

package/survey-creator-core.d.ts

@@ -1,12 +1,12 @@
 /*
-* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.20
+* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.23
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: https://surveyjs.io/Licenses#SurveyCreator
 */
 import { Base, JsonObjectProperty, Question, ItemValue, MatrixDropdownColumn } from "survey-core";
-import { IAction, SurveyModel, SurveyElement, AdaptiveActionContainer, Action } from "survey-core";
-import { ActionContainer, DragDropSurveyElements, DragDropChoices, Event, PageModel } from "survey-core";
-import { IElement, IPanel, ISurveyElement, QuestionSelectBase, QuestionRowModel } from "survey-core";
+import { IAction, SurveyModel, ActionContainer, DragDropSurveyElements, DragDropChoices } from "survey-core";
+import { Event, AdaptiveActionContainer, PageModel, IElement, IPanel } from "survey-core";
+import { ISurveyElement, Action, 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 { ComputedUpdater, QuestionCheckboxModel, ILocalizableString, ArrayChanges, ImageItemValue } from "survey-core";
@@ -139,6 +139,18 @@ export interface ISurveyQuestionEditorDefinition {
   properties?: any;
   tabs?: any;
 }
+export interface IPropertyEditorInfo {
+  name: string;
+  title?: string;
+  tab?: string;
+  placeholder?: string;
+}
+export interface IPropertyTabInfo {
+  name: string;
+  index?: number;
+  title?: string;
+  visible?: boolean;
+}
 export interface IPropertyEditorSetup {
   editSurvey: SurveyModel;
   apply(): boolean;
@@ -223,25 +235,6 @@ export interface IPortableMouseEvent {
 export interface IPortableDragEvent extends IPortableMouseEvent {
   dataTransfer: any;
 }
-export declare class ActionContainerViewModel extends Base {
-  constructor(creator: CreatorBase, surveyElement: SurveyElement);
-  creator: CreatorBase;
-  surveyElement: SurveyElement;
-  actionContainer: any;
-  allowDragging: boolean;
-  selectedPropPageFunc: any;
-  sidebarFlyoutModeChangedFunc: any;
-  protected checkActionProperties(): void;
-  dispose(): void;
-  protected onElementSelectedChanged(isSelected: boolean): void;
-  protected updateActionsProperties(): void;
-  protected updateElementAllowOptions(options: any, operationsAllow: boolean): void;
-  protected isOperationsAllow(): boolean;
-  protected updateActionVisibility(id: string, isVisible: boolean): void;
-  getActionById(id: string): Action;
-  protected buildActions(items: any): void;
-  protected duplicate(): void;
-}
 export declare class ConditionEditorItem {
   conjunction: string;
   questionName: string;
@@ -286,6 +279,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   * Set it to true to show "Logic" tab and to false to hide the tab
   */
   showLogicTab: boolean;
+  useTableViewInLogicTab: boolean;
   /*
   * Set delay for page hover
   */
@@ -311,7 +305,6 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   isAutoSave: boolean;
   showOptions: boolean;
-  showState: boolean;
   showSearch: boolean;
   generateValidJSON: boolean;
   currentAddQuestionType: string;
@@ -320,12 +313,12 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   toolbarValue: any;
   responsivityManager: CreatorResponsivityManager;
   footerToolbar: any;
-  pageEditModeValue: "standard" | "single";
+  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
   */
-  get pageEditMode(): "standard" | "single";
+  get pageEditMode(): "standard" | "single" | "bypage";
   surveyValue: SurveyModel;
   get toolbarItems(): any;
   get toolbar(): any;
@@ -335,7 +328,6 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   newQuestions: any;
   newPanels: any;
   newQuestionChangedNames: any;
-  pagesControllerValue: PagesController;
   selectionHistoryControllerValue: SelectionHistory;
   saveSurveyFuncValue: any;
   viewType: string;
@@ -402,14 +394,21 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   onGetObjectDisplayName: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
-  * Use this event to disable some operations for an element (question/panel).
-  * <br/> sender the survey creator object that fires the event
-  * <br/> options.obj the survey object question/panel
-  * <br/> options.allowDelete set it to false to disable deleting the object
-  * <br/> options.allowCopy set it to false to disable copying the object
-  * <br/> options.allowDragging set it to false to disable dragging the element
-  * <br/> options.allowChangeType set it to false to disable changing element type
-  * <br/> options.allowChangeRequired set it to false to disable changing isRequired property
+  * Use this event to disable user interactions with a question or panel on the design surface.
+  * 
+  * The event handler accepts the following arguments:
+  * 
+  * - `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.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.
+  * 
+  * To disable a user interaction, set the correponding `allow...` property to `false`.
   */
   onElementAllowOperations: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
@@ -693,6 +692,18 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   onTranslationLocaleInitiallySelected: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
+  * Use this event to control drag&drop operations.
+  * <br/> sender the survey creator object that fires the event.
+  * <br/> options.survey the editing survey object.
+  * <br/> options.allow set it to false to disable dragging.
+  * <br/> options.target a target element that is dragging.
+  * <br/> options.source a source element. It can be null, if it is a new element, dragging from toolbox.
+  * <br/> options.parent a page or panel where target element is dragging.
+  * <br/> 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.
+  * <br/> 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.
+  */
+  onDragDropAllow: Event<(sender: CreatorBase, options: any) => any, any>;
+  /*
   * This callback is used internally for providing survey JSON text.
   */
   getSurveyJSONTextCallback: any;
@@ -806,6 +817,17 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   get isRTL(): boolean;
   set isRTL(val: boolean);
+  /*
+  * The event is called when creator is going to change the active tab.
+  * <br/> sender the survey creator object that fires the event
+  * <br/> options.tabName the name of new active tab
+  */
+  onActiveTabChanging: Event<(sender: CreatorBase, options: any) => any, any>;
+  /*
+  * The event is called when creator active tab is changed.
+  * <br/> sender the survey creator object that fires the event
+  * <br/> options.tabName the name of new active tab
+  */
   onActiveTabChanged: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
   * Get/set the active tab.
@@ -822,7 +844,6 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   get toolboxCategories(): any;
   sidebar: SidebarModel;
   updateToolboxIsCompact(newVal?: boolean): void;
-  onSurveyElementPropertyValueChanged(property: JsonObjectProperty, obj: any, newValue: any): void;
   showToolboxValue: boolean;
   get showToolbox(): boolean;
   set showToolbox(val: boolean);
@@ -881,7 +902,6 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   * This method performs redo uperation if possible.
   */
   redo(): void;
-  get pagesController(): PagesController;
   get selectionHistoryController(): SelectionHistory;
   get currentPage(): PageModel;
   set currentPage(val: PageModel);
@@ -902,7 +922,6 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   onAfterDrop: Event<() => any, any>;
   updateElementsOnLocaleChanged(obj: Base, propertyName: string): void;
   updateConditionsOnQuestionNameChanged(obj: Base, propertyName: string, oldValue: any): void;
-  updatePagesController(sender: Base, name: string): void;
   isObjQuestion(obj: Base): boolean;
   isObjPage(obj: Base): boolean;
   protected setSurvey(survey: SurveyModel): void;
@@ -1064,7 +1083,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   get addNewQuestionText(): any;
   getQuestionTypeSelectorModel(beforeAdd: any, panel?: IPanel): any;
   addNewQuestionInPage(beforeAdd: any, panel?: IPanel, type?: string): void;
-  createIActionBarItemByClass(className: string, title?: string): Action;
+  createIActionBarItemByClass(className: string, title: string, iconName: string): Action;
   onElementMenuItemsChanged(element: any, items: any): void;
   getElementAllowOperations(element: SurveyElement): any;
   getNextItemValue(question: QuestionSelectBase): string | number;
@@ -1262,12 +1281,12 @@ export declare class ObjectSelectorModel extends Base {
   refresh(): void;
 }
 export declare class PageNavigatorViewModel extends Base {
-  constructor(pagesController: PagesController);
+  constructor(pagesController: PagesController, pageEditMode: string);
   icon: string;
   pageListModel: ListModel;
   popupModel: any;
   pagesChangedFunc: any;
-  pageNameChangedFunc: any;
+  currentPagesChangedFunc: any;
   dispose(): void;
   items: any;
   visible: boolean;
@@ -1282,19 +1301,18 @@ export declare class PagesController extends Base {
   constructor(creator: ICreatorSelectionOwner);
   creator: ICreatorSelectionOwner;
   onPagesChanged: EventBase<PagesController>;
-  onCurrentPagesChanged: EventBase<PagesController>;
-  onPageNameChanged: EventBase<PagesController>;
-  pagesChangedFunc: any;
-  currentpagedChangedFunc: any;
+  onCurrentPageChanged: EventBase<PagesController>;
+  currentPageChangedFunc: any;
   surveyValue: SurveyModel;
+  page2Display: PageModel;
   get survey(): SurveyModel;
   get pages(): any;
   get currentPage(): PageModel;
   set currentPage(val: PageModel);
   selectPage(value: PageModel): void;
   getDisplayName(page: PageModel): string;
+  raisePagesChanged(): void;
   onSurveyChanged(): void;
-  pageNameChanged(page: PageModel): void;
   dispose(): void;
 }
 export declare class PropertiesHelpTexts {
@@ -1416,7 +1434,17 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
   activeCategory: string;
   hasCategories: boolean;
   canCollapseCategories: boolean;
+  /*
+  * Indicates whether the toolbox is currently in compact mode.
+  */
   isCompact: boolean;
+  /*
+  * Specifies whether the toolbox should be in compact or full mode.
+  * Accepts the following values:
+  * - `true` - Toolbox is always in compact mode.
+  * - `false` - Toolbox is always in full mode.
+  * - `undefined` - Toolbox switches between the full and compact modes automatically based on available width.
+  */
   forceCompact: boolean;
   setLocation(toolboxLocation: any): void;
   /*
@@ -1629,6 +1657,27 @@ export declare class StylesManager {
   static set currentTheme(val: string);
   static applyTheme(name?: string): void;
 }
+export declare class SurveyElementAdornerBase<T extends SurveyElement = SurveyElement> extends Base {
+  constructor(creator: CreatorBase, surveyElement: T);
+  creator: CreatorBase;
+  actionContainer: any;
+  allowDragging: boolean;
+  selectedPropPageFunc: any;
+  sidebarFlyoutModeChangedFunc: any;
+  protected detachElement(surveyElement: T): void;
+  protected attachElement(surveyElement: T): void;
+  protected setSurveyElement(surveyElement: T): void;
+  protected checkActionProperties(): void;
+  dispose(): void;
+  protected onElementSelectedChanged(isSelected: boolean): void;
+  protected updateActionsProperties(): void;
+  protected updateElementAllowOptions(options: any, operationsAllow: boolean): void;
+  protected isOperationsAllow(): boolean;
+  protected updateActionVisibility(id: string, isVisible: boolean): void;
+  getActionById(id: string): Action;
+  protected buildActions(items: any): void;
+  protected duplicate(): void;
+}
 export declare class SurveyForTextWorker extends SurveyModel {
   constructor(jsonObj: any);
 }
@@ -1797,6 +1846,8 @@ export declare class SurveyLogicItem {
   get name(): string;
   get survey(): SurveyModel;
   getVisibleLogicTypes(): Array<SurveyLogicType>;
+  get expressionText(): any;
+  get actionsText(): any;
   getDisplayText(): any;
   edit(): void;
   remove(): void;
@@ -1950,6 +2001,7 @@ export declare class TabDesignerViewModel extends Base {
   widthUpdater: any;
   checkNewPageHandler: any;
   surveyOnPropertyChanged: any;
+  pagesControllerValue: PagesController;
   newPage: PageModel;
   showNewPage: boolean;
   pageCount: number;
@@ -1957,10 +2009,10 @@ export declare class TabDesignerViewModel extends Base {
   showPlaceholder: boolean;
   creator: CreatorBase;
   get survey(): SurveyModel;
+  get pagesController(): PagesController;
   get isToolboxVisible(): boolean;
   get placeholderText(): string;
   initSurvey(): void;
-  onPagesChangedHandler: any;
   dispose(): void;
   clickDesigner(): void;
   getDesignerCss(): string;
@@ -2226,22 +2278,23 @@ export declare class LogicActionTriggerModel extends LogicActionModelBase {
   updatePanelElements(selectedElement: string, options?: ISurveyCreatorOptions): void;
   getSelectedElement(): string;
 }
-export declare class PageViewModel extends ActionContainerViewModel {
+export declare class PageAdorner extends SurveyElementAdornerBase<PageModel> {
   constructor(creator: CreatorBase, page: PageModel);
   isSelected: boolean;
   isPageLive: boolean;
   onPageSelectedCallback: any;
   questionTypeSelectorModel: any;
   currentAddQuestionType: string;
-  _page: PageModel;
+  protected attachElement(surveyElement: PageModel): void;
   protected onElementSelectedChanged(isSelected: boolean): void;
   dispose(): void;
   get isGhost(): boolean;
   protected isOperationsAllow(): boolean;
+  protected getPage(): PageModel;
   get page(): PageModel;
   addGhostPage: any;
-  addNewQuestion(model: PageViewModel, event: IPortableMouseEvent): void;
-  select(model: PageViewModel, event: IPortableMouseEvent): void;
+  addNewQuestion(model: PageAdorner, event: IPortableMouseEvent): void;
+  select(model: PageAdorner, event: IPortableMouseEvent): void;
   get css(): string;
   hover(event: any, element: any): void;
   hoverStopper(event: any, element: any): void;
@@ -2271,12 +2324,13 @@ export declare class PropertyGridEditor implements IPropertyGridEditor {
   isSupportGrouping(): boolean;
   onUpdateQuestionCssClasses(obj: Base, options: any): void;
 }
-export declare class QuestionAdornerViewModel extends ActionContainerViewModel {
+export declare class QuestionAdornerViewModel extends SurveyElementAdornerBase {
   constructor(creator: CreatorBase, surveyElement: SurveyElement, templateData: SurveyTemplateRendererTemplateData);
   templateData: SurveyTemplateRendererTemplateData;
   isDragged: boolean;
   currentAddQuestionType: string;
   dragOrClickHelper: DragOrClickHelper;
+  get element(): SurveyElement;
   select(model: QuestionAdornerViewModel, event: IPortableMouseEvent): boolean;
   rootCss(): "" | " svc-question__adorner--start-with-new-line";
   css(): string;
@@ -2572,16 +2626,24 @@ export declare class DefaultValueEditor extends PropertyEditorSetupValue {
   protected getSurveyCreationReason(): string;
   apply(): boolean;
 }
-export declare class FastEntryEditor extends PropertyEditorSetupValue {
+export declare class FastEntryEditorBase extends PropertyEditorSetupValue {
   constructor(choices: any, options?: ISurveyCreatorOptions, className?: string, names?: any);
   choices: any;
-  static applyItemValueArray(dest: any, src: any, names?: any): void;
-  commentValue: QuestionCommentModel;
+  protected commentValue: QuestionCommentModel;
+  protected static calcBeforeApplyItemsArray(dest: any, src: any, names: any): void;
+  static applyItemsArray(dest: any, src: any, names?: any): void;
   protected getSurveyJSON(): any;
   protected getSurveyCreationReason(): string;
-  get comment(): QuestionCommentModel;
   apply(): boolean;
+  protected convertTextToItemValues(text: string): Array<ItemValue>;
+  get comment(): QuestionCommentModel;
+  protected getChoicesCount(): number;
+  protected getPlaceHolder(): string;
+  protected get isValueUnique(): boolean;
+  protected getFirstUniqueValue(): boolean;
   setComment(): void;
+  protected collectNames(item: any, type: string, separatorCounter: number): string;
+  protected convertItemValuesToText(): string;
 }
 export declare class LogicItemEditor extends PropertyEditorSetupValue {
   constructor(editableItem: SurveyLogicItem, options?: ISurveyCreatorOptions);
@@ -2711,7 +2773,7 @@ export declare class QuestionImageAdornerViewModel extends QuestionAdornerViewMo
 }
 export declare class QuestionRatingAdornerViewModel extends QuestionAdornerViewModel {
   constructor(creator: CreatorBase, surveyElement: SurveyElement, templateData: SurveyTemplateRendererTemplateData);
-  get question(): QuestionRatingModel;
+  get element(): QuestionRatingModel;
   addItem(model: QuestionRatingAdornerViewModel): void;
   removeItem(model: QuestionRatingAdornerViewModel): void;
   get allowAdd(): boolean;
@@ -2734,6 +2796,13 @@ export declare class DefaultArrayValueEditor extends DefaultValueEditor {
   protected getQuestionValue(): any;
   protected getEditValue(): any;
 }
+export declare class FastEntryEditor extends FastEntryEditorBase {
+  constructor(choices: any, options?: ISurveyCreatorOptions, className?: string, names?: any);
+  choices: any;
+  static applyItemValueArray(dest: any, src: any, names?: any): void;
+  apply(): boolean;
+  protected convertItemValuesToText(): string;
+}
 export declare class PropertyGridCellsEditor extends PropertyGridValueEditorBase {
   constructor();
   fit(prop: JsonObjectProperty): boolean;
@@ -2752,6 +2821,11 @@ export declare class PropertyGridEditorHtml extends PropertyGridEditorStringBase
   fit(prop: JsonObjectProperty): boolean;
   getJSON(obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions): any;
 }
+export declare class PropertyGridEditorImageSize extends PropertyGridEditorNumber {
+  constructor();
+  fit(prop: JsonObjectProperty): boolean;
+  onCreated(obj: Base, question: Question, prop: JsonObjectProperty): void;
+}
 export declare class PropertyGridEditorMatrixCalculatedValues extends PropertyGridEditorMatrix {
   constructor();
   fit(prop: JsonObjectProperty): boolean;
@@ -2807,6 +2881,9 @@ export declare class PropertyGridEditorMatrixMutlipleTextItems extends PropertyG
   protected getDefaulColumnNames(): Array<any>;
   protected getKeyValue(): string;
   protected getBaseValue(prop: JsonObjectProperty): string;
+  protected getAllowRowDragDrop(): boolean;
+  createPropertyEditorSetup(obj: Base, prop: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions): IPropertyEditorSetup;
+  onMatrixCellCreated(obj: Base, options: any): void;
 }
 export declare class PropertyGridEditorMatrixPages extends PropertyGridEditorMatrix {
   constructor();
@@ -2996,6 +3073,8 @@ export declare var settings: {
   logic: {
     visibleActions: any,
     logicItemTitleMaxChars: number,
+    openBracket: string,
+    closeBracket: string,
   },
   /*
   * Determines which types of questions the conversion will be available for.
@@ -4160,5 +4239,6 @@ export declare var logicCss: {
 };
 export declare var initialSettingsAllowShowEmptyTitleInDesignMode: boolean;
 export declare var editableStringRendererName: any;
-export declare var svgBundle: string;
+export declare var svgBundle: any;
+export declare var path: any;
 export declare var Version: string;