survey-creator-core 1.9.52 → 1.9.54

package/survey-creator-core.d.ts

@@ -1,17 +1,18 @@
 /*
-* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.52
+* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.54
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: https://surveyjs.io/Licenses#SurveyCreator
 */
-import { Base, JsonObjectProperty, Question, SurveyModel, ItemValue } from "survey-core";
-import { MatrixDropdownColumn, ILocalizableString, IAction, Action, ILocalizableOwner } from "survey-core";
-import { LocalizableString, ActionContainer, DragDropSurveyElements, DragDropChoices, Event } from "survey-core";
-import { AdaptiveActionContainer, PageModel, IElement, IPanel, ISurveyElement } from "survey-core";
-import { SurveyElement, QuestionSelectBase, Operand, DragOrClickHelper, PanelModel } from "survey-core";
+import { Base, JsonObjectProperty, Question, SurveyModel, PopupBaseViewModel } from "survey-core";
+import { ItemValue, MatrixDropdownColumn, ILocalizableString, IAction, Action } from "survey-core";
+import { ILocalizableOwner, LocalizableString, ActionContainer, DragDropSurveyElements, DragDropChoices } from "survey-core";
+import { Event, AdaptiveActionContainer, PageModel, IElement, IPanel } from "survey-core";
+import { ISurveyElement, QuestionSelectBase, Operand, DragOrClickHelper, PanelModel } from "survey-core";
 import { QuestionDropdownModel, ListModel, PopupModel, EventBase, PanelModelBase } from "survey-core";
-import { QuestionNonValue, SurveyTemplateRendererTemplateData, QuestionRatingModel, QuestionRowModel, ComputedUpdater } from "survey-core";
-import { QuestionCheckboxModel, ArrayChanges, ImageItemValue, HashTable, QuestionMatrixDynamicModel } from "survey-core";
-import { QuestionMatrixModel, QuestionMatrixDropdownModel, QuestionPanelDynamicModel, QuestionCommentModel, MatrixDynamicRowModel } from "survey-core";
+import { QuestionNonValue, SurveyTemplateRendererTemplateData, SurveyElement, QuestionRatingModel, QuestionRowModel } from "survey-core";
+import { ComputedUpdater, QuestionCheckboxModel, ArrayChanges, ImageItemValue, HashTable } from "survey-core";
+import { QuestionMatrixDynamicModel, QuestionMatrixModel, QuestionMatrixDropdownModel, QuestionPanelDynamicModel, QuestionCommentModel } from "survey-core";
+import { MatrixDynamicRowModel } from "survey-core";
 
 export { editorLocalization as localization };
 
@@ -32,6 +33,7 @@ export interface ICollectionItemAllowOperations {
   allowEdit: boolean;
 }
 export interface ISurveyCreatorOptions {
+  isMobileView: boolean;
   alwaySaveTextInPropertyEditors: boolean;
   readOnly: boolean;
   maxLogicItemsInCondition: number;
@@ -47,6 +49,7 @@ export interface ISurveyCreatorOptions {
   onPropertyEditorCreatedCallback(object: any, property: JsonObjectProperty, editor: Question): any;
   onPropertyGridSurveyCreatedCallback(object: any, survey: SurveyModel): any;
   onPropertyEditorUpdateTitleActionsCallback(object: any, property: JsonObjectProperty, editor: Question, titleActions: any): any;
+  onPropertyGridShowModalCallback(object: any, property: JsonObjectProperty, editor: Question, popupEditor: any, popupModel: PopupBaseViewModel): any;
   onIsPropertyReadOnlyCallback(obj: Base, property: JsonObjectProperty, readOnly: boolean, parentObj: Base, parentProperty: JsonObjectProperty): boolean;
   onCanDeleteItemCallback(object: any, item: Base, allowDelete: boolean): boolean;
   onCollectionItemDeletingCallback(obj: Base, property: JsonObjectProperty, collection: any, item: Base): boolean;
@@ -398,7 +401,7 @@ export interface IPropertyGridEditor {
   fit(prop: JsonObjectProperty, context?: string): boolean;
   isDefault?: any;
   getJSON(obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions): any;
-  showModalPropertyEditor?: (editor: IPropertyGridEditor, property: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions) => any;
+  showModalPropertyEditor?: (editor: IPropertyGridEditor, property: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions) => IPropertyEditorSetup;
   onCreated?: (obj: Base, question: Question, prop: JsonObjectProperty, options: ISurveyCreatorOptions) => void;
   validateValue?: (obj: Base, question: Question, prop: JsonObjectProperty, val: any) => string;
   onAfterRenderQuestion?: (obj: Base, prop: JsonObjectProperty, evtOptions: any) => void;
@@ -442,6 +445,20 @@ export interface IUndoRedoAction {
   getChanges(): IUndoRedoChange;
   tryMerge(sender: Base, propertyName: string, newValue: any): boolean;
 }
+export interface IPortableMouseEvent {
+  stopPropagation(): any;
+  preventDefault(): any;
+  cancelBubble: boolean;
+  target: any;
+  currentTarget: any;
+  clientX: number;
+  clientY: number;
+  offsetX: number;
+  offsetY: number;
+}
+export interface IPortableDragEvent extends IPortableMouseEvent {
+  dataTransfer: any;
+}
 export interface IKeyboardShortcut {
   name?: string;
   hotKey: any;
@@ -460,20 +477,6 @@ export interface ITabbedMenuItem extends IAction {
   componentContent: string;
   renderTab?: any;
 }
-export interface IPortableMouseEvent {
-  stopPropagation(): any;
-  preventDefault(): any;
-  cancelBubble: boolean;
-  target: any;
-  currentTarget: any;
-  clientX: number;
-  clientY: number;
-  offsetX: number;
-  offsetY: number;
-}
-export interface IPortableDragEvent extends IPortableMouseEvent {
-  dataTransfer: any;
-}
 export declare class ConditionEditorItem {
   conjunction: string;
   questionName: string;
@@ -755,6 +758,21 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   onPropertyEditorUpdateTitleActions: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
+  * An event that is raised before Survey Creator displays a pop-up window called from the Property Grid. This window allows users to edit choices, conditions, and so on.
+  * 
+  * Use this event to customize the pop-up window, for example, add custom action buttons.
+  * 
+  * Parameters:
+  * 
+  * - `sender` - A Survey Creator instance that raised the event.
+  * - `options.obj` - An instance of a survey element (question or panel) that users are configuring in the Property Grid.
+  * - `options.property`- A `JsonObjectProperty` object with metadata about the property being edited.
+  * - `options.editor` - A property editor. It is an object of the [`Question`](https://surveyjs.io/form-library/documentation/question) type because the Property Grid is [built upon a regular survey](https://surveyjs.io/survey-creator/documentation/creator-v2-whats-new#survey-creator-ui-elements-are-surveys).
+  * - `options.popupEditor` - An editor inside the pop-up window.
+  * - `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: Event<(sender: CreatorBase, options: any) => any, any>;
+  /*
   * The event is called before rendering a delete button in the Property Grid or in Question Editor.
   * Obsolete, please use onCollectionItemAllowOperations
   * - sender the survey creator object that fires the event
@@ -1443,7 +1461,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   protected deleteObject(obj: any): void;
   protected updateConditionsOnRemove(obj: any): void;
   isElementSelected(element: Base): boolean;
-  selectElement(element: any, propertyName?: string, focus?: boolean, startEdit?: boolean): void;
+  selectElement(element: any, propertyName?: string, focus?: string | boolean, startEdit?: boolean): void;
   protected get designerPropertyGrid(): any;
   /*
   * Collapse certain property editor tab (category) in properties panel/grid
@@ -1500,6 +1518,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   onPropertyGridSurveyCreatedCallback(object: any, survey: SurveyModel): void;
   onPropertyEditorCreatedCallback(object: any, property: JsonObjectProperty, editor: Question): void;
   onPropertyEditorUpdateTitleActionsCallback(object: any, property: JsonObjectProperty, editor: Question, titleActions: any): void;
+  onPropertyGridShowModalCallback(object: any, property: JsonObjectProperty, editor: Question, popupEditor: any, popupModel: PopupBaseViewModel): void;
   onCanDeleteItemCallback(object: any, item: Base, allowDelete: boolean): boolean;
   onCollectionItemDeletingCallback(obj: Base, property: JsonObjectProperty, collection: any, item: Base): boolean;
   onCollectionItemAllowingCallback(obj: Base, property: JsonObjectProperty, collection: any, item: Base, itemOptions: ICollectionItemAllowOperations): void;
@@ -1535,7 +1554,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   addNewQuestionInPage(beforeAdd: (string: any) => void, panel?: IPanel, type?: string): void;
   createIActionBarItemByClass(className: string, title: string, iconName: string, needSeparator: boolean): Action;
   onElementMenuItemsChanged(element: any, items: any): void;
-  getElementAllowOperations(element: SurveyElement): any;
+  getElementAllowOperations(element: any): any;
   getNextItemValue(question: QuestionSelectBase): string | number;
   createNewItemValue(question: QuestionSelectBase): ItemValue;
   protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
@@ -1641,6 +1660,7 @@ export declare class ItemValueWrapperViewModel extends Base {
   dragOrClickHelper: DragOrClickHelper;
   allowItemOperations: ICollectionItemAllowOperations;
   canTouchItems: boolean;
+  focusCameFromDown: boolean;
   onPointerDown(pointerDownEvent: any): void;
   startDragItemValue: (pointerDownEvent: any, currentTarget: any) => void;
   dispose(): void;
@@ -1650,6 +1670,7 @@ export declare class ItemValueWrapperViewModel extends Base {
   add(model: ItemValueWrapperViewModel): void;
   addNewItem(item: ItemValue, question: QuestionSelectBase, creator: CreatorBase): void;
   remove(model: ItemValueWrapperViewModel): void;
+  onFocusOut(event: any): void;
   get allowRemove(): boolean;
   get tooltip(): string;
   get dragTooltip(): string;
@@ -1755,6 +1776,7 @@ export declare class PageNavigatorViewModel extends Base {
   popupModel: any;
   pagesChangedFunc: (sender: PagesController, options: any) => void;
   currentPagesChangedFunc: (sender: PagesController, options: any) => void;
+  _resizeObserver: any;
   dispose(): void;
   items: any;
   visible: boolean;
@@ -1764,6 +1786,15 @@ export declare class PageNavigatorViewModel extends Base {
   get pageSelectorCaption(): string;
   onContainerScroll(viewPort: any): any;
   currentPage: PageModel;
+  stopItemsContainerHeightObserver(): void;
+  visibleItemsStartIndex: number;
+  visibleItemsCount: number;
+  _itemsContainer: any;
+  setItemsContainer(itemsContainer: any): void;
+  static PAGE_NAVIGATION_MENU_ITEM_HEIGHT: number;
+  static PAGE_NAVIGATION_ITEM_HEIGHT: number;
+  protected updateVisibleItems(allAvailableHeight: number): void;
+  get visibleItems(): any;
 }
 export declare class PagesController extends Base {
   constructor(creator: ICreatorSelectionOwner);
@@ -1869,9 +1900,9 @@ export declare class QuestionLinkValueModel extends Question {
   doClearClick(): void;
 }
 export declare class QuestionRatingAdornerViewModel extends Base {
-  constructor(creator: CreatorBase, surveyElement: SurveyElement, templateData: SurveyTemplateRendererTemplateData);
+  constructor(creator: CreatorBase, surveyElement: any, templateData: SurveyTemplateRendererTemplateData);
   creator: CreatorBase;
-  surveyElement: SurveyElement;
+  surveyElement: any;
   templateData: SurveyTemplateRendererTemplateData;
   get element(): QuestionRatingModel;
   addItem(model: QuestionRatingAdornerViewModel): void;
@@ -2134,9 +2165,10 @@ export declare class StringEditorConnector extends Base {
   hasEditCompleteHandler: boolean;
   focusOnEditor: boolean;
   activateEditor(): void;
-  setItemValue(item: ItemValueWrapperViewModel): void;
   onDoActivate: Event<(sender: StringEditorViewModelBase, options: any) => any, any>;
+  onTextChanging: Event<(sender: StringEditorViewModelBase, options: any) => any, any>;
   onEditComplete: Event<(sender: StringEditorViewModelBase, options: any) => any, any>;
+  onBackspaceEmptyString: Event<(sender: StringEditorViewModelBase, options: any) => any, any>;
 }
 export declare class StringEditorViewModelBase extends Base {
   constructor(locString: LocalizableString, creator: CreatorBase);
@@ -2150,7 +2182,7 @@ export declare class StringEditorViewModelBase extends Base {
   editAsText: boolean;
   compostionInProgress: boolean;
   afterRender(): void;
-  activate(): void;
+  activate(): boolean;
   setLocString(locString: LocalizableString): void;
   checkConstraints(event: any): void;
   blurEditor: any;
@@ -2172,6 +2204,15 @@ export declare class StringEditorViewModelBase extends Base {
   get contentEditable(): boolean;
   className(text: any): string;
 }
+export declare class StringItemsNavigatorBase {
+  constructor(question: any);
+  protected getItemLocString(items: any, item: any): LocalizableString;
+  protected getItemSets(): Array<any>;
+  protected addNewItem(items: any, text?: string): void;
+  protected getItemsPropertyName(items: any): string;
+  protected addNewItems(items: any, startIndex: number, itemsToAdd: any): void;
+  static setQuestion(questionAdorner: QuestionAdornerViewModel): void;
+}
 export declare class StylesManager {
   static get currentTheme(): string;
   static set currentTheme(val: string);
@@ -2776,6 +2817,7 @@ export declare class AceJsonEditorModel extends JsonEditorBaseModel {
   onEditorActivated(): void;
 }
 export declare class EmptySurveyCreatorOptions implements ISurveyCreatorOptions {
+  isMobileView: boolean;
   alwaySaveTextInPropertyEditors: boolean;
   readOnly: boolean;
   maxLogicItemsInCondition: number;
@@ -2791,6 +2833,7 @@ export declare class EmptySurveyCreatorOptions implements ISurveyCreatorOptions
   onPropertyGridSurveyCreatedCallback(object: any, survey: SurveyModel): void;
   onPropertyEditorCreatedCallback(object: any, property: JsonObjectProperty, editor: Question): void;
   onPropertyEditorUpdateTitleActionsCallback(object: any, property: JsonObjectProperty, editor: Question, titleActions: any): void;
+  onPropertyGridShowModalCallback(object: any, property: JsonObjectProperty, editor: Question, popupEditor: any, popupModel: PopupBaseViewModel): void;
   onIsPropertyReadOnlyCallback(obj: Base, property: JsonObjectProperty, readOnly: boolean, parentObj: Base, parentProperty: JsonObjectProperty): boolean;
   onCanDeleteItemCallback(object: any, item: Base, allowDelete: boolean): boolean;
   onCollectionItemDeletingCallback(obj: Base, property: JsonObjectProperty, collection: any, item: Base): boolean;
@@ -2883,19 +2926,19 @@ export declare class PropertyGridEditor implements IPropertyGridEditor {
   constructor();
   fit(prop: JsonObjectProperty): boolean;
   getJSON(obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions): any;
-  showModalPropertyEditor(editor: IPropertyGridEditor, property: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions, onClose?: any): any;
+  showModalPropertyEditor(editor: IPropertyGridEditor, property: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions, onClose?: any): IPropertyEditorSetup;
   protected onModalPropertyEditorShown(editor: IPropertyGridEditor, property: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions): void;
   protected onModalPropertyEditorClosed(editor: IPropertyGridEditor, property: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions, reason: "apply" | "cancel"): void;
   isSupportGrouping(): boolean;
   onUpdateQuestionCssClasses(obj: Base, options: any): void;
 }
 export declare class QuestionAdornerViewModel extends SurveyElementAdornerBase {
-  constructor(creator: CreatorBase, surveyElement: SurveyElement, templateData: SurveyTemplateRendererTemplateData);
+  constructor(creator: CreatorBase, surveyElement: any, templateData: SurveyTemplateRendererTemplateData);
   templateData: SurveyTemplateRendererTemplateData;
   isDragged: boolean;
   currentAddQuestionType: string;
   dragOrClickHelper: DragOrClickHelper;
-  get element(): SurveyElement;
+  get element(): any;
   select(model: QuestionAdornerViewModel, event: IPortableMouseEvent): boolean;
   rootCss(): "" | " svc-question__adorner--start-with-new-line";
   css(): string;
@@ -2918,6 +2961,28 @@ export declare class QuestionAdornerViewModel extends SurveyElementAdornerBase {
   questionTypeSelectorModel: any;
   get addNewQuestionText(): string;
 }
+export declare class StringItemsNavigatorMatrix extends StringItemsNavigatorBase {
+  constructor(question: any);
+  protected getItemLocString(items: any, item: any): any;
+  protected getItemSets(): any;
+  protected addNewItem(items: any, text?: string): void;
+  protected getItemsPropertyName(items: any): "columns" | "rows";
+}
+export declare class StringItemsNavigatorMultipleText extends StringItemsNavigatorBase {
+  constructor(question: any);
+  protected getItemLocString(items: any, item: any): any;
+  protected getItemSets(): any;
+  protected addNewItem(items: any, text?: string): void;
+  protected getItemsPropertyName(items: any): string;
+  protected addNewItems(items: any, startIndex: number, itemsToAdd: any): void;
+}
+export declare class StringItemsNavigatorSelectBase extends StringItemsNavigatorBase {
+  constructor(question: any);
+  protected getItemLocString(items: any, item: any): any;
+  protected getItemSets(): any;
+  protected addNewItem(items: any, text?: string): void;
+  protected getItemsPropertyName(items: any): string;
+}
 export declare class SurveyConditionEditorItem extends ConditionEditorItem {
   constructor(survey: SurveyModel);
   survey: SurveyModel;
@@ -3336,10 +3401,11 @@ export declare class PropertyGridValueEditorBase extends PropertyGridEditor {
   isSupportGrouping(): boolean;
 }
 export declare class QuestionDropdownAdornerViewModel extends QuestionAdornerViewModel {
-  constructor(creator: CreatorBase, surveyElement: SurveyElement, templateData: SurveyTemplateRendererTemplateData);
+  constructor(creator: CreatorBase, surveyElement: any, templateData: SurveyTemplateRendererTemplateData);
   isCollapsed: boolean;
   visibleCount: number;
   get question(): QuestionDropdownModel;
+  get itemComponent(): string;
   get needToCollapse(): boolean;
   get isCollapseView(): boolean;
   leftFocus(): void;
@@ -3350,10 +3416,15 @@ export declare class QuestionDropdownAdornerViewModel extends QuestionAdornerVie
   dispose(): void;
 }
 export declare class QuestionImageAdornerViewModel extends QuestionAdornerViewModel {
-  constructor(creator: CreatorBase, surveyElement: SurveyElement, templateData: SurveyTemplateRendererTemplateData, questionRoot: any);
+  constructor(creator: CreatorBase, surveyElement: any, templateData: SurveyTemplateRendererTemplateData, questionRoot: any);
   questionRoot: any;
   chooseFile(model: QuestionImageAdornerViewModel): void;
 }
+export declare class StringItemsNavigatorMatrixDropdown extends StringItemsNavigatorMatrix {
+  constructor(question: any);
+  protected getItemLocString(items: any, item: any): any;
+  protected addNewItems(items: any, startIndex: number, itemsToAdd: any): void;
+}
 export declare class TabJsonEditorAcePlugin extends TabJsonEditorBasePlugin implements ICreatorPlugin {
   constructor(creator: CreatorBase);
   protected createModel(creator: CreatorBase): JsonEditorBaseModel;
@@ -3533,6 +3604,10 @@ export declare class PropertyGridValueEditor extends PropertyGridValueEditorBase
   fit(prop: JsonObjectProperty): boolean;
   createPropertyEditorSetup(obj: Base, prop: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions): IPropertyEditorSetup;
 }
+export declare class StringItemsNavigatorMatrixDynamic extends StringItemsNavigatorMatrixDropdown {
+  constructor(question: any);
+  protected getItemSets(): any;
+}
 export declare class TriggerValueEditor extends DefaultValueEditor {
   constructor(editQuestion: Question, editObj: Base, propertyName: string, options?: ISurveyCreatorOptions);
   editQuestion: Question;
@@ -4045,17 +4120,6 @@ export declare var simulatorDevices: {
     deviceType: string,
     title: string,
   },
-  iPhone5: {
-    cssPixelRatio: number,
-    ppi: number,
-    width: number,
-    height: number,
-    frameWidth: number,
-    frameHeight: number,
-    deviceType: string,
-    title: string,
-    cssClass: string,
-  },
   iPhone6: {
     cssPixelRatio: number,
     ppi: number,