survey-creator-core 1.9.34 → 1.9.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  /*
2
- * Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.34
2
+ * Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.37
3
3
  * Copyright (c) 2015-2022 Devsoft Baltic OÜ - https://surveyjs.io/
4
4
  * License: https://surveyjs.io/Licenses#SurveyCreator
5
5
  */
@@ -99,6 +99,7 @@ export interface ICreatorOptions {
99
99
  maximumRowsCount?: number;
100
100
  maximumRateValues?: number;
101
101
  maxLogicItemsInCondition?: number;
102
+ allowChangeThemeInPreview?: boolean;
102
103
  }
103
104
  /*
104
105
  * The Toolbox item description.
@@ -405,43 +406,44 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
405
406
  getPlugin<P extends ICreatorPlugin = ICreatorPlugin>(name: string): any;
406
407
  /*
407
408
  * The event is called on deleting an element (question/panel/page) from the survey. Typically, when a user click the delete from the element menu.
408
- * <br/> sender the survey creator object that fires the event
409
- * <br/> options.element an instance of the deleting element
410
- * <br/> options.elementType the type of the element: 'question', 'panel' or 'page'.
411
- * <br/> options.allowing set it to false to cancel the element deleting
409
+ * sender the survey creator object that fires the event
410
+ * options.element an instance of the deleting element
411
+ * options.elementType the type of the element: 'question', 'panel' or 'page'.
412
+ * options.allowing set it to false to cancel the element deleting
412
413
  */
413
414
  onElementDeleting: Event<(sender: CreatorBase, options: any) => any, any>;
414
415
  /*
415
416
  * The event is called on setting a readOnly property of the property editor. By default the property.readOnly property is used.
416
417
  * You may changed it and make the property editor read only or enabled for a particular object.
417
- * <br/> sender the survey creator object that fires the event
418
- * <br/> options.obj the survey object, Survey, Page, Panel or Question
419
- * <br/> options.property the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties.
420
- * <br/> options.readOnly a boolean value. It has value equals to options.readOnly property by default. You may change it.
421
- * <br/> options.parentObj the parent object. It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is a question (dropdown, radigroup, checkbox, matrices and so on).
422
- * <br/> options.parentProperty the parent property (Survey.JsonObjectProperty object). It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is choices, columns, rows, triggers and so on.
418
+ * sender the survey creator object that fires the event
419
+ * options.obj the survey object, Survey, Page, Panel or Question
420
+ * options.property the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties.
421
+ * options.readOnly a boolean value. It has value equals to options.readOnly property by default. You may change it.
422
+ * options.parentObj the parent object. It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is a question (dropdown, radigroup, checkbox, matrices and so on).
423
+ * options.parentProperty the parent property (Survey.JsonObjectProperty object). It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is choices, columns, rows, triggers and so on.
423
424
  */
424
425
  onGetPropertyReadOnly: Event<(sender: CreatorBase, options: any) => any, any>;
425
426
  /*
426
427
  * The event is fired when the survey creator creates a survey object (Survey.Survey).
427
- * <br/> sender the survey creator object that fires the event
428
- * <br/> options.survey the survey object showing in the creator.
429
- * <br/> options.reason indicates what component of the creator requests the survey. There are several reason types: "designer" - survey for designer survey, "test" - survey for "Preview" tab and "conditionEditor", "defaultValueEditor", "restfulEditor" - surveys for different property editors.
428
+ * sender the survey creator object that fires the event
429
+ * options.survey the survey object showing in the creator.
430
+ * options.reason indicates what component of the creator requests the survey. There are several reason types: "designer" - survey for designer survey, "test" - survey for "Preview" tab and "conditionEditor", "defaultValueEditor", "restfulEditor" - surveys for different property editors.
430
431
  */
431
432
  onSurveyInstanceCreated: Event<(sender: CreatorBase, options: any) => any, any>;
432
433
  /*
433
434
  * 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.
434
435
  * Use this event, if you want custom display name for objects.
435
- * <br/> sender the survey creator object that fires the event
436
- * <br/> options.obj the survey object, Survey, Page, Panel or Question
437
- * <br/> options.reason the name of the UI that requests the object display name.
438
- * <br/> options.displayName change this property to show your custom display name for the object
439
- * <br/> The list of possible values in options.reason:
440
- * <br/> "condition" - raised from Condition modal window or on setup condition in a logic tab
441
- * <br/> "survey-tester" - raised from page selector list in "Preview" tab
442
- * <br/> "survey-tester-selected" - raised on setting page selector title in "Preview" tab
443
- * <br/> "survey-translation" - raised from translation tab
444
- * <br/> "property-grid" - raised from showing object selector for property grid in "Designer" tab.
436
+ * sender the survey creator object that fires the event
437
+ * options.obj the survey object, Survey, Page, Panel or Question
438
+ * options.reason the name of the UI that requests the object display name.
439
+ * options.displayName change this property to show your custom display name for the object
440
+ * The list of possible values in options.reason:
441
+ * "condition" - raised from Condition modal window or on setup condition in a logic tab
442
+ * "survey-tester" - raised from page selector list in "Preview" tab
443
+ * "survey-tester-selected" - raised on setting page selector title in "Preview" tab
444
+ * "survey-translation" - raised from translation tab
445
+ * "property-grid" - raised from showing object selector for property grid in "Designer" tab.
446
+ * "property-grid-title" - raised on rendering selected object title in property grid in "Designer" tab.
445
447
  */
446
448
  onGetObjectDisplayName: Event<(sender: CreatorBase, options: any) => any, any>;
447
449
  /*
@@ -476,127 +478,127 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
476
478
  onElementAllowOperations: Event<(sender: CreatorBase, options: any) => any, any>;
477
479
  /*
478
480
  * Use this event to add/remove/modify the element (question/panel) menu items.
479
- * <br/> sender the survey creator object that fires the event
480
- * <br/> options.obj the survey object which property is edited in the Property Editor.
481
- * <br/> options.items the list of menu items. It has two required fields: text and onClick: function(obj: Survey.Base) {} and optional name field.
481
+ * sender the survey creator object that fires the event
482
+ * options.obj the survey object which property is edited in the Property Editor.
483
+ * options.items the list of menu items. It has two required fields: text and onClick: function(obj: Survey.Base) {} and optional name field.
482
484
  */
483
485
  onDefineElementMenuItems: Event<(sender: CreatorBase, options: any) => any, any>;
484
486
  /*
485
487
  * The event is called before showing a property in the Properties Grid or in the Question Editor.
486
- * <br/> sender the survey creator object that fires the event
487
- * <br/> options.obj the survey object, Survey, Page, Panel or Question
488
- * <br/> options.property the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties.
489
- * <br/> options.canShow a boolean value. It is true by default. Set it false to hide the property from the Properties Grid and in the Question Editor.
490
- * <br/> options.parentObj the parent object. It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is a question (dropdown, radigroup, checkbox, matrices and so on).
491
- * <br/> options.parentProperty the parent property (Survey.JsonObjectProperty object). It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is choices, columns, rows, triggers and so on.
492
- * <br/>
493
- * <br/> [Example: Hide a category in the Properties Grid](https://surveyjs.io/Examples/Survey-Creator?id=hidecategoryinpropertiesgrid)
488
+ * sender the survey creator object that fires the event
489
+ * options.obj the survey object, Survey, Page, Panel or Question
490
+ * options.property the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties.
491
+ * options.canShow a boolean value. It is true by default. Set it false to hide the property from the Properties Grid and in the Question Editor.
492
+ * options.parentObj the parent object. It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is a question (dropdown, radigroup, checkbox, matrices and so on).
493
+ * options.parentProperty the parent property (Survey.JsonObjectProperty object). It is null for non-nested properties. It is not null for itemvalue or column objects. The parent object is choices, columns, rows, triggers and so on.
494
+ *
495
+ * [Example: Hide a category in the Properties Grid](https://surveyjs.io/Examples/Survey-Creator?id=hidecategoryinpropertiesgrid)
494
496
  */
495
497
  onShowingProperty: Event<(sender: CreatorBase, options: any) => any, any>;
496
498
  onCanShowProperty: Event<(sender: CreatorBase, options: any) => any, any>;
497
499
  /*
498
500
  * The event is called after a survey that represents the Property Grid is created and all its questions (property editors) are setup.
499
501
  * You can use this event to modify this survey to change the property grid behavior
500
- * <br/> options.obj the survey object that is currently editing in the property grid
501
- * <br/> options.survey the property grid survey
502
+ * options.obj the survey object that is currently editing in the property grid
503
+ * options.survey the property grid survey
502
504
  */
503
505
  onPropertyGridSurveyCreated: Event<(sender: CreatorBase, options: any) => any, any>;
504
506
  /*
505
507
  * The event is called after a property editor (in fact a survey question) has been created and all it's properties have been assign.
506
508
  * You can use this event to modify the property editor properties or set event handlers to customize it's behavior
507
- * <br/> options.obj the survey object that is currently editing in the property grid
508
- * <br/> options.property the property that the current property editor is editing
509
- * <br/> options.editor the property editor. In fact it is a survey question. We are using a heavily customizable survey as a property grid in Creator V2. It means that every property editor is a question.
509
+ * options.obj the survey object that is currently editing in the property grid
510
+ * options.property the property that the current property editor is editing
511
+ * options.editor the property editor. In fact it is a survey question. We are using a heavily customizable survey as a property grid in Creator V2. It means that every property editor is a question.
510
512
  */
511
513
  onPropertyEditorCreated: Event<(sender: CreatorBase, options: any) => any, any>;
512
514
  /*
513
515
  * The event is called after a property editor setups its title actions.
514
516
  * You can use this event to modify the property editor title actions
515
- * <br/> options.obj the survey object that is currently editing in the property grid
516
- * <br/> options.property the property that the current property editor is editing
517
- * <br/> options.editor the property editor. In fact it is a survey question. We are using a heavily customizable survey as a property grid in Creator V2. It means that every property editor is a question.
518
- * <br/> options.titleActions the list of title actions.
517
+ * options.obj the survey object that is currently editing in the property grid
518
+ * options.property the property that the current property editor is editing
519
+ * options.editor the property editor. In fact it is a survey question. We are using a heavily customizable survey as a property grid in Creator V2. It means that every property editor is a question.
520
+ * options.titleActions the list of title actions.
519
521
  */
520
522
  onPropertyEditorUpdateTitleActions: Event<(sender: CreatorBase, options: any) => any, any>;
521
523
  /*
522
524
  * The event is called before rendering a delete button in the Property Grid or in Question Editor.
523
525
  * Obsolete, please use onCollectionItemAllowOperations
524
- * <br/> sender the survey creator object that fires the event
525
- * <br/> options.obj the survey Question
526
- * <br/> options.item the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
527
- * <br/> options.canDelete a boolean value. It is true by default. Set it false to remove delete button from the Property Grid or in Question Editor
526
+ * sender the survey creator object that fires the event
527
+ * options.obj the survey Question
528
+ * options.item the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
529
+ * options.canDelete a boolean value. It is true by default. Set it false to remove delete button from the Property Grid or in Question Editor
528
530
  */
529
531
  onCanDeleteItem: Event<(sender: CreatorBase, options: any) => any, any>;
530
532
  /*
531
533
  * The event is called on deleting a collection item from the Property Editor. For example: column in columns editor or item in choices and so on.
532
534
  * Obsolete, please use onCollectionItemAllowOperations
533
- * <br/> sender the survey creator object that fires the event
534
- * <br/> options.obj the survey object: Question, Panel, Page or Survey
535
- * <br/> options.property the collection property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
536
- * <br/> options.propertyName the collection property name
537
- * <br/> options.collection the editing collection where deleting item is located. It is can be columns in the matrices or choices in dropdown question and so on.
538
- * <br/> options.item the collection item that we are going to delete
539
- * <br/> options.allowDelete a boolean value. It is true by default. Set it false to abondome the element removing from the collection
535
+ * sender the survey creator object that fires the event
536
+ * options.obj the survey object: Question, Panel, Page or Survey
537
+ * options.property the collection property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
538
+ * options.propertyName the collection property name
539
+ * options.collection the editing collection where deleting item is located. It is can be columns in the matrices or choices in dropdown question and so on.
540
+ * options.item the collection item that we are going to delete
541
+ * options.allowDelete a boolean value. It is true by default. Set it false to abondome the element removing from the collection
540
542
  */
541
543
  onCollectionItemDeleting: Event<(sender: CreatorBase, options: any) => any, any>;
542
544
  /*
543
545
  * The event is called before rendering a collection item from the Property Editor. For example: column in columns editor or item in choices and so on.
544
546
  * You can make detail/edit and remove buttons invsible and/or disable editing.
545
- * <br/> sender the survey creator object that fires the event
546
- * <br/> options.obj the survey object: Question, Panel, Page or Survey
547
- * <br/> options.property the collection property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
548
- * <br/> options.propertyName the collection property name
549
- * <br/> options.collection the editing collection where deleting item is located. It is can be columns in the matrices or choices in dropdown question and so on.
550
- * <br/> options.item the collection item that we are going to delete
551
- * <br/> options.allowDelete a boolean value. It is true by default. Set it false to abondome the element removing from the collection
552
- * <br/> options.allowEdit a boolean value. It is true by default. Set it false to disable editing.
547
+ * sender the survey creator object that fires the event
548
+ * options.obj the survey object: Question, Panel, Page or Survey
549
+ * options.property the collection property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
550
+ * options.propertyName the collection property name
551
+ * options.collection the editing collection where deleting item is located. It is can be columns in the matrices or choices in dropdown question and so on.
552
+ * options.item the collection item that we are going to delete
553
+ * options.allowDelete a boolean value. It is true by default. Set it false to abondome the element removing from the collection
554
+ * options.allowEdit a boolean value. It is true by default. Set it false to disable editing.
553
555
  */
554
556
  onCollectionItemAllowOperations: Event<(sender: CreatorBase, options: any) => any, any>;
555
557
  /*
556
558
  * The event is called on adding a new Survey.ItemValue object. It uses as an element in choices array in Radiogroup, checkbox and dropdown questions or Matrix columns and rows properties.
557
559
  * Use this event, to set ItemValue.value and ItemValue.text properties by default or set a value to the custom property.
558
- * <br/> sender the survey creator object that fires the event
559
- * <br /> options.obj the object that contains the itemsValues array, for example selector, rating and single choice matrix questions.
560
- * <br/> options.propertyName the object property Name. It can be "choices" for selector questions or rateValues for rating question or columns/rows for single choice matrix.
561
- * <br/> options.newItem a new created Survey.ItemValue object.
562
- * <br/> options.itemValues an editing Survey.ItemValue array. newItem object is not added yet into this array.
560
+ * sender the survey creator object that fires the event
561
+ * options.obj the object that contains the itemsValues array, for example selector, rating and single choice matrix questions.
562
+ * options.propertyName the object property Name. It can be "choices" for selector questions or rateValues for rating question or columns/rows for single choice matrix.
563
+ * options.newItem a new created Survey.ItemValue object.
564
+ * options.itemValues an editing Survey.ItemValue array. newItem object is not added yet into this array.
563
565
  */
564
566
  onItemValueAdded: Event<(sender: CreatorBase, options: any) => any, any>;
565
567
  /*
566
568
  * The event is called when a user adds a new column into MatrixDropdown or MatrixDynamic questions. Use it to set some properties of Survey.MatrixDropdownColumn by default, for example name or a custom property.
567
- * <br/> sender the survey creator object that fires the event
568
- * <br/> options.matrix a matrix question where column is located, matrix.columns.
569
- * <br/> options.newColumn a new created Survey.MatrixDropdownColumn object.
570
- * <br/> options.columns editable columns objects. They can be different from options.matrix.columns. options.columns and options.matrix.columns are equal after user press Apply or Cancel and options.columns will be set to options.matrix.columns or reset to initial state.
569
+ * sender the survey creator object that fires the event
570
+ * options.matrix a matrix question where column is located, matrix.columns.
571
+ * options.newColumn a new created Survey.MatrixDropdownColumn object.
572
+ * options.columns editable columns objects. They can be different from options.matrix.columns. options.columns and options.matrix.columns are equal after user press Apply or Cancel and options.columns will be set to options.matrix.columns or reset to initial state.
571
573
  */
572
574
  onMatrixColumnAdded: Event<(sender: CreatorBase, options: any) => any, any>;
573
575
  /*
574
576
  * Use this event to control Property Editors UI.
575
- * <br/> sender the survey creator object that fires the event
576
- * <br/> options.obj the survey object which property is edited in the Property Editor.
577
- * <br/> options.propertyName the name of the edited property.
578
- * <br/> options.editorOptions options that can be changed.
579
- * <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'.
580
- * <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'.
581
- * <br/> options.editorOptions.showTextView a boolean property, true by default. Set it false to disable "Manual Entry" tab for "choices" property.
582
- * <br/> options.editorOptions.itemsEntryType a string property, 'form' by default. Set it 'fast' to show "Manual Entry" tab for "choices" property by default.
577
+ * sender the survey creator object that fires the event
578
+ * options.obj the survey object which property is edited in the Property Editor.
579
+ * options.propertyName the name of the edited property.
580
+ * options.editorOptions options that can be changed.
581
+ * 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'.
582
+ * 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'.
583
+ * options.editorOptions.showTextView a boolean property, true by default. Set it false to disable "Manual Entry" tab for "choices" property.
584
+ * options.editorOptions.itemsEntryType a string property, 'form' by default. Set it 'fast' to show "Manual Entry" tab for "choices" property by default.
583
585
  */
584
586
  onSetPropertyEditorOptions: Event<(sender: CreatorBase, options: any) => any, any>;
585
587
  /*
586
588
  * The event is called on generation a new name for a new created element.
587
- * <br/> sender the survey creator object that fires the event
588
- * <br/> options.element a new created survey element. It can be question, panel or page
589
- * <br/> options.name a new suggested name, that is unique for the current survey. You can suggest your own name. If it is unique, creator will assign it to the element.
590
- * <br/> options.isUnique a boolean property, set this property to false, if you want to ask Creator to generate another name
589
+ * sender the survey creator object that fires the event
590
+ * options.element a new created survey element. It can be question, panel or page
591
+ * options.name a new suggested name, that is unique for the current survey. You can suggest your own name. If it is unique, creator will assign it to the element.
592
+ * options.isUnique a boolean property, set this property to false, if you want to ask Creator to generate another name
591
593
  */
592
594
  onGenerateNewName: Event<(sender: CreatorBase, options: any) => any, any>;
593
595
  /*
594
596
  * Use this event to show a custom error in the Question Editor on pressing Apply or OK buttons, if the values are not set correctly. The error will be displayed under the property editor.
595
- * <br/> sender the survey creator object that fires the event
596
- * <br/> options.obj the survey object which property is edited in the Property Editor.
597
- * <br/> options.propertyName the name of the edited property.
598
- * <br/> options.value the property value.
599
- * <br/> options.error the error you want to display. Set the empty string (the default value) or null if there is no errors.
597
+ * sender the survey creator object that fires the event
598
+ * options.obj the survey object which property is edited in the Property Editor.
599
+ * options.propertyName the name of the edited property.
600
+ * options.value the property value.
601
+ * options.error the error you want to display. Set the empty string (the default value) or null if there is no errors.
600
602
  */
601
603
  onPropertyValidationCustomError: Event<(sender: CreatorBase, options: any) => any, any>;
602
604
  /*
@@ -624,98 +626,98 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
624
626
  onSurveyPropertyValueChanged: Event<(sender: CreatorBase, options: any) => any, any>;
625
627
  /*
626
628
  * Use this event to modify the list (name and titles) of the questions available in a condition editor.
627
- * <br/> sender the survey creator object that fires the event
628
- * <br/> options.obj the survey object which property is edited in the Property Editor.
629
- * <br/> options.propertyName the name of the edited property.
630
- * <br/> options.editor the instance of Property Editor.
631
- * <br/> options.list the list of the questions available for condition
629
+ * sender the survey creator object that fires the event
630
+ * options.obj the survey object which property is edited in the Property Editor.
631
+ * options.propertyName the name of the edited property.
632
+ * options.editor the instance of Property Editor.
633
+ * options.list the list of the questions available for condition
632
634
  */
633
635
  onConditionQuestionsGetList: Event<(sender: CreatorBase, options: any) => any, any>;
634
636
  /*
635
637
  * Use this event to modify the title in a condition editor. The title is changing during editing. In case of empty or incorrect expression it tells that expression is incorrect
636
- * <br/> sender the survey creator object that fires the event.
637
- * <br/> options.expression the current expression. If the expression is empty or incorrect then the value is empty.
638
- * <br/> options.title the default value of the title. You can change the default value.
638
+ * sender the survey creator object that fires the event.
639
+ * options.expression the current expression. If the expression is empty or incorrect then the value is empty.
640
+ * options.title the default value of the title. You can change the default value.
639
641
  */
640
642
  onConditionGetTitle: Event<(sender: CreatorBase, options: any) => any, any>;
641
643
  /*
642
644
  * The event is called when a survey is changed in the designer. A new page/question/page is added or existing is removed, a property is changed and so on.
643
- * <br/> sender the survey creator object that fires the event
644
- * <br/> options object contains the information about certain modifications
645
- * <br/> options.type contains string constant describing certain modification
646
- * <br/> Available values:
647
- * <br/>
648
- * <br/> options.type: "ADDED_FROM_TOOLBOX"
649
- * <br/> options.question: newly added question
650
- * <br/>
651
- * <br/> options.type: "PAGE_ADDED"
652
- * <br/> options.newValue: newly created page
653
- * <br/>
654
- * <br/> options.type: "PAGE_MOVED"
655
- * <br/> options.page: page has been moved
656
- * <br/> options.indexFrom: pevious index
657
- * <br/> options.indexTo: new index
658
- * <br/>
659
- * <br/> options.type: "QUESTION_CONVERTED"
660
- * <br/> options.className: the converted class name
661
- * <br/> options.oldValue: pevious object
662
- * <br/> options.newValue: the new object, converted from oldVale to the given class name
663
- * <br/>
664
- * <br/> options.type: "QUESTION_CHANGED_BY_EDITOR"
665
- * <br/> options.question: question has been edited in the popup question editor
666
- * <br/>
667
- * <br/> options.type: "PROPERTY_CHANGED"
668
- * <br/> options.name: the name of the property has been changed
669
- * <br/> options.target: the object containing the changed property
670
- * <br/> options.oldValue: the previous value of the changed property
671
- * <br/> options.newValue: the new value of the changed property
672
- * <br/>
673
- * <br/> options.type: "OBJECT_DELETED"
674
- * <br/> options.target: deleted object
675
- * <br/>
676
- * <br/> options.type: "VIEW_TYPE_CHANGED"
677
- * <br/> options.newType: new type of the creator view: editor or designer
678
- * <br/>
679
- * <br/> options.type: "DO_DROP"
680
- * <br/> options.page: the page of the drap/drop operation
681
- * <br/> options.source: the source dragged object
682
- * <br/> options.target: the drop target
683
- * <br/> options.newElement: a new element. It is defined if a user drops question or panel from the toolbox
684
- * <br/>
685
- * <br/> options.type: "TRANSLATIONS_CHANGED"
686
- * <br/> options.type: "JSON_EDITOR"
645
+ * sender the survey creator object that fires the event
646
+ * options object contains the information about certain modifications
647
+ * options.type contains string constant describing certain modification
648
+ * Available values:
649
+ *
650
+ * options.type: "ADDED_FROM_TOOLBOX"
651
+ * options.question: newly added question
652
+ *
653
+ * options.type: "PAGE_ADDED"
654
+ * options.newValue: newly created page
655
+ *
656
+ * options.type: "PAGE_MOVED"
657
+ * options.page: page has been moved
658
+ * options.indexFrom: pevious index
659
+ * options.indexTo: new index
660
+ *
661
+ * options.type: "QUESTION_CONVERTED"
662
+ * options.className: the converted class name
663
+ * options.oldValue: pevious object
664
+ * options.newValue: the new object, converted from oldVale to the given class name
665
+ *
666
+ * options.type: "QUESTION_CHANGED_BY_EDITOR"
667
+ * options.question: question has been edited in the popup question editor
668
+ *
669
+ * options.type: "PROPERTY_CHANGED"
670
+ * options.name: the name of the property has been changed
671
+ * options.target: the object containing the changed property
672
+ * options.oldValue: the previous value of the changed property
673
+ * options.newValue: the new value of the changed property
674
+ *
675
+ * options.type: "OBJECT_DELETED"
676
+ * options.target: deleted object
677
+ *
678
+ * options.type: "VIEW_TYPE_CHANGED"
679
+ * options.newType: new type of the creator view: editor or designer
680
+ *
681
+ * options.type: "DO_DROP"
682
+ * options.page: the page of the drap/drop operation
683
+ * options.source: the source dragged object
684
+ * options.target: the drop target
685
+ * options.newElement: a new element. It is defined if a user drops question or panel from the toolbox
686
+ *
687
+ * options.type: "TRANSLATIONS_CHANGED"
688
+ * options.type: "JSON_EDITOR"
687
689
  */
688
690
  onModified: Event<(sender: CreatorBase, options: any) => any, any>;
689
691
  /*
690
692
  * The event is called on adding a new question into the survey. Typically, when a user dropped a Question from the Question Toolbox into designer Survey area.
691
- * <br/> sender the survey creator object that fires the event
692
- * <br/> options.question a new added survey question. Survey.Question object
693
- * <br/> options.page the survey Page object where question has been added.
693
+ * sender the survey creator object that fires the event
694
+ * options.question a new added survey question. Survey.Question object
695
+ * options.page the survey Page object where question has been added.
694
696
  */
695
697
  onQuestionAdded: Event<(sender: CreatorBase, options: any) => any, any>;
696
698
  /*
697
699
  * The event is called on adding a new panel into the survey. Typically, when a user dropped a Panel from the Question Toolbox into designer Survey area.
698
- * <br/> sender the survey creator object that fires the event
699
- * <br/> options.panel a new added survey panel. Survey.Panel object
700
- * <br/> options.page the survey Page object where question has been added.
700
+ * sender the survey creator object that fires the event
701
+ * options.panel a new added survey panel. Survey.Panel object
702
+ * options.page the survey Page object where question has been added.
701
703
  */
702
704
  onPanelAdded: Event<(sender: CreatorBase, options: any) => any, any>;
703
705
  /*
704
706
  * The event is called on adding a new page into the survey.
705
- * <br/> sender the survey creator object that fires the event
706
- * <br/> options.page the new survey Page object.
707
+ * sender the survey creator object that fires the event
708
+ * options.page the new survey Page object.
707
709
  */
708
710
  onPageAdded: Event<(sender: CreatorBase, options: any) => any, any>;
709
711
  /*
710
712
  * The event is fired when the survey creator is initialized and a survey object (Survey.Survey) is created.
711
- * <br/> sender the survey creator object that fires the event
712
- * <br/> options.survey the survey object showing in the creator.
713
+ * sender the survey creator object that fires the event
714
+ * options.survey the survey object showing in the creator.
713
715
  */
714
716
  onDesignerSurveyCreated: Event<(sender: CreatorBase, options: any) => any, any>;
715
717
  /*
716
718
  * The event is fired when the survey creator creates survey in Preview tab for testing.
717
- * <br/> sender the survey creator object that fires the event
718
- * <br/> options.survey the survey object showing in the "Preview" tab.
719
+ * sender the survey creator object that fires the event
720
+ * options.survey the survey object showing in the "Preview" tab.
719
721
  */
720
722
  onPreviewSurveyCreated: Event<(sender: CreatorBase, options: any) => any, any>;
721
723
  /*
@@ -725,34 +727,34 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
725
727
  /*
726
728
  * The event is called in case of UI notifications. By default all notifications are done via built-in alert () function.
727
729
  * In case of any subscriptions to this event all notifications will be redirected into the event handler.
728
- * <br/> options.message is a message to show.
730
+ * options.message is a message to show.
729
731
  */
730
732
  onNotify: Event<(sender: CreatorBase, options: any) => any, any>;
731
733
  /*
732
734
  * The event is called on changing the selected element. You may change the new selected element by changing the property options.newSelectedElement to your own
733
- * <br/> options.newSelectedElement the element that is going to be selected in the survey desiger: question, panel, page or survey.
735
+ * options.newSelectedElement the element that is going to be selected in the survey desiger: question, panel, page or survey.
734
736
  */
735
737
  onSelectedElementChanging: Event<(sender: CreatorBase, options: any) => any, any>;
736
738
  /*
737
739
  * The event is called after the selected element is changed.
738
- * <br/> options.newSelectedElement the new selected element in the survey desiger: question, panel, page or survey.
740
+ * options.newSelectedElement the new selected element in the survey desiger: question, panel, page or survey.
739
741
  */
740
742
  onSelectedElementChanged: Event<(sender: CreatorBase, options: any) => any, any>;
741
743
  /*
742
744
  * The event is fired then one need to choose files.
743
- * <br/> sender the survey creator object that fires the event
744
- * <br/> input file input HTML element
745
- * <br/> callback need to be called after files has been chosen
745
+ * sender the survey creator object that fires the event
746
+ * input file input HTML element
747
+ * callback need to be called after files has been chosen
746
748
  */
747
749
  onOpenFileChooser: Event<(sender: CreatorBase, options: any) => any, any>;
748
750
  /*
749
751
  * The event is fired on uploading the files.
750
- * <br/> sender the survey creator object that fires the event
751
- * <br/> There are two properties in options:
752
- * <br/> files the Javascript File objects array
753
- * <br/> callback called on upload complete,
754
- * <br/> which takes two string arguments:
755
- * <br/> a status and an image link
752
+ * sender the survey creator object that fires the event
753
+ * There are two properties in options:
754
+ * files the Javascript File objects array
755
+ * callback called on upload complete,
756
+ * which takes two string arguments:
757
+ * a status and an image link
756
758
  */
757
759
  onUploadFile: Event<(sender: CreatorBase, options: any) => any, any>;
758
760
  /*
@@ -777,31 +779,46 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
777
779
  */
778
780
  onTranslationLocaleInitiallySelected: Event<(sender: CreatorBase, options: any) => any, any>;
779
781
  /*
782
+ * Use this event to modify the imported localizable text. To block importing a particular localization text, set the options.text into undefined.
783
+ *
784
+ * The event handler accepts the following arguments:
785
+ *
786
+ * - `sender` - A Survey Creator instance that raised the event.
787
+ * - `options.locale` - the locale name, like 'en', 'de' and so on.
788
+ * - `options.name` - The full name of the localizable string, it can be: "survey.page1.question2.title"
789
+ * - `options.text` - The imported text for the locale for this item. Set it to undefined or empty string to block importing for this item
790
+ */
791
+ onTranslationImportItem: Event<(sender: CreatorBase, options: any) => any, any>;
792
+ /*
793
+ * The method is called when the translation from csv file is imported.
794
+ */
795
+ onTranslationImported: Event<(sender: CreatorBase, options: any) => any, any>;
796
+ /*
780
797
  * Use this event to control drag&drop operations.
781
- * <br/> sender the survey creator object that fires the event.
782
- * <br/> options.survey the editing survey object.
783
- * <br/> options.allow set it to false to disable dragging.
784
- * <br/> options.target a target element that is dragging.
785
- * <br/> options.source a source element. It can be null, if it is a new element, dragging from toolbox.
786
- * <br/> options.parent a page or panel where target element is dragging.
787
- * <br/> options.insertBefore an element before the target element is dragging. It can be null if parent container (page or panel) is empty or dragging an element under the last element of the container.
788
- * <br/> options.insertAfter an element after the target element is dragging. It can be null if parent container (page or panel) is empty or dragging element to the top of the parent container.
798
+ * sender the survey creator object that fires the event.
799
+ * options.survey the editing survey object.
800
+ * options.allow set it to false to disable dragging.
801
+ * options.target a target element that is dragging.
802
+ * options.source a source element. It can be null, if it is a new element, dragging from toolbox.
803
+ * options.parent a page or panel where target element is dragging.
804
+ * options.insertBefore an element before the target element is dragging. It can be null if parent container (page or panel) is empty or dragging an element under the last element of the container.
805
+ * options.insertAfter an element after the target element is dragging. It can be null if parent container (page or panel) is empty or dragging element to the top of the parent container.
789
806
  */
790
807
  onDragDropAllow: Event<(sender: CreatorBase, options: any) => any, any>;
791
808
  /*
792
809
  * Use this event to override/disable element adorners - wrapping component name.
793
- * <br/> sender the survey creator object that fires the event.
794
- * <br/> options.element a survey object to be wrapped.
795
- * <br/> options.reason why we need to wrap an element.
796
- * <br/> options.conponentName component wrapper name.
810
+ * sender the survey creator object that fires the event.
811
+ * options.element a survey object to be wrapped.
812
+ * options.reason why we need to wrap an element.
813
+ * options.conponentName component wrapper name.
797
814
  */
798
815
  onGetElementWrapperComponentName: Event<(sender: CreatorBase, options: any) => any, any>;
799
816
  /*
800
817
  * Use this event to override/disable element adorners - wrapping component data.
801
- * <br/> sender the survey creator object that fires the event.
802
- * <br/> options.element a survey object to be wrapped.
803
- * <br/> options.reason why we need to wrap an element.
804
- * <br/> options.conponentData component wrapper data.
818
+ * sender the survey creator object that fires the event.
819
+ * options.element a survey object to be wrapped.
820
+ * options.reason why we need to wrap an element.
821
+ * options.conponentData component wrapper data.
805
822
  */
806
823
  onGetElementWrapperComponentData: Event<(sender: CreatorBase, options: any) => any, any>;
807
824
  /*
@@ -901,6 +918,10 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
901
918
  * Set this property to true if you want to show "page selector" in the toolabar instead of "pages editor"
902
919
  */
903
920
  showPageSelectorInToolbar: boolean;
921
+ /*
922
+ * Set this property to false if you want to hide the "theme selector" in the Preview Tab
923
+ */
924
+ allowChangeThemeInPreview: boolean;
904
925
  tabbedMenu: any;
905
926
  get tabs(): any;
906
927
  set tabs(val: any);
@@ -931,14 +952,14 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
931
952
  set isRTL(val: boolean);
932
953
  /*
933
954
  * The event is called when creator is going to change the active tab.
934
- * <br/> sender the survey creator object that fires the event
935
- * <br/> options.tabName the name of new active tab
955
+ * sender the survey creator object that fires the event
956
+ * options.tabName the name of new active tab
936
957
  */
937
958
  onActiveTabChanging: Event<(sender: CreatorBase, options: any) => any, any>;
938
959
  /*
939
960
  * The event is called when creator active tab is changed.
940
- * <br/> sender the survey creator object that fires the event
941
- * <br/> options.tabName the name of new active tab
961
+ * sender the survey creator object that fires the event
962
+ * options.tabName the name of new active tab
942
963
  */
943
964
  onActiveTabChanged: Event<(sender: CreatorBase, options: any) => any, any>;
944
965
  /*
@@ -974,22 +995,22 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
974
995
  leftContainerActiveItem(name: string): void;
975
996
  /*
976
997
  * The event is called before undo happens.
977
- * <br/> options.canUndo a boolean value. It is true by default. Set it false to hide prevent undo operation.
998
+ * options.canUndo a boolean value. It is true by default. Set it false to hide prevent undo operation.
978
999
  */
979
1000
  onBeforeUndo: Event<(sender: CreatorBase, options: any) => any, any>;
980
1001
  /*
981
1002
  * The event is called before redo happens.
982
- * <br/> options.canRedo a boolean value. It is true by default. Set it false to hide prevent redo operation.
1003
+ * options.canRedo a boolean value. It is true by default. Set it false to hide prevent redo operation.
983
1004
  */
984
1005
  onBeforeRedo: Event<(sender: CreatorBase, options: any) => any, any>;
985
1006
  /*
986
1007
  * The event is called after undo happens.
987
- * <br/> options.state is an undo/redo item.
1008
+ * options.state is an undo/redo item.
988
1009
  */
989
1010
  onAfterUndo: Event<(sender: CreatorBase, options: any) => any, any>;
990
1011
  /*
991
1012
  * The event is called after redo happens.
992
- * <br/> options.state is an undo/redo item.
1013
+ * options.state is an undo/redo item.
993
1014
  */
994
1015
  onAfterRedo: Event<(sender: CreatorBase, options: any) => any, any>;
995
1016
  get undoRedoManager(): UndoRedoManager;
@@ -1797,6 +1818,7 @@ export declare class StringEditorViewModelBase extends Base {
1797
1818
  onInput(event: any): void;
1798
1819
  done(event: any): void;
1799
1820
  onKeyDown(event: any): boolean;
1821
+ onKeyUp(event: any): boolean;
1800
1822
  justFocused: boolean;
1801
1823
  onMouseUp(event: any): boolean;
1802
1824
  findProperty(): JsonObjectProperty;
@@ -1837,10 +1859,12 @@ export declare class SurveyForTextWorker extends SurveyModel {
1837
1859
  }
1838
1860
  export declare class SurveyHelper {
1839
1861
  static getNewPageName(objs: any): string;
1862
+ static isPageNameAutoGenerated(name: string): boolean;
1840
1863
  static getNewQuestionName(objs: any): string;
1841
1864
  static getNewPanelName(objs: any): string;
1842
1865
  static generateNewName(name: string): string;
1843
1866
  static getNewName(objs: any, baseName: string): string;
1867
+ static isNameAutoGenerated(name: string, baseName: string): boolean;
1844
1868
  static getObjectType(obj: any): ObjType;
1845
1869
  static getObjectTypeStr(obj: any): string;
1846
1870
  static getObjectName(obj: any, showObjectTitle?: boolean): string;
@@ -1893,27 +1917,27 @@ export declare class SurveyLogic extends Base implements ISurveyLogicItemOwner {
1893
1917
  onChangedCallback: (item: SurveyLogicItem, changeType: string) => void;
1894
1918
  /*
1895
1919
  * The event is called when logic item is saved.
1896
- * <br/> options.item is the saved logic item.
1920
+ * options.item is the saved logic item.
1897
1921
  */
1898
1922
  onLogicItemSaved: Event<(sender: SurveyLogic, options: any) => any, any>;
1899
1923
  /*
1900
1924
  * The event is called before logic item is saved. You can set options.error to non empty string to show error instead of saving the item.
1901
1925
  * You can use options.item.actions to access actions and optionally set errorText to a particular action.
1902
- * <br/> options.item is the editing logic item. options.item.actions contains the old actions.
1903
- * <br/> options.actions is the array of logic actions that user edit and create.
1904
- * <br/> usedNamesInExpression - the string list of all variables (questions, calculatedValues, and so on) that are used in expression
1905
- * <br/> error - the error string. It is empty by default. You have to set it to non-empty string to show the error on saving.
1926
+ * options.item is the editing logic item. options.item.actions contains the old actions.
1927
+ * options.actions is the array of logic actions that user edit and create.
1928
+ * usedNamesInExpression - the string list of all variables (questions, calculatedValues, and so on) that are used in expression
1929
+ * error - the error string. It is empty by default. You have to set it to non-empty string to show the error on saving.
1906
1930
  */
1907
1931
  onLogicItemValidation: Event<(sender: SurveyLogic, options: any) => any, any>;
1908
1932
  /*
1909
1933
  * The event is called before logic item is being removed.
1910
- * <br/> options.allowRemove is the option you can set to false and prevent removing.
1911
- * <br/> options.item is the logic item to remove.
1934
+ * options.allowRemove is the option you can set to false and prevent removing.
1935
+ * options.item is the logic item to remove.
1912
1936
  */
1913
1937
  onLogicItemRemoving: Event<(sender: SurveyLogic, options: any) => any, any>;
1914
1938
  /*
1915
1939
  * The event is called when logic item is removed.
1916
- * <br/> options.item is the removed logic item.
1940
+ * options.item is the removed logic item.
1917
1941
  */
1918
1942
  onLogicItemRemoved: Event<(sender: SurveyLogic, options: any) => any, any>;
1919
1943
  koAfterRender: any;
@@ -2162,6 +2186,7 @@ export declare class TabDesignerViewModel extends Base {
2162
2186
  constructor(creator: CreatorBase);
2163
2187
  widthUpdater: any;
2164
2188
  checkNewPageHandler: (sender: SurveyModel, options: any) => void;
2189
+ checkRemovePageHandler: (sender: SurveyModel, options: any) => void;
2165
2190
  surveyOnPropertyChanged: (sender: SurveyModel, options: any) => void;
2166
2191
  pagesControllerValue: PagesController;
2167
2192
  newPage: PageModel;
@@ -2243,6 +2268,7 @@ export declare class Translation extends Base implements ITranslationLocales {
2243
2268
  static newLineDelimiter: string;
2244
2269
  exportToCSVFileUI: any;
2245
2270
  importFromCSVFileUI: any;
2271
+ importItemCallback: (name: string, locale: string, text: string) => string;
2246
2272
  importFinishedCallback: any;
2247
2273
  translateItemAfterRenderCallback: (item: TranslationItem, el: any, locale: string) => void;
2248
2274
  availableTranlationsChangedCallback: any;
@@ -2295,7 +2321,7 @@ export declare class Translation extends Base implements ITranslationLocales {
2295
2321
  /*
2296
2322
  * Update a translation item with given values
2297
2323
  */
2298
- updateItemWithStrings(item: TranslationItem, values: any, locales: any): void;
2324
+ updateItemWithStrings(name: string, item: TranslationItem, values: any, locales: any): void;
2299
2325
  dispose(): void;
2300
2326
  }
2301
2327
  export declare class TranslationItemBase extends Base {
@@ -2328,22 +2354,22 @@ export declare class UndoRedoController extends Base {
2328
2354
  createActions(): any;
2329
2355
  /*
2330
2356
  * The event is called before undo happens.
2331
- * <br/> options.canUndo a boolean value. It is true by default. Set it false to hide prevent undo operation.
2357
+ * options.canUndo a boolean value. It is true by default. Set it false to hide prevent undo operation.
2332
2358
  */
2333
2359
  onBeforeUndo: Event<(sender: CreatorBase, options: any) => any, any>;
2334
2360
  /*
2335
2361
  * The event is called before redo happens.
2336
- * <br/> options.canRedo a boolean value. It is true by default. Set it false to hide prevent redo operation.
2362
+ * options.canRedo a boolean value. It is true by default. Set it false to hide prevent redo operation.
2337
2363
  */
2338
2364
  onBeforeRedo: Event<(sender: CreatorBase, options: any) => any, any>;
2339
2365
  /*
2340
2366
  * The event is called after undo happens.
2341
- * <br/> options.state is an undo/redo item.
2367
+ * options.state is an undo/redo item.
2342
2368
  */
2343
2369
  onAfterUndo: Event<(sender: CreatorBase, options: any) => any, any>;
2344
2370
  /*
2345
2371
  * The event is called after redo happens.
2346
- * <br/> options.state is an undo/redo item.
2372
+ * options.state is an undo/redo item.
2347
2373
  */
2348
2374
  onAfterRedo: Event<(sender: CreatorBase, options: any) => any, any>;
2349
2375
  }
@@ -2617,7 +2643,7 @@ export declare class TabTestPlugin implements ICreatorPlugin {
2617
2643
  languageListModel: ListModel;
2618
2644
  changeThemePopupModel: any;
2619
2645
  changeThemeModel: ListModel;
2620
- changeThemeAction: Action;
2646
+ protected changeThemeAction: Action;
2621
2647
  deviceSelectorAction: Action;
2622
2648
  deviceListModel: ListModel;
2623
2649
  orientationSelectorAction: Action;
@@ -2631,6 +2657,7 @@ export declare class TabTestPlugin implements ICreatorPlugin {
2631
2657
  activate(): void;
2632
2658
  update(): void;
2633
2659
  deactivate(): boolean;
2660
+ protected getAvailableThemes(themeMapper: any): any;
2634
2661
  createActions(): any;
2635
2662
  addFooterActions(): void;
2636
2663
  }
@@ -2904,8 +2931,7 @@ export declare class PropertyGridEditorMatrix extends PropertyGridEditor {
2904
2931
  protected getAllowRowDragDrop(prop: JsonObjectProperty): boolean;
2905
2932
  getJSON(obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions): any;
2906
2933
  protected getMatrixJSON(obj: Base, prop: JsonObjectProperty, propNames: any, options: ISurveyCreatorOptions): any;
2907
- protected getHideColumnsEmpty(prop: JsonObjectProperty): boolean;
2908
- protected getEmptyRowsText(props: any): string;
2934
+ protected getEmptyRowsText(prop: JsonObjectProperty): string;
2909
2935
  protected getMaximumRowCount(obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions): number;
2910
2936
  protected getColumnsJSON(obj: Base, prop: JsonObjectProperty, propNames: any, options: ISurveyCreatorOptions): any;
2911
2937
  protected getEditItemAsStandAlone(): boolean;
@@ -3027,8 +3053,6 @@ export declare class PropertyGridEditorMatrixItemValues extends PropertyGridEdit
3027
3053
  protected getColumnClassName(obj: Base, prop: JsonObjectProperty): string;
3028
3054
  protected getDefaulColumnNames(): Array<any>;
3029
3055
  protected getKeyValue(): string;
3030
- protected getHideColumnsEmpty(prop: JsonObjectProperty): boolean;
3031
- protected getEmptyRowsText(prop: any): string;
3032
3056
  protected getMaximumRowCount(obj: Base, prop: JsonObjectProperty, options: ISurveyCreatorOptions): number;
3033
3057
  }
3034
3058
  export declare class PropertyGridEditorMatrixMultipleTypes extends PropertyGridEditorMatrix {
@@ -3203,6 +3227,10 @@ export declare var settings: {
3203
3227
  * The maximum number of locales that user can select at once for translation
3204
3228
  */
3205
3229
  maximumSelectedLocales: number,
3230
+ /*
3231
+ * The name of the translation export file in csv format
3232
+ */
3233
+ exportFileName: string,
3206
3234
  },
3207
3235
  operators: {
3208
3236
  empty: any,