survey-creator-core 1.9.37 → 1.9.38

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.37
2
+ * Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.38
3
3
  * Copyright (c) 2015-2022 Devsoft Baltic OÜ - https://surveyjs.io/
4
4
  * License: https://surveyjs.io/Licenses#SurveyCreator
5
5
  */
@@ -64,41 +64,210 @@ export interface ISurveyCreatorOptions {
64
64
  onConditionGetTitleCallback(expression: string, title: string): string;
65
65
  }
66
66
  /*
67
- * Creator options that you can pass in Creator constructor
67
+ * Survey Creator configuration. Pass it as an argument to the `SurveyCreator` constructor:
68
+ *
69
+ * ```js
70
+ * const creator = new SurveyCreator.SurveyCreator(creatorOptions);
71
+ * ```
68
72
  */
69
73
  export interface ICreatorOptions {
74
+ /*
75
+ * Specifies whether to display the Designer tab.
76
+ *
77
+ * Default value: `true`
78
+ */
70
79
  showDesignerTab?: boolean;
80
+ /*
81
+ * Specifies whether to display the Preview tab.
82
+ *
83
+ * Default value: `true`
84
+ */
71
85
  showPreviewTab?: boolean;
86
+ /*
87
+ * Specifies whether to display the JSON Editor tab.
88
+ *
89
+ * Default value: `true`
90
+ */
72
91
  showJSONEditorTab?: boolean;
92
+ /*
93
+ * Specifies whether to display the Logic tab.
94
+ *
95
+ * Default value: `false`
96
+ */
73
97
  showLogicTab?: boolean;
98
+ /*
99
+ * Specifies whether to display the Embed Survey tab.
100
+ *
101
+ * Default value: `false`
102
+ */
74
103
  showEmbeddedSurveyTab?: boolean;
104
+ /*
105
+ * Specifies whether to display the Translation tab.
106
+ *
107
+ * Default value: `false`
108
+ */
75
109
  showTranslationTab?: boolean;
110
+ /*
111
+ * Removes the Free Trial bar.
112
+ *
113
+ * Default value: `false`
114
+ *
115
+ * **IMPORTANT**: You can enable this property only if you have a Survey Creator commercial license. It is illegal to enable this property without a license.
116
+ */
76
117
  haveCommercialLicense?: boolean;
118
+ /*
119
+ * Specifies whether to call the [saveSurveyFunc](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#saveSurveyFunc) each time survey settings are changed.
120
+ *
121
+ * Default value: `false`
122
+ */
77
123
  isAutoSave?: boolean;
78
- isRTLValue?: boolean;
79
- allowEditSurveyTitle?: boolean;
124
+ /*
125
+ * Specifies whether to enable support for right-to-left languages.
126
+ *
127
+ * Default value: `false`
128
+ */
129
+ isRTL?: boolean;
130
+ /*
131
+ * Specifies whether users can see and edit the survey title and related survey properties.
132
+ *
133
+ * Default value: `true`
134
+ */
135
+ showSurveyTitle?: boolean;
136
+ /*
137
+ * Specifies whether users can edit expressions in the Logic tab as plain text.
138
+ *
139
+ * If you set this property to `false`, users can only use UI elements to edit logical expressions.
140
+ *
141
+ * Default value: `true`
142
+ */
80
143
  allowEditExpressionsInTextEditor?: boolean;
81
- showOptions?: boolean;
144
+ /*
145
+ * Specifies whether to display question titles instead of names when users edit logical expressions.
146
+ *
147
+ * Default value: `false`
148
+ */
82
149
  showTitlesInExpressions?: boolean;
83
- useTabsInElementEditor?: boolean;
150
+ /*
151
+ * Specifies whether to show an error message if a survey is not saved in the database.
152
+ *
153
+ * Default value: `true`
154
+ */
84
155
  showErrorOnFailedSave?: boolean;
156
+ /*
157
+ * Specifies whether the Survey Creator generates the survey definition as a valid JSON object or JavaScript object.
158
+ *
159
+ * Default value: `true`
160
+ *
161
+ * 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)
162
+ */
85
163
  generateValidJSON?: boolean;
164
+ /*
165
+ * Enables the read-only mode. If you set this property to `true`, users cannot change the initial survey configuration.
166
+ *
167
+ * Default value: `false`
168
+ */
86
169
  readOnly?: boolean;
87
- showPagesInTestSurveyTab?: boolean;
170
+ /*
171
+ * Specifies whether to show the page selector at the bottom of the Preview tab.
172
+ *
173
+ * Default value: `true`
174
+ */
88
175
  showPagesInPreviewTab?: boolean;
89
- showSimulatorInTestSurveyTab?: boolean;
176
+ /*
177
+ * A [UI theme](https://surveyjs.io/Documentation/Library?id=get-started-react#configure-styles) used to display the survey in the Preview tab.
178
+ *
179
+ * Accepted values: `"modern"`, `"default"`, `"defaultV2"`
180
+ *
181
+ * Default value: `"defaultV2"`
182
+ */
90
183
  themeForPreview?: string;
184
+ /*
185
+ * Specifies whether the Preview tab displays the Device button that allows users to preview the survey on different device types.
186
+ *
187
+ * Default value: `true`
188
+ */
91
189
  showSimulatorInPreviewTab?: boolean;
190
+ /*
191
+ * Specifies whether the Preview tab displays the language selector.
192
+ *
193
+ * Accepted values:
194
+ *
195
+ * - `"auto"` (default)
196
+ * Display the language selector only if the survey is translated to more than one language.
197
+ *
198
+ * - `true`
199
+ * Always display the language selector regardless of how many languages are used in the survey.
200
+ *
201
+ * - `false`
202
+ * Never display the language selector.
203
+ *
204
+ * - `"all"`
205
+ * Always display the language selector with [all supported languages](https://github.com/surveyjs/survey-creator/tree/master/packages/survey-creator-core/src/localization).
206
+ *
207
+ * **See also**: [Localization & Globalization](https://surveyjs.io/Documentation/Survey-Creator?id=localization)
208
+ */
92
209
  showDefaultLanguageInPreviewTab?: string | boolean;
210
+ /*
211
+ * Specifies whether the Preview tab displays a checkbox that allows users to show or hide invisible survey elements.
212
+ *
213
+ * Default value: `true`
214
+ */
93
215
  showInvisibleElementsInPreviewTab?: boolean;
216
+ /*
217
+ * Specifies whether UI elements display survey, page, and question titles instead of their names.
218
+ *
219
+ * Default value: `false`
220
+ */
94
221
  showObjectTitles?: boolean;
222
+ /*
223
+ * Specifies whether the design surface displays the survey title and description when the survey does not contain any elements.
224
+ *
225
+ * Default value: `false`
226
+ */
95
227
  showHeaderInEmptySurvey?: boolean;
228
+ /*
229
+ * Specifies whether users can add, edit, and delete survey pages.
230
+ *
231
+ * Default value: `true`
232
+ */
96
233
  allowModifyPages?: boolean;
234
+ /*
235
+ * 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.
236
+ *
237
+ * Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumColumnsCount`)
238
+ */
97
239
  maximumColumnsCount?: number;
240
+ /*
241
+ * 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.
242
+ *
243
+ * Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumChoicesCount`)
244
+ */
98
245
  maximumChoicesCount?: number;
246
+ /*
247
+ * 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.
248
+ *
249
+ * Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumRowsCount`)
250
+ */
99
251
  maximumRowsCount?: number;
252
+ /*
253
+ * Limits the number of rate value that users can add to [Rating](https://surveyjs.io/Documentation/Library?id=questionratingmodel) questions.
254
+ *
255
+ * Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumRateValues`)
256
+ */
100
257
  maximumRateValues?: number;
258
+ /*
259
+ * Limits the number of items in a logical expression.
260
+ *
261
+ * Default value: -1 (unlimited)
262
+ */
101
263
  maxLogicItemsInCondition?: number;
264
+ /*
265
+ * Specifies whether users can switch between UI themes in the Preview tab.
266
+ *
267
+ * Default value: `true`
268
+ *
269
+ * [View the "Switch Between Themes" demo](https://surveyjs.io/Examples/Creator?id=theme-switcher)
270
+ */
102
271
  allowChangeThemeInPreview?: boolean;
103
272
  }
104
273
  /*
@@ -302,11 +471,15 @@ export declare class CreatorAction extends Action implements ICreatorAction {
302
471
  export declare class CreatorBase extends Base implements ISurveyCreatorOptions, ICreatorSelectionOwner {
303
472
  constructor(options: ICreatorOptions, options2?: ICreatorOptions);
304
473
  /*
305
- * Set it to true to show "Designer" tab and to false to hide the tab
474
+ * Specifies whether to display the Designer tab.
475
+ *
476
+ * Default value: `true`
306
477
  */
307
478
  showDesignerTab: boolean;
308
479
  /*
309
- * Set it to true to show "JSON Editor" tab and to false to hide the tab
480
+ * Specifies whether to display the JSON Editor tab.
481
+ *
482
+ * Default value: `true`
310
483
  */
311
484
  showJSONEditorTab: boolean;
312
485
  /*
@@ -314,20 +487,28 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
314
487
  */
315
488
  showTestSurveyTab: boolean;
316
489
  /*
317
- * Set it to true to show "Preview" tab and to false to hide the tab
490
+ * Specifies whether to display the Preview tab.
491
+ *
492
+ * Default value: `true`
318
493
  */
319
494
  get showPreviewTab(): boolean;
320
495
  set showPreviewTab(val: boolean);
321
496
  /*
322
- * Set it to true to show "Embed Survey" tab and to false to hide the tab
497
+ * Specifies whether to display the Embed Survey tab.
498
+ *
499
+ * Default value: `false`
323
500
  */
324
501
  showEmbeddedSurveyTab: boolean;
325
502
  /*
326
- * Set it to true to show "Translation" tab and to false to hide the tab
503
+ * Specifies whether to display the Translation tab.
504
+ *
505
+ * Default value: `false`
327
506
  */
328
507
  showTranslationTab: boolean;
329
508
  /*
330
- * Set it to true to show "Logic" tab and to false to hide the tab
509
+ * Specifies whether to display the Logic tab.
510
+ *
511
+ * Default value: `false`
331
512
  */
332
513
  showLogicTab: boolean;
333
514
  useTableViewInLogicTab: boolean;
@@ -340,19 +521,30 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
340
521
  */
341
522
  inplaceEditForValues: boolean;
342
523
  /*
343
- * Set it to false to hide survey title and coresponding properties
524
+ * Obsolete. Use the [`showSurveyTitle`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showSurveyTitle) property instead.
344
525
  */
345
526
  get allowEditSurveyTitle(): boolean;
346
527
  set allowEditSurveyTitle(val: boolean);
347
528
  /*
348
- * You have right to set this property to true if you have bought the commercial licence only.
349
- * It will remove the text about non-commerical usage on the top of the widget.
350
- * Setting this property true without having a commercial licence is illegal.
529
+ * Specifies whether users can see and edit the survey title and related survey properties.
530
+ *
531
+ * Default value: `true`
532
+ */
533
+ get showSurveyTitle(): boolean;
534
+ set showSurveyTitle(val: boolean);
535
+ /*
536
+ * Removes the Free Trial bar.
537
+ *
538
+ * Default value: `false`
539
+ *
540
+ * **IMPORTANT**: You can enable this property only if you have a Survey Creator commercial license. It is illegal to enable this property without a license.
351
541
  */
352
542
  haveCommercialLicense: boolean;
353
543
  get licenseText(): string;
354
544
  /*
355
- * A boolean property, false by default. Set it to true to call protected doSave method automatically on survey changing.
545
+ * Specifies whether to call the [saveSurveyFunc](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#saveSurveyFunc) each time survey settings are changed.
546
+ *
547
+ * Default value: `false`
356
548
  */
357
549
  isAutoSave: boolean;
358
550
  showOptions: boolean;
@@ -406,44 +598,45 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
406
598
  getPlugin<P extends ICreatorPlugin = ICreatorPlugin>(name: string): any;
407
599
  /*
408
600
  * 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.
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
601
+ * - sender the survey creator object that fires the event
602
+ * - options.element an instance of the deleting element
603
+ * - options.elementType the type of the element: 'question', 'panel' or 'page'.
604
+ * - options.allowing set it to false to cancel the element deleting
413
605
  */
414
606
  onElementDeleting: Event<(sender: CreatorBase, options: any) => any, any>;
415
607
  /*
416
608
  * The event is called on setting a readOnly property of the property editor. By default the property.readOnly property is used.
417
609
  * You may changed it and make the property editor read only or enabled for a particular object.
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.
610
+ * - sender the survey creator object that fires the event
611
+ * - options.obj the survey object, Survey, Page, Panel or Question
612
+ * - options.property the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties.
613
+ * - options.readOnly a boolean value. It has value equals to options.readOnly property by default. You may change it.
614
+ * - 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).
615
+ * - 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.
424
616
  */
425
617
  onGetPropertyReadOnly: Event<(sender: CreatorBase, options: any) => any, any>;
426
618
  /*
427
619
  * The event is fired when the survey creator creates a survey object (Survey.Survey).
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.
620
+ * - sender the survey creator object that fires the event
621
+ * - options.survey the survey object showing in the creator.
622
+ * - 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.
431
623
  */
432
624
  onSurveyInstanceCreated: Event<(sender: CreatorBase, options: any) => any, any>;
433
625
  /*
434
626
  * 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.
435
627
  * Use this event, if you want custom display name for objects.
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
628
+ * - sender the survey creator object that fires the event
629
+ * - options.obj the survey object, Survey, Page, Panel or Question
630
+ * - options.reason the name of the UI that requests the object display name.
631
+ * - options.displayName change this property to show your custom display name for the object
632
+ *
440
633
  * 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.
634
+ * - "condition" - raised from Condition modal window or on setup condition in a logic tab
635
+ * - "survey-tester" - raised from page selector list in "Preview" tab
636
+ * - "survey-tester-selected" - raised on setting page selector title in "Preview" tab
637
+ * - "survey-translation" - raised from translation tab
638
+ * - "property-grid" - raised from showing object selector for property grid in "Designer" tab.
639
+ * - "property-grid-title" - raised on rendering selected object title in property grid in "Designer" tab.
447
640
  */
448
641
  onGetObjectDisplayName: Event<(sender: CreatorBase, options: any) => any, any>;
449
642
  /*
@@ -478,19 +671,19 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
478
671
  onElementAllowOperations: Event<(sender: CreatorBase, options: any) => any, any>;
479
672
  /*
480
673
  * Use this event to add/remove/modify the element (question/panel) menu items.
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.
674
+ * - sender the survey creator object that fires the event
675
+ * - options.obj the survey object which property is edited in the Property Editor.
676
+ * - options.items the list of menu items. It has two required fields: text and onClick: function(obj: Survey.Base) {} and optional name field.
484
677
  */
485
678
  onDefineElementMenuItems: Event<(sender: CreatorBase, options: any) => any, any>;
486
679
  /*
487
680
  * The event is called before showing a property in the Properties Grid or in the Question Editor.
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.
681
+ * - sender the survey creator object that fires the event
682
+ * - options.obj the survey object, Survey, Page, Panel or Question
683
+ * - options.property the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties.
684
+ * - 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.
685
+ * - 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).
686
+ * - 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
687
  *
495
688
  * [Example: Hide a category in the Properties Grid](https://surveyjs.io/Examples/Survey-Creator?id=hidecategoryinpropertiesgrid)
496
689
  */
@@ -499,106 +692,106 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
499
692
  /*
500
693
  * The event is called after a survey that represents the Property Grid is created and all its questions (property editors) are setup.
501
694
  * You can use this event to modify this survey to change the property grid behavior
502
- * options.obj the survey object that is currently editing in the property grid
503
- * options.survey the property grid survey
695
+ * - options.obj the survey object that is currently editing in the property grid
696
+ * - options.survey the property grid survey
504
697
  */
505
698
  onPropertyGridSurveyCreated: Event<(sender: CreatorBase, options: any) => any, any>;
506
699
  /*
507
700
  * The event is called after a property editor (in fact a survey question) has been created and all it's properties have been assign.
508
701
  * You can use this event to modify the property editor properties or set event handlers to customize it's behavior
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.
702
+ * - options.obj the survey object that is currently editing in the property grid
703
+ * - options.property the property that the current property editor is editing
704
+ * - 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.
512
705
  */
513
706
  onPropertyEditorCreated: Event<(sender: CreatorBase, options: any) => any, any>;
514
707
  /*
515
708
  * The event is called after a property editor setups its title actions.
516
709
  * You can use this event to modify the property editor 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.
710
+ * - options.obj the survey object that is currently editing in the property grid
711
+ * - options.property the property that the current property editor is editing
712
+ * - 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.
713
+ * - options.titleActions the list of title actions.
521
714
  */
522
715
  onPropertyEditorUpdateTitleActions: Event<(sender: CreatorBase, options: any) => any, any>;
523
716
  /*
524
717
  * The event is called before rendering a delete button in the Property Grid or in Question Editor.
525
718
  * Obsolete, please use onCollectionItemAllowOperations
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
719
+ * - sender the survey creator object that fires the event
720
+ * - options.obj the survey Question
721
+ * - options.item the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
722
+ * - 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
530
723
  */
531
724
  onCanDeleteItem: Event<(sender: CreatorBase, options: any) => any, any>;
532
725
  /*
533
726
  * 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.
534
727
  * Obsolete, please use onCollectionItemAllowOperations
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
728
+ * - sender the survey creator object that fires the event
729
+ * - options.obj the survey object: Question, Panel, Page or Survey
730
+ * - options.property the collection property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
731
+ * - options.propertyName the collection property name
732
+ * - 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.
733
+ * - options.item the collection item that we are going to delete
734
+ * - options.allowDelete a boolean value. It is true by default. Set it false to abondome the element removing from the collection
542
735
  */
543
736
  onCollectionItemDeleting: Event<(sender: CreatorBase, options: any) => any, any>;
544
737
  /*
545
738
  * 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.
546
739
  * You can make detail/edit and remove buttons invsible and/or 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.
740
+ * - sender the survey creator object that fires the event
741
+ * - options.obj the survey object: Question, Panel, Page or Survey
742
+ * - options.property the collection property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
743
+ * - options.propertyName the collection property name
744
+ * - 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.
745
+ * - options.item the collection item that we are going to delete
746
+ * - options.allowDelete a boolean value. It is true by default. Set it false to abondome the element removing from the collection
747
+ * - options.allowEdit a boolean value. It is true by default. Set it false to disable editing.
555
748
  */
556
749
  onCollectionItemAllowOperations: Event<(sender: CreatorBase, options: any) => any, any>;
557
750
  /*
558
751
  * 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.
559
752
  * Use this event, to set ItemValue.value and ItemValue.text properties by default or set a value to the custom property.
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.
753
+ * - sender the survey creator object that fires the event
754
+ * - options.obj the object that contains the itemsValues array, for example selector, rating and single choice matrix questions.
755
+ * - 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.
756
+ * - options.newItem a new created Survey.ItemValue object.
757
+ * - options.itemValues an editing Survey.ItemValue array. newItem object is not added yet into this array.
565
758
  */
566
759
  onItemValueAdded: Event<(sender: CreatorBase, options: any) => any, any>;
567
760
  /*
568
761
  * 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.
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.
762
+ * - sender the survey creator object that fires the event
763
+ * - options.matrix a matrix question where column is located, matrix.columns.
764
+ * - options.newColumn a new created Survey.MatrixDropdownColumn object.
765
+ * - 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.
573
766
  */
574
767
  onMatrixColumnAdded: Event<(sender: CreatorBase, options: any) => any, any>;
575
768
  /*
576
769
  * Use this event to control Property Editors UI.
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.
770
+ * - sender the survey creator object that fires the event
771
+ * - options.obj the survey object which property is edited in the Property Editor.
772
+ * - options.propertyName the name of the edited property.
773
+ * - options.editorOptions options that can be changed.
774
+ * - 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'.
775
+ * - 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'.
776
+ * - options.editorOptions.showTextView a boolean property, true by default. Set it false to disable "Manual Entry" tab for "choices" property.
777
+ * - options.editorOptions.itemsEntryType a string property, 'form' by default. Set it 'fast' to show "Manual Entry" tab for "choices" property by default.
585
778
  */
586
779
  onSetPropertyEditorOptions: Event<(sender: CreatorBase, options: any) => any, any>;
587
780
  /*
588
781
  * The event is called on generation a new name for a new created element.
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
782
+ * - sender the survey creator object that fires the event
783
+ * - options.element a new created survey element. It can be question, panel or page
784
+ * - 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.
785
+ * - options.isUnique a boolean property, set this property to false, if you want to ask Creator to generate another name
593
786
  */
594
787
  onGenerateNewName: Event<(sender: CreatorBase, options: any) => any, any>;
595
788
  /*
596
789
  * 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.
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.
790
+ * - sender the survey creator object that fires the event
791
+ * - options.obj the survey object which property is edited in the Property Editor.
792
+ * - options.propertyName the name of the edited property.
793
+ * - options.value the property value.
794
+ * - options.error the error you want to display. Set the empty string (the default value) or null if there is no errors.
602
795
  */
603
796
  onPropertyValidationCustomError: Event<(sender: CreatorBase, options: any) => any, any>;
604
797
  /*
@@ -626,98 +819,98 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
626
819
  onSurveyPropertyValueChanged: Event<(sender: CreatorBase, options: any) => any, any>;
627
820
  /*
628
821
  * Use this event to modify the list (name and titles) of the questions available in a condition editor.
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
822
+ * - sender the survey creator object that fires the event
823
+ * - options.obj the survey object which property is edited in the Property Editor.
824
+ * - options.propertyName the name of the edited property.
825
+ * - options.editor the instance of Property Editor.
826
+ * - options.list the list of the questions available for condition
634
827
  */
635
828
  onConditionQuestionsGetList: Event<(sender: CreatorBase, options: any) => any, any>;
636
829
  /*
637
830
  * 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
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.
831
+ * - sender the survey creator object that fires the event.
832
+ * - options.expression the current expression. If the expression is empty or incorrect then the value is empty.
833
+ * - options.title the default value of the title. You can change the default value.
641
834
  */
642
835
  onConditionGetTitle: Event<(sender: CreatorBase, options: any) => any, any>;
643
836
  /*
644
837
  * 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.
645
- * sender the survey creator object that fires the event
838
+ * - sender the survey creator object that fires the event
646
839
  * options object contains the information about certain modifications
647
- * options.type contains string constant describing certain modification
840
+ * - options.type contains string constant describing certain modification
648
841
  * Available values:
649
842
  *
650
- * options.type: "ADDED_FROM_TOOLBOX"
651
- * options.question: newly added question
843
+ * - options.type: "ADDED_FROM_TOOLBOX"
844
+ * - options.question: newly added question
652
845
  *
653
- * options.type: "PAGE_ADDED"
654
- * options.newValue: newly created page
846
+ * - options.type: "PAGE_ADDED"
847
+ * - options.newValue: newly created page
655
848
  *
656
- * options.type: "PAGE_MOVED"
657
- * options.page: page has been moved
658
- * options.indexFrom: pevious index
659
- * options.indexTo: new index
849
+ * - options.type: "PAGE_MOVED"
850
+ * - options.page: page has been moved
851
+ * - options.indexFrom: pevious index
852
+ * - options.indexTo: new index
660
853
  *
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
854
+ * - options.type: "QUESTION_CONVERTED"
855
+ * - options.className: the converted class name
856
+ * - options.oldValue: pevious object
857
+ * - options.newValue: the new object, converted from oldVale to the given class name
665
858
  *
666
- * options.type: "QUESTION_CHANGED_BY_EDITOR"
667
- * options.question: question has been edited in the popup question editor
859
+ * - options.type: "QUESTION_CHANGED_BY_EDITOR"
860
+ * - options.question: question has been edited in the popup question editor
668
861
  *
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
862
+ * - options.type: "PROPERTY_CHANGED"
863
+ * - options.name: the name of the property has been changed
864
+ * - options.target: the object containing the changed property
865
+ * - options.oldValue: the previous value of the changed property
866
+ * - options.newValue: the new value of the changed property
674
867
  *
675
- * options.type: "OBJECT_DELETED"
676
- * options.target: deleted object
868
+ * - options.type: "OBJECT_DELETED"
869
+ * - options.target: deleted object
677
870
  *
678
- * options.type: "VIEW_TYPE_CHANGED"
679
- * options.newType: new type of the creator view: editor or designer
871
+ * - options.type: "VIEW_TYPE_CHANGED"
872
+ * - options.newType: new type of the creator view: editor or designer
680
873
  *
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
874
+ * - options.type: "DO_DROP"
875
+ * - options.page: the page of the drap/drop operation
876
+ * - options.source: the source dragged object
877
+ * - options.target: the drop target
878
+ * - options.newElement: a new element. It is defined if a user drops question or panel from the toolbox
686
879
  *
687
- * options.type: "TRANSLATIONS_CHANGED"
688
- * options.type: "JSON_EDITOR"
880
+ * - options.type: "TRANSLATIONS_CHANGED"
881
+ * - options.type: "JSON_EDITOR"
689
882
  */
690
883
  onModified: Event<(sender: CreatorBase, options: any) => any, any>;
691
884
  /*
692
885
  * 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.
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.
886
+ * - sender the survey creator object that fires the event
887
+ * - options.question a new added survey question. Survey.Question object
888
+ * - options.page the survey Page object where question has been added.
696
889
  */
697
890
  onQuestionAdded: Event<(sender: CreatorBase, options: any) => any, any>;
698
891
  /*
699
892
  * 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.
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.
893
+ * - sender the survey creator object that fires the event
894
+ * - options.panel a new added survey panel. Survey.Panel object
895
+ * - options.page the survey Page object where question has been added.
703
896
  */
704
897
  onPanelAdded: Event<(sender: CreatorBase, options: any) => any, any>;
705
898
  /*
706
899
  * The event is called on adding a new page into the survey.
707
- * sender the survey creator object that fires the event
708
- * options.page the new survey Page object.
900
+ * - sender the survey creator object that fires the event
901
+ * - options.page the new survey Page object.
709
902
  */
710
903
  onPageAdded: Event<(sender: CreatorBase, options: any) => any, any>;
711
904
  /*
712
905
  * The event is fired when the survey creator is initialized and a survey object (Survey.Survey) is created.
713
- * sender the survey creator object that fires the event
714
- * options.survey the survey object showing in the creator.
906
+ * - sender the survey creator object that fires the event
907
+ * - options.survey the survey object showing in the creator.
715
908
  */
716
909
  onDesignerSurveyCreated: Event<(sender: CreatorBase, options: any) => any, any>;
717
910
  /*
718
911
  * The event is fired when the survey creator creates survey in Preview tab for testing.
719
- * sender the survey creator object that fires the event
720
- * options.survey the survey object showing in the "Preview" tab.
912
+ * - sender the survey creator object that fires the event
913
+ * - options.survey the survey object showing in the "Preview" tab.
721
914
  */
722
915
  onPreviewSurveyCreated: Event<(sender: CreatorBase, options: any) => any, any>;
723
916
  /*
@@ -727,29 +920,29 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
727
920
  /*
728
921
  * The event is called in case of UI notifications. By default all notifications are done via built-in alert () function.
729
922
  * In case of any subscriptions to this event all notifications will be redirected into the event handler.
730
- * options.message is a message to show.
923
+ * - options.message is a message to show.
731
924
  */
732
925
  onNotify: Event<(sender: CreatorBase, options: any) => any, any>;
733
926
  /*
734
927
  * 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
735
- * options.newSelectedElement the element that is going to be selected in the survey desiger: question, panel, page or survey.
928
+ * - options.newSelectedElement the element that is going to be selected in the survey desiger: question, panel, page or survey.
736
929
  */
737
930
  onSelectedElementChanging: Event<(sender: CreatorBase, options: any) => any, any>;
738
931
  /*
739
932
  * The event is called after the selected element is changed.
740
- * options.newSelectedElement the new selected element in the survey desiger: question, panel, page or survey.
933
+ * - options.newSelectedElement the new selected element in the survey desiger: question, panel, page or survey.
741
934
  */
742
935
  onSelectedElementChanged: Event<(sender: CreatorBase, options: any) => any, any>;
743
936
  /*
744
937
  * The event is fired then one need to choose files.
745
- * sender the survey creator object that fires the event
938
+ * - sender the survey creator object that fires the event
746
939
  * input file input HTML element
747
940
  * callback need to be called after files has been chosen
748
941
  */
749
942
  onOpenFileChooser: Event<(sender: CreatorBase, options: any) => any, any>;
750
943
  /*
751
944
  * The event is fired on uploading the files.
752
- * sender the survey creator object that fires the event
945
+ * - sender the survey creator object that fires the event
753
946
  * There are two properties in options:
754
947
  * files the Javascript File objects array
755
948
  * callback called on upload complete,
@@ -795,30 +988,30 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
795
988
  onTranslationImported: Event<(sender: CreatorBase, options: any) => any, any>;
796
989
  /*
797
990
  * Use this event to control drag&drop operations.
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.
991
+ * - sender the survey creator object that fires the event.
992
+ * - options.survey the editing survey object.
993
+ * - options.allow set it to false to disable dragging.
994
+ * - options.target a target element that is dragging.
995
+ * - options.source a source element. It can be null, if it is a new element, dragging from toolbox.
996
+ * - options.parent a page or panel where target element is dragging.
997
+ * - 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.
998
+ * - 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.
806
999
  */
807
1000
  onDragDropAllow: Event<(sender: CreatorBase, options: any) => any, any>;
808
1001
  /*
809
1002
  * Use this event to override/disable element adorners - wrapping component 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.
1003
+ * - sender the survey creator object that fires the event.
1004
+ * - options.element a survey object to be wrapped.
1005
+ * - options.reason why we need to wrap an element.
1006
+ * - options.conponentName component wrapper name.
814
1007
  */
815
1008
  onGetElementWrapperComponentName: Event<(sender: CreatorBase, options: any) => any, any>;
816
1009
  /*
817
1010
  * Use this event to override/disable element adorners - wrapping component 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.
1011
+ * - sender the survey creator object that fires the event.
1012
+ * - options.element a survey object to be wrapped.
1013
+ * - options.reason why we need to wrap an element.
1014
+ * - options.conponentData component wrapper data.
822
1015
  */
823
1016
  onGetElementWrapperComponentData: Event<(sender: CreatorBase, options: any) => any, any>;
824
1017
  /*
@@ -830,87 +1023,124 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
830
1023
  */
831
1024
  setSurveyJSONTextCallback: (text: string) => void;
832
1025
  /*
833
- * You need to set this property to true if you want to use tabs instead of accordion in the popup element's editor.
834
- */
835
- useTabsInElementEditor: boolean;
836
- /*
837
- * You need to set this property to value bigger than 0 to disable adding more logic items in condition than this value.
1026
+ * Limits the number of items in a logical expression.
1027
+ *
1028
+ * Default value: -1 (unlimited)
838
1029
  */
839
1030
  maxLogicItemsInCondition: number;
840
1031
  /*
841
- * You need to set this property to true if you want to show titles instead of names in pages editor and object selector.
1032
+ * Specifies whether UI elements display survey, page, and question titles instead of their names.
1033
+ *
1034
+ * Default value: `false`
842
1035
  */
843
1036
  showObjectTitles: boolean;
844
1037
  /*
845
- * You need to set this property to true if you want to show titles instead of names in expression editor.
1038
+ * Specifies whether to display question titles instead of names when users edit logical expressions.
1039
+ *
1040
+ * Default value: `false`
846
1041
  */
847
1042
  showTitlesInExpressions: boolean;
848
1043
  /*
849
- * You need to set this property to false to allow your users build expressions visually only, without editing them in text editor.
1044
+ * Specifies whether users can edit expressions in the Logic tab as plain text.
1045
+ *
1046
+ * If you set this property to `false`, users can only use UI elements to edit logical expressions.
1047
+ *
1048
+ * Default value: `true`
850
1049
  */
851
1050
  allowEditExpressionsInTextEditor: boolean;
852
1051
  /*
853
- * You need to set this property to number more than 0 to limit the number of columns that users can create for matrix dynamic/matrix dropdown questions.
1052
+ * 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.
1053
+ *
1054
+ * Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumColumnsCount`)
854
1055
  */
855
1056
  maximumColumnsCount: number;
856
1057
  /*
857
- * You need to set this property to number more than 0 to limit the number of choices that users can added to checkbox/dropdown/radiogroup questions.
1058
+ * 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.
1059
+ *
1060
+ * Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumChoicesCount`)
858
1061
  */
859
1062
  maximumChoicesCount: number;
860
1063
  /*
861
- * You need to set this property to number more than 0 to limit the number of rows that users can add to matrix dropdown and single matrix questions.
1064
+ * 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.
1065
+ *
1066
+ * Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumRowsCount`)
862
1067
  */
863
1068
  maximumRowsCount: number;
864
1069
  /*
865
- * You need to set this property to number more than 0 to limit the number of rate values that users can add to rate question.
1070
+ * Limits the number of rate value that users can add to [Rating](https://surveyjs.io/Documentation/Library?id=questionratingmodel) questions.
1071
+ *
1072
+ * Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumRateValues`)
866
1073
  */
867
1074
  maximumRateValues: number;
868
1075
  /*
869
- * Obsolete. Please use showPagesInPreviewTab
1076
+ * Obsolete. Use the [`showPagesInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showPagesInPreviewTab) property instead.
870
1077
  */
871
1078
  showPagesInTestSurveyTab: boolean;
872
1079
  /*
873
- * Set this property to false to hide the pages selector in the Preview Tab
1080
+ * Specifies whether to show the page selector at the bottom of the Preview tab.
1081
+ *
1082
+ * Default value: `true`
874
1083
  */
875
1084
  get showPagesInPreviewTab(): boolean;
876
1085
  set showPagesInPreviewTab(val: boolean);
877
1086
  /*
878
- * Obsolete. Please use showSimulatorInPreviewTab.
1087
+ * Obsolete. Use the [`showSimulatorInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showSimulatorInPreviewTab) property instead.
879
1088
  */
880
1089
  showSimulatorInTestSurveyTab: boolean;
881
1090
  /*
882
- * Set this property to false to hide the device simulator in the Preview Tab
1091
+ * Specifies whether the Preview tab displays the Device button that allows users to preview the survey on different device types.
1092
+ *
1093
+ * Default value: `true`
883
1094
  */
884
1095
  get showSimulatorInPreviewTab(): boolean;
885
1096
  set showSimulatorInPreviewTab(val: boolean);
886
1097
  /*
887
- * Specifies a theme to use for the survey in the Preview tab.
1098
+ * A [UI theme](https://surveyjs.io/Documentation/Library?id=get-started-react#configure-styles) used to display the survey in the Preview tab.
1099
+ *
888
1100
  * Accepted values: `"modern"`, `"default"`, `"defaultV2"`
1101
+ *
1102
+ * Default value: `"defaultV2"`
889
1103
  */
890
1104
  themeForPreview: string;
891
1105
  /*
892
- * Set this property to false to disable pages adding, editing and deleting
1106
+ * Specifies whether users can add, edit, and delete survey pages.
1107
+ *
1108
+ * Default value: `true`
893
1109
  */
894
1110
  allowModifyPages: boolean;
895
1111
  /*
896
- * Obsolete. Please use showDefaultLanguageInPreviewTab
1112
+ * Obsolete. Use the [`showDefaultLanguageInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showDefaultLanguageInPreviewTab) property instead.
897
1113
  */
898
1114
  showDefaultLanguageInTestSurveyTab: string | boolean;
899
1115
  /*
900
- * The default value is _"auto"_. It shows the language selector if there are more than two languages are using in the survey.
901
- * It shows only used languages in the survey.
902
- * Set this property to _false_ to hide the default language selector in the Preview Tab.
903
- * Set it to _true_ to show this selector even if there is only one language in the survey
904
- * Set it to _all_ to show the selector with all available languages (30+)
1116
+ * Specifies whether the Preview tab displays the language selector.
1117
+ *
1118
+ * Accepted values:
1119
+ *
1120
+ * - `"auto"` (default)
1121
+ * Display the language selector only if the survey is translated to more than one language.
1122
+ *
1123
+ * - `true`
1124
+ * Always display the language selector regardless of how many languages are used in the survey.
1125
+ *
1126
+ * - `false`
1127
+ * Never display the language selector.
1128
+ *
1129
+ * - `"all"`
1130
+ * Always display the language selector with [all supported languages](https://github.com/surveyjs/survey-creator/tree/master/packages/survey-creator-core/src/localization).
1131
+ *
1132
+ * **See also**: [Localization & Globalization](https://surveyjs.io/Documentation/Survey-Creator?id=localization)
905
1133
  */
906
1134
  get showDefaultLanguageInPreviewTab(): string | boolean;
907
1135
  set showDefaultLanguageInPreviewTab(val: string | boolean);
908
1136
  /*
909
- * Set this property to false to hide the show invisible element checkbox in the Preview Tab
1137
+ * Obsolete. Use the [`showInvisibleElementsInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showInvisibleElementsInPreviewTab) property instead.
910
1138
  */
911
1139
  showInvisibleElementsInTestSurveyTab: boolean;
912
1140
  /*
913
- * Set this property to false to hide the show invisible element checkbox in the Preview Tab
1141
+ * Specifies whether the Preview tab displays a checkbox that allows users to show or hide invisible survey elements.
1142
+ *
1143
+ * Default value: `true`
914
1144
  */
915
1145
  get showInvisibleElementsInPreviewTab(): boolean;
916
1146
  set showInvisibleElementsInPreviewTab(val: boolean);
@@ -919,7 +1149,11 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
919
1149
  */
920
1150
  showPageSelectorInToolbar: boolean;
921
1151
  /*
922
- * Set this property to false if you want to hide the "theme selector" in the Preview Tab
1152
+ * Specifies whether users can switch between UI themes in the Preview tab.
1153
+ *
1154
+ * Default value: `true`
1155
+ *
1156
+ * [View the "Switch Between Themes" demo](https://surveyjs.io/Examples/Creator?id=theme-switcher)
923
1157
  */
924
1158
  allowChangeThemeInPreview: boolean;
925
1159
  tabbedMenu: any;
@@ -930,7 +1164,9 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
930
1164
  */
931
1165
  getLocString(str: string): string;
932
1166
  /*
933
- * Set it to false to suppress an alert message about error on saving the survey into database.
1167
+ * Specifies whether to show an error message if a survey is not saved in the database.
1168
+ *
1169
+ * Default value: `true`
934
1170
  */
935
1171
  showErrorOnFailedSave: boolean;
936
1172
  protected onSetReadOnly(newVal: boolean): void;
@@ -941,25 +1177,29 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
941
1177
  get locale(): string;
942
1178
  set locale(val: string);
943
1179
  /*
944
- * A boolean property, false by default. Set it to true to deny editing.
1180
+ * Enables the read-only mode. If you set this property to `true`, users cannot change the initial survey configuration.
1181
+ *
1182
+ * Default value: `false`
945
1183
  */
946
1184
  get readOnly(): boolean;
947
1185
  set readOnly(val: boolean);
948
1186
  /*
949
- * Set it to true to activate RTL support
1187
+ * Specifies whether to enable support for right-to-left languages.
1188
+ *
1189
+ * Default value: `false`
950
1190
  */
951
1191
  get isRTL(): boolean;
952
1192
  set isRTL(val: boolean);
953
1193
  /*
954
1194
  * The event is called when creator is going to change the active tab.
955
- * sender the survey creator object that fires the event
956
- * options.tabName the name of new active tab
1195
+ * - sender the survey creator object that fires the event
1196
+ * - options.tabName the name of new active tab
957
1197
  */
958
1198
  onActiveTabChanging: Event<(sender: CreatorBase, options: any) => any, any>;
959
1199
  /*
960
1200
  * The event is called when creator active tab is changed.
961
- * sender the survey creator object that fires the event
962
- * options.tabName the name of new active tab
1201
+ * - sender the survey creator object that fires the event
1202
+ * - options.tabName the name of new active tab
963
1203
  */
964
1204
  onActiveTabChanged: Event<(sender: CreatorBase, options: any) => any, any>;
965
1205
  /*
@@ -995,22 +1235,22 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
995
1235
  leftContainerActiveItem(name: string): void;
996
1236
  /*
997
1237
  * The event is called before undo happens.
998
- * options.canUndo a boolean value. It is true by default. Set it false to hide prevent undo operation.
1238
+ * - options.canUndo a boolean value. It is true by default. Set it false to hide prevent undo operation.
999
1239
  */
1000
1240
  onBeforeUndo: Event<(sender: CreatorBase, options: any) => any, any>;
1001
1241
  /*
1002
1242
  * The event is called before redo happens.
1003
- * options.canRedo a boolean value. It is true by default. Set it false to hide prevent redo operation.
1243
+ * - options.canRedo a boolean value. It is true by default. Set it false to hide prevent redo operation.
1004
1244
  */
1005
1245
  onBeforeRedo: Event<(sender: CreatorBase, options: any) => any, any>;
1006
1246
  /*
1007
1247
  * The event is called after undo happens.
1008
- * options.state is an undo/redo item.
1248
+ * - options.state is an undo/redo item.
1009
1249
  */
1010
1250
  onAfterUndo: Event<(sender: CreatorBase, options: any) => any, any>;
1011
1251
  /*
1012
1252
  * The event is called after redo happens.
1013
- * options.state is an undo/redo item.
1253
+ * - options.state is an undo/redo item.
1014
1254
  */
1015
1255
  onAfterRedo: Event<(sender: CreatorBase, options: any) => any, any>;
1016
1256
  get undoRedoManager(): UndoRedoManager;
@@ -1940,7 +2180,6 @@ export declare class SurveyLogic extends Base implements ISurveyLogicItemOwner {
1940
2180
  * options.item is the removed logic item.
1941
2181
  */
1942
2182
  onLogicItemRemoved: Event<(sender: SurveyLogic, options: any) => any, any>;
1943
- koAfterRender: any;
1944
2183
  dispose(): void;
1945
2184
  items: any;
1946
2185
  logicTypes: any;
@@ -2236,7 +2475,6 @@ export declare class TestSurveyTabViewModel extends Base {
2236
2475
  testAgain(): void;
2237
2476
  buildActions(): void;
2238
2477
  setTheme(themeName: string, themeMapper: any): void;
2239
- getCurrThemeTitle(themeMapper: any): string;
2240
2478
  protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
2241
2479
  }
2242
2480
  export declare class ToolbarActionContainer extends ActionContainer {
@@ -2448,8 +2686,15 @@ export declare class ImageItemValueWrapperViewModel extends ItemValueWrapperView
2448
2686
  item: ImageItemValue;
2449
2687
  templateData: any;
2450
2688
  itemsRoot: any;
2689
+ isFileDragging: boolean;
2690
+ getRootCss(): string;
2691
+ getIsNewItemSingle(): boolean;
2451
2692
  chooseFile(model: ImageItemValueWrapperViewModel): void;
2693
+ uploadFiles(files: any): void;
2452
2694
  chooseNewFile(model: ImageItemValueWrapperViewModel): void;
2695
+ onDragOver: (event: any) => void;
2696
+ onDrop: (event: any) => void;
2697
+ onDragLeave: (event: any) => void;
2453
2698
  }
2454
2699
  export declare class LogicActionModel extends LogicActionModelBase {
2455
2700
  constructor(panel: PanelModel, logicAction: SurveyLogicAction, logicType: SurveyLogicType, selectorElementsHash: any);
@@ -2643,7 +2888,7 @@ export declare class TabTestPlugin implements ICreatorPlugin {
2643
2888
  languageListModel: ListModel;
2644
2889
  changeThemePopupModel: any;
2645
2890
  changeThemeModel: ListModel;
2646
- protected changeThemeAction: Action;
2891
+ protected changeThemeAction: CreatorAction;
2647
2892
  deviceSelectorAction: Action;
2648
2893
  deviceListModel: ListModel;
2649
2894
  orientationSelectorAction: Action;
@@ -2657,8 +2902,8 @@ export declare class TabTestPlugin implements ICreatorPlugin {
2657
2902
  activate(): void;
2658
2903
  update(): void;
2659
2904
  deactivate(): boolean;
2660
- protected getAvailableThemes(themeMapper: any): any;
2661
- createActions(): any;
2905
+ protected filterThemeMapper(themeMapper: any): Array<any>;
2906
+ createActions(): Array<Action>;
2662
2907
  addFooterActions(): void;
2663
2908
  }
2664
2909
  export declare class TabTranslationPlugin implements ICreatorPlugin {
@@ -3025,6 +3270,7 @@ export declare class PropertyGridEditorMatrixCalculatedValues extends PropertyGr
3025
3270
  protected getKeyValue(): string;
3026
3271
  protected getBaseValue(prop: JsonObjectProperty): string;
3027
3272
  protected getShowDetailPanelOnAdding(): boolean;
3273
+ protected setupMatrixQuestion(obj: Base, matrix: QuestionMatrixDynamicModel, prop: JsonObjectProperty): void;
3028
3274
  }
3029
3275
  export declare class PropertyGridEditorMatrixColumns extends PropertyGridEditorMatrix {
3030
3276
  constructor();