survey-creator-core 1.9.47 → 1.9.48

package/survey-creator-core.d.ts

@@ -1,15 +1,15 @@
 /*
-* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.47
+* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.48
 * 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, 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, Operand, DragOrClickHelper, PanelModel, QuestionDropdownModel } from "survey-core";
-import { ListModel, PopupModel, EventBase, PanelModelBase, QuestionNonValue } from "survey-core";
-import { SurveyTemplateRendererTemplateData, QuestionRatingModel, ComputedUpdater, QuestionCheckboxModel, ILocalizableString } from "survey-core";
+import { IPanel, ISurveyElement, SurveyElement, QuestionSelectBase, Operand } from "survey-core";
+import { DragOrClickHelper, PanelModel, QuestionDropdownModel, ListModel, PopupModel } from "survey-core";
+import { EventBase, PanelModelBase, QuestionNonValue, SurveyTemplateRendererTemplateData, QuestionRatingModel } from "survey-core";
+import { QuestionRowModel, LocalizableString, ComputedUpdater, QuestionCheckboxModel, ILocalizableString } from "survey-core";
 import { ArrayChanges, ImageItemValue, HashTable, QuestionMatrixDynamicModel, QuestionMatrixModel } from "survey-core";
 import { QuestionMatrixDropdownModel, QuestionPanelDynamicModel, QuestionCommentModel, MatrixDynamicRowModel } from "survey-core";
 
@@ -42,7 +42,7 @@ export interface ISurveyCreatorOptions {
   maximumChoicesCount: number;
   maximumRowsCount: number;
   maximumRateValues: number;
-  getObjectDisplayName(obj: Base, reason: string, displayName: string): string;
+  getObjectDisplayName(obj: Base, area: string, 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;
@@ -340,7 +340,7 @@ export interface ICreatorSelectionOwner {
   survey: SurveyModel;
   selectElement(el: Base, propertyName?: string): any;
   selectedElement: Base;
-  getObjectDisplayName(el: Base): string;
+  getObjectDisplayName(el: Base, area: string): string;
 }
 export interface ISelectionHistoryItem {
   obj: Base;
@@ -399,6 +399,7 @@ export interface IPropertyGridEditor {
   getJSON(obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions): any;
   showModalPropertyEditor?: (editor: IPropertyGridEditor, property: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions) => any;
   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;
   createPropertyEditorSetup?: (obj: Base, prop: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions) => IPropertyEditorSetup;
   isPropertyEditorSetupEnabled?: (obj: Base, prop: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions) => boolean;
@@ -653,21 +654,34 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   */
   onSurveyInstanceCreated: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
-  * The event allows to display the custom name for objects: questions, pages and panels. By default the object name is using. You may show object title by setting showObjectTitles property to true.
-  * Use this event, if you want custom display name for objects.
-  * - sender the survey creator object that fires the event
-  * - options.obj the survey object, Survey, Page, Panel or Question
-  * - options.reason the name of the UI that requests the object display name.
-  * - options.displayName change this property to show your custom display name for the object
+  * An event that is raised when Survey Creator obtains a survey element name to display it in the UI.
+  * 
+  * Handle this event to replace survey element names in the UI with custom display texts.
+  * If you only want to replace the names with survey element titles, enable the [`showObjectTitles`](https://surveyjs.io/survey-creator/documentation/surveycreator#showObjectTitles) property instead of handling this event.
+  * 
+  * The event handler accepts the following arguments:
   * 
-  * The list of possible values in options.reason:
-  * - "condition" - raised from Condition modal window or on setup condition in a logic tab
-  * - "survey-tester" - raised from page selector list in "Preview" tab
-  * - "survey-tester-selected" - raised on setting page selector title in "Preview" tab
-  * - "survey-translation" - raised from translation tab
-  * - "property-editor" - raised on showing question property editor, for example "gotoName". It is raised for all elements (questions) in the dropdown.
-  * - "property-grid" - raised from showing object selector for property grid in "Designer" tab.
-  * - "property-grid-title" - raised on rendering selected object title in property grid in "Designer" tab.
+  * - `sender`- A Survey Creator instance that raised the event.
+  * - `options.obj` - The instance of a survey element (survey, page, question, or panel) whose name has been requested.
+  * - `options.area` - A Survey Creator UI element that requests the display name.
+  *   - `"page-selector"` - Page selector on the design surface
+  *   - `"condition-editor"` - Condition pop-up window or drop-down menus that allow users to select questions in the Logic tab
+  *   - `"logic-tab:question-filter"` - Question filter in the Logic tab
+  *   - `"preview-tab:page-list"` - Page list in the Preview tab
+  *   - `"preview-tab:selected-page"` - Selected page name in the Preview tab
+  *   - `"property-grid:property-editor"` - Property editors in the Property Grid
+  *   - `"property-grid-header:element-list"` - Survey element list in the header of the Property Grid
+  *   - `"property-grid-header:selected-element"` - Selected survey element in the header of the Property Grid
+  *   - `"translation-tab"` - Translation tab
+  * - `options.displayName` - Modify this property to set a custom display text for the survey element.
+  * - `options.reason` - Obsolete. Use the `options.area` property instead.
+  *   - `"condition"` - Use the `"condition-editor"` value of `options.area` instead.
+  *   - `"survey-tester"` - Use the `"preview-tab:page-list"` value of `options.area` instead.
+  *   - `"survey-tester-selected"` - Use the `"preview-tab:selected-page"` value of `options.area` instead.
+  *   - `"survey-translation"` - Use the `"translation-tab"` value of `options.area` instead.
+  *   - `"property-editor"` - Use the `"property-grid:property-editor"` value of `options.area` instead.
+  *   - `"property-grid"` - Use the `"property-grid-header:element-list"` value of `options.area` instead.
+  *   - `"property-grid-title"` - Use the `"property-grid-header:selected-element"` value of `options.area` instead.
   */
   onGetObjectDisplayName: Event<(sender: CreatorBase, options: any) => any, any>;
   /*
@@ -1349,7 +1363,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
   get text(): string;
   set text(val: string);
   getSurveyJSON(): any;
-  getObjectDisplayName(obj: Base, reason?: string, displayName?: string): string;
+  getObjectDisplayName(obj: Base, area: string, reason?: string, displayName?: string): string;
   createSurvey(json?: any, reason?: string): SurveyModel;
   protected createSurveyCore(json: any, reason: string): SurveyModel;
   _stateValue: string;
@@ -1536,20 +1550,6 @@ export declare class DescriptionMardownParser {
   static linkRegEx: any;
   parse(text: string): string;
 }
-export declare class DesignTimeSurveyModel extends SurveyModel {
-  constructor(creator: CreatorBase, jsonObj?: any);
-  creator: CreatorBase;
-  isPopupEditorContent: boolean;
-  getElementWrapperComponentName(element: any, reason?: string): string;
-  getQuestionContentWrapperComponentName(element: any, reason?: string): string;
-  getElementWrapperComponentData(element: any, reason?: string): any;
-  getRowWrapperComponentName(row: QuestionRowModel): string;
-  getRowWrapperComponentData(row: QuestionRowModel): any;
-  getItemValueWrapperComponentName(item: ItemValue, question: QuestionSelectBase): string;
-  getItemValueWrapperComponentData(item: ItemValue, question: QuestionSelectBase): any;
-  getRendererForString(element: Base, name: string): string;
-  getRendererContextForString(element: Base, locStr: LocalizableString): any;
-}
 export declare class EditableObject {
   constructor(obj: Base);
   static isCopyObject(obj: any): boolean;
@@ -1700,7 +1700,7 @@ export declare class Notifier extends Base {
   notify(message: string, type?: "info" | "error"): void;
 }
 export declare class ObjectSelector {
-  constructor(creator: CreatorBase, survey: SurveyModel, getObjectDisplayName?: (obj: Base, reason: string, displayName: string) => string);
+  constructor(creator: CreatorBase, survey: SurveyModel, getObjectDisplayName?: (obj: Base, area: string, reason: string, displayName: string) => string);
   surveyValue: SurveyModel;
   deepestLevel: number;
   filteredTextInLow: string;
@@ -1719,7 +1719,7 @@ export declare class ObjectSelectorItem extends Action {
   hasText(filteredTextInLow: string): boolean;
 }
 export declare class ObjectSelectorModel extends Base {
-  constructor(creator: CreatorBase, getObjectDisplayName?: (obj: Base, reason: string, displayName: string) => string);
+  constructor(creator: CreatorBase, getObjectDisplayName?: (obj: Base, area: string, reason: string, displayName: string) => string);
   selector: ObjectSelector;
   listModelValue: ListModel;
   isVisible: boolean;
@@ -1824,7 +1824,9 @@ export declare class QuestionConverter {
 }
 export declare class QuestionEmbeddedSurveyModel extends QuestionNonValue {
   constructor(name: string);
-  embeddedSurvey: SurveyModel;
+  embeddedSurveyValue: SurveyModel;
+  onEmbeddedSurveyValueChanged: any;
+  get embeddedSurvey(): SurveyModel;
   getType(): string;
 }
 export declare class QuestionLinkValueModel extends Question {
@@ -2604,7 +2606,7 @@ export declare class Translation extends Base implements ITranslationLocales {
   protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
   get survey(): SurveyModel;
   set survey(val: SurveyModel);
-  reset(): void;
+  reset(resetSelectedLocales?: boolean): void;
   canShowProperty(obj: Base, prop: JsonObjectProperty, isEmpty: boolean): boolean;
   get defaultLocale(): string;
   getLocaleName(loc: string): string;
@@ -2726,7 +2728,7 @@ export declare class EmptySurveyCreatorOptions implements ISurveyCreatorOptions
   maximumChoicesCount: number;
   maximumRowsCount: number;
   maximumRateValues: number;
-  getObjectDisplayName(obj: Base, reason: string, displayName: string): string;
+  getObjectDisplayName(obj: Base, area: string, 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;
@@ -3534,6 +3536,7 @@ 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 initializeDesignTimeSurveyModel(model: any, creator: CreatorBase): 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;
@@ -4162,6 +4165,7 @@ export declare var PropertyGridEditorCollection: {
   isEditorFit: (prop: JsonObjectProperty, asDefault?: boolean) => IPropertyGridEditor,
   getJSON: (obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions, context?: string) => any,
   onCreated: (obj: Base, question: Question, prop: JsonObjectProperty, options: ISurveyCreatorOptions) => any,
+  validateValue: (obj: Base, question: Question, prop: JsonObjectProperty, value: any) => string,
   onAfterRenderQuestion: (obj: Base, prop: JsonObjectProperty, evtOptions: any) => void,
   onMatrixCellCreated: (obj: Base, prop: JsonObjectProperty, options: any) => void,
   onMatrixCellValueChanged: (obj: Base, prop: JsonObjectProperty, options: any) => void,

package/survey-creator-core.i18n.js

@@ -1,5 +1,5 @@
 /*!
- * SurveyJS Creator v1.9.47
+ * SurveyJS Creator v1.9.48
  * (c) 2015-2022 Devsoft Baltic OÜ - http://surveyjs.io/
  * Github: https://github.com/surveyjs/survey-creator
  * License: https://surveyjs.io/Licenses#SurveyCreator

package/survey-creator-core.i18n.min.js

@@ -1,5 +1,5 @@
 /*!
- * SurveyJS Creator v1.9.47
+ * SurveyJS Creator v1.9.48
  * (c) 2015-2022 Devsoft Baltic OÜ - http://surveyjs.io/
  * Github: https://github.com/surveyjs/survey-creator
  * License: https://surveyjs.io/Licenses#SurveyCreator