survey-creator-core 1.9.6-beta.1 → 1.9.10-beta.1

package/survey-creator-core.d.ts

@@ -1,4 +1,4 @@
-/*Type definitions for SurveyJS Creator JavaScript library v1.9.6-beta.1
+/*Type definitions for SurveyJS Creator JavaScript library v1.9.10-beta.1
 (c) 2015-2022 Devsoft Baltic OÜ - http://surveyjs.io/
 Github: https://github.com/surveyjs/survey-creator
 License: https://surveyjs.io/Licenses#SurveyCreator
@@ -49,6 +49,7 @@ import { SurveyModel, Base, Question, SurveyElement } from "survey-core";
 import { SurveyModel, QuestionPanelDynamicModel, ItemValue, PanelModel, Base, Question, QuestionCommentModel } from "survey-core";
 import { SurveyModel, QuestionPanelDynamicModel, PanelModel, Question } from "survey-core";
 import { Base, AdaptiveActionContainer, Action, SurveyModel, SurveyElement } from "survey-core";
+import { Base, ItemValue, PanelModel, QuestionDropdownModel, SurveyModel } from "survey-core";
 
 
 import "../components/property-panel/property-panel-item.scss";
@@ -62,28 +63,6 @@ import "../components/side-bar/side-bar.scss";
 import "../property-grid-theme/property-grid.scss";
 import "../utils/design.scss";
 import "../utils/layout.scss";
-import "../localization/arabic";
-import "../localization/danish";
-import "../localization/french";
-import "../localization/german";
-import "../localization/finnish";
-import "../localization/italian";
-import "../localization/indonesian";
-import "../localization/korean";
-import "../localization/persian";
-import "../localization/polish";
-import "../localization/portuguese";
-import "../localization/simplified-chinese";
-import "../localization/spanish";
-import "../localization/swedish";
-import "../localization/traditional-chinese";
-import "../localization/turkish";
-import "../localization/norwegian";
-import "../localization/hungarian";
-import "../localization/russian";
-import "../localization/tajik";
-import "../localization/dutch";
-import "../localization/croatian";
 
 export declare var enStrings: {
     survey: {
@@ -198,6 +177,7 @@ export declare var enStrings: {
         translationLanguages: string;
         translationAddLanguage: string;
         translationShowAllStrings: string;
+        translationShowUsedStringsOnly: string;
         translationShowAllPages: string;
         translationNoStrings: string;
         translationExportToSCVButton: string;
@@ -212,6 +192,7 @@ export declare var enStrings: {
         chooseElement: string;
         htmlPlaceHolder: string;
         panelPlaceHolder: string;
+        surveyPlaceHolder: string;
         addNewQuestion: string;
         addNewTypeQuestion: string;
         chooseLogoPlaceholder: string;
@@ -1032,6 +1013,7 @@ export declare var defaultStrings: {
         translationLanguages: string;
         translationAddLanguage: string;
         translationShowAllStrings: string;
+        translationShowUsedStringsOnly: string;
         translationShowAllPages: string;
         translationNoStrings: string;
         translationExportToSCVButton: string;
@@ -1046,6 +1028,7 @@ export declare var defaultStrings: {
         chooseElement: string;
         htmlPlaceHolder: string;
         panelPlaceHolder: string;
+        surveyPlaceHolder: string;
         addNewQuestion: string;
         addNewTypeQuestion: string;
         chooseLogoPlaceholder: string;
@@ -1740,9 +1723,13 @@ export declare enum QuestionConvertMode {
         CompatibleTypes = 1
 }
 export declare var settings: {
-        traslation: {
+        translation: {
                 sortByName: boolean;
                 exportPrefix: string;
+                /**
+                    * The maximum number of locales that user can select at once for translation
+                    */
+                maximumSelectedLocales: number;
         };
         operators: {
                 empty: any[];
@@ -1758,11 +1745,7 @@ export declare var settings: {
                 greaterorequal: string[];
                 lessorequal: string[];
         };
-        defaultNewSurveyJSON: {
-                pages: {
-                        name: string;
-                }[];
-        };
+        defaultNewSurveyJSON: {};
         logic: {
                 visibleActions: any[];
                 logicItemTitleMaxChars: number;
@@ -1772,7 +1755,6 @@ export declare var settings: {
             */
         questionConvertMode: QuestionConvertMode;
         propertyGrid: {
-                allowCollapse: boolean;
                 useButtonGroup: boolean;
                 maxCharsInButtonGroup: number;
                 showNavigationButtons: boolean;
@@ -1806,6 +1788,7 @@ export declare var settings: {
         layout: {
                 showTabs: boolean;
                 showToolbar: boolean;
+                allowCollapseSidebar: boolean;
         };
         jsonEditor: {
                 indentation: number;
@@ -1918,7 +1901,7 @@ export declare class ToolbarActionContainer extends ActionContainer {
         constructor(creator: CreatorBase);
         protected getRenderedActions(): Array<Action>;
 }
-export declare type toolBoxLocationType = "left" | "right" | "insideSideBar" | "hidden";
+export declare type toolboxLocationType = "left" | "right" | "sidebar";
 /**
     * Base class for Survey Creator.
     */
@@ -2366,6 +2349,16 @@ export declare class CreatorBase<T extends SurveyModel = SurveyModel> extends Su
             * - `options.visible` - A Boolean value that specifies the property visibility. Set it to `false` to hide the property.
             */
         onTranslationStringVisibility: Survey.Event<(sender: CreatorBase<T>, options: any) => any, any>;
+        /**
+            * Use this event to define is the locale initially selected (default value) and ready for translaion or it is unselected.
+            *
+            * The event handler accepts the following arguments:
+            *
+            * - `sender` - A Survey Creator instance that raised the event.
+            * - `options.locale` - the locale name, like 'en', 'de' and so on.
+            * - `options.isSelected` - it is true by default. Set it to false to make the translation unselected.
+            */
+        onTranslationLocaleInitiallySelected: Survey.Event<(sender: CreatorBase<T>, options: any) => any, any>;
         /**
             * This callback is used internally for providing survey JSON text.
             */
@@ -2500,19 +2493,22 @@ export declare class CreatorBase<T extends SurveyModel = SurveyModel> extends Su
             * @param viewName name of new active view (tab). The following values are available: "designer", "editor", "test", "embed", "logic" and "translation".
             */
         makeNewViewActive(viewName: string): boolean;
-        static defaultNewSurveyText: string;
         toolbox: QuestionToolbox;
         get toolboxCategories(): Array<any>;
-        sideBar: SideBarModel;
+        sidebar: SidebarModel;
         constructor(options: ICreatorOptions, options2?: ICreatorOptions);
         updateToolboxIsCompact(newVal?: boolean): void;
         onSurveyElementPropertyValueChanged(property: Survey.JsonObjectProperty, obj: any, newValue: any): void;
-        get showToolbox(): "left" | "right" | "top" | "none" | boolean;
-        set showToolbox(val: "left" | "right" | "top" | "none" | boolean);
-        onShowPropertyGridVisiblityChanged: Survey.Event<(sender: CreatorBase<T>, options: any) => any, any>;
+        showToolboxValue: boolean;
+        get showToolbox(): boolean;
+        set showToolbox(val: boolean);
+        onShowSidebarVisiblityChanged: Survey.Event<(sender: CreatorBase<T>, options: any) => any, any>;
         /**
             * Set this this property grid false to hide the property grid.
             */
+        get showSidebar(): boolean;
+        set showSidebar(val: boolean);
+        onShowPropertyGridVisiblityChanged: Survey.Event<(sender: CreatorBase<T>, options: any) => any, any>;
         get showPropertyGrid(): boolean;
         set showPropertyGrid(val: boolean);
         rightContainerActiveItem(name: string): void;
@@ -2547,6 +2543,10 @@ export declare class CreatorBase<T extends SurveyModel = SurveyModel> extends Su
             * This method stops undo/redo transaction.
             */
         stopUndoRedoTransaction(): void;
+        /**
+            * Returns true if Creator is currently doing undo or redo opertaions
+            */
+        get isProcessingUndoRedo(): boolean;
         /**
             * This method performs undo uperation if possible.
             */
@@ -2799,9 +2799,10 @@ export declare class CreatorBase<T extends SurveyModel = SurveyModel> extends Su
         showPageNavigator: any;
         showTabs: any;
         showToolbar: any;
+        allowCollapseSidebar: any;
         isMobileView: any;
-        toolboxLocation: toolBoxLocationType;
-        sideBarLocation: "left" | "right";
+        toolboxLocation: toolboxLocationType;
+        sidebarLocation: "left" | "right";
         selectFromStringEditor: boolean;
 }
 export declare class StylesManager {
@@ -3111,6 +3112,7 @@ export declare class SurveyLogic extends Base implements ISurveyLogicItemOwner {
         protected hasErrorInUI(): boolean;
         protected getExpressionText(): string;
         protected getEditingActions(): Array<SurveyLogicAction>;
+        protected onReadOnlyChanged(): void;
         addNew(): void;
         editItem(item: SurveyLogicItem): void;
         protected onStartEditing(): void;
@@ -3217,6 +3219,7 @@ export declare class Translation extends Base implements ITranslationLocales {
     availableTranlationsChangedCallback: () => void;
     tranlationChangedCallback: (locale: string, name: string, value: string, context: any) => void;
     translationStringVisibilityCallback: (obj: Base, propertyName: string, visible: boolean) => boolean;
+    localeInitialVisibleCallback: (locale: string) => boolean;
     chooseLanguageActions: Array<IAction>;
     constructor(survey: SurveyModel, options?: ISurveyCreatorOptions, hasUI?: boolean);
     getType(): string;
@@ -3569,6 +3572,7 @@ export declare class TabTranslationPlugin implements ICreatorPlugin {
     deactivate(): boolean;
     get selectLanguageOptionsCaption(): any;
     get showAllStringsText(): string;
+    get showUsedStringsOnlyText(): string;
     get showAllPagesText(): string;
     get exportToCSVText(): string;
     get importFromCSVText(): string;
@@ -3576,15 +3580,18 @@ export declare class TabTranslationPlugin implements ICreatorPlugin {
 }
 
 import "./designer.scss";
+export declare const initialSettingsAllowShowEmptyTitleInDesignMode: boolean;
 export declare class TabDesignerViewModel<T extends SurveyModel> extends Base {
     newPage: PageModel;
     showNewPage: boolean;
     pageCount: number;
     withModifier: string;
+    showPlaceholder: boolean;
     creator: CreatorBase<T>;
     constructor(creator: CreatorBase<T>);
     get survey(): T;
     get isToolboxVisible(): boolean;
+    get placeholderText(): string;
     initSurvey(): void;
     dispose(): void;
     clickDesigner(): void;
@@ -3621,6 +3628,7 @@ export declare class SurveyLogicUI extends SurveyLogic {
     addNewUI(): void;
     toggleExpressionEditorIsFastEntry(): void;
     protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
+    protected onReadOnlyChanged(): void;
     get expressionEditor(): ConditionEditor;
     get itemEditor(): LogicItemEditor;
     getExpressionEditor(item: SurveyLogicItem): ConditionEditor;
@@ -4008,6 +4016,7 @@ export declare class PageViewModel<T extends SurveyModel> extends ActionContaine
     select(model: PageViewModel<T>, event: IPortableMouseEvent): void;
     get css(): string;
     hover(event: MouseEvent, element: HTMLElement): void;
+    hoverStopper(event: MouseEvent, element: HTMLElement): void;
     protected duplicate(): void;
     get allowEdit(): boolean;
     get addNewQuestionText(): string;
@@ -4336,8 +4345,9 @@ export declare var simulatorDevices: {
 import "./results.scss";
 export declare class SurveyResultsItemModel extends Base {
     collapsed: boolean;
+    lvl: number;
     items: Array<any>;
-    constructor(_data: any);
+    constructor(_data: any, _lvl: number);
     get data(): Array<any>;
     toggle: () => void;
     get isNode(): boolean;
@@ -4346,6 +4356,8 @@ export declare class SurveyResultsItemModel extends Base {
     get value(): any;
     get displayValue(): string;
     getString(data: any): string;
+    get markerMargin(): string;
+    get textMargin(): string;
 }
 export declare class SurveyResultsModel extends Base {
     constructor(survey: Survey.SurveyModel);
@@ -4358,8 +4370,10 @@ export declare class SurveyResultsModel extends Base {
     get resultsName(): any;
     get resultsValue(): any;
     get resultsDisplayValue(): any;
-    selectTableClick(model: SurveyResultsModel): void;
-    selectJsonClick(model: SurveyResultsModel): void;
+    get isTableSelected(): boolean;
+    get isJsonSelected(): boolean;
+    selectTableClick: () => void;
+    selectJsonClick: () => void;
 }
 
 import "./logo-image.scss";
@@ -4375,6 +4389,7 @@ export declare class LogoImageViewModel extends Base {
 
 export declare class StringEditorViewModelBase extends Base {
     errorText: string;
+    focused: boolean;
     constructor(locString: LocalizableString, creator: CreatorBase);
     setLocString(locString: LocalizableString): void;
     checkConstraints(event: any): void;
@@ -4446,7 +4461,7 @@ export interface IPropertyGridEditor {
     fit(prop: JsonObjectProperty, context?: string): boolean;
     isDefault?: () => boolean;
     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) => any;
     onCreated?: (obj: Base, question: Question, prop: JsonObjectProperty, options: ISurveyCreatorOptions) => void;
     onAfterRenderQuestion?: (obj: Base, prop: JsonObjectProperty, evtOptions: any) => void;
     createPropertyEditorSetup?: (obj: Base, prop: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions) => IPropertyEditorSetup;
@@ -4713,7 +4728,7 @@ export declare class PropertyGridEditorBindings extends PropertyGridEditor {
     fit(prop: JsonObjectProperty): boolean;
     getJSON(obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions): any;
     onMatrixCellCreated(obj: Base, options: any): void;
-    onMatrixCellValueChanged(obj: Base, options: any): void;
+    onCreated(obj: Base, question: Question, prop: JsonObjectProperty): void;
 }
 
 export declare class PropertyGridViewModel<T extends SurveyModel> extends Base {
@@ -4906,7 +4921,6 @@ export declare var propertyGridCss: {
         itemSvgIconId: string;
         labelChecked: string;
         itemControl: string;
-        itemDecorator: string;
         controlLabel: string;
         materialDecorator: string;
         other: string;
@@ -4940,7 +4954,6 @@ export declare var propertyGridCss: {
         svgIconId: string;
         label: string;
         disabledLabel: string;
-        itemDecorator: string;
         materialDecorator: string;
     };
     text: {
@@ -5179,7 +5192,7 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
         canCollapseCategories: boolean;
         isCompact: boolean;
         constructor(supportedQuestions?: Array<string>, creator?: CreatorBase<SurveyModel>);
-        setLocation(toolboxLocation: toolBoxLocationType): void;
+        setLocation(toolboxLocation: toolboxLocationType): void;
         /**
             * The Array of Toolbox items as Text JSON.
             */
@@ -5289,36 +5302,38 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
         dispose(): void;
 }
 
-export declare class SideBarModel extends Base {
+export declare class SidebarModel extends Base {
     toolbar: AdaptiveActionContainer;
-    tabs: Array<SideBarTabModel>;
+    tabs: Array<SidebarTabModel>;
     headerText: string;
     visible: boolean;
+    collapsedManually: boolean;
+    expandedManually: boolean;
     hasVisibleTabs: boolean;
     flyoutMode: boolean;
     activeTab: string;
     get flyoutPanelMode(): boolean;
     get closeText(): string;
-    getTabById(id: string): SideBarTabModel;
+    getTabById(id: string): SidebarTabModel;
     constructor(creator: CreatorBase, collapseAction?: () => void, expandAction?: () => void);
     getExpandAction(): Action;
-    collapseSideBar(): void;
-    expandSideBar(): void;
-    addTab(id: string, componentName?: string, model?: any, buildActions?: () => Array<Action>): SideBarTabModel;
+    collapseSidebar(): void;
+    expandSidebar(): void;
+    addTab(id: string, componentName?: string, model?: any, buildActions?: () => Array<Action>): SidebarTabModel;
     updateHasVisibleTabs(): void;
     dispose(): void;
     initResizeManager(container: HTMLDivElement): void;
     resetResizeManager(): void;
 }
 
-export declare class SideBarTabModel extends Base {
+export declare class SidebarTabModel extends Base {
     id: string;
-    sidePanel: SideBarModel;
+    sidePanel: SidebarModel;
     caption: string;
     visible: boolean;
     model: any;
     componentName: string;
-    constructor(id: string, sidePanel: SideBarModel, componentName?: string, model?: any);
+    constructor(id: string, sidePanel: SidebarModel, componentName?: string, model?: any);
 }
 
 export interface IPortableMouseEvent {
@@ -5452,6 +5467,7 @@ export declare class UndoRedoManager {
     canUndoRedoCallback(): void;
     startTransaction(name: string): void;
     stopTransaction(): void;
+    get isProcessingUndoRedo(): boolean;
     canUndo(): boolean;
     undo(): void;
     canRedo(): boolean;
@@ -5855,8 +5871,8 @@ export declare class LogicItemEditor extends PropertyEditorSetupValue {
     get isModified(): boolean;
     get panel(): QuestionPanelDynamicModel;
     get panels(): Array<PanelModel>;
-    getPanelByAction(action: SurveyLogicAction): PanelModel;
-    getActionByPanel(panel: PanelModel): SurveyLogicAction;
+    getActionModelByPanel(panel: PanelModel): LogicActionModelBase;
+    setActionModelByPanel(panel: PanelModel, actionModel: LogicActionModelBase): void;
     get context(): Question;
     set context(val: Question);
     protected getSurveyJSON(): any;
@@ -5906,7 +5922,7 @@ export interface IPropertyGridEditor {
     fit(prop: JsonObjectProperty, context?: string): boolean;
     isDefault?: () => boolean;
     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) => any;
     onCreated?: (obj: Base, question: Question, prop: JsonObjectProperty, options: ISurveyCreatorOptions) => void;
     onAfterRenderQuestion?: (obj: Base, prop: JsonObjectProperty, evtOptions: any) => void;
     createPropertyEditorSetup?: (obj: Base, prop: JsonObjectProperty, question: Question, options: ISurveyCreatorOptions) => IPropertyEditorSetup;
@@ -6051,3 +6067,37 @@ export declare class PropertyGridEditorQuestionValue extends PropertyGridEditorQ
     protected getItemValue(question: Question): any;
 }
 
+export declare class LogicActionModelBase {
+    protected panel: PanelModel;
+    initialLogicAction: SurveyLogicAction;
+    logicType: SurveyLogicType;
+    isTrigger: boolean;
+    currentLogicAction: SurveyLogicAction;
+    static createActionModel(panel: PanelModel, logicAction: SurveyLogicAction, logicType: SurveyLogicType, selectorElementsHash: any): LogicActionModelBase;
+    constructor(panel: PanelModel, initialLogicAction: SurveyLogicAction, logicType: SurveyLogicType);
+    updateCurrentLogicAction(survey: SurveyModel): boolean;
+    afterUpdateInitialLogicAction(): void;
+    resetElements(): void;
+    getSelectedElement(): string;
+    updateInitialLogicAction(): void;
+    setInitialElementValue(question: QuestionDropdownModel, action: SurveyLogicAction, selectedQuestion: string): void;
+}
+export declare class LogicActionModel extends LogicActionModelBase {
+    constructor(panel: PanelModel, logicAction: SurveyLogicAction, logicType: SurveyLogicType, selectorElementsHash: any);
+    updateCurrentLogicAction(survey: SurveyModel): boolean;
+    resetElements(): void;
+    updatePanelElements(selectedElement: string, choices: Array<ItemValue>): void;
+    getSelectedElement(): string;
+}
+export declare class LogicActionTriggerModel extends LogicActionModelBase {
+    isTrigger: boolean;
+    constructor(panel: PanelModel, logicAction: SurveyLogicAction, logicType: SurveyLogicType);
+    afterUpdateInitialLogicAction(): void;
+    updateCurrentLogicAction(survey: SurveyModel): boolean;
+    updatePanel(propertyName: string, newValue: any, options: ISurveyCreatorOptions, survey: SurveyModel): void;
+    setPanelObj(obj: Base): void;
+    resetElements(): void;
+    updatePanelElements(selectedElement: string, options?: ISurveyCreatorOptions): void;
+    getSelectedElement(): string;
+}
+