survey-creator-core 1.9.82 → 1.9.84

package/typings/creator-options.d.ts

@@ -0,0 +1,247 @@
+/**
+ * Survey Creator configuration. Pass it as an argument to the `SurveyCreator` constructor:
+ *
+ * ```js
+ * const creator = new SurveyCreator.SurveyCreator(creatorOptions);
+ * ```
+ */
+export interface ICreatorOptions {
+    [index: string]: any;
+    /**
+     * Specifies whether to display the Designer tab.
+     *
+     * Default value: `true`
+     */
+    showDesignerTab?: boolean;
+    /**
+     * Specifies whether to display the Preview tab.
+     *
+     * Default value: `true`
+     */
+    showPreviewTab?: boolean;
+    /**
+     * Specifies whether to display the JSON Editor tab.
+     *
+     * Default value: `true`
+     */
+    showJSONEditorTab?: boolean;
+    /**
+     * Specifies whether to display the Logic tab.
+     *
+     * Default value: `false`
+     */
+    showLogicTab?: boolean;
+    /**
+     * Specifies whether to display the Embed Survey tab.
+     *
+     * Default value: `false`
+     */
+    showEmbeddedSurveyTab?: boolean;
+    /**
+     * Specifies whether to display the Translation tab.
+     *
+     * Default value: `false`
+     */
+    showTranslationTab?: boolean;
+    /**
+     * Removes the Free Trial bar.
+     *
+     * Default value: `false`
+     *
+     * > You can enable this property only if you have a Survey Creator commercial license. It is illegal to enable this property without a license.
+     */
+    haveCommercialLicense?: boolean;
+    /**
+     * Specifies whether to call the [saveSurveyFunc](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#saveSurveyFunc) each time survey settings are changed.
+     *
+     * Default value: `false`
+     */
+    isAutoSave?: boolean;
+    /**
+     * Specifies whether to enable support for right-to-left languages.
+     *
+     * Default value: `false`
+     */
+    isRTL?: boolean;
+    /**
+     * Specifies whether users can see and edit the survey title and related survey properties.
+     *
+     * Default value: `true`
+     */
+    showSurveyTitle?: boolean;
+    /**
+     * Specifies whether users can edit expressions in the Logic tab as plain text.
+     *
+     * If you set this property to `false`, users can only use UI elements to edit logical expressions.
+     *
+     * Default value: `true`
+     *
+     * @see showLogicTab
+     */
+    allowEditExpressionsInTextEditor?: boolean;
+    /**
+     * Specifies whether to display question titles instead of names when users edit logical expressions.
+     *
+     * Default value: `false`
+     */
+    showTitlesInExpressions?: boolean;
+    /**
+     * Specifies whether to show an error message if a survey is not saved in the database.
+     *
+     * Default value: `true`
+     */
+    showErrorOnFailedSave?: boolean;
+    /**
+     * Specifies whether the Survey Creator generates the survey definition as a valid JSON object or JavaScript object.
+     *
+     * Default value: `true`
+     *
+     * Refer to the following MDN topic for information on differences between JSON and JavaScript objects: [JavaScript and JSON Differences](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON#javascript_and_json_differences)
+     */
+    generateValidJSON?: boolean;
+    /**
+     * Enables the read-only mode. If you set this property to `true`, users cannot change the initial survey configuration.
+     *
+     * Default value: `false`
+     */
+    readOnly?: boolean;
+    /**
+     * Specifies whether to show the page selector at the bottom of the Preview tab.
+     *
+     * Default value: `true`
+     */
+    showPagesInPreviewTab?: boolean;
+    /**
+     * A [UI theme](https://surveyjs.io/Documentation/Library?id=get-started-react#configure-styles) used to display the survey in the Preview tab.
+     *
+     * Accepted values: `"modern"`, `"default"`, `"defaultV2"`
+     *
+     * Default value: `"defaultV2"`
+     */
+    themeForPreview?: string;
+    /**
+     * Specifies whether the Preview tab displays the Device button that allows users to preview the survey on different device types.
+     *
+     * Default value: `true`
+     */
+    showSimulatorInPreviewTab?: boolean;
+    /**
+     * Specifies whether the Preview tab displays the language selector.
+     *
+     * Accepted values:
+     *
+     * - `"auto"` (default)
+     * Display the language selector only if the survey is translated into more than one language.
+     *
+     * - `true`
+     * Always display the language selector regardless of how many languages are used in the survey.
+     *
+     * - `false`
+     * Never display the language selector.
+     *
+     * - `"all"`
+     * Always display the language selector with [all supported languages](https://github.com/surveyjs/survey-creator/tree/master/packages/survey-creator-core/src/localization).
+     *
+     * **See also**: [Localization & Globalization](https://surveyjs.io/Documentation/Survey-Creator?id=localization)
+     */
+    showDefaultLanguageInPreviewTab?: boolean | string;
+    /**
+     * Specifies whether the Preview tab displays a checkbox that allows users to show or hide invisible survey elements.
+     *
+     * Default value: `true`
+     */
+    showInvisibleElementsInPreviewTab?: boolean;
+    /**
+     * Specifies whether UI elements display survey, page, and question titles instead of their names.
+     *
+     * Default value: `false`
+     */
+    showObjectTitles?: boolean;
+    /**
+     * Limits the number of visible choices. Users can click "Show more" to view hidden choices.
+     *
+     * Set this property to -1 if you do not want to hide any choices.
+     *
+     * Default value: 10
+     */
+    maxVisibleChoices?: number;
+    /**
+     * Specifies whether the design surface displays the survey title and description when the survey does not contain any elements.
+     *
+     * Default value: `false`
+     */
+    showHeaderInEmptySurvey?: boolean;
+    /**
+     * Specifies whether users can add, edit, and delete survey pages.
+     *
+     * Default value: `true`
+     */
+    allowModifyPages?: boolean;
+    /**
+     * Limits the number of columns that users can add to [Matrix](https://surveyjs.io/Documentation/Library?id=questionmatrixmodel), [Matrix Dynamic](https://surveyjs.io/Documentation/Library?id=questionmatrixdynamicmodel), and [Matrix Dropdown](https://surveyjs.io/Documentation/Library?id=questionmatrixdropdownmodel) questions.
+     *
+     * Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumColumnsCount`)
+     */
+    maximumColumnsCount?: number;
+    /**
+     * Limits the number of choices that users can add to [Checkbox](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel), [Dropdown](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel), and [Radiogroup](https://surveyjs.io/Documentation/Library?id=questionradiogroupmodel) questions.
+     *
+     * Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumChoicesCount`)
+     */
+    maximumChoicesCount?: number;
+    /**
+     * Limits the number of rows that users can add to [Matrix](https://surveyjs.io/Documentation/Library?id=questionmatrixmodel) and [Matrix Dropdown](https://surveyjs.io/Documentation/Library?id=questionmatrixdropdownmodel) questions.
+     *
+     * Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumRowsCount`)
+     */
+    maximumRowsCount?: number;
+    /**
+     * Limits the number of rate value that users can add to [Rating](https://surveyjs.io/Documentation/Library?id=questionratingmodel) questions.
+     *
+     * Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumRateValues`)
+     */
+    maximumRateValues?: number;
+    /**
+     * Limits the number of items in a logical expression.
+     *
+     * Default value: -1 (unlimited)
+     */
+    maxLogicItemsInCondition?: number;
+    /**
+     * Specifies whether users can switch between UI themes in the Preview tab.
+     *
+     * Default value: `true`
+     *
+     * [View Demo](https://surveyjs.io/Examples/Creator?id=theme-switcher (linkStyle))
+     */
+    allowChangeThemeInPreview?: boolean;
+    /**
+     * Specifies the orientation of the selected device in the Preview tab.
+     *
+     * Possible values:
+     * - `"landscape"` (default)
+     * - `"portrait"`
+     */
+    previewOrientation?: "landscape" | "portrait";
+    /**
+     * Limits question and panels types available in the Toolbox and Add Question menu.
+     *
+     * Refer to the [Limit Available Question and Panel Types](https://surveyjs.io/Documentation/Survey-Creator?id=toolbox#limit-available-question-and-panel-types) help topic for more information.
+     */
+    questionTypes?: Array<string>;
+    /**
+     * Specifies how Survey Creator users edit survey pages.
+     *
+     * Accepted values:
+     *
+     * - `"standard"` (default)
+     * Questions and panels are divided between pages. Users can scroll the design surface to reach a required page.
+     *
+     * - `"single"`
+     * All questions and panels belong to a single page. Users cannot add or remove pages.
+     *
+     * - `"bypage"`
+     * Questions and panels are divided between pages. Users can use the page navigator to switch to a required page.
+     */
+    pageEditMode?: "standard" | "single" | "bypage";
+}

package/typings/creator-responsivity-manager.d.ts

@@ -0,0 +1,22 @@
+import { CreatorBase } from "./creator-base";
+export declare class CreatorResponsivityManager {
+    protected container: HTMLDivElement;
+    private creator;
+    private resizeObserver;
+    private currentWidth;
+    private prevShowToolbox;
+    private prevShowPageNavigator;
+    static screenSizeBreakpoints: {
+        [key: string]: number;
+    };
+    private getScreenWidth;
+    private initMobileView;
+    private resetMobileView;
+    private procesShowToolbox;
+    private procesShowPageNavigator;
+    private findCorrectParent;
+    constructor(container: HTMLDivElement, creator: CreatorBase);
+    private _process;
+    process(): void;
+    dispose(): void;
+}

package/typings/creator-settings.d.ts

@@ -0,0 +1,216 @@
+import { Base, IAction, ItemValue, JsonObjectProperty, MatrixDropdownColumn, Question, SurveyModel, ILocalizableString, PopupBaseViewModel } from "survey-core";
+/**
+ * List available question convert modes
+ */
+export declare enum QuestionConvertMode {
+    AllTypes = 0,
+    CompatibleTypes = 1
+}
+export declare var settings: {
+    translation: {
+        sortByName: boolean;
+        exportPrefix: string;
+        /**
+         * The maximum number of locales that user can select at once for translation
+         */
+        maximumSelectedLocales: number;
+        /**
+         * The name of the translation export file in csv format
+         */
+        exportFileName: string;
+    };
+    operators: {
+        empty: any[];
+        notempty: any[];
+        equal: string[];
+        notequal: string[];
+        contains: string[];
+        notcontains: string[];
+        anyof: string[];
+        allof: string[];
+        greater: string[];
+        less: string[];
+        greaterorequal: string[];
+        lessorequal: string[];
+    };
+    defaultNewSurveyJSON: {};
+    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: {
+        defaultOperator: string;
+        visibleActions: any[];
+        logicItemTitleMaxChars: number;
+        openBracket: string;
+        closeBracket: string;
+        /**
+         * Set these properties to false if you don't want to update expressions on changing question and column names and on changing choices values
+         */
+        updateExpressionsOnChanging: {
+            questionName: boolean;
+            columnName: boolean;
+            choiceValue: boolean;
+        };
+    };
+    /**
+     * Determines which types of questions the conversion will be available for.
+     */
+    questionConvertMode: QuestionConvertMode;
+    propertyGrid: {
+        useButtonGroup: boolean;
+        maxCharsInButtonGroup: number;
+        showNavigationButtons: boolean;
+        maximumColumnsCount: number;
+        maximumChoicesCount: number;
+        maximumRowsCount: number;
+        maximumRateValues: number;
+        generalTabName: string;
+        defaultExpandedTabName: string;
+    };
+    toolbox: {
+        /**
+         * Use it to change the default question JSON on dropping it into designer or converting questions
+         */
+        defaultJSON: {
+            dropdown: {
+                choices: string[];
+            };
+            tagbox: {
+                choices: string[];
+            };
+            checkbox: {
+                choices: string[];
+            };
+            radiogroup: {
+                choices: string[];
+            };
+            ranking: {
+                choices: string[];
+            };
+            imagepicker: {
+                choices: {
+                    value: string;
+                    imageLink: string;
+                }[];
+            };
+            image: {
+                imageLink: string;
+            };
+        };
+    };
+    /**
+     * Notification settings
+     */
+    notifications: {
+        lifetime: number;
+    };
+    /**
+     * Auto save parameters
+     */
+    autoSave: {
+        delay: number;
+    };
+    /**
+     * Drag Drop Settings
+     */
+    dragDrop: {
+        restrictDragQuestionBetweenPages: boolean;
+    };
+    /**
+     * Creator layout settings
+     */
+    layout: {
+        showTabs: boolean;
+        showToolbar: boolean;
+        allowCollapseSidebar: boolean;
+    };
+    jsonEditor: {
+        indentation: number;
+    };
+};
+export interface ICollectionItemAllowOperations {
+    allowDelete: boolean;
+    allowEdit: boolean;
+    allowAdd: boolean;
+}
+export interface ISurveyCreatorOptions {
+    isMobileView: boolean;
+    alwaySaveTextInPropertyEditors: boolean;
+    readOnly: boolean;
+    maxLogicItemsInCondition: number;
+    showTitlesInExpressions: boolean;
+    showObjectTitles: boolean;
+    allowEditExpressionsInTextEditor: boolean;
+    maximumColumnsCount: number;
+    maximumChoicesCount: number;
+    maximumRowsCount: number;
+    maximumRateValues: number;
+    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;
+    onPropertyEditorUpdateTitleActionsCallback(object: any, property: JsonObjectProperty, editor: Question, titleActions: IAction[]): any;
+    onPropertyGridShowModalCallback(object: any, property: JsonObjectProperty, editor: Question, popupEditor: any, popupModel: PopupBaseViewModel): any;
+    onIsPropertyReadOnlyCallback(obj: Base, property: JsonObjectProperty, readOnly: boolean, parentObj: Base, parentProperty: JsonObjectProperty): boolean;
+    onCanDeleteItemCallback(object: any, item: Base, allowDelete: boolean): boolean;
+    onCollectionItemDeletingCallback(obj: Base, property: JsonObjectProperty, collection: Array<Base>, item: Base): boolean;
+    onCollectionItemAllowingCallback(obj: Base, property: JsonObjectProperty, collection: Array<Base>, item: Base, options: ICollectionItemAllowOperations): void;
+    onItemValueAddedCallback(obj: Base, propertyName: string, itemValue: ItemValue, itemValues: Array<ItemValue>): any;
+    onMatrixDropdownColumnAddedCallback(matrix: Question, column: MatrixDropdownColumn, columns: Array<MatrixDropdownColumn>): any;
+    onSetPropertyEditorOptionsCallback(propertyName: string, obj: Base, editorOptions: any): any;
+    onGetErrorTextOnValidationCallback(propertyName: string, obj: Base, value: any): string;
+    onValueChangingCallback(options: any): any;
+    onGetElementEditorTitleCallback(obj: Base, title: string): string;
+    startUndoRedoTransaction(): any;
+    stopUndoRedoTransaction(): any;
+    createSurvey(json: any, reason: string, surveyType?: new (json: any) => SurveyModel): any;
+    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;
+    getProcessedTranslationItemText(locale: string, locString: ILocalizableString, newText: string, obj: any): string;
+    getTranslationExportedText(obj: Base, name: string, locString: ILocalizableString, locale: string, text: string): string;
+}
+export declare class EmptySurveyCreatorOptions implements ISurveyCreatorOptions {
+    getProcessedTranslationItemText(locale: string, locString: ILocalizableString, newText: string, obj: any): string;
+    isMobileView: boolean;
+    alwaySaveTextInPropertyEditors: boolean;
+    readOnly: boolean;
+    maxLogicItemsInCondition: number;
+    showTitlesInExpressions: boolean;
+    showObjectTitles: boolean;
+    allowEditExpressionsInTextEditor: boolean;
+    maximumColumnsCount: number;
+    maximumChoicesCount: number;
+    maximumRowsCount: number;
+    maximumRateValues: number;
+    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;
+    onPropertyEditorUpdateTitleActionsCallback(object: any, property: JsonObjectProperty, editor: Question, titleActions: IAction[]): void;
+    onPropertyGridShowModalCallback(object: any, property: JsonObjectProperty, editor: Question, popupEditor: any, popupModel: PopupBaseViewModel): void;
+    onIsPropertyReadOnlyCallback(obj: Base, property: JsonObjectProperty, readOnly: boolean, parentObj: Base, parentProperty: JsonObjectProperty): boolean;
+    onCanDeleteItemCallback(object: any, item: Base, allowDelete: boolean): boolean;
+    onCollectionItemDeletingCallback(obj: Base, property: JsonObjectProperty, collection: Array<Base>, item: Base): boolean;
+    onCollectionItemAllowingCallback(obj: Base, property: JsonObjectProperty, collection: Array<Base>, item: Base, options: ICollectionItemAllowOperations): void;
+    onItemValueAddedCallback(obj: Base, propertyName: string, itemValue: ItemValue, itemValues: Array<ItemValue>): void;
+    onMatrixDropdownColumnAddedCallback(matrix: Question, column: MatrixDropdownColumn, columns: Array<MatrixDropdownColumn>): void;
+    onSetPropertyEditorOptionsCallback(propertyName: string, obj: Base, editorOptions: any): void;
+    onGetErrorTextOnValidationCallback(propertyName: string, obj: Base, value: any): string;
+    onValueChangingCallback(options: any): void;
+    onGetElementEditorTitleCallback(obj: Base, title: string): string;
+    startUndoRedoTransaction(): void;
+    stopUndoRedoTransaction(): void;
+    createSurvey(json: any, reason: string, surveyType?: new (json: any) => SurveyModel): SurveyModel;
+    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;
+}

package/typings/custom-questions/question-color.d.ts

@@ -0,0 +1,15 @@
+import { QuestionTextModel } from "survey-core";
+export declare class QuestionColorModel extends QuestionTextModel {
+    unit: string;
+    private getCorrectedValue;
+    protected setNewValue(newValue: string): void;
+    onBeforeInput(event: InputEvent): void;
+    onColorInputChange(event: Event): void;
+    getType(): string;
+    _renderedValue: string;
+    get renderedValue(): string;
+    getSwatchStyle(): {
+        [index: string]: string;
+    };
+    get isInputTextUpdate(): boolean;
+}

package/typings/custom-questions/question-file.d.ts

@@ -0,0 +1,15 @@
+import { QuestionFileModel } from "survey-core";
+export declare class QuestionFileEditorModel extends QuestionFileModel {
+    protected loadedFilesValue: any;
+    protected onChangeQuestionValue(newValue: any): void;
+    protected setNewValue(newValue: any): void;
+    protected loadPreview(newValue: any): void;
+    get allowMultiple(): boolean;
+    set allowMultiple(val: boolean);
+    clear(doneCallback?: () => void, shouldClearValue?: boolean): void;
+    protected updateValueFromInputEvent(event: Event): void;
+    onInputChange(event: Event): void;
+    onInputBlur(event: Event): void;
+    getType(): string;
+    getIsClearButtonDisabled(): boolean;
+}

package/typings/custom-questions/question-spin-editor.d.ts

@@ -0,0 +1,25 @@
+import { QuestionTextModel } from "survey-core";
+export declare class QuestionSpinEditorModel extends QuestionTextModel {
+    unit: string;
+    private _showUnitsInEditor;
+    private parseValue;
+    private changeValue;
+    private get showUnitsInEditor();
+    private correctValue;
+    protected setNewValue(newValue: string | number): void;
+    get renderedValue(): string;
+    private increase;
+    decrease(): void;
+    private increaseTimer;
+    private decreaseTimer;
+    onUpButtonMouseDown: () => void;
+    onDownButtonMouseDown: () => void;
+    onButtonMouseUp: () => void;
+    onKeyDown: (event: KeyboardEvent) => void;
+    onInputKeyDown: (event: KeyboardEvent) => void;
+    onBeforeInput(event: InputEvent): void;
+    onFocus: (event: Event) => void;
+    onBlur: (event: Event) => void;
+    getType(): string;
+    get isInputTextUpdate(): boolean;
+}

package/typings/editable-object.d.ts

@@ -0,0 +1,20 @@
+import { Base, SurveyModel } from "survey-core";
+export declare class EditableObject {
+    static isCopyObject(obj: any): boolean;
+    static getSurvey(object: any): SurveyModel;
+    static getOriginalObject(object: any): any;
+    static getOriginalSurvey(survey: SurveyModel): SurveyModel;
+    private objValue;
+    private editableObjValue;
+    constructor(obj: Base);
+    get obj(): Base;
+    get editableObj(): Base;
+    isPropertyChanged(propertyName: string): boolean;
+    apply(propertyName: string): void;
+    reset(): void;
+    applyAll(excludedProps?: Array<string>): void;
+    private getProperties;
+    protected createEditableObj(): Base;
+    private assignProperties;
+    private getObjJson;
+}