survey-creator-core 1.9.50 → 1.9.52

package/survey-creator-core.d.ts

@@ -1,16 +1,16 @@
 /*
-* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.50
+* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.52
 * 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, IAction, Action, ILocalizableOwner, LocalizableString } from "survey-core";
-import { ActionContainer, DragDropSurveyElements, DragDropChoices, Event, AdaptiveActionContainer } from "survey-core";
-import { PageModel, IElement, IPanel, ISurveyElement, SurveyElement } from "survey-core";
-import { QuestionSelectBase, Operand, DragOrClickHelper, PanelModel, QuestionDropdownModel } from "survey-core";
-import { ListModel, PopupModel, EventBase, PanelModelBase, QuestionNonValue } from "survey-core";
-import { SurveyTemplateRendererTemplateData, QuestionRatingModel, QuestionRowModel, ComputedUpdater, QuestionCheckboxModel } from "survey-core";
-import { ILocalizableString, ArrayChanges, ImageItemValue, HashTable, QuestionMatrixDynamicModel } 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 { 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";
 
 export { editorLocalization as localization };
@@ -63,6 +63,7 @@ export interface ISurveyCreatorOptions {
   onConditionQuestionsGetListCallback(propertyName: string, obj: Base, editor: any, list: any): string;
   onConditionGetTitleCallback(expression: string, title: string): string;
   onLogicGetTitleCallback(expression: string, displayExpression: string, text: string, logicItem: any): string;
+  getTranslationExportedText(obj: Base, name: string, locString: ILocalizableString, locale: string, text: string): string;
 }
 /*
 * Survey Creator configuration. Pass it as an argument to the `SurveyCreator` constructor:
@@ -1037,10 +1038,23 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   onTranslationImportItem: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
-  * The method is called when the translation from csv file is imported.
+  * The event is called when the translation from csv file is imported.
   */
   onTranslationImported: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
+  * Use this event to modify a translated string before it is exported to CSV.
+  * 
+  * The event handler accepts the following arguments:
+  * 
+  * - `sender` - A Survey Creator instance that raised the event.
+  * - `options.obj` - A survey object instance (survey, page, panel, question) whose string translations are being exported to CSV.
+  * - `options.locale` - The current locale identifier (`"en"`, `"de"`, etc.). Contains an empty string if the default locale is used.
+  * - `options.name` - A full name of the translated string. It is composed of names of all parent elements, for example: `"mySurvey.page1.question2.title"`.
+  * - `options.locString` - A `LocalizableString` instance. Call the `options.locString.getLocaleText(locale)` method if you need to get a text string for a specific locale.
+  * - `options.text` - A text string to be exported. The string is taken from the current locale. Redefine this property if you want to export a different string.
+  */
+  onTranslationExportItem: Event<(sender: CreatorBase, options: any) => any, any>;
+  /*
   * Use this event to control drag&drop operations.
   * - sender the survey creator object that fires the event.
   * - options.survey the editing survey object.
@@ -1429,7 +1443,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): void;
+  selectElement(element: any, propertyName?: string, focus?: boolean, startEdit?: boolean): void;
   protected get designerPropertyGrid(): any;
   /*
   * Collapse certain property editor tab (category) in properties panel/grid
@@ -1498,6 +1512,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   onConditionQuestionsGetListCallback(propertyName: string, obj: Base, editor: any, list: any): string;
   onConditionGetTitleCallback(expression: string, title: string): string;
   onLogicGetTitleCallback(expression: string, expressionText: string, text: string, logicItem: any): string;
+  getTranslationExportedText(obj: Base, name: string, locString: ILocalizableString, locale: string, text: string): 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.
@@ -1518,7 +1533,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   get addNewQuestionText(): any;
   getQuestionTypeSelectorModel(beforeAdd: (type: string) => void, panel?: IPanel): any;
   addNewQuestionInPage(beforeAdd: (string: any) => void, panel?: IPanel, type?: string): void;
-  createIActionBarItemByClass(className: string, title: string, iconName: string): Action;
+  createIActionBarItemByClass(className: string, title: string, iconName: string, needSeparator: boolean): Action;
   onElementMenuItemsChanged(element: any, items: any): void;
   getElementAllowOperations(element: SurveyElement): any;
   getNextItemValue(question: QuestionSelectBase): string | number;
@@ -1633,6 +1648,7 @@ export declare class ItemValueWrapperViewModel extends Base {
   get isDraggable(): boolean;
   isDraggableItem(item: ItemValue): boolean;
   add(model: ItemValueWrapperViewModel): void;
+  addNewItem(item: ItemValue, question: QuestionSelectBase, creator: CreatorBase): void;
   remove(model: ItemValueWrapperViewModel): void;
   get allowRemove(): boolean;
   get tooltip(): string;
@@ -1869,11 +1885,13 @@ export declare class QuestionRatingAdornerViewModel extends Base {
 * The list of Toolbox items.
 */
 export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToolboxItem> implements IQuestionToolbox {
-  constructor(supportedQuestions?: any, creator?: CreatorBase);
+  constructor(supportedQuestions?: any, creator?: CreatorBase, useDefaultCategories?: boolean);
   creator: CreatorBase;
   static hiddenTypes: any;
   static defaultIconName: string;
+  static defaultCategories: any;
   _orderedQuestions: any;
+  showTitleOnCategoryChange: boolean;
   static getQuestionDefaultSettings(questionType: string): any;
   /*
   * Modify this array to change the toolbox items order.
@@ -1886,6 +1904,7 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
   copiedItemMaxCount: number;
   allowExpandMultipleCategoriesValue: boolean;
   keepAllCategoriesExpandedValue: boolean;
+  showCategoryTitlesValue: boolean;
   dragOrClickHelper: DragOrClickHelper;
   /*
   * Contains toolbox categories and allows you to modify them.
@@ -1974,6 +1993,13 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
   */
   get keepAllCategoriesExpanded(): boolean;
   set keepAllCategoriesExpanded(val: boolean);
+  /*
+  * Specifies whether to display category titles in the Toolbox.
+  * 
+  * If you disable this property, the Toolbox hides the titles but continues to display horizontal lines that divide categories. To remove these lines as well, call the `removeCategories()` method.
+  */
+  get showCategoryTitles(): boolean;
+  set showCategoryTitles(val: boolean);
   updateTitles(): void;
   /*
   * Change the category of the toolbox item
@@ -1983,6 +2009,10 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
   * Change categories for several toolbox items.
   */
   changeCategories(changedItems: any): void;
+  /*
+  * Removes categories from the Toolbox.
+  */
+  removeCategories(): void;
   toggleCategoryState(categoryName: string): void;
   /*
   * Expand a category by its name. If allowExpandMultipleCategories is false (default value), all other categories become collapsed
@@ -2097,15 +2127,30 @@ export declare class SidebarTabModel extends Base {
   model: any;
   componentName: string;
 }
+export declare class StringEditorConnector extends Base {
+  constructor(locString: LocalizableString);
+  static get(locString: LocalizableString): StringEditorConnector;
+  setAutoFocus(): void;
+  hasEditCompleteHandler: boolean;
+  focusOnEditor: boolean;
+  activateEditor(): void;
+  setItemValue(item: ItemValueWrapperViewModel): void;
+  onDoActivate: Event<(sender: StringEditorViewModelBase, options: any) => any, any>;
+  onEditComplete: Event<(sender: StringEditorViewModelBase, options: any) => any, any>;
+}
 export declare class StringEditorViewModelBase extends Base {
   constructor(locString: LocalizableString, creator: CreatorBase);
   blurredByEscape: boolean;
   focusedProgram: boolean;
   valueBeforeEdit: string;
+  connector: StringEditorConnector;
+  getEditorElement: any;
   errorText: string;
   focused: boolean;
   editAsText: boolean;
   compostionInProgress: boolean;
+  afterRender(): void;
+  activate(): void;
   setLocString(locString: LocalizableString): void;
   checkConstraints(event: any): void;
   blurEditor: any;
@@ -2762,6 +2807,7 @@ export declare class EmptySurveyCreatorOptions implements ISurveyCreatorOptions
   onConditionQuestionsGetListCallback(propertyName: string, obj: Base, editor: any, list: any): string;
   onConditionGetTitleCallback(expression: string, title: string): string;
   onLogicGetTitleCallback(expression: string, displayExpression: string, text: string, logicItem: any): string;
+  getTranslationExportedText(obj: Base, name: string, locString: ILocalizableString, locale: string, text: string): string;
 }
 export declare class ImageItemValueWrapperViewModel extends ItemValueWrapperViewModel {
   constructor(creator: CreatorBase, question: QuestionSelectBase, item: ImageItemValue, templateData: any, itemsRoot: any);
@@ -3055,6 +3101,7 @@ export declare class TranslationItem extends TranslationItemBase {
   name: string;
   locString: ILocalizableString;
   defaultValue: string;
+  context: any;
   hashValues: any;
   customText: string;
   afterRender: any;
@@ -3070,6 +3117,9 @@ export declare class TranslationItem extends TranslationItemBase {
   fillLocales(locales: any): void;
   toJSON(): any;
   mergeLocaleWithDefault(loc: string): void;
+  getPlaceholder(locale: string): string;
+  getTextForExport(loc: string): string;
+  getPlaceholderText(loc: string): string;
 }
 export declare class UndoRedoAction implements IUndoRedoAction {
   constructor(_propertyName: string, _oldValue: any, _newValue: any, _sender: Base);