survey-creator-core 1.9.24 → 1.9.27

package/survey-creator-core.d.ts

@@ -1,12 +1,12 @@
 /*
-* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.24
+* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.27
 * 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, 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 { IAction, SurveyModel, 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 { ComputedUpdater, QuestionCheckboxModel, ILocalizableString, ArrayChanges, ImageItemValue } from "survey-core";
@@ -217,7 +217,13 @@ export interface ICreatorPlugin {
   dispose?: any;
   model: Base;
 }
-export interface ITabbedMenuItem extends IAction {
+export interface ICreatorAction extends IAction {
+  locTitleName?: string;
+  locTooltipName?: string;
+  onUpdateTitle?: any;
+  onUpdateTooltip?: any;
+}
+export interface ITabbedMenuItem extends ICreatorAction {
   componentContent: string;
   renderTab?: any;
 }
@@ -245,6 +251,14 @@ export declare class ConditionEditorItemsBuilder {
   constructor(hasValue?: any);
   build(text: string): Array<ConditionEditorItem>;
 }
+export declare class CreatorAction extends Action implements ICreatorAction {
+  constructor(item: ICreatorAction);
+  locTitleName: string;
+  locTooltipName: string;
+  onUpdateTitle: any;
+  onUpdateTooltip: any;
+  updateTitle(): void;
+}
 /*
 * Base class for Survey Creator.
 */
@@ -394,6 +408,18 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   onGetObjectDisplayName: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
+  * This event is raised after a user has edited a text value on the design surface. This value may include HTML markup. You can handle the `onHtmlToMarkdown` event to convert the HTML markup to Markdown.
+  * 
+  * The event handler accepts the following arguments:
+  * 
+  * - `sender` - A Survey Creator instance that raised the event.
+  * - `options.element` - The instance of a survey element (survey, page, panel, question) that the user configures.
+  * - `options.name` - The name of a property whose value has been edited.
+  * - `options.html` - HTML content. Pass this field's value to an HTML-to-Markdown converter.
+  * - `options.text` - A text string that may contain Markdown. Assign the result of the HTML-to-Markdown conversion to this field.
+  */
+  onHtmlToMarkdown: Event<(sender: CreatorBase, options: any) => any, any>;
+  /*
   * Use this event to disable user interactions with a question or panel on the design surface.
   * 
   * The event handler accepts the following arguments:
@@ -508,8 +534,8 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   * <br/> options.editorOptions  options that can be changed.
   * <br/> options.editorOptions.allowAddRemoveItems a boolean property, true by default. Set it false to disable add/remove items in array properties. For example 'choices', 'columns', 'rows'.
   * <br/> options.editorOptions.allowRemoveAllItems a boolean property, true by default. Set it false to disable remove all items in array properties. For example 'choices', 'columns', 'rows'.
-  * <br/> options.editorOptions.showTextView a boolean property, true by default. Set it false to disable "Fast Entry" tab for "choices" property.
-  * <br/> options.editorOptions.itemsEntryType a string property, 'form' by default. Set it 'fast' to show "Fast Entry" tab for "choices" property by default.
+  * <br/> options.editorOptions.showTextView a boolean property, true by default. Set it false to disable "Manual Entry" tab for "choices" property.
+  * <br/> options.editorOptions.itemsEntryType a string property, 'form' by default. Set it 'fast' to show "Manual Entry" tab for "choices" property by default.
   */
   onSetPropertyEditorOptions: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
@@ -801,13 +827,19 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   /*
   * Returns the localized string by its id
   */
-  getLocString(str: string): any;
+  getLocString(str: string): string;
   /*
   * Set it to false to suppress an alert message about error on saving the survey into database.
   */
   showErrorOnFailedSave: boolean;
   protected onSetReadOnly(newVal: boolean): void;
   /*
+  * Gets or sets the survey locale. The default value it is empty, this means the 'en' locale is used.
+  * You can set it to 'de' - German, 'fr' - French and so on.
+  */
+  get locale(): string;
+  set locale(val: string);
+  /*
   * A boolean property, false by default. Set it to true to deny editing.
   */
   get readOnly(): boolean;
@@ -1113,6 +1145,13 @@ export declare class CreatorResponsivityManager {
   process(): void;
   dispose(): void;
 }
+export declare class DescriptionMardownParser {
+  static boldRegEx: any;
+  static italicRegEx: any;
+  static codeRegEx: any;
+  static linkRegEx: any;
+  parse(text: string): string;
+}
 export declare class DesignTimeSurveyModel extends SurveyModel {
   constructor(creator: CreatorBase, jsonObj?: any);
   creator: CreatorBase;
@@ -1143,6 +1182,29 @@ export declare class EditableObject {
   applyAll(excludedProps?: any): void;
   protected createEditableObj(): Base;
 }
+export declare class EditorLocalization {
+  camelCaseBreaking: boolean;
+  currentLocale: string;
+  locales: any;
+  peByClass: any;
+  peHelpByClass: any;
+  reset(): void;
+  getString(strName: string, locale?: string): string;
+  hasString(strName: string, locale?: string): boolean;
+  getLocaleName(loc: string, defaultLocale?: string): string;
+  getPropertyName(strName: string, defaultName?: string): string;
+  getPropertyTitle(strName: string): string;
+  getPropertyNameInEditor(typeName: string, propName: string, defaultName?: string): string;
+  getPropertyHelpInEditor(typeName: string, propName: string, propType?: string): string;
+  getProperty(strName: string, defaultName?: string): string;
+  convertToCamelCase(value: string, toLowCase?: boolean): string;
+  getPropertyValueInEditor(propName: string, value: any): string;
+  getPropertyValue(value: any, locale?: string): string;
+  getValidatorName(name: string, locale?: string): string;
+  getTriggerName(name: string, locale?: string): string;
+  getLocale(locale?: string): any;
+  getLocales(): Array<any>;
+}
 export declare class EmbedModel extends Base {
   constructor(creator: CreatorBase);
   survey: SurveyModel;
@@ -1183,8 +1245,8 @@ export declare class ItemValueWrapperViewModel extends Base {
   add(model: ItemValueWrapperViewModel): void;
   remove(model: ItemValueWrapperViewModel): void;
   get allowRemove(): boolean;
-  get tooltip(): any;
-  get dragTooltip(): any;
+  get tooltip(): string;
+  get dragTooltip(): string;
   get allowAdd(): boolean;
   select(model: ItemValueWrapperViewModel, event: any): void;
 }
@@ -1225,7 +1287,7 @@ export declare class LogoImageViewModel extends Base {
   get survey(): SurveyModel;
   chooseFile(model: LogoImageViewModel): void;
   remove(model: LogoImageViewModel): void;
-  get chooseLogoPlaceholder(): any;
+  get chooseLogoPlaceholder(): string;
 }
 export declare class MatrixCellWrapperViewModel extends Base {
   constructor(creator: CreatorBase, templateData: any, question: Question, row: any, column: any);
@@ -1293,7 +1355,7 @@ export declare class PageNavigatorViewModel extends Base {
   isPopupOpened: boolean;
   protected createActionBarCore(item: IAction): Action;
   togglePageSelector: any;
-  get pageSelectorCaption(): any;
+  get pageSelectorCaption(): string;
   onContainerScroll(viewPort: any): any;
   currentPage: PageModel;
 }
@@ -1315,14 +1377,6 @@ export declare class PagesController extends Base {
   onSurveyChanged(): void;
   dispose(): void;
 }
-export declare class PropertiesHelpTexts {
-  constructor();
-  static instanceValue: PropertiesHelpTexts;
-  static get instance(): PropertiesHelpTexts;
-  locsCache: any;
-  reset(): void;
-  getHelpText(obj: Base, prop: JsonObjectProperty): string;
-}
 export declare class PropertyGridModel {
   constructor(obj?: Base, options?: ISurveyCreatorOptions);
   surveyValue: SurveyModel;
@@ -1506,6 +1560,7 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
   */
   get keepAllCategoriesExpanded(): boolean;
   set keepAllCategoriesExpanded(val: boolean);
+  updateTitles(): void;
   /*
   * Change the category of the toolbox item
   */
@@ -1636,6 +1691,7 @@ export declare class StringEditorViewModelBase extends Base {
   valueBeforeEdit: string;
   errorText: string;
   focused: boolean;
+  editAsText: boolean;
   setLocString(locString: LocalizableString): void;
   checkConstraints(event: any): void;
   blurEditor: any;
@@ -1777,7 +1833,7 @@ export declare class SurveyLogic extends Base implements ISurveyLogicItemOwner {
   */
   get mode(): string;
   set mode(val: string);
-  getLocString(name: string): any;
+  getLocString(name: string): string;
   getTypeByName(name: string): SurveyLogicType;
   update(survey?: SurveyModel, options?: ISurveyCreatorOptions): void;
   get optionsReadOnly(): boolean;
@@ -1827,7 +1883,7 @@ export declare class SurveyLogicAction {
   get logicTypeDescription(): string;
   get text(): string;
   get deleteActionText(): string;
-  getLocString(name: string): any;
+  getLocString(name: string): string;
   isSuitableByQuestionName(questionName: string): boolean;
   isSuitableByLogicType(logicTypeName: string): boolean;
   addQuestionNames(names: any): void;
@@ -1847,7 +1903,7 @@ export declare class SurveyLogicItem {
   get name(): string;
   get survey(): SurveyModel;
   getVisibleLogicTypes(): Array<SurveyLogicType>;
-  get expressionText(): any;
+  get expressionText(): string;
   get actionsText(): any;
   getDisplayText(): any;
   edit(): void;
@@ -1958,12 +2014,12 @@ export declare class SurveyResultsModel extends Base {
   resultViewType: string;
   resultText: string;
   resultData: any;
-  getLocString(name: string): any;
-  get surveyResultsText(): any;
-  get resultsTitle(): any;
-  get resultsName(): any;
-  get resultsValue(): any;
-  get resultsDisplayValue(): any;
+  getLocString(name: string): string;
+  get surveyResultsText(): string;
+  get resultsTitle(): string;
+  get resultsName(): string;
+  get resultsValue(): string;
+  get resultsDisplayValue(): string;
   get isTableSelected(): boolean;
   get isJsonSelected(): boolean;
   selectTableClick: any;
@@ -1978,6 +2034,14 @@ export declare class SurveySimulatorModel extends Base {
   considerDPI: boolean;
   simulatorEnabled: boolean;
   simulatorScaleEnabled: boolean;
+  currZoomScale: number;
+  get zoomScale(): number;
+  activateZoom: any;
+  deactivateZoom: any;
+  listenTryToZoomWithWheel: any;
+  listenTryToZoom: any;
+  tryToZoom(data: any, event: any): boolean;
+  resetZoomParameters(): void;
   get activeDevice(): string;
   set activeDevice(val: string);
   get landscapeOrientation(): boolean;
@@ -2022,11 +2086,6 @@ export declare class TabDesignerViewModel extends Base {
 export declare class TabbedMenuContainer extends AdaptiveActionContainer<TabbedMenuItem> {
   constructor();
 }
-export declare class TabbedMenuItem extends Action implements ITabbedMenuItem {
-  constructor(item: ITabbedMenuItem);
-  componentContent: string;
-  renderTab: any;
-}
 export declare class TestSurveyTabViewModel extends Base {
   constructor(surveyProvider: CreatorBase, startTheme?: any);
   json: any;
@@ -2437,11 +2496,9 @@ export declare class TabJsonEditorBasePlugin implements ICreatorPlugin {
 }
 export declare class TabLogicPlugin implements ICreatorPlugin {
   constructor(creator: CreatorBase);
-  filterQuestionAction: Action;
-  filterActionTypeAction: Action;
-  fastEntryAction: Action;
-  showAllQuestionsText: any;
-  showAllActionTypesText: any;
+  filterQuestionAction: CreatorAction;
+  filterActionTypeAction: CreatorAction;
+  fastEntryAction: CreatorAction;
   model: SurveyLogicUI;
   activate(): void;
   update(): void;
@@ -2487,7 +2544,7 @@ export declare class TabTranslationPlugin implements ICreatorPlugin {
   activate(): void;
   update(): void;
   deactivate(): boolean;
-  get selectLanguageOptionsCaption(): any;
+  get selectLanguageOptionsCaption(): string;
   get showAllStringsText(): string;
   get showUsedStringsOnlyText(): string;
   get showAllPagesText(): string;
@@ -2495,6 +2552,11 @@ export declare class TabTranslationPlugin implements ICreatorPlugin {
   get importFromCSVText(): string;
   createActions(): any;
 }
+export declare class TabbedMenuItem extends CreatorAction implements ITabbedMenuItem {
+  constructor(item: ITabbedMenuItem);
+  componentContent: string;
+  renderTab: any;
+}
 export declare class TextareaJsonEditorModel extends JsonEditorBaseModel {
   constructor(creator: CreatorBase);
   protected _text: string;
@@ -2529,7 +2591,7 @@ export declare class TranslationGroup extends TranslationItemBase {
   get groups(): any;
   get isGroup(): boolean;
   get locales(): any;
-  get removeLocaleText(): any;
+  get removeLocaleText(): string;
   get localeCount(): number;
   get locWidth(): string;
   getLocaleName(loc: string): string;
@@ -2738,7 +2800,7 @@ export declare class PropertyGridEditorMatrix extends PropertyGridEditor {
   getJSON(obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions): any;
   protected getMatrixJSON(obj: Base, prop: JsonObjectProperty, propNames: any, options: ISurveyCreatorOptions): any;
   protected getHideColumnsEmpty(prop: JsonObjectProperty): boolean;
-  protected getEmptyRowsText(props: any): any;
+  protected getEmptyRowsText(props: any): string;
   protected getMaximumRowCount(obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions): number;
   protected getColumnsJSON(obj: Base, prop: JsonObjectProperty, propNames: any, options: ISurveyCreatorOptions): any;
   protected getEditItemAsStandAlone(): boolean;
@@ -2786,8 +2848,8 @@ export declare class QuestionRatingAdornerViewModel extends QuestionAdornerViewM
   removeItem(model: QuestionRatingAdornerViewModel): void;
   get allowAdd(): boolean;
   get allowRemove(): boolean;
-  get addTooltip(): any;
-  get removeTooltip(): any;
+  get addTooltip(): string;
+  get removeTooltip(): string;
 }
 export declare class TabJsonEditorAcePlugin extends TabJsonEditorBasePlugin implements ICreatorPlugin {
   constructor(creator: CreatorBase);
@@ -2871,7 +2933,7 @@ export declare class PropertyGridEditorMatrixItemValues extends PropertyGridEdit
   protected getDefaulColumnNames(): Array<any>;
   protected getKeyValue(): string;
   protected getHideColumnsEmpty(prop: JsonObjectProperty): boolean;
-  protected getEmptyRowsText(prop: any): any;
+  protected getEmptyRowsText(prop: any): string;
   protected getMaximumRowCount(obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions): number;
 }
 export declare class PropertyGridEditorMatrixMultipleTypes extends PropertyGridEditorMatrix {
@@ -3006,7 +3068,7 @@ export declare class PropertyGridTriggerValueInLogicEditor extends PropertyGridT
   fit(prop: JsonObjectProperty, context?: string): boolean;
   getJSON(obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions): any;
 }
-export declare function getLocString(strName: string, locale?: string): any;
+export declare function getLocString(strName: string, locale?: string): string;
 export declare function getNextValue(prefix: string, values: any): string | number;
 export declare function findParentNode(className: string, sourceNode: any): any;
 export declare function focusFirstControl(renderedElements: any): void;
@@ -3021,38 +3083,20 @@ export declare function copyObject(dst: any, src: any): void;
 export declare function copyCssClasses(dest: any, source: any): void;
 export declare function assignDefaultV2Classes(destination: any, questionType: string): void;
 export declare function wrapTextByCurlyBraces(text: string): string;
-export declare function getLogicString(name: string): any;
+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;
 export declare function findAction(actions: any, id: string): IAction;
 export declare function updateMatrixLogicExpandAction(question: QuestionMatrixDynamicModel, actions: any, row: MatrixDynamicRowModel): void;
 export declare function updateMatrixLogicRemoveAction(question: QuestionMatrixDynamicModel, actions: any, row: MatrixDynamicRowModel): void;
 export declare function updateMatrixRemoveAction(question: QuestionMatrixDynamicModel, actions: any, row: MatrixDynamicRowModel): void;
-export declare function setSurveyJSONForPropertyGrid(json: any, updateOnTyping?: boolean, titleLocationLeft?: boolean): void;
 export declare function getElementWrapperComponentName(element: any, reason: string, isPopupEditorContent: boolean): string;
 export declare function getQuestionContentWrapperComponentName(element: any): string;
 export declare function getElementWrapperComponentData(element: any, reason: string, creator: CreatorBase): any;
 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 var editorLocalization: {
-  camelCaseBreaking: boolean,
-  currentLocale: string,
-  locales: any,
-  getString: any,
-  hasString: any,
-  getLocaleName: any,
-  getPropertyName: any,
-  getPropertyTitle: any,
-  getPropertyNameInEditor: any,
-  getProperty: any,
-  convertToCamelCase: any,
-  getAutoPropertyName: any,
-  getPropertyValue: any,
-  getValidatorName: any,
-  getTriggerName: any,
-  getLocale: any,
-  getValueInternal: any,
-  getLocales: any,
-};
+export declare var editorLocalization: EditorLocalization;
 export declare var defaultStrings: any;
 export declare var settings: {
   translation: {
@@ -3431,6 +3475,14 @@ export declare var propertyGridCss: {
       buttonCollapsed: string,
     },
   },
+  actionBar: {
+    root: string,
+    item: string,
+    itemPressed: string,
+    itemAsIcon: string,
+    itemIcon: string,
+    itemTitle: string,
+  },
 };
 export declare var json: {
   name: string,
@@ -4246,6 +4298,7 @@ export declare var logicCss: {
   embeddedsurvey: {
     mainRoot: string,
   },
+  actionBar: any,
 };
 export declare var initialSettingsAllowShowEmptyTitleInDesignMode: boolean;
 export declare var editableStringRendererName: any;