survey-creator-core 1.9.37 → 1.9.40
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.
- package/package.json +1 -1
- package/survey-creator-core.css +80 -46
- package/survey-creator-core.d.ts +535 -241
- package/survey-creator-core.i18n.js +1 -1
- package/survey-creator-core.i18n.min.js +1 -1
- package/survey-creator-core.js +947 -396
- package/survey-creator-core.min.css +12 -12
- package/survey-creator-core.min.js +3 -3
package/survey-creator-core.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/*
|
|
2
|
-
* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.
|
|
2
|
+
* Type definition for Survey Creatorlibrary. Platform independent (core) v1.9.40
|
|
3
3
|
* Copyright (c) 2015-2022 Devsoft Baltic OÜ - https://surveyjs.io/
|
|
4
4
|
* License: https://surveyjs.io/Licenses#SurveyCreator
|
|
5
5
|
*/
|
|
@@ -7,11 +7,11 @@ import { Base, JsonObjectProperty, Question, SurveyModel, ItemValue } from "surv
|
|
|
7
7
|
import { MatrixDropdownColumn, IAction, Action, ActionContainer, DragDropSurveyElements } from "survey-core";
|
|
8
8
|
import { DragDropChoices, Event, AdaptiveActionContainer, PageModel, IElement } from "survey-core";
|
|
9
9
|
import { IPanel, ISurveyElement, SurveyElement, QuestionSelectBase, QuestionRowModel } from "survey-core";
|
|
10
|
-
import { LocalizableString, DragOrClickHelper, PanelModel, QuestionDropdownModel
|
|
11
|
-
import { PopupModel, EventBase, PanelModelBase, QuestionNonValue
|
|
12
|
-
import { QuestionRatingModel, ComputedUpdater, QuestionCheckboxModel, ILocalizableString
|
|
13
|
-
import { ImageItemValue, HashTable, QuestionMatrixDynamicModel, QuestionMatrixModel
|
|
14
|
-
import { QuestionPanelDynamicModel, QuestionCommentModel, MatrixDynamicRowModel } from "survey-core";
|
|
10
|
+
import { LocalizableString, Operand, DragOrClickHelper, PanelModel, QuestionDropdownModel } from "survey-core";
|
|
11
|
+
import { ListModel, PopupModel, EventBase, PanelModelBase, QuestionNonValue } from "survey-core";
|
|
12
|
+
import { SurveyTemplateRendererTemplateData, QuestionRatingModel, ComputedUpdater, QuestionCheckboxModel, ILocalizableString } from "survey-core";
|
|
13
|
+
import { ArrayChanges, ImageItemValue, HashTable, QuestionMatrixDynamicModel, QuestionMatrixModel } from "survey-core";
|
|
14
|
+
import { QuestionMatrixDropdownModel, QuestionPanelDynamicModel, QuestionCommentModel, MatrixDynamicRowModel } from "survey-core";
|
|
15
15
|
|
|
16
16
|
export { editorLocalization as localization };
|
|
17
17
|
|
|
@@ -62,44 +62,235 @@ export interface ISurveyCreatorOptions {
|
|
|
62
62
|
createSurvey(json: any, reason: string, surveyType?: any): any;
|
|
63
63
|
onConditionQuestionsGetListCallback(propertyName: string, obj: Base, editor: any, list: any): any;
|
|
64
64
|
onConditionGetTitleCallback(expression: string, title: string): string;
|
|
65
|
+
onLogicGetTitleCallback(expression: string, displayExpression: string, text: string, logicItem: any): string;
|
|
65
66
|
}
|
|
66
67
|
/*
|
|
67
|
-
* Creator
|
|
68
|
+
* Survey Creator configuration. Pass it as an argument to the `SurveyCreator` constructor:
|
|
69
|
+
*
|
|
70
|
+
* ```js
|
|
71
|
+
* const creator = new SurveyCreator.SurveyCreator(creatorOptions);
|
|
72
|
+
* ```
|
|
68
73
|
*/
|
|
69
74
|
export interface ICreatorOptions {
|
|
75
|
+
/*
|
|
76
|
+
* Specifies whether to display the Designer tab.
|
|
77
|
+
*
|
|
78
|
+
* Default value: `true`
|
|
79
|
+
*/
|
|
70
80
|
showDesignerTab?: boolean;
|
|
81
|
+
/*
|
|
82
|
+
* Specifies whether to display the Preview tab.
|
|
83
|
+
*
|
|
84
|
+
* Default value: `true`
|
|
85
|
+
*/
|
|
71
86
|
showPreviewTab?: boolean;
|
|
87
|
+
/*
|
|
88
|
+
* Specifies whether to display the JSON Editor tab.
|
|
89
|
+
*
|
|
90
|
+
* Default value: `true`
|
|
91
|
+
*/
|
|
72
92
|
showJSONEditorTab?: boolean;
|
|
93
|
+
/*
|
|
94
|
+
* Specifies whether to display the Logic tab.
|
|
95
|
+
*
|
|
96
|
+
* Default value: `false`
|
|
97
|
+
*/
|
|
73
98
|
showLogicTab?: boolean;
|
|
99
|
+
/*
|
|
100
|
+
* Specifies whether to display the Embed Survey tab.
|
|
101
|
+
*
|
|
102
|
+
* Default value: `false`
|
|
103
|
+
*/
|
|
74
104
|
showEmbeddedSurveyTab?: boolean;
|
|
105
|
+
/*
|
|
106
|
+
* Specifies whether to display the Translation tab.
|
|
107
|
+
*
|
|
108
|
+
* Default value: `false`
|
|
109
|
+
*/
|
|
75
110
|
showTranslationTab?: boolean;
|
|
111
|
+
/*
|
|
112
|
+
* Removes the Free Trial bar.
|
|
113
|
+
*
|
|
114
|
+
* Default value: `false`
|
|
115
|
+
*
|
|
116
|
+
* **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.
|
|
117
|
+
*/
|
|
76
118
|
haveCommercialLicense?: boolean;
|
|
119
|
+
/*
|
|
120
|
+
* Specifies whether to call the [saveSurveyFunc](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#saveSurveyFunc) each time survey settings are changed.
|
|
121
|
+
*
|
|
122
|
+
* Default value: `false`
|
|
123
|
+
*/
|
|
77
124
|
isAutoSave?: boolean;
|
|
78
|
-
|
|
79
|
-
|
|
125
|
+
/*
|
|
126
|
+
* Specifies whether to enable support for right-to-left languages.
|
|
127
|
+
*
|
|
128
|
+
* Default value: `false`
|
|
129
|
+
*/
|
|
130
|
+
isRTL?: boolean;
|
|
131
|
+
/*
|
|
132
|
+
* Specifies whether users can see and edit the survey title and related survey properties.
|
|
133
|
+
*
|
|
134
|
+
* Default value: `true`
|
|
135
|
+
*/
|
|
136
|
+
showSurveyTitle?: boolean;
|
|
137
|
+
/*
|
|
138
|
+
* Specifies whether users can edit expressions in the Logic tab as plain text.
|
|
139
|
+
*
|
|
140
|
+
* If you set this property to `false`, users can only use UI elements to edit logical expressions.
|
|
141
|
+
*
|
|
142
|
+
* Default value: `true`
|
|
143
|
+
*/
|
|
80
144
|
allowEditExpressionsInTextEditor?: boolean;
|
|
81
|
-
|
|
145
|
+
/*
|
|
146
|
+
* Specifies whether to display question titles instead of names when users edit logical expressions.
|
|
147
|
+
*
|
|
148
|
+
* Default value: `false`
|
|
149
|
+
*/
|
|
82
150
|
showTitlesInExpressions?: boolean;
|
|
83
|
-
|
|
151
|
+
/*
|
|
152
|
+
* Specifies whether to show an error message if a survey is not saved in the database.
|
|
153
|
+
*
|
|
154
|
+
* Default value: `true`
|
|
155
|
+
*/
|
|
84
156
|
showErrorOnFailedSave?: boolean;
|
|
157
|
+
/*
|
|
158
|
+
* Specifies whether the Survey Creator generates the survey definition as a valid JSON object or JavaScript object.
|
|
159
|
+
*
|
|
160
|
+
* Default value: `true`
|
|
161
|
+
*
|
|
162
|
+
* 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)
|
|
163
|
+
*/
|
|
85
164
|
generateValidJSON?: boolean;
|
|
165
|
+
/*
|
|
166
|
+
* Enables the read-only mode. If you set this property to `true`, users cannot change the initial survey configuration.
|
|
167
|
+
*
|
|
168
|
+
* Default value: `false`
|
|
169
|
+
*/
|
|
86
170
|
readOnly?: boolean;
|
|
87
|
-
|
|
171
|
+
/*
|
|
172
|
+
* Specifies whether to show the page selector at the bottom of the Preview tab.
|
|
173
|
+
*
|
|
174
|
+
* Default value: `true`
|
|
175
|
+
*/
|
|
88
176
|
showPagesInPreviewTab?: boolean;
|
|
89
|
-
|
|
177
|
+
/*
|
|
178
|
+
* A [UI theme](https://surveyjs.io/Documentation/Library?id=get-started-react#configure-styles) used to display the survey in the Preview tab.
|
|
179
|
+
*
|
|
180
|
+
* Accepted values: `"modern"`, `"default"`, `"defaultV2"`
|
|
181
|
+
*
|
|
182
|
+
* Default value: `"defaultV2"`
|
|
183
|
+
*/
|
|
90
184
|
themeForPreview?: string;
|
|
185
|
+
/*
|
|
186
|
+
* Specifies whether the Preview tab displays the Device button that allows users to preview the survey on different device types.
|
|
187
|
+
*
|
|
188
|
+
* Default value: `true`
|
|
189
|
+
*/
|
|
91
190
|
showSimulatorInPreviewTab?: boolean;
|
|
191
|
+
/*
|
|
192
|
+
* Specifies whether the Preview tab displays the language selector.
|
|
193
|
+
*
|
|
194
|
+
* Accepted values:
|
|
195
|
+
*
|
|
196
|
+
* - `"auto"` (default)
|
|
197
|
+
* Display the language selector only if the survey is translated into more than one language.
|
|
198
|
+
*
|
|
199
|
+
* - `true`
|
|
200
|
+
* Always display the language selector regardless of how many languages are used in the survey.
|
|
201
|
+
*
|
|
202
|
+
* - `false`
|
|
203
|
+
* Never display the language selector.
|
|
204
|
+
*
|
|
205
|
+
* - `"all"`
|
|
206
|
+
* Always display the language selector with [all supported languages](https://github.com/surveyjs/survey-creator/tree/master/packages/survey-creator-core/src/localization).
|
|
207
|
+
*
|
|
208
|
+
* **See also**: [Localization & Globalization](https://surveyjs.io/Documentation/Survey-Creator?id=localization)
|
|
209
|
+
*/
|
|
92
210
|
showDefaultLanguageInPreviewTab?: string | boolean;
|
|
211
|
+
/*
|
|
212
|
+
* Specifies whether the Preview tab displays a checkbox that allows users to show or hide invisible survey elements.
|
|
213
|
+
*
|
|
214
|
+
* Default value: `true`
|
|
215
|
+
*/
|
|
93
216
|
showInvisibleElementsInPreviewTab?: boolean;
|
|
217
|
+
/*
|
|
218
|
+
* Specifies whether UI elements display survey, page, and question titles instead of their names.
|
|
219
|
+
*
|
|
220
|
+
* Default value: `false`
|
|
221
|
+
*/
|
|
94
222
|
showObjectTitles?: boolean;
|
|
223
|
+
/*
|
|
224
|
+
* Specifies whether the design surface displays the survey title and description when the survey does not contain any elements.
|
|
225
|
+
*
|
|
226
|
+
* Default value: `false`
|
|
227
|
+
*/
|
|
95
228
|
showHeaderInEmptySurvey?: boolean;
|
|
229
|
+
/*
|
|
230
|
+
* Specifies whether users can add, edit, and delete survey pages.
|
|
231
|
+
*
|
|
232
|
+
* Default value: `true`
|
|
233
|
+
*/
|
|
96
234
|
allowModifyPages?: boolean;
|
|
235
|
+
/*
|
|
236
|
+
* 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.
|
|
237
|
+
*
|
|
238
|
+
* Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumColumnsCount`)
|
|
239
|
+
*/
|
|
97
240
|
maximumColumnsCount?: number;
|
|
241
|
+
/*
|
|
242
|
+
* 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.
|
|
243
|
+
*
|
|
244
|
+
* Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumChoicesCount`)
|
|
245
|
+
*/
|
|
98
246
|
maximumChoicesCount?: number;
|
|
247
|
+
/*
|
|
248
|
+
* 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.
|
|
249
|
+
*
|
|
250
|
+
* Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumRowsCount`)
|
|
251
|
+
*/
|
|
99
252
|
maximumRowsCount?: number;
|
|
253
|
+
/*
|
|
254
|
+
* Limits the number of rate value that users can add to [Rating](https://surveyjs.io/Documentation/Library?id=questionratingmodel) questions.
|
|
255
|
+
*
|
|
256
|
+
* Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumRateValues`)
|
|
257
|
+
*/
|
|
100
258
|
maximumRateValues?: number;
|
|
259
|
+
/*
|
|
260
|
+
* Limits the number of items in a logical expression.
|
|
261
|
+
*
|
|
262
|
+
* Default value: -1 (unlimited)
|
|
263
|
+
*/
|
|
101
264
|
maxLogicItemsInCondition?: number;
|
|
265
|
+
/*
|
|
266
|
+
* Specifies whether users can switch between UI themes in the Preview tab.
|
|
267
|
+
*
|
|
268
|
+
* Default value: `true`
|
|
269
|
+
*
|
|
270
|
+
* [View the "Switch Between Themes" demo](https://surveyjs.io/Examples/Creator?id=theme-switcher)
|
|
271
|
+
*/
|
|
102
272
|
allowChangeThemeInPreview?: boolean;
|
|
273
|
+
/*
|
|
274
|
+
* Limits question and panels types available in the Toolbox and Add Question menu.
|
|
275
|
+
*
|
|
276
|
+
* Refer to the [Limit Available Question and Panel Types](https://surveyjs.io/Documentation/Survey-Creator?id=toolbox#limit-available-question-and-panel-types) help topic for more information.
|
|
277
|
+
*/
|
|
278
|
+
questionTypes?: any;
|
|
279
|
+
/*
|
|
280
|
+
* Specifies how Survey Creator users edit survey pages.
|
|
281
|
+
*
|
|
282
|
+
* Accepted values:
|
|
283
|
+
*
|
|
284
|
+
* - `"standard"` (default)
|
|
285
|
+
* Questions and panels are divided between pages. Users can scroll the design surface to reach a required page.
|
|
286
|
+
*
|
|
287
|
+
* - `"single"`
|
|
288
|
+
* All questions and panels belong to a single page. Users cannot add or remove pages.
|
|
289
|
+
*
|
|
290
|
+
* - `"bypage"`
|
|
291
|
+
* Questions and panels are divided between pages. Users can use the page navigator to switch to a required page.
|
|
292
|
+
*/
|
|
293
|
+
pageEditMode?: "standard" | "single" | "bypage" | "readonly";
|
|
103
294
|
}
|
|
104
295
|
/*
|
|
105
296
|
* The Toolbox item description.
|
|
@@ -302,11 +493,15 @@ export declare class CreatorAction extends Action implements ICreatorAction {
|
|
|
302
493
|
export declare class CreatorBase extends Base implements ISurveyCreatorOptions, ICreatorSelectionOwner {
|
|
303
494
|
constructor(options: ICreatorOptions, options2?: ICreatorOptions);
|
|
304
495
|
/*
|
|
305
|
-
*
|
|
496
|
+
* Specifies whether to display the Designer tab.
|
|
497
|
+
*
|
|
498
|
+
* Default value: `true`
|
|
306
499
|
*/
|
|
307
500
|
showDesignerTab: boolean;
|
|
308
501
|
/*
|
|
309
|
-
*
|
|
502
|
+
* Specifies whether to display the JSON Editor tab.
|
|
503
|
+
*
|
|
504
|
+
* Default value: `true`
|
|
310
505
|
*/
|
|
311
506
|
showJSONEditorTab: boolean;
|
|
312
507
|
/*
|
|
@@ -314,20 +509,28 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
314
509
|
*/
|
|
315
510
|
showTestSurveyTab: boolean;
|
|
316
511
|
/*
|
|
317
|
-
*
|
|
512
|
+
* Specifies whether to display the Preview tab.
|
|
513
|
+
*
|
|
514
|
+
* Default value: `true`
|
|
318
515
|
*/
|
|
319
516
|
get showPreviewTab(): boolean;
|
|
320
517
|
set showPreviewTab(val: boolean);
|
|
321
518
|
/*
|
|
322
|
-
*
|
|
519
|
+
* Specifies whether to display the Embed Survey tab.
|
|
520
|
+
*
|
|
521
|
+
* Default value: `false`
|
|
323
522
|
*/
|
|
324
523
|
showEmbeddedSurveyTab: boolean;
|
|
325
524
|
/*
|
|
326
|
-
*
|
|
525
|
+
* Specifies whether to display the Translation tab.
|
|
526
|
+
*
|
|
527
|
+
* Default value: `false`
|
|
327
528
|
*/
|
|
328
529
|
showTranslationTab: boolean;
|
|
329
530
|
/*
|
|
330
|
-
*
|
|
531
|
+
* Specifies whether to display the Logic tab.
|
|
532
|
+
*
|
|
533
|
+
* Default value: `false`
|
|
331
534
|
*/
|
|
332
535
|
showLogicTab: boolean;
|
|
333
536
|
useTableViewInLogicTab: boolean;
|
|
@@ -340,19 +543,30 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
340
543
|
*/
|
|
341
544
|
inplaceEditForValues: boolean;
|
|
342
545
|
/*
|
|
343
|
-
*
|
|
546
|
+
* Obsolete. Use the [`showSurveyTitle`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showSurveyTitle) property instead.
|
|
344
547
|
*/
|
|
345
548
|
get allowEditSurveyTitle(): boolean;
|
|
346
549
|
set allowEditSurveyTitle(val: boolean);
|
|
347
550
|
/*
|
|
348
|
-
*
|
|
349
|
-
*
|
|
350
|
-
*
|
|
551
|
+
* Specifies whether users can see and edit the survey title and related survey properties.
|
|
552
|
+
*
|
|
553
|
+
* Default value: `true`
|
|
554
|
+
*/
|
|
555
|
+
get showSurveyTitle(): boolean;
|
|
556
|
+
set showSurveyTitle(val: boolean);
|
|
557
|
+
/*
|
|
558
|
+
* Removes the Free Trial bar.
|
|
559
|
+
*
|
|
560
|
+
* Default value: `false`
|
|
561
|
+
*
|
|
562
|
+
* **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
563
|
*/
|
|
352
564
|
haveCommercialLicense: boolean;
|
|
353
565
|
get licenseText(): string;
|
|
354
566
|
/*
|
|
355
|
-
*
|
|
567
|
+
* Specifies whether to call the [saveSurveyFunc](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#saveSurveyFunc) each time survey settings are changed.
|
|
568
|
+
*
|
|
569
|
+
* Default value: `false`
|
|
356
570
|
*/
|
|
357
571
|
isAutoSave: boolean;
|
|
358
572
|
showOptions: boolean;
|
|
@@ -364,13 +578,12 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
364
578
|
toolbarValue: any;
|
|
365
579
|
responsivityManager: CreatorResponsivityManager;
|
|
366
580
|
footerToolbar: any;
|
|
367
|
-
pageEditModeValue: "standard" | "single" | "bypage";
|
|
581
|
+
pageEditModeValue: "standard" | "single" | "bypage" | "readonly";
|
|
368
582
|
/*
|
|
369
|
-
*
|
|
370
|
-
* You can set this option in creator constructor only
|
|
583
|
+
* Contains the value of the [`pageEditMode`](https://surveyjs.io/Documentation/Survey-Creator?id=ICreatorOptions#pageEditMode) property specified in the constructor.
|
|
371
584
|
*/
|
|
372
|
-
get pageEditMode(): "standard" | "single" | "bypage";
|
|
373
|
-
set pageEditMode(val: "standard" | "single" | "bypage");
|
|
585
|
+
get pageEditMode(): "standard" | "single" | "bypage" | "readonly";
|
|
586
|
+
set pageEditMode(val: "standard" | "single" | "bypage" | "readonly");
|
|
374
587
|
surveyValue: SurveyModel;
|
|
375
588
|
get toolbarItems(): any;
|
|
376
589
|
get toolbar(): any;
|
|
@@ -406,44 +619,45 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
406
619
|
getPlugin<P extends ICreatorPlugin = ICreatorPlugin>(name: string): any;
|
|
407
620
|
/*
|
|
408
621
|
* 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
|
|
622
|
+
* - sender the survey creator object that fires the event
|
|
623
|
+
* - options.element an instance of the deleting element
|
|
624
|
+
* - options.elementType the type of the element: 'question', 'panel' or 'page'.
|
|
625
|
+
* - options.allowing set it to false to cancel the element deleting
|
|
413
626
|
*/
|
|
414
627
|
onElementDeleting: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
415
628
|
/*
|
|
416
629
|
* The event is called on setting a readOnly property of the property editor. By default the property.readOnly property is used.
|
|
417
630
|
* 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.
|
|
631
|
+
* - sender the survey creator object that fires the event
|
|
632
|
+
* - options.obj the survey object, Survey, Page, Panel or Question
|
|
633
|
+
* - options.property the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties.
|
|
634
|
+
* - options.readOnly a boolean value. It has value equals to options.readOnly property by default. You may change it.
|
|
635
|
+
* - 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).
|
|
636
|
+
* - 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
637
|
*/
|
|
425
638
|
onGetPropertyReadOnly: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
426
639
|
/*
|
|
427
640
|
* 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.
|
|
641
|
+
* - sender the survey creator object that fires the event
|
|
642
|
+
* - options.survey the survey object showing in the creator.
|
|
643
|
+
* - 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
644
|
*/
|
|
432
645
|
onSurveyInstanceCreated: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
433
646
|
/*
|
|
434
647
|
* 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
648
|
* 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
|
|
649
|
+
* - sender the survey creator object that fires the event
|
|
650
|
+
* - options.obj the survey object, Survey, Page, Panel or Question
|
|
651
|
+
* - options.reason the name of the UI that requests the object display name.
|
|
652
|
+
* - options.displayName change this property to show your custom display name for the object
|
|
653
|
+
*
|
|
440
654
|
* 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.
|
|
655
|
+
* - "condition" - raised from Condition modal window or on setup condition in a logic tab
|
|
656
|
+
* - "survey-tester" - raised from page selector list in "Preview" tab
|
|
657
|
+
* - "survey-tester-selected" - raised on setting page selector title in "Preview" tab
|
|
658
|
+
* - "survey-translation" - raised from translation tab
|
|
659
|
+
* - "property-grid" - raised from showing object selector for property grid in "Designer" tab.
|
|
660
|
+
* - "property-grid-title" - raised on rendering selected object title in property grid in "Designer" tab.
|
|
447
661
|
*/
|
|
448
662
|
onGetObjectDisplayName: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
449
663
|
/*
|
|
@@ -478,19 +692,19 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
478
692
|
onElementAllowOperations: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
479
693
|
/*
|
|
480
694
|
* 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.
|
|
695
|
+
* - sender the survey creator object that fires the event
|
|
696
|
+
* - options.obj the survey object which property is edited in the Property Editor.
|
|
697
|
+
* - options.items the list of menu items. It has two required fields: text and onClick: function(obj: Survey.Base) {} and optional name field.
|
|
484
698
|
*/
|
|
485
699
|
onDefineElementMenuItems: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
486
700
|
/*
|
|
487
701
|
* 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.
|
|
702
|
+
* - sender the survey creator object that fires the event
|
|
703
|
+
* - options.obj the survey object, Survey, Page, Panel or Question
|
|
704
|
+
* - options.property the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties.
|
|
705
|
+
* - 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.
|
|
706
|
+
* - 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).
|
|
707
|
+
* - 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
708
|
*
|
|
495
709
|
* [Example: Hide a category in the Properties Grid](https://surveyjs.io/Examples/Survey-Creator?id=hidecategoryinpropertiesgrid)
|
|
496
710
|
*/
|
|
@@ -499,106 +713,106 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
499
713
|
/*
|
|
500
714
|
* The event is called after a survey that represents the Property Grid is created and all its questions (property editors) are setup.
|
|
501
715
|
* 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
|
|
716
|
+
* - options.obj the survey object that is currently editing in the property grid
|
|
717
|
+
* - options.survey the property grid survey
|
|
504
718
|
*/
|
|
505
719
|
onPropertyGridSurveyCreated: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
506
720
|
/*
|
|
507
721
|
* 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
722
|
* 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.
|
|
723
|
+
* - options.obj the survey object that is currently editing in the property grid
|
|
724
|
+
* - options.property the property that the current property editor is editing
|
|
725
|
+
* - 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
726
|
*/
|
|
513
727
|
onPropertyEditorCreated: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
514
728
|
/*
|
|
515
729
|
* The event is called after a property editor setups its title actions.
|
|
516
730
|
* 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.
|
|
731
|
+
* - options.obj the survey object that is currently editing in the property grid
|
|
732
|
+
* - options.property the property that the current property editor is editing
|
|
733
|
+
* - 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.
|
|
734
|
+
* - options.titleActions the list of title actions.
|
|
521
735
|
*/
|
|
522
736
|
onPropertyEditorUpdateTitleActions: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
523
737
|
/*
|
|
524
738
|
* The event is called before rendering a delete button in the Property Grid or in Question Editor.
|
|
525
739
|
* 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
|
|
740
|
+
* - sender the survey creator object that fires the event
|
|
741
|
+
* - options.obj the survey Question
|
|
742
|
+
* - options.item the object property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
|
|
743
|
+
* - 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
744
|
*/
|
|
531
745
|
onCanDeleteItem: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
532
746
|
/*
|
|
533
747
|
* 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
748
|
* 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
|
|
749
|
+
* - sender the survey creator object that fires the event
|
|
750
|
+
* - options.obj the survey object: Question, Panel, Page or Survey
|
|
751
|
+
* - options.property the collection property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
|
|
752
|
+
* - options.propertyName the collection property name
|
|
753
|
+
* - 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.
|
|
754
|
+
* - options.item the collection item that we are going to delete
|
|
755
|
+
* - options.allowDelete a boolean value. It is true by default. Set it false to abondome the element removing from the collection
|
|
542
756
|
*/
|
|
543
757
|
onCollectionItemDeleting: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
544
758
|
/*
|
|
545
759
|
* 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
760
|
* 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.
|
|
761
|
+
* - sender the survey creator object that fires the event
|
|
762
|
+
* - options.obj the survey object: Question, Panel, Page or Survey
|
|
763
|
+
* - options.property the collection property (Survey.JsonObjectProperty object). It has name, className, type, visible, readOnly and other properties
|
|
764
|
+
* - options.propertyName the collection property name
|
|
765
|
+
* - 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.
|
|
766
|
+
* - options.item the collection item that we are going to delete
|
|
767
|
+
* - options.allowDelete a boolean value. It is true by default. Set it false to abondome the element removing from the collection
|
|
768
|
+
* - options.allowEdit a boolean value. It is true by default. Set it false to disable editing.
|
|
555
769
|
*/
|
|
556
770
|
onCollectionItemAllowOperations: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
557
771
|
/*
|
|
558
772
|
* 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
773
|
* 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.
|
|
774
|
+
* - sender the survey creator object that fires the event
|
|
775
|
+
* - options.obj the object that contains the itemsValues array, for example selector, rating and single choice matrix questions.
|
|
776
|
+
* - 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.
|
|
777
|
+
* - options.newItem a new created Survey.ItemValue object.
|
|
778
|
+
* - options.itemValues an editing Survey.ItemValue array. newItem object is not added yet into this array.
|
|
565
779
|
*/
|
|
566
780
|
onItemValueAdded: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
567
781
|
/*
|
|
568
782
|
* 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.
|
|
783
|
+
* - sender the survey creator object that fires the event
|
|
784
|
+
* - options.matrix a matrix question where column is located, matrix.columns.
|
|
785
|
+
* - options.newColumn a new created Survey.MatrixDropdownColumn object.
|
|
786
|
+
* - 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
787
|
*/
|
|
574
788
|
onMatrixColumnAdded: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
575
789
|
/*
|
|
576
790
|
* 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.
|
|
791
|
+
* - sender the survey creator object that fires the event
|
|
792
|
+
* - options.obj the survey object which property is edited in the Property Editor.
|
|
793
|
+
* - options.propertyName the name of the edited property.
|
|
794
|
+
* - options.editorOptions options that can be changed.
|
|
795
|
+
* - 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'.
|
|
796
|
+
* - 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'.
|
|
797
|
+
* - options.editorOptions.showTextView a boolean property, true by default. Set it false to disable "Manual Entry" tab for "choices" property.
|
|
798
|
+
* - options.editorOptions.itemsEntryType a string property, 'form' by default. Set it 'fast' to show "Manual Entry" tab for "choices" property by default.
|
|
585
799
|
*/
|
|
586
800
|
onSetPropertyEditorOptions: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
587
801
|
/*
|
|
588
802
|
* 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
|
|
803
|
+
* - sender the survey creator object that fires the event
|
|
804
|
+
* - options.element a new created survey element. It can be question, panel or page
|
|
805
|
+
* - 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.
|
|
806
|
+
* - options.isUnique a boolean property, set this property to false, if you want to ask Creator to generate another name
|
|
593
807
|
*/
|
|
594
808
|
onGenerateNewName: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
595
809
|
/*
|
|
596
810
|
* 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.
|
|
811
|
+
* - sender the survey creator object that fires the event
|
|
812
|
+
* - options.obj the survey object which property is edited in the Property Editor.
|
|
813
|
+
* - options.propertyName the name of the edited property.
|
|
814
|
+
* - options.value the property value.
|
|
815
|
+
* - options.error the error you want to display. Set the empty string (the default value) or null if there is no errors.
|
|
602
816
|
*/
|
|
603
817
|
onPropertyValidationCustomError: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
604
818
|
/*
|
|
@@ -626,98 +840,107 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
626
840
|
onSurveyPropertyValueChanged: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
627
841
|
/*
|
|
628
842
|
* 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
|
|
843
|
+
* - sender the survey creator object that fires the event
|
|
844
|
+
* - options.obj the survey object which property is edited in the Property Editor.
|
|
845
|
+
* - options.propertyName the name of the edited property.
|
|
846
|
+
* - options.editor the instance of Property Editor.
|
|
847
|
+
* - options.list the list of the questions available for condition
|
|
634
848
|
*/
|
|
635
849
|
onConditionQuestionsGetList: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
636
850
|
/*
|
|
637
851
|
* 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.
|
|
852
|
+
* - sender the survey creator object that fires the event.
|
|
853
|
+
* - options.expression the current expression. If the expression is empty or incorrect then the value is empty.
|
|
854
|
+
* - options.title the default value of the title. You can change the default value.
|
|
641
855
|
*/
|
|
642
856
|
onConditionGetTitle: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
643
857
|
/*
|
|
858
|
+
* Use this event to modify the display text in a logic viewer.
|
|
859
|
+
* - sender the survey creator object that fires the event.
|
|
860
|
+
* - options.expression the item expression.
|
|
861
|
+
* - options.expressionText expression as display text. It can show question title instead of question name
|
|
862
|
+
* - options.logicItem the link to the Logic Item object. It has the array of actions and other properties
|
|
863
|
+
* - options.text the string property that you can change
|
|
864
|
+
*/
|
|
865
|
+
onLogicItemDisplayText: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
866
|
+
/*
|
|
644
867
|
* 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
|
|
868
|
+
* - sender the survey creator object that fires the event
|
|
646
869
|
* options object contains the information about certain modifications
|
|
647
|
-
* options.type contains string constant describing certain modification
|
|
870
|
+
* - options.type contains string constant describing certain modification
|
|
648
871
|
* Available values:
|
|
649
872
|
*
|
|
650
|
-
* options.type: "ADDED_FROM_TOOLBOX"
|
|
651
|
-
* options.question: newly added question
|
|
873
|
+
* - options.type: "ADDED_FROM_TOOLBOX"
|
|
874
|
+
* - options.question: newly added question
|
|
652
875
|
*
|
|
653
|
-
* options.type: "PAGE_ADDED"
|
|
654
|
-
* options.newValue: newly created page
|
|
876
|
+
* - options.type: "PAGE_ADDED"
|
|
877
|
+
* - options.newValue: newly created page
|
|
655
878
|
*
|
|
656
|
-
* options.type: "PAGE_MOVED"
|
|
657
|
-
* options.page: page has been moved
|
|
658
|
-
* options.indexFrom: pevious index
|
|
659
|
-
* options.indexTo: new index
|
|
879
|
+
* - options.type: "PAGE_MOVED"
|
|
880
|
+
* - options.page: page has been moved
|
|
881
|
+
* - options.indexFrom: pevious index
|
|
882
|
+
* - options.indexTo: new index
|
|
660
883
|
*
|
|
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
|
|
884
|
+
* - options.type: "QUESTION_CONVERTED"
|
|
885
|
+
* - options.className: the converted class name
|
|
886
|
+
* - options.oldValue: pevious object
|
|
887
|
+
* - options.newValue: the new object, converted from oldVale to the given class name
|
|
665
888
|
*
|
|
666
|
-
* options.type: "QUESTION_CHANGED_BY_EDITOR"
|
|
667
|
-
* options.question: question has been edited in the popup question editor
|
|
889
|
+
* - options.type: "QUESTION_CHANGED_BY_EDITOR"
|
|
890
|
+
* - options.question: question has been edited in the popup question editor
|
|
668
891
|
*
|
|
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
|
|
892
|
+
* - options.type: "PROPERTY_CHANGED"
|
|
893
|
+
* - options.name: the name of the property has been changed
|
|
894
|
+
* - options.target: the object containing the changed property
|
|
895
|
+
* - options.oldValue: the previous value of the changed property
|
|
896
|
+
* - options.newValue: the new value of the changed property
|
|
674
897
|
*
|
|
675
|
-
* options.type: "OBJECT_DELETED"
|
|
676
|
-
* options.target: deleted object
|
|
898
|
+
* - options.type: "OBJECT_DELETED"
|
|
899
|
+
* - options.target: deleted object
|
|
677
900
|
*
|
|
678
|
-
* options.type: "VIEW_TYPE_CHANGED"
|
|
679
|
-
* options.newType: new type of the creator view: editor or designer
|
|
901
|
+
* - options.type: "VIEW_TYPE_CHANGED"
|
|
902
|
+
* - options.newType: new type of the creator view: editor or designer
|
|
680
903
|
*
|
|
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
|
|
904
|
+
* - options.type: "DO_DROP"
|
|
905
|
+
* - options.page: the page of the drap/drop operation
|
|
906
|
+
* - options.source: the source dragged object
|
|
907
|
+
* - options.target: the drop target
|
|
908
|
+
* - options.newElement: a new element. It is defined if a user drops question or panel from the toolbox
|
|
686
909
|
*
|
|
687
|
-
* options.type: "TRANSLATIONS_CHANGED"
|
|
688
|
-
* options.type: "JSON_EDITOR"
|
|
910
|
+
* - options.type: "TRANSLATIONS_CHANGED"
|
|
911
|
+
* - options.type: "JSON_EDITOR"
|
|
689
912
|
*/
|
|
690
913
|
onModified: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
691
914
|
/*
|
|
692
915
|
* 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.
|
|
916
|
+
* - sender the survey creator object that fires the event
|
|
917
|
+
* - options.question a new added survey question. Survey.Question object
|
|
918
|
+
* - options.page the survey Page object where question has been added.
|
|
696
919
|
*/
|
|
697
920
|
onQuestionAdded: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
698
921
|
/*
|
|
699
922
|
* 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.
|
|
923
|
+
* - sender the survey creator object that fires the event
|
|
924
|
+
* - options.panel a new added survey panel. Survey.Panel object
|
|
925
|
+
* - options.page the survey Page object where question has been added.
|
|
703
926
|
*/
|
|
704
927
|
onPanelAdded: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
705
928
|
/*
|
|
706
929
|
* 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.
|
|
930
|
+
* - sender the survey creator object that fires the event
|
|
931
|
+
* - options.page the new survey Page object.
|
|
709
932
|
*/
|
|
710
933
|
onPageAdded: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
711
934
|
/*
|
|
712
935
|
* 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.
|
|
936
|
+
* - sender the survey creator object that fires the event
|
|
937
|
+
* - options.survey the survey object showing in the creator.
|
|
715
938
|
*/
|
|
716
939
|
onDesignerSurveyCreated: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
717
940
|
/*
|
|
718
941
|
* 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.
|
|
942
|
+
* - sender the survey creator object that fires the event
|
|
943
|
+
* - options.survey the survey object showing in the "Preview" tab.
|
|
721
944
|
*/
|
|
722
945
|
onPreviewSurveyCreated: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
723
946
|
/*
|
|
@@ -727,29 +950,29 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
727
950
|
/*
|
|
728
951
|
* The event is called in case of UI notifications. By default all notifications are done via built-in alert () function.
|
|
729
952
|
* 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.
|
|
953
|
+
* - options.message is a message to show.
|
|
731
954
|
*/
|
|
732
955
|
onNotify: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
733
956
|
/*
|
|
734
957
|
* 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.
|
|
958
|
+
* - options.newSelectedElement the element that is going to be selected in the survey desiger: question, panel, page or survey.
|
|
736
959
|
*/
|
|
737
960
|
onSelectedElementChanging: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
738
961
|
/*
|
|
739
962
|
* 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.
|
|
963
|
+
* - options.newSelectedElement the new selected element in the survey desiger: question, panel, page or survey.
|
|
741
964
|
*/
|
|
742
965
|
onSelectedElementChanged: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
743
966
|
/*
|
|
744
967
|
* The event is fired then one need to choose files.
|
|
745
|
-
* sender the survey creator object that fires the event
|
|
968
|
+
* - sender the survey creator object that fires the event
|
|
746
969
|
* input file input HTML element
|
|
747
970
|
* callback need to be called after files has been chosen
|
|
748
971
|
*/
|
|
749
972
|
onOpenFileChooser: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
750
973
|
/*
|
|
751
974
|
* The event is fired on uploading the files.
|
|
752
|
-
* sender the survey creator object that fires the event
|
|
975
|
+
* - sender the survey creator object that fires the event
|
|
753
976
|
* There are two properties in options:
|
|
754
977
|
* files the Javascript File objects array
|
|
755
978
|
* callback called on upload complete,
|
|
@@ -795,33 +1018,17 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
795
1018
|
onTranslationImported: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
796
1019
|
/*
|
|
797
1020
|
* 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.
|
|
1021
|
+
* - sender the survey creator object that fires the event.
|
|
1022
|
+
* - options.survey the editing survey object.
|
|
1023
|
+
* - options.allow set it to false to disable dragging.
|
|
1024
|
+
* - options.target a target element that is dragging.
|
|
1025
|
+
* - options.source a source element. It can be null, if it is a new element, dragging from toolbox.
|
|
1026
|
+
* - options.parent a page or panel where target element is dragging.
|
|
1027
|
+
* - 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.
|
|
1028
|
+
* - 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
1029
|
*/
|
|
807
1030
|
onDragDropAllow: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
808
1031
|
/*
|
|
809
|
-
* 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.
|
|
814
|
-
*/
|
|
815
|
-
onGetElementWrapperComponentName: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
816
|
-
/*
|
|
817
|
-
* 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.
|
|
822
|
-
*/
|
|
823
|
-
onGetElementWrapperComponentData: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
824
|
-
/*
|
|
825
1032
|
* This callback is used internally for providing survey JSON text.
|
|
826
1033
|
*/
|
|
827
1034
|
getSurveyJSONTextCallback: any;
|
|
@@ -830,87 +1037,126 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
830
1037
|
*/
|
|
831
1038
|
setSurveyJSONTextCallback: (text: string) => void;
|
|
832
1039
|
/*
|
|
833
|
-
*
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
/*
|
|
837
|
-
* You need to set this property to value bigger than 0 to disable adding more logic items in condition than this value.
|
|
1040
|
+
* Limits the number of items in a logical expression.
|
|
1041
|
+
*
|
|
1042
|
+
* Default value: -1 (unlimited)
|
|
838
1043
|
*/
|
|
839
1044
|
maxLogicItemsInCondition: number;
|
|
840
1045
|
/*
|
|
841
|
-
*
|
|
1046
|
+
* Specifies whether UI elements display survey, page, and question titles instead of their names.
|
|
1047
|
+
*
|
|
1048
|
+
* Default value: `false`
|
|
842
1049
|
*/
|
|
843
1050
|
showObjectTitles: boolean;
|
|
844
1051
|
/*
|
|
845
|
-
*
|
|
1052
|
+
* Specifies whether to display question titles instead of names when users edit logical expressions.
|
|
1053
|
+
*
|
|
1054
|
+
* Default value: `false`
|
|
846
1055
|
*/
|
|
847
1056
|
showTitlesInExpressions: boolean;
|
|
848
1057
|
/*
|
|
849
|
-
*
|
|
1058
|
+
* Specifies whether users can edit expressions in the Logic tab as plain text.
|
|
1059
|
+
*
|
|
1060
|
+
* If you set this property to `false`, users can only use UI elements to edit logical expressions.
|
|
1061
|
+
*
|
|
1062
|
+
* Default value: `true`
|
|
850
1063
|
*/
|
|
851
1064
|
allowEditExpressionsInTextEditor: boolean;
|
|
852
1065
|
/*
|
|
853
|
-
*
|
|
1066
|
+
* 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.
|
|
1067
|
+
*
|
|
1068
|
+
* Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumColumnsCount`)
|
|
854
1069
|
*/
|
|
855
1070
|
maximumColumnsCount: number;
|
|
856
1071
|
/*
|
|
857
|
-
*
|
|
1072
|
+
* 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.
|
|
1073
|
+
*
|
|
1074
|
+
* Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumChoicesCount`)
|
|
858
1075
|
*/
|
|
859
1076
|
maximumChoicesCount: number;
|
|
860
1077
|
/*
|
|
861
|
-
*
|
|
1078
|
+
* 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.
|
|
1079
|
+
*
|
|
1080
|
+
* Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumRowsCount`)
|
|
862
1081
|
*/
|
|
863
1082
|
maximumRowsCount: number;
|
|
864
1083
|
/*
|
|
865
|
-
*
|
|
1084
|
+
* Limits the number of rate value that users can add to [Rating](https://surveyjs.io/Documentation/Library?id=questionratingmodel) questions.
|
|
1085
|
+
*
|
|
1086
|
+
* Default value: 0 (unlimited, taken from `settings.propertyGrid.maximumRateValues`)
|
|
866
1087
|
*/
|
|
867
1088
|
maximumRateValues: number;
|
|
868
1089
|
/*
|
|
869
|
-
* Obsolete.
|
|
1090
|
+
* Obsolete. Use the [`showPagesInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showPagesInPreviewTab) property instead.
|
|
870
1091
|
*/
|
|
871
1092
|
showPagesInTestSurveyTab: boolean;
|
|
872
1093
|
/*
|
|
873
|
-
*
|
|
1094
|
+
* Specifies whether to show the page selector at the bottom of the Preview tab.
|
|
1095
|
+
*
|
|
1096
|
+
* Default value: `true`
|
|
874
1097
|
*/
|
|
875
1098
|
get showPagesInPreviewTab(): boolean;
|
|
876
1099
|
set showPagesInPreviewTab(val: boolean);
|
|
877
1100
|
/*
|
|
878
|
-
* Obsolete.
|
|
1101
|
+
* Obsolete. Use the [`showSimulatorInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showSimulatorInPreviewTab) property instead.
|
|
879
1102
|
*/
|
|
880
1103
|
showSimulatorInTestSurveyTab: boolean;
|
|
881
1104
|
/*
|
|
882
|
-
*
|
|
1105
|
+
* Specifies whether the Preview tab displays the Device button that allows users to preview the survey on different device types.
|
|
1106
|
+
*
|
|
1107
|
+
* Default value: `true`
|
|
883
1108
|
*/
|
|
884
1109
|
get showSimulatorInPreviewTab(): boolean;
|
|
885
1110
|
set showSimulatorInPreviewTab(val: boolean);
|
|
886
1111
|
/*
|
|
887
|
-
*
|
|
1112
|
+
* A [UI theme](https://surveyjs.io/Documentation/Library?id=get-started-react#configure-styles) used to display the survey in the Preview tab.
|
|
1113
|
+
*
|
|
888
1114
|
* Accepted values: `"modern"`, `"default"`, `"defaultV2"`
|
|
1115
|
+
*
|
|
1116
|
+
* Default value: `"defaultV2"`
|
|
889
1117
|
*/
|
|
890
1118
|
themeForPreview: string;
|
|
1119
|
+
_allowModifyPages: boolean;
|
|
891
1120
|
/*
|
|
892
|
-
*
|
|
1121
|
+
* Specifies whether users can add, edit, and delete survey pages.
|
|
1122
|
+
*
|
|
1123
|
+
* Default value: `true`
|
|
893
1124
|
*/
|
|
894
|
-
allowModifyPages: boolean;
|
|
1125
|
+
get allowModifyPages(): boolean;
|
|
1126
|
+
set allowModifyPages(val: boolean);
|
|
895
1127
|
/*
|
|
896
|
-
* Obsolete.
|
|
1128
|
+
* Obsolete. Use the [`showDefaultLanguageInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showDefaultLanguageInPreviewTab) property instead.
|
|
897
1129
|
*/
|
|
898
1130
|
showDefaultLanguageInTestSurveyTab: string | boolean;
|
|
899
1131
|
/*
|
|
900
|
-
*
|
|
901
|
-
*
|
|
902
|
-
*
|
|
903
|
-
*
|
|
904
|
-
*
|
|
1132
|
+
* Specifies whether the Preview tab displays the language selector.
|
|
1133
|
+
*
|
|
1134
|
+
* Accepted values:
|
|
1135
|
+
*
|
|
1136
|
+
* - `"auto"` (default)
|
|
1137
|
+
* Display the language selector only if the survey is translated into more than one language.
|
|
1138
|
+
*
|
|
1139
|
+
* - `true`
|
|
1140
|
+
* Always display the language selector regardless of how many languages are used in the survey.
|
|
1141
|
+
*
|
|
1142
|
+
* - `false`
|
|
1143
|
+
* Never display the language selector.
|
|
1144
|
+
*
|
|
1145
|
+
* - `"all"`
|
|
1146
|
+
* Always display the language selector with [all supported languages](https://github.com/surveyjs/survey-creator/tree/master/packages/survey-creator-core/src/localization).
|
|
1147
|
+
*
|
|
1148
|
+
* **See also**: [Localization & Globalization](https://surveyjs.io/Documentation/Survey-Creator?id=localization)
|
|
905
1149
|
*/
|
|
906
1150
|
get showDefaultLanguageInPreviewTab(): string | boolean;
|
|
907
1151
|
set showDefaultLanguageInPreviewTab(val: string | boolean);
|
|
908
1152
|
/*
|
|
909
|
-
*
|
|
1153
|
+
* Obsolete. Use the [`showInvisibleElementsInPreviewTab`](https://surveyjs.io/Documentation/Survey-Creator?id=surveycreator#showInvisibleElementsInPreviewTab) property instead.
|
|
910
1154
|
*/
|
|
911
1155
|
showInvisibleElementsInTestSurveyTab: boolean;
|
|
912
1156
|
/*
|
|
913
|
-
*
|
|
1157
|
+
* Specifies whether the Preview tab displays a checkbox that allows users to show or hide invisible survey elements.
|
|
1158
|
+
*
|
|
1159
|
+
* Default value: `true`
|
|
914
1160
|
*/
|
|
915
1161
|
get showInvisibleElementsInPreviewTab(): boolean;
|
|
916
1162
|
set showInvisibleElementsInPreviewTab(val: boolean);
|
|
@@ -919,7 +1165,11 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
919
1165
|
*/
|
|
920
1166
|
showPageSelectorInToolbar: boolean;
|
|
921
1167
|
/*
|
|
922
|
-
*
|
|
1168
|
+
* Specifies whether users can switch between UI themes in the Preview tab.
|
|
1169
|
+
*
|
|
1170
|
+
* Default value: `true`
|
|
1171
|
+
*
|
|
1172
|
+
* [View the "Switch Between Themes" demo](https://surveyjs.io/Examples/Creator?id=theme-switcher)
|
|
923
1173
|
*/
|
|
924
1174
|
allowChangeThemeInPreview: boolean;
|
|
925
1175
|
tabbedMenu: any;
|
|
@@ -930,7 +1180,9 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
930
1180
|
*/
|
|
931
1181
|
getLocString(str: string): string;
|
|
932
1182
|
/*
|
|
933
|
-
*
|
|
1183
|
+
* Specifies whether to show an error message if a survey is not saved in the database.
|
|
1184
|
+
*
|
|
1185
|
+
* Default value: `true`
|
|
934
1186
|
*/
|
|
935
1187
|
showErrorOnFailedSave: boolean;
|
|
936
1188
|
protected onSetReadOnly(newVal: boolean): void;
|
|
@@ -941,25 +1193,29 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
941
1193
|
get locale(): string;
|
|
942
1194
|
set locale(val: string);
|
|
943
1195
|
/*
|
|
944
|
-
*
|
|
1196
|
+
* Enables the read-only mode. If you set this property to `true`, users cannot change the initial survey configuration.
|
|
1197
|
+
*
|
|
1198
|
+
* Default value: `false`
|
|
945
1199
|
*/
|
|
946
1200
|
get readOnly(): boolean;
|
|
947
1201
|
set readOnly(val: boolean);
|
|
948
1202
|
/*
|
|
949
|
-
*
|
|
1203
|
+
* Specifies whether to enable support for right-to-left languages.
|
|
1204
|
+
*
|
|
1205
|
+
* Default value: `false`
|
|
950
1206
|
*/
|
|
951
1207
|
get isRTL(): boolean;
|
|
952
1208
|
set isRTL(val: boolean);
|
|
953
1209
|
/*
|
|
954
1210
|
* 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
|
|
1211
|
+
* - sender the survey creator object that fires the event
|
|
1212
|
+
* - options.tabName the name of new active tab
|
|
957
1213
|
*/
|
|
958
1214
|
onActiveTabChanging: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
959
1215
|
/*
|
|
960
1216
|
* 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
|
|
1217
|
+
* - sender the survey creator object that fires the event
|
|
1218
|
+
* - options.tabName the name of new active tab
|
|
963
1219
|
*/
|
|
964
1220
|
onActiveTabChanged: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
965
1221
|
/*
|
|
@@ -995,22 +1251,22 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
995
1251
|
leftContainerActiveItem(name: string): void;
|
|
996
1252
|
/*
|
|
997
1253
|
* 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.
|
|
1254
|
+
* - options.canUndo a boolean value. It is true by default. Set it false to hide prevent undo operation.
|
|
999
1255
|
*/
|
|
1000
1256
|
onBeforeUndo: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
1001
1257
|
/*
|
|
1002
1258
|
* 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.
|
|
1259
|
+
* - options.canRedo a boolean value. It is true by default. Set it false to hide prevent redo operation.
|
|
1004
1260
|
*/
|
|
1005
1261
|
onBeforeRedo: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
1006
1262
|
/*
|
|
1007
1263
|
* The event is called after undo happens.
|
|
1008
|
-
* options.state is an undo/redo item.
|
|
1264
|
+
* - options.state is an undo/redo item.
|
|
1009
1265
|
*/
|
|
1010
1266
|
onAfterUndo: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
1011
1267
|
/*
|
|
1012
1268
|
* The event is called after redo happens.
|
|
1013
|
-
* options.state is an undo/redo item.
|
|
1269
|
+
* - options.state is an undo/redo item.
|
|
1014
1270
|
*/
|
|
1015
1271
|
onAfterRedo: Event<(sender: CreatorBase, options: any) => any, any>;
|
|
1016
1272
|
get undoRedoManager(): UndoRedoManager;
|
|
@@ -1054,7 +1310,10 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
1054
1310
|
onBeforeDrop: Event<() => any, any>;
|
|
1055
1311
|
onAfterDrop: Event<() => any, any>;
|
|
1056
1312
|
updateElementsOnLocaleChanged(obj: Base, propertyName: string): void;
|
|
1057
|
-
|
|
1313
|
+
updateConditionsOnNameChanged(obj: Base, propertyName: string, oldValue: any): void;
|
|
1314
|
+
surveyLogicForUpdate: SurveyLogic;
|
|
1315
|
+
surveyLogicRenaming: boolean;
|
|
1316
|
+
protected createSurveyLogicForUpdate(): SurveyLogic;
|
|
1058
1317
|
isObjQuestion(obj: Base): boolean;
|
|
1059
1318
|
isObjPage(obj: Base): boolean;
|
|
1060
1319
|
protected setSurvey(survey: SurveyModel): void;
|
|
@@ -1198,6 +1457,7 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
|
|
|
1198
1457
|
onGetElementEditorTitleCallback(obj: Base, title: string): string;
|
|
1199
1458
|
onConditionQuestionsGetListCallback(propertyName: string, obj: Base, editor: any, list: any): void;
|
|
1200
1459
|
onConditionGetTitleCallback(expression: string, title: string): string;
|
|
1460
|
+
onLogicGetTitleCallback(expression: string, expressionText: string, text: string, logicItem: any): string;
|
|
1201
1461
|
/*
|
|
1202
1462
|
* The delay on saving survey JSON on autoSave in ms. It is 500 ms by default.
|
|
1203
1463
|
* If during this period of time an end-user modify survey, then the last version will be saved only. Set to 0 to save immediately.
|
|
@@ -1323,6 +1583,7 @@ export declare class ExpressionToDisplayText {
|
|
|
1323
1583
|
currentQuestion: Question;
|
|
1324
1584
|
showTitles: boolean;
|
|
1325
1585
|
toDisplayText(expression: string): string;
|
|
1586
|
+
toExpression(node: Operand): string;
|
|
1326
1587
|
static operatorText: any;
|
|
1327
1588
|
}
|
|
1328
1589
|
export declare class ItemValueWrapperViewModel extends Base {
|
|
@@ -1387,6 +1648,7 @@ export declare class LogoImageViewModel extends Base {
|
|
|
1387
1648
|
constructor(creator: CreatorBase, root: any);
|
|
1388
1649
|
root: any;
|
|
1389
1650
|
get allowEdit(): boolean;
|
|
1651
|
+
get containerCss(): string;
|
|
1390
1652
|
get survey(): SurveyModel;
|
|
1391
1653
|
chooseFile(model: LogoImageViewModel): void;
|
|
1392
1654
|
remove(model: LogoImageViewModel): void;
|
|
@@ -1940,7 +2202,6 @@ export declare class SurveyLogic extends Base implements ISurveyLogicItemOwner {
|
|
|
1940
2202
|
* options.item is the removed logic item.
|
|
1941
2203
|
*/
|
|
1942
2204
|
onLogicItemRemoved: Event<(sender: SurveyLogic, options: any) => any, any>;
|
|
1943
|
-
koAfterRender: any;
|
|
1944
2205
|
dispose(): void;
|
|
1945
2206
|
items: any;
|
|
1946
2207
|
logicTypes: any;
|
|
@@ -1963,6 +2224,9 @@ export declare class SurveyLogic extends Base implements ISurveyLogicItemOwner {
|
|
|
1963
2224
|
protected onEditableItemApply(): void;
|
|
1964
2225
|
protected onItemChanged(item: SurveyLogicItem, changeType: string): void;
|
|
1965
2226
|
renameQuestion(oldName: string, newName: string): void;
|
|
2227
|
+
renameItemValue(item: ItemValue, oldValue: any): void;
|
|
2228
|
+
renameRowValue(item: ItemValue, oldValue: any): void;
|
|
2229
|
+
renameColumn(column: MatrixDropdownColumn, oldName: string): void;
|
|
1966
2230
|
removeQuestion(name: string): void;
|
|
1967
2231
|
hasError(): boolean;
|
|
1968
2232
|
getUsedQuestions(): Array<Question>;
|
|
@@ -2010,6 +2274,15 @@ export declare class SurveyLogicAction {
|
|
|
2010
2274
|
addQuestionNames(names: any): void;
|
|
2011
2275
|
get elementName(): string;
|
|
2012
2276
|
}
|
|
2277
|
+
export declare class SurveyLogicExpressionUpdater {
|
|
2278
|
+
constructor(expresion: string);
|
|
2279
|
+
operand: Operand;
|
|
2280
|
+
constChanges: any;
|
|
2281
|
+
update(varName: string, oldValue: any, newValue: any): void;
|
|
2282
|
+
get isModified(): boolean;
|
|
2283
|
+
toString(): string;
|
|
2284
|
+
static operatorText: any;
|
|
2285
|
+
}
|
|
2013
2286
|
export declare class SurveyLogicItem {
|
|
2014
2287
|
constructor(owner: ISurveyLogicItemOwner, expression?: string);
|
|
2015
2288
|
expression: string;
|
|
@@ -2037,6 +2310,9 @@ export declare class SurveyLogicItem {
|
|
|
2037
2310
|
equals(item: SurveyLogicItem): boolean;
|
|
2038
2311
|
apply(expression: string): void;
|
|
2039
2312
|
renameQuestion(oldName: string, newName: string): void;
|
|
2313
|
+
renameColumn(question: Question, column: MatrixDropdownColumn, oldName: string): void;
|
|
2314
|
+
renameItemValue(question: Question, item: ItemValue, oldValue: any): void;
|
|
2315
|
+
renameRowValue(question: Question, item: ItemValue, oldValue: any): void;
|
|
2040
2316
|
removeQuestion(name: string): void;
|
|
2041
2317
|
getQuestionNames(): Array<any>;
|
|
2042
2318
|
getActionTypes(): Array<any>;
|
|
@@ -2236,7 +2512,6 @@ export declare class TestSurveyTabViewModel extends Base {
|
|
|
2236
2512
|
testAgain(): void;
|
|
2237
2513
|
buildActions(): void;
|
|
2238
2514
|
setTheme(themeName: string, themeMapper: any): void;
|
|
2239
|
-
getCurrThemeTitle(themeMapper: any): string;
|
|
2240
2515
|
protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
|
|
2241
2516
|
}
|
|
2242
2517
|
export declare class ToolbarActionContainer extends ActionContainer {
|
|
@@ -2441,6 +2716,7 @@ export declare class EmptySurveyCreatorOptions implements ISurveyCreatorOptions
|
|
|
2441
2716
|
createSurvey(json: any, reason: string, surveyType?: any): SurveyModel;
|
|
2442
2717
|
onConditionQuestionsGetListCallback(propertyName: string, obj: Base, editor: any, list: any): void;
|
|
2443
2718
|
onConditionGetTitleCallback(expression: string, title: string): string;
|
|
2719
|
+
onLogicGetTitleCallback(expression: string, displayExpression: string, text: string, logicItem: any): string;
|
|
2444
2720
|
}
|
|
2445
2721
|
export declare class ImageItemValueWrapperViewModel extends ItemValueWrapperViewModel {
|
|
2446
2722
|
constructor(creator: CreatorBase, question: QuestionSelectBase, item: ImageItemValue, templateData: any, itemsRoot: any);
|
|
@@ -2448,8 +2724,15 @@ export declare class ImageItemValueWrapperViewModel extends ItemValueWrapperView
|
|
|
2448
2724
|
item: ImageItemValue;
|
|
2449
2725
|
templateData: any;
|
|
2450
2726
|
itemsRoot: any;
|
|
2727
|
+
isFileDragging: boolean;
|
|
2728
|
+
getRootCss(): string;
|
|
2729
|
+
getIsNewItemSingle(): boolean;
|
|
2451
2730
|
chooseFile(model: ImageItemValueWrapperViewModel): void;
|
|
2731
|
+
uploadFiles(files: any): void;
|
|
2452
2732
|
chooseNewFile(model: ImageItemValueWrapperViewModel): void;
|
|
2733
|
+
onDragOver: (event: any) => void;
|
|
2734
|
+
onDrop: (event: any) => void;
|
|
2735
|
+
onDragLeave: (event: any) => void;
|
|
2453
2736
|
}
|
|
2454
2737
|
export declare class LogicActionModel extends LogicActionModelBase {
|
|
2455
2738
|
constructor(panel: PanelModel, logicAction: SurveyLogicAction, logicType: SurveyLogicType, selectorElementsHash: any);
|
|
@@ -2643,7 +2926,7 @@ export declare class TabTestPlugin implements ICreatorPlugin {
|
|
|
2643
2926
|
languageListModel: ListModel;
|
|
2644
2927
|
changeThemePopupModel: any;
|
|
2645
2928
|
changeThemeModel: ListModel;
|
|
2646
|
-
protected changeThemeAction:
|
|
2929
|
+
protected changeThemeAction: CreatorAction;
|
|
2647
2930
|
deviceSelectorAction: Action;
|
|
2648
2931
|
deviceListModel: ListModel;
|
|
2649
2932
|
orientationSelectorAction: Action;
|
|
@@ -2657,8 +2940,8 @@ export declare class TabTestPlugin implements ICreatorPlugin {
|
|
|
2657
2940
|
activate(): void;
|
|
2658
2941
|
update(): void;
|
|
2659
2942
|
deactivate(): boolean;
|
|
2660
|
-
protected
|
|
2661
|
-
createActions():
|
|
2943
|
+
protected filterThemeMapper(themeMapper: any): Array<any>;
|
|
2944
|
+
createActions(): Array<Action>;
|
|
2662
2945
|
addFooterActions(): void;
|
|
2663
2946
|
}
|
|
2664
2947
|
export declare class TabTranslationPlugin implements ICreatorPlugin {
|
|
@@ -3025,6 +3308,7 @@ export declare class PropertyGridEditorMatrixCalculatedValues extends PropertyGr
|
|
|
3025
3308
|
protected getKeyValue(): string;
|
|
3026
3309
|
protected getBaseValue(prop: JsonObjectProperty): string;
|
|
3027
3310
|
protected getShowDetailPanelOnAdding(): boolean;
|
|
3311
|
+
protected setupMatrixQuestion(obj: Base, matrix: QuestionMatrixDynamicModel, prop: JsonObjectProperty): void;
|
|
3028
3312
|
}
|
|
3029
3313
|
export declare class PropertyGridEditorMatrixColumns extends PropertyGridEditorMatrix {
|
|
3030
3314
|
constructor();
|
|
@@ -3203,6 +3487,7 @@ export declare function assignDefaultV2Classes(destination: any, questionType: s
|
|
|
3203
3487
|
export declare function wrapTextByCurlyBraces(text: string): string;
|
|
3204
3488
|
export declare function capitalize(str: string): string;
|
|
3205
3489
|
export declare function getLocString(strName: string, locale?: string): string;
|
|
3490
|
+
export declare function updateLogicExpression(expression: string, varName: string, oldValue: any, newValue: any): string;
|
|
3206
3491
|
export declare function getLogicString(name: string): string;
|
|
3207
3492
|
export declare function parsePropertyDescription(text: string): string;
|
|
3208
3493
|
export declare function setSurveyJSONForPropertyGrid(json: any, updateOnTyping?: boolean, titleLocationLeft?: boolean): void;
|
|
@@ -3262,6 +3547,14 @@ export declare var settings: {
|
|
|
3262
3547
|
logicItemTitleMaxChars: number,
|
|
3263
3548
|
openBracket: string,
|
|
3264
3549
|
closeBracket: string,
|
|
3550
|
+
/*
|
|
3551
|
+
* Set these properties to false if you don't want to update expressions on changing question and column names and on changing choices values
|
|
3552
|
+
*/
|
|
3553
|
+
updateExpressionsOnChanging: {
|
|
3554
|
+
questionName: boolean,
|
|
3555
|
+
columnName: boolean,
|
|
3556
|
+
choiceValue: boolean,
|
|
3557
|
+
},
|
|
3265
3558
|
},
|
|
3266
3559
|
/*
|
|
3267
3560
|
* Determines which types of questions the conversion will be available for.
|
|
@@ -3564,6 +3857,7 @@ export declare var propertyGridCss: {
|
|
|
3564
3857
|
dragElementDecorator: string,
|
|
3565
3858
|
iconDragElement: string,
|
|
3566
3859
|
iconDrag: string,
|
|
3860
|
+
footer: string,
|
|
3567
3861
|
dragDropGhostPositionTop: string,
|
|
3568
3862
|
dragDropGhostPositionBottom: string,
|
|
3569
3863
|
emptyRowsSection: string,
|