survey-creator-core 1.9.27 → 1.9.30

package/survey-creator-core.d.ts

@@ -1,10 +1,10 @@
 /*
-* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.27
+* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.30
 * 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, Action, ActionContainer, DragDropSurveyElements } from "survey-core";
+import { Base, JsonObjectProperty, Question, SurveyModel, ItemValue } from "survey-core";
+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";
@@ -45,6 +45,7 @@ export interface ISurveyCreatorOptions {
   getObjectDisplayName(obj: Base, reason: string, displayName: string): string;
   onCanShowPropertyCallback(object: any, property: JsonObjectProperty, showMode: string, parentObj: any, parentProperty: JsonObjectProperty): boolean;
   onPropertyEditorCreatedCallback(object: any, property: JsonObjectProperty, editor: Question): any;
+  onPropertyGridSurveyCreatedCallback(object: any, survey: SurveyModel): any;
   onPropertyEditorUpdateTitleActionsCallback(object: any, property: JsonObjectProperty, editor: Question, titleActions: any): any;
   onIsPropertyReadOnlyCallback(obj: Base, property: JsonObjectProperty, readOnly: boolean, parentObj: Base, parentProperty: JsonObjectProperty): boolean;
   onCanDeleteItemCallback(object: any, item: Base, allowDelete: boolean): boolean;
@@ -458,6 +459,13 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   onShowingProperty: Event<(sender: CreatorBase, options: any) => any, any>;
   onCanShowProperty: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
+  * The event is called after a survey that represents the Property Grid is created and all its questions (property editors) are setup.
+  * You can use this event to modify this survey to change the property grid behavior
+  * <br/> options.obj the survey object that is currently editing in the property grid
+  * <br/> options.survey the property grid survey
+  */
+  onPropertyGridSurveyCreated: Event<(sender: CreatorBase, options: any) => any, any>;
+  /*
   * The event is called after a property editor (in fact a survey question) has been created and all it's properties have been assign.
   * You can use this event to modify the property editor properties or set event handlers to customize it's behavior
   * <br/> options.obj the survey object that is currently editing in the property grid
@@ -566,6 +574,14 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   onPropertyValueChanging: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
+  * The event is fired when a property in any survey object object is changed.
+  * <br/> sender the survey creator object that fires the event
+  * <br/> options.obj the survey object which property has been changed.
+  * <br/> options.propertyName  the name of the changed property.
+  * <br/> options.value the property value.
+  */
+  onSurveyPropertyValueChanged: Event<(sender: CreatorBase, options: any) => any, any>;
+  /*
   * Use this event to modify the list (name and titles) of the questions available in a condition editor.
   * <br/> sender the survey creator object that fires the event
   * <br/> options.obj the survey object which property is edited in the Property Editor.
@@ -693,7 +709,9 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   * <br/> sender the survey creator object that fires the event
   * <br/> There are two properties in options:
   * <br/> files the Javascript File objects array
-  * <br/> callback called on upload complete
+  * <br/> callback called on upload complete,
+  * <br/> which takes two string arguments:
+  * <br/> a status and an image link
   */
   onUploadFile: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
@@ -792,6 +810,11 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   get showSimulatorInPreviewTab(): boolean;
   set showSimulatorInPreviewTab(val: boolean);
   /*
+  * Specifies a theme to use for the survey in the Preview tab.
+  * Accepted values: `"modern"`, `"default"`, `"defaultV2"`
+  */
+  themeForPreview: string;
+  /*
   * Set this property to false to disable pages adding, editing and deleting
   */
   allowModifyPages: boolean;
@@ -980,6 +1003,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   onStateChanged: Event<(sender: CreatorBase, options: any) => any, any>;
   notifier: Notifier;
   setModified(options?: any): void;
+  notifySurveyPropertyChanged(options: any): void;
   /*
   * This function triggers user notification (via the alert() function if no onNotify event handler added).
   */
@@ -1082,6 +1106,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   get alwaySaveTextInPropertyEditors(): boolean;
   set alwaySaveTextInPropertyEditors(val: boolean);
   onCanShowPropertyCallback(object: any, property: JsonObjectProperty, showMode: string, parentObj: any, parentProperty: JsonObjectProperty): boolean;
+  onPropertyGridSurveyCreatedCallback(object: any, survey: SurveyModel): void;
   onPropertyEditorCreatedCallback(object: any, property: JsonObjectProperty, editor: Question): void;
   onPropertyEditorUpdateTitleActionsCallback(object: any, property: JsonObjectProperty, editor: Question, titleActions: any): void;
   onCanDeleteItemCallback(object: any, item: Base, allowDelete: boolean): boolean;
@@ -1141,7 +1166,6 @@ export declare class CreatorResponsivityManager {
   prevShowToolbox: any;
   prevShowPageNavigator: any;
   screenWidth: any;
-  devicePixelRatio: any;
   process(): void;
   dispose(): void;
 }
@@ -1328,7 +1352,6 @@ export declare class ObjectSelector {
 export declare class ObjectSelectorItem extends Action {
   constructor(id: number, data: Base, title: string, level: number);
   data: Base;
-  title: string;
   level: number;
   textInLow: string;
   hasText(filteredTextInLow: string): boolean;
@@ -1467,6 +1490,7 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
   constructor(supportedQuestions?: any, creator?: CreatorBase);
   creator: CreatorBase;
   static hiddenTypes: any;
+  static defaultIconName: string;
   _orderedQuestions: any;
   static getQuestionDefaultSettings(questionType: string): any;
   static _questionDefaultSettings: any;
@@ -1529,6 +1553,10 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
   * Add a copied Question into Toolbox
   */
   addCopiedItem(question: Question, options?: any): void;
+  /*
+  * Add a toolbox item
+  */
+  getActionByItem(item: IQuestionToolboxItem): QuestionToolboxItem;
   addItem(item: IQuestionToolboxItem, index?: number): void;
   /*
   * Add a new toolbox item, add delete the old item with the same name
@@ -1603,7 +1631,6 @@ export declare class QuestionToolboxItem extends Action implements IQuestionTool
   iconName: string;
   name: string;
   json: any;
-  title: string;
   tooltip: string;
   isCopied: boolean;
   category: string;
@@ -2194,6 +2221,10 @@ export declare class Translation extends Base implements ITranslationLocales {
   importFromCSVFile(file: any): void;
   mergeLocaleWithDefault(): void;
   translateItemAfterRender(item: TranslationItem, el: any, locale: string): void;
+  /*
+  * Update a translation item with given values
+  */
+  updateItemWithStrings(item: TranslationItem, values: any, locales: any): void;
   dispose(): void;
 }
 export declare class TranslationItemBase extends Base {
@@ -2295,6 +2326,7 @@ export declare class EmptySurveyCreatorOptions implements ISurveyCreatorOptions
   maximumRateValues: number;
   getObjectDisplayName(obj: Base, reason: string, displayName: string): string;
   onCanShowPropertyCallback(object: any, property: JsonObjectProperty, showMode: string, parentObj: any, parentProperty: JsonObjectProperty): boolean;
+  onPropertyGridSurveyCreatedCallback(object: any, survey: SurveyModel): void;
   onPropertyEditorCreatedCallback(object: any, property: JsonObjectProperty, editor: Question): void;
   onPropertyEditorUpdateTitleActionsCallback(object: any, property: JsonObjectProperty, editor: Question, titleActions: any): void;
   onIsPropertyReadOnlyCallback(obj: Base, property: JsonObjectProperty, readOnly: boolean, parentObj: Base, parentProperty: JsonObjectProperty): boolean;
@@ -2363,6 +2395,7 @@ export declare class PageAdorner extends SurveyElementAdornerBase<PageModel> {
   hoverStopper(event: any, element: any): void;
   protected duplicate(): void;
   get allowEdit(): boolean;
+  get showAddQuestionButton(): boolean;
   get addNewQuestionText(): string;
 }
 export declare class PropertyEditorSetupValue implements IPropertyEditorSetup {
@@ -2410,6 +2443,7 @@ export declare class QuestionAdornerViewModel extends SurveyElementAdornerBase {
   onPointerDown(pointerDownEvent: any): void;
   startDragSurveyElement: any;
   get allowEdit(): boolean;
+  get showAddQuestionButton(): boolean;
   getConvertToTypesActions(): Array<IAction>;
   protected buildActions(items: any): void;
   protected duplicate(): void;
@@ -3096,6 +3130,7 @@ export declare function getElementWrapperComponentData(element: any, reason: str
 export declare function getItemValueWrapperComponentName(item: ItemValue, question: QuestionSelectBase): string;
 export declare function getItemValueWrapperComponentData(item: ItemValue, question: QuestionSelectBase, creator: CreatorBase): any;
 export declare function isStringEditable(element: any, name: string): boolean;
+export declare function isTextInput(target: any): boolean;
 export declare var editorLocalization: EditorLocalization;
 export declare var defaultStrings: any;
 export declare var settings: {
@@ -3122,6 +3157,16 @@ export declare var settings: {
     lessorequal: any,
   },
   defaultNewSurveyJSON: any,
+  designer: {
+    /*
+    * The default question type on clicking Add Question button.
+    */
+    defaultAddQuestionType: string,
+    /*
+    * Set this property to false, to hide "Add Question" button on designer surface
+    */
+    showAddQuestionButton: boolean,
+  },
   logic: {
     visibleActions: any,
     logicItemTitleMaxChars: number,