survey-react 1.9.56 → 1.9.58

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/survey.react.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  /*
2
- * Type definition for Survey JavaScript library for React v1.9.56
2
+ * Type definition for Survey JavaScript library for React v1.9.58
3
3
  * Copyright (c) 2015-2022 Devsoft Baltic OÜ - https://surveyjs.io/
4
4
  * License: MIT (http://www.opensource.org/licenses/mit-license.php)
5
5
  */
@@ -235,6 +235,7 @@ export interface IAction {
235
235
  mode?: any;
236
236
  visibleIndex?: number;
237
237
  needSpace?: boolean;
238
+ ariaChecked?: boolean;
238
239
  }
239
240
  export interface IActionDropdownPopupOptions extends IListModel, IPopupOptionsBase {
240
241
  }
@@ -400,6 +401,7 @@ export interface ISurvey extends ITextProcessor, ISurveyErrorOwner {
400
401
  canChangeChoiceItemsVisibility(): boolean;
401
402
  getChoiceItemVisibility(question: IQuestion, item: any, val: boolean): boolean;
402
403
  loadQuestionChoices(options: any): void;
404
+ getChoiceDisplayValue(options: any): void;
403
405
  matrixRowAdded(question: IQuestion, row: any): any;
404
406
  matrixBeforeRowAdded(options: any): any;
405
407
  matrixRowRemoved(question: IQuestion, rowIndex: number, row: any): any;
@@ -1700,6 +1702,7 @@ export declare class Action extends Base implements IAction, ILocalizableOwner {
1700
1702
  disableShrink: boolean;
1701
1703
  disableHide: boolean;
1702
1704
  needSpace: boolean;
1705
+ ariaChecked: boolean;
1703
1706
  title: string;
1704
1707
  get locTitle(): any;
1705
1708
  set locTitle(val: any);
@@ -2637,6 +2640,7 @@ export declare class MultipleTextItemModel extends Base implements IValidatorOwn
2637
2640
  get editor(): QuestionTextModel;
2638
2641
  protected createEditor(name: string): QuestionTextModel;
2639
2642
  addUsedLocales(locales: any): void;
2643
+ localeChanged(): void;
2640
2644
  locStrsChanged(): void;
2641
2645
  setData(data: IMultipleTextData): void;
2642
2646
  /*
@@ -2826,10 +2830,11 @@ export declare class PopupModel<T = any> extends Base {
2826
2830
  }
2827
2831
  /*
2828
2832
  * A Model for a survey running in the Popup Window.
2833
+ *
2834
+ * [View Demo](https://surveyjs.io/form-library/examples/popup-survey/ (linkStyle))
2829
2835
  */
2830
2836
  export declare class PopupSurveyModel extends Base {
2831
2837
  constructor(jsonObj: any, initialModel?: SurveyModel);
2832
- static surveyElementName: string;
2833
2838
  surveyValue: SurveyModel;
2834
2839
  windowElement: any;
2835
2840
  templateValue: string;
@@ -3686,6 +3691,7 @@ export declare class PopupDropdownViewModel extends PopupBaseViewModel {
3686
3691
  targetElement: any;
3687
3692
  isAutoScroll: boolean;
3688
3693
  scrollEventCallBack: any;
3694
+ protected getActualHorizontalPosition(): "left" | "right" | "center";
3689
3695
  protected hidePopup(): void;
3690
3696
  protected getStyleClass(): CssClassBuilder;
3691
3697
  protected getShowHeader(): boolean;
@@ -4031,6 +4037,8 @@ export declare class SurveyElementErrors extends ReactSurveyElement {
4031
4037
  }
4032
4038
  /*
4033
4039
  * The `SurveyModel` object contains properties and methods that allow you to control the survey and access its elements.
4040
+ *
4041
+ * [View Demo](https://surveyjs.io/form-library/examples/nps-question/ (linkStyle))
4034
4042
  */
4035
4043
  export declare class SurveyModel extends SurveyElementCore implements ISurvey, ISurveyData, ISurveyImpl, ISurveyTriggerOwner, ISurveyErrorOwner, ISurveyTimerText {
4036
4044
  constructor(jsonObj?: any, renderedElement?: any);
@@ -4310,6 +4318,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4310
4318
  * - `options.name` - a property name is going to be rendered.
4311
4319
  * - `options.text` - a text that is going to be rendered.
4312
4320
  * - `options.html` - an HTML content. It is `null` by default. Use this property to specify the HTML content rendered instead of `options.text`.
4321
+ *
4322
+ * [View Demo](https://surveyjs.io/form-library/examples/edit-survey-questions-markdown/ (linkStyle))
4313
4323
  */
4314
4324
  onTextMarkdown: EventBase<SurveyModel>;
4315
4325
  /*
@@ -4395,6 +4405,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4395
4405
  * - `sender` - the survey object that fires the event.
4396
4406
  * - `options.question` - a question for which you can change the CSS classes.
4397
4407
  * - `options.cssClasses` - an object with CSS classes. For example `{root: "table", button: "button"}`. You can change them to your own CSS classes.
4408
+ *
4409
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-cssclasses/ (linkStyle))
4398
4410
  */
4399
4411
  onUpdateQuestionCssClasses: EventBase<SurveyModel>;
4400
4412
  /*
@@ -4436,6 +4448,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4436
4448
  * - `sender` - the survey object that fires the event.
4437
4449
  * - `options.page` - a page object for which the event is fired. Typically the current/active page.
4438
4450
  * - `options.htmlElement` - an HTML element bound to the page object.
4451
+ *
4452
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-afterrender/ (linkStyle))
4439
4453
  */
4440
4454
  onAfterRenderPage: EventBase<SurveyModel>;
4441
4455
  /*
@@ -4443,6 +4457,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4443
4457
  * - `sender` - the survey object that fires the event.
4444
4458
  * - `options.question` - a question object for which the event is fired.
4445
4459
  * - `options.htmlElement` - an HTML element bound to the question object.
4460
+ *
4461
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-afterrender/ (linkStyle))
4446
4462
  */
4447
4463
  onAfterRenderQuestion: EventBase<SurveyModel>;
4448
4464
  /*
@@ -4484,6 +4500,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4484
4500
  */
4485
4501
  onShowingChoiceItem: EventBase<SurveyModel>;
4486
4502
  onChoicesLazyLoad: EventBase<SurveyModel>;
4503
+ onGetChoiceDisplayValue: EventBase<SurveyModel>;
4487
4504
  /*
4488
4505
  * The event is fired on adding a new row in Matrix Dynamic question.
4489
4506
  * - `sender` - the survey object that fires the event
@@ -4747,6 +4764,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4747
4764
  * By default all rows are rendered no matters if they are visible or not.
4748
4765
  * Set it true, and survey markup rows will be rendered only if they are visible in viewport.
4749
4766
  * This feature is experimantal and might do not support all the use cases.
4767
+ *
4768
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-lazy/ (linkStyle))
4750
4769
  */
4751
4770
  get lazyRendering(): boolean;
4752
4771
  set lazyRendering(val: boolean);
@@ -5060,6 +5079,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5060
5079
  /*
5061
5080
  * Adds a custom navigation item similar to the Previous Page, Next Page, and Complete buttons.
5062
5081
  * Accepts an object described in the [IAction](https://surveyjs.io/Documentation/Library?id=IAction) help section.
5082
+ *
5083
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-changenavigation/ (linkStyle))
5063
5084
  */
5064
5085
  addNavigationItem(val: IAction): Action;
5065
5086
  /*
@@ -5116,6 +5137,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5116
5137
  getUpdatedQuestionNo(question: IQuestion, no: string): string;
5117
5138
  /*
5118
5139
  * Gets or sets whether the survey displays page numbers on pages titles.
5140
+ *
5141
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-options/ (linkStyle))
5119
5142
  */
5120
5143
  get showPageNumbers(): boolean;
5121
5144
  set showPageNumbers(val: boolean);
@@ -5127,6 +5150,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5127
5150
  * - `on` - display question numbers
5128
5151
  * - `onpage` - display question numbers, start numbering on every page
5129
5152
  * - `off` - turn off the numbering for questions titles
5153
+ *
5154
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-options/ (linkStyle))
5130
5155
  */
5131
5156
  get showQuestionNumbers(): string;
5132
5157
  set showQuestionNumbers(val: string);
@@ -5139,6 +5164,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5139
5164
  * - `top` - show progress bar in the top
5140
5165
  * - `bottom` - show progress bar in the bottom
5141
5166
  * - `both` - show progress bar in both sides: top and bottom.
5167
+ *
5168
+ * [View Demo](https://surveyjs.io/form-library/examples/navigation-default/ (linkStyle))
5142
5169
  */
5143
5170
  get showProgressBar(): string;
5144
5171
  set showProgressBar(val: string);
@@ -5152,6 +5179,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5152
5179
  * - `requiredQuestions`,
5153
5180
  * - `correctQuestions`,
5154
5181
  * - `buttons`
5182
+ *
5183
+ * [View Demo](https://surveyjs.io/form-library/examples/navigation-buttons/ (linkStyle))
5155
5184
  */
5156
5185
  get progressBarType(): string;
5157
5186
  set progressBarType(val: string);
@@ -5198,6 +5227,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5198
5227
  *
5199
5228
  * - `edit` (default) - make a survey editable,
5200
5229
  * - `display` - make a survey read-only.
5230
+ *
5231
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-displaymode/ (linkStyle))
5201
5232
  */
5202
5233
  get mode(): string;
5203
5234
  set mode(val: string);
@@ -5281,6 +5312,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5281
5312
  get isShowingPage(): boolean;
5282
5313
  /*
5283
5314
  * The zero-based index of the current page in the visible pages array.
5315
+ *
5316
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-editprevious/ (linkStyle))
5284
5317
  */
5285
5318
  get currentPageNo(): number;
5286
5319
  set currentPageNo(val: number);
@@ -5475,7 +5508,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5475
5508
  * Set this property to "showAllQuestions" or "showAnsweredQuestions" to allow respondents to preview answers before submitting the survey results.
5476
5509
  *
5477
5510
  * Details: [Preview State](https://surveyjs.io/Documentation/Library#states-preview)
5478
- * Example: [Show Preview Before Complete](https://surveyjs.io/Examples/Library?id=survey-showpreview)
5511
+ * [View Demo](https://surveyjs.io/Examples/Library?id=survey-showpreview (linkStyle))
5479
5512
  */
5480
5513
  get showPreviewBeforeComplete(): string;
5481
5514
  set showPreviewBeforeComplete(val: string);
@@ -5568,6 +5601,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5568
5601
  canChangeChoiceItemsVisibility(): boolean;
5569
5602
  getChoiceItemVisibility(question: IQuestion, item: any, val: boolean): boolean;
5570
5603
  loadQuestionChoices(options: any): void;
5604
+ getChoiceDisplayValue(options: any): void;
5571
5605
  matrixBeforeRowAdded(options: any): void;
5572
5606
  matrixRowAdded(question: IQuestion, row: any): void;
5573
5607
  getQuestionByValueNameFromArray(valueName: string, name: string, index: number): IQuestion;
@@ -6344,6 +6378,8 @@ export declare class MultiSelectListModel extends ListModel {
6344
6378
  }
6345
6379
  /*
6346
6380
  * A base class for a Panel and Page objects.
6381
+ *
6382
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-panel/ (linkStyle))
6347
6383
  */
6348
6384
  export declare class PanelModelBase extends SurveyElement<Question> implements IPanel, IConditionRunner, ISurveyErrorOwner, ITitleOwner {
6349
6385
  constructor(name?: string);
@@ -6389,6 +6425,10 @@ export declare class PanelModelBase extends SurveyElement<Question> implements I
6389
6425
  protected isRandomizing: boolean;
6390
6426
  randomizeElements(isRandom: boolean): void;
6391
6427
  /*
6428
+ * The property returns true, if the elements are randomized on the panel or page
6429
+ */
6430
+ get areQuestionsRandomized(): boolean;
6431
+ /*
6392
6432
  * A parent element. It is always null for the Page object and always not null for the Panel object. Panel object may contain Questions and other Panels.
6393
6433
  */
6394
6434
  get parent(): PanelModelBase;
@@ -6659,6 +6699,7 @@ export declare class Question extends SurveyElement<Question> implements IQuesti
6659
6699
  get isReady(): boolean;
6660
6700
  get ariaRequired(): "true" | "false";
6661
6701
  get ariaInvalid(): "true" | "false";
6702
+ get ariaLabelledBy(): string;
6662
6703
  get ariaDescribedBy(): string;
6663
6704
  choicesLoaded(): void;
6664
6705
  /*
@@ -6735,6 +6776,7 @@ export declare class Question extends SurveyElement<Question> implements IQuesti
6735
6776
  * - [*"checkbox"*](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel)
6736
6777
  * - [*"comment"*](https://surveyjs.io/Documentation/Library?id=questioncommentmodel)
6737
6778
  * - [*"dropdown"*](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel)
6779
+ * - [*"tagbox"*](https://surveyjs.io/form-library/documentation/questiontagboxmodel)
6738
6780
  * - [*"expression"*](https://surveyjs.io/Documentation/Library?id=questionexpressionmodel)
6739
6781
  * - [*"file"*](https://surveyjs.io/Documentation/Library?id=questionfilemodel)
6740
6782
  * - [*"html"*](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel)
@@ -6774,7 +6816,7 @@ export declare class Question extends SurveyElement<Question> implements IQuesti
6774
6816
  *
6775
6817
  * Possible values:
6776
6818
  *
6777
- * - `"default"` - Inherits the setting from the `questionTitleLocation` property specified for the question's container.
6819
+ * - `"default"` (default) - Inherits the setting from the `questionTitleLocation` property specified for the question's container.
6778
6820
  * - `"top"` - Displays the title above the input field.
6779
6821
  * - `"bottom"` - Displays the title below the input field.
6780
6822
  * - `"left"` - Displays the title to the left of the input field.
@@ -7139,6 +7181,7 @@ export declare class Question extends SurveyElement<Question> implements IQuesti
7139
7181
  updateValueFromSurvey(newValue: any): void;
7140
7182
  updateCommentFromSurvey(newValue: any): any;
7141
7183
  protected onChangeQuestionValue(newValue: any): void;
7184
+ protected setValueChangedDirectly(): void;
7142
7185
  protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
7143
7186
  onSurveyValueChanged(newValue: any): void;
7144
7187
  setVisibleIndex(val: number): number;
@@ -7434,10 +7477,6 @@ export declare class PageModel extends PanelModelBase implements IPage {
7434
7477
  get hasShown(): boolean;
7435
7478
  setWasShown(val: boolean): void;
7436
7479
  /*
7437
- * The property returns true, if the elements are randomized on the page
7438
- */
7439
- get areQuestionsRandomized(): boolean;
7440
- /*
7441
7480
  * Call it to scroll to the page top.
7442
7481
  */
7443
7482
  scrollToTop(): void;
@@ -7579,6 +7618,7 @@ export declare class QuestionBooleanModel extends Question {
7579
7618
  set defaultValue(val: any);
7580
7619
  getDefaultValue(): any;
7581
7620
  get locTitle(): LocalizableString;
7621
+ get labelRenderedAriaID(): string;
7582
7622
  showTitle: boolean;
7583
7623
  get label(): string;
7584
7624
  set label(val: string);
@@ -8039,6 +8079,7 @@ export declare class QuestionMultipleTextModel extends Question implements IMult
8039
8079
  addConditionObjectsByContext(objects: any, context: any): void;
8040
8080
  getConditionJson(operator?: string, path?: string): any;
8041
8081
  locStrsChanged(): void;
8082
+ localeChanged(): void;
8042
8083
  supportGoNextPageAutomatic(): boolean;
8043
8084
  /*
8044
8085
  * The number of columns used to arrange input items. Accepts the following values: 1, 2, 3, 4, 5.
@@ -8104,8 +8145,11 @@ export declare class QuestionNonValue extends Question {
8104
8145
  getConditionJson(operator?: string, path?: string): any;
8105
8146
  }
8106
8147
  /*
8107
- * A Model for a panel dymanic question. You setup the template panel, but adding elements (any question or a panel) and assign a text to it's title, and this panel will be used as a template on creating dynamic panels. The number of panels is defined by panelCount property.
8108
- * An end-user may dynamically add/remove panels, unless you forbidden this.
8148
+ * A class that describes the Dynamic Panel question type.
8149
+ *
8150
+ * Dynamic Panel allows respondents to add panels based on a template panel and delete them. Specify the [`templateElements`](https://surveyjs.io/form-library/documentation/questionpaneldynamicmodel#templateElements) property to configure template panel elements.
8151
+ *
8152
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-paneldynamic/ (linkStyle))
8109
8153
  */
8110
8154
  export declare class QuestionPanelDynamicModel extends Question implements IQuestionPanelDynamicData {
8111
8155
  constructor(name: string);
@@ -8126,82 +8170,88 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8126
8170
  get isAllowTitleLeft(): boolean;
8127
8171
  removeElement(element: IElement): boolean;
8128
8172
  /*
8129
- * The template Panel. This panel is used as a template on creatign dynamic panels
8173
+ * A `PanelModel` object used as a template to create dynamic panels.
8130
8174
  */
8131
8175
  get template(): PanelModel;
8132
8176
  getPanel(): IPanel;
8133
8177
  /*
8134
- * The template Panel elements, questions and panels.
8178
+ * An array of questions and panels included in the template panel.
8135
8179
  */
8136
8180
  get templateElements(): any;
8137
8181
  /*
8138
- * The template Panel title property.
8182
+ * A title for the template panel.
8139
8183
  */
8140
8184
  get templateTitle(): string;
8141
8185
  set templateTitle(val: string);
8142
8186
  get locTemplateTitle(): LocalizableString;
8143
8187
  /*
8144
- * The template Panel description property.
8188
+ * A description for the template panel.
8145
8189
  */
8146
8190
  get templateDescription(): string;
8147
8191
  set templateDescription(val: string);
8148
8192
  get locTemplateDescription(): LocalizableString;
8149
8193
  protected get items(): any;
8150
8194
  /*
8151
- * The array of dynamic panels created based on panel template
8195
+ * An array of `PanelModel` objects created based on the template panel.
8152
8196
  */
8153
8197
  get panels(): any;
8154
8198
  /*
8155
- * The index of current active dynamical panel when the renderMode is not "list". If there is no dymamic panel (panelCount = 0) or renderMode equals "list" it returns -1, otherwise it returns a value from 0 to panelCount - 1.
8199
+ * A zero-based index of the currently displayed panel.
8200
+ *
8201
+ * When `renderMode` is `"list"` or Dynamic Panel is empty (`panelCount` is 0), this property contains -1.
8156
8202
  */
8157
8203
  get currentIndex(): number;
8158
8204
  set currentIndex(val: number);
8159
8205
  /*
8160
- * The current active dynamical panel when the renderMode is not "list". If there is no dymamic panel (panelCount = 0) or renderMode equals "list" it returns null.
8206
+ * A `PanelModel` object that is the currently displayed panel.
8207
+ *
8208
+ * When `renderMode` is `"list"` or Dynamic Panel is empty (`panelCount` is 0), this property contains `null`.
8161
8209
  */
8162
8210
  get currentPanel(): PanelModel;
8163
8211
  /*
8164
- * Set it to true, to show a confirmation dialog on removing a panel
8212
+ * Specifies whether to display a confirmation dialog when a respondent wants to delete a panel.
8165
8213
  */
8166
8214
  get confirmDelete(): boolean;
8167
8215
  set confirmDelete(val: boolean);
8168
8216
  /*
8169
- * Set it to a question name used in the template panel and the library shows duplication error, if there are same values in different panels of this question.
8217
+ * Specifies a key question. Set this property to the name of a question used in the template, and Dynamic Panel will display `keyDuplicationError` if a user tries to enter a duplicate value in this question.
8170
8218
  */
8171
8219
  get keyName(): string;
8172
8220
  set keyName(val: string);
8173
8221
  /*
8174
- * Use this property to change the default text showing in the confirmation delete dialog on removing a panel.
8222
+ * A message displayed in a confirmation dialog that appears when a respondent wants to delete a panel.
8175
8223
  */
8176
8224
  get confirmDeleteText(): string;
8177
8225
  set confirmDeleteText(val: string);
8178
8226
  get locConfirmDeleteText(): LocalizableString;
8179
8227
  /*
8180
- * The duplication value error text. Set it to show the text different from the default.
8228
+ * An error message displayed when users enter a duplicate value into a question that accepts only unique values (`isUnique` is set to `true` or `keyName` is specified).
8229
+ *
8230
+ * A default value for this property is taken from a [localization dictionary](https://github.com/surveyjs/survey-library/tree/master/src/localization). Refer to the following help topic for more information: [Localization & Globalization](https://surveyjs.io/form-library/documentation/localization).
8181
8231
  */
8182
8232
  get keyDuplicationError(): string;
8183
8233
  set keyDuplicationError(val: string);
8184
8234
  get locKeyDuplicationError(): LocalizableString;
8185
8235
  /*
8186
- * Use this property to change the default previous button text. Previous button shows the previous panel, change the currentPanel, when the renderMode doesn't equal to "list".
8236
+ * A caption for the Previous button. Applies only if `renderMode` is different from `"list"`.
8187
8237
  */
8188
8238
  get panelPrevText(): string;
8189
8239
  set panelPrevText(val: string);
8190
8240
  get locPanelPrevText(): LocalizableString;
8191
8241
  /*
8192
- * Use this property to change the default next button text. Next button shows the next panel, change the currentPanel, when the renderMode doesn't equal to "list".
8242
+ * A caption for the Next button. Applies only if `renderMode` is different from `"list"`.
8193
8243
  */
8194
8244
  get panelNextText(): string;
8195
8245
  set panelNextText(val: string);
8196
8246
  get locPanelNextText(): LocalizableString;
8197
8247
  /*
8198
- * Use this property to change the default value of add panel button text.
8248
+ * A caption for the Add Panel button.
8199
8249
  */
8200
8250
  get panelAddText(): string;
8201
8251
  set panelAddText(val: string);
8202
8252
  get locPanelAddText(): LocalizableString;
8203
8253
  /*
8204
- * Use this property to change the default value of remove panel button text.
8254
+ * A caption for the Delete Panel button.
8205
8255
  */
8206
8256
  get panelRemoveText(): string;
8207
8257
  set panelRemoveText(val: string);
@@ -8215,11 +8265,11 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8215
8265
  */
8216
8266
  get isProgressBottomShowing(): boolean;
8217
8267
  /*
8218
- * Returns true when currentIndex is more than 0.
8268
+ * Indicates whether the Previous button is visible.
8219
8269
  */
8220
8270
  get isPrevButtonShowing(): boolean;
8221
8271
  /*
8222
- * Returns true when currentIndex is more than or equal 0 and less than panelCount - 1.
8272
+ * Indicates whether the Next button is visible.
8223
8273
  */
8224
8274
  get isNextButtonShowing(): boolean;
8225
8275
  /*
@@ -8233,41 +8283,58 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8233
8283
  protected getValueCore(): any;
8234
8284
  protected setValueCore(newValue: any): void;
8235
8285
  /*
8236
- * Use this property to get/set the number of dynamic panels.
8286
+ * The number of panels in Dynamic Panel.
8237
8287
  */
8238
8288
  get panelCount(): number;
8239
8289
  set panelCount(val: number);
8240
8290
  /*
8241
- * Use this property to allow the end-user to collapse/expand the panels. It works only if the renderMode property equals to "list" and templateTitle property is not empty. The following values are available:
8242
- * default - the default value. User can't collapse/expand panels
8243
- * expanded - User can collapse/expand panels and all panels are expanded by default
8244
- * collapsed - User can collapse/expand panels and all panels are collapsed by default
8245
- * firstExpanded - User can collapse/expand panels. The first panel is expanded and others are collapsed
8291
+ * Specifies whether users can expand and collapse panels. Applies if `renderMode` is `"list"` and the `templateTitle` property is specified.
8292
+ *
8293
+ * Possible values:
8294
+ *
8295
+ * - `"default"` (default) - All panels are displayed in full and cannot be collapsed.
8296
+ * - `"expanded"` - All panels are displayed in full and can be collapsed in the UI.
8297
+ * - `"collapsed"` - All panels display only their titles and descriptions and can be expanded in the UI.
8298
+ * - `"firstExpanded"` - Only the first panel is displayed in full; other panels are collapsed and can be expanded in the UI.
8246
8299
  */
8247
8300
  get panelsState(): string;
8248
8301
  set panelsState(val: string);
8249
8302
  /*
8250
- * The minimum panel count. A user could not delete a panel if the panelCount equals to minPanelCount
8303
+ * A minimum number of panels in Dynamic Panel. Users cannot delete panels if `panelCount` equals `minPanelCount`.
8304
+ *
8305
+ * Default value: 0
8251
8306
  */
8252
8307
  get minPanelCount(): number;
8253
8308
  set minPanelCount(val: number);
8254
8309
  /*
8255
- * The maximum panel count. A user could not add a panel if the panelCount equals to maxPanelCount
8310
+ * A maximum number of panels in Dynamic Panel. Users cannot add new panels if `panelCount` equals `maxPanelCount`.
8311
+ *
8312
+ * Default value: 100 (inherited from [`settings.panelMaximumPanelCount`](https://surveyjs.io/form-library/documentation/settings#panelMaximumPanelCount))
8256
8313
  */
8257
8314
  get maxPanelCount(): number;
8258
8315
  set maxPanelCount(val: number);
8259
8316
  /*
8260
- * Set this property to false to hide the 'Add New' button
8317
+ * Specifies whether users are allowed to add new panels.
8318
+ *
8319
+ * Default value: `true`
8261
8320
  */
8262
8321
  get allowAddPanel(): boolean;
8263
8322
  set allowAddPanel(val: boolean);
8264
8323
  /*
8265
- * Set this property to false to hide the 'Remove' button
8324
+ * Specifies whether users are allowed to delete panels.
8325
+ *
8326
+ * Default value: `true`
8266
8327
  */
8267
8328
  get allowRemovePanel(): boolean;
8268
8329
  set allowRemovePanel(val: boolean);
8269
8330
  /*
8270
- * Set this property different from "default" to set the specific question title location for the template questions.
8331
+ * Gets or sets the location of question titles within the template panel relative to their input fields.
8332
+ *
8333
+ * - `"default"` (default) - Inherits the setting from the Dynamic Panel's `titleLocation` property, which in turn inherits the [`questionTitleLocation`](https://surveyjs.io/form-library/documentation/surveymodel#questionTitleLocation) property value specified for the Dynamic Panel's container (page or survey).
8334
+ * - `"top"` - Displays question titles above input fields.
8335
+ * - `"bottom"` - Displays question titles below input fields.
8336
+ * - `"left"` - Displays question titles to the left of input fields.
8337
+ * - `"hidden"` - Hides question titles.
8271
8338
  */
8272
8339
  get templateTitleLocation(): string;
8273
8340
  set templateTitleLocation(val: string);
@@ -8278,8 +8345,12 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8278
8345
  get showQuestionNumbers(): string;
8279
8346
  set showQuestionNumbers(val: string);
8280
8347
  /*
8281
- * Use this property to change the location of the remove button relative to the panel.
8282
- * By default the value is "bottom". You may set it to "right" and remove button will appear to the right of the panel.
8348
+ * Specifies the location of the Delete Panel button relative to panel content.
8349
+ *
8350
+ * Possible values:
8351
+ *
8352
+ * - `"bottom"` (default) - Displays the Delete Panel button below panel content.
8353
+ * - `"right"` - Displays the Delete Panel button to the right of panel content.
8283
8354
  */
8284
8355
  get panelRemoveButtonLocation(): string;
8285
8356
  set panelRemoveButtonLocation(val: string);
@@ -8293,18 +8364,26 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8293
8364
  */
8294
8365
  get renderMode(): string;
8295
8366
  set renderMode(val: string);
8296
- /*
8297
- * Returns true when renderMode equals to "list".
8298
- */
8299
8367
  get isRenderModeList(): boolean;
8300
8368
  setVisibleIndex(value: number): number;
8301
8369
  /*
8302
- * Returns true when an end user may add a new panel. The question is not read only and panelCount less than maxPanelCount
8303
- * and renderMode is "list" or the current panel doesn't have any errors
8370
+ * Indicates whether it is possible to add a new panel.
8371
+ *
8372
+ * This property returns `true` when all of the following conditions apply:
8373
+ *
8374
+ * - Users are allowed to add new panels (`allowAddPanel` is `true`).
8375
+ * - Dynamic Panel or its parent survey is not in read-only state.
8376
+ * - `panelCount` is less than `maxPanelCount`.
8304
8377
  */
8305
8378
  get canAddPanel(): boolean;
8306
8379
  /*
8307
- * Returns true when an end user may remove a panel. The question is not read only and panelCount is more than minPanelCount
8380
+ * Indicates whether it is possible to delete panels.
8381
+ *
8382
+ * This property returns `true` when all of the following conditions apply:
8383
+ *
8384
+ * - Users are allowed to delete panels (`allowRemovePanel` is `true`).
8385
+ * - Dynamic Panel or its parent survey is not in read-only state.
8386
+ * - `panelCount` exceeds `minPanelCount`.
8308
8387
  */
8309
8388
  get canRemovePanel(): boolean;
8310
8389
  protected rebuildPanels(): void;
@@ -8314,8 +8393,9 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8314
8393
  get defaultPanelValue(): any;
8315
8394
  set defaultPanelValue(val: any);
8316
8395
  /*
8317
- * Set it to true to copy the value into new added panel from the last panel. If defaultPanelValue is set and this property equals to true,
8318
- * then the value for new added panel is merging.
8396
+ * Specifies whether default values for a new panel should be copied from the last panel.
8397
+ *
8398
+ * If you also specify `defaultValue`, it will be merged with the copied values.
8319
8399
  */
8320
8400
  get defaultValueFromLastPanel(): boolean;
8321
8401
  set defaultValueFromLastPanel(val: boolean);
@@ -8337,12 +8417,11 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8337
8417
  */
8338
8418
  removePanelUI(value: any): void;
8339
8419
  /*
8340
- * Goes to the next panel in the PanelDynamic
8341
- * Returns true, if it can move to the next panel. It can return false if the renderMode is "list" or the current panel has errors.
8420
+ * Switches Dynamic Panel to the next panel. Returns `true` in case of success, or `false` if `renderMode` is `"list"` or the current panel contains validation errors.
8342
8421
  */
8343
8422
  goToNextPanel(): boolean;
8344
8423
  /*
8345
- * Goes to the previous panel in the PanelDynamic
8424
+ * Switches Dynamic Panel to the previous panel.
8346
8425
  */
8347
8426
  goToPrevPanel(): void;
8348
8427
  /*
@@ -8375,6 +8454,8 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8375
8454
  protected createNewPanelObject(): PanelModel;
8376
8455
  setQuestionValue(newValue: any): void;
8377
8456
  onSurveyValueChanged(newValue: any): void;
8457
+ onReadyChangedCallback: any;
8458
+ recalculateIsReadyValue(): void;
8378
8459
  protected onSetData(): void;
8379
8460
  getItemIndex(item: ISurveyData): number;
8380
8461
  getPanelItemData(item: ISurveyData): any;
@@ -8392,7 +8473,7 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8392
8473
  getPrevButtonCss(): string;
8393
8474
  getNextButtonCss(): string;
8394
8475
  /*
8395
- * A text displayed when the dynamic panel contains no entries. Applies only in the Default V2 theme.
8476
+ * A text displayed when Dynamic Panel contains no entries. Applies only in the Default V2 theme.
8396
8477
  */
8397
8478
  get noEntriesText(): string;
8398
8479
  set noEntriesText(val: string);
@@ -8405,7 +8486,7 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8405
8486
  updateFooterActionsCallback: any;
8406
8487
  }
8407
8488
  /*
8408
- * A class that describes the Rating question type.
8489
+ * A Model for a rating question.
8409
8490
  *
8410
8491
  * [View Demo](https://surveyjs.io/form-library/examples/questiontype-rating/ (linkStyle))
8411
8492
  */
@@ -8506,6 +8587,7 @@ export declare class QuestionRatingModel extends Question {
8506
8587
  set placeholder(val: string);
8507
8588
  get locPlaceholder(): LocalizableString;
8508
8589
  get allowClear(): boolean;
8590
+ get searchEnabled(): boolean;
8509
8591
  get renderedValue(): boolean;
8510
8592
  set renderedValue(val: boolean);
8511
8593
  get visibleChoices(): any;
@@ -8536,6 +8618,7 @@ export declare class QuestionSelectBase extends Question {
8536
8618
  noneItemValue: ItemValue;
8537
8619
  newItemValue: ItemValue;
8538
8620
  canShowOptionItemCallback: (item: ItemValue) => boolean;
8621
+ protected selectedItemValues: any;
8539
8622
  getType(): string;
8540
8623
  dispose(): void;
8541
8624
  protected getItemValueType(): string;
@@ -8552,6 +8635,7 @@ export declare class QuestionSelectBase extends Question {
8552
8635
  * Returns `true` if the "Other" choice item is selected.
8553
8636
  */
8554
8637
  get isOtherSelected(): boolean;
8638
+ get isNoneSelected(): boolean;
8555
8639
  /*
8556
8640
  * Specifies whether to display the "None" choice item.
8557
8641
  *
@@ -8626,6 +8710,8 @@ export declare class QuestionSelectBase extends Question {
8626
8710
  protected rendredValueToData(val: any): any;
8627
8711
  protected renderedValueFromDataCore(val: any): any;
8628
8712
  protected rendredValueToDataCore(val: any): any;
8713
+ protected updateSelectedItemValues(): void;
8714
+ protected resetSelectedItemValues(): void;
8629
8715
  protected hasUnknownValue(val: any, includeOther?: boolean, isFilteredChoices?: boolean, checkEmptyValue?: boolean): boolean;
8630
8716
  protected isValueDisabled(val: any): boolean;
8631
8717
  /*
@@ -9316,6 +9402,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9316
9402
  * - [*"checkbox"*](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel)
9317
9403
  * - [*"comment"*](https://surveyjs.io/Documentation/Library?id=questioncommentmodel)
9318
9404
  * - [*"dropdown"*](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel)
9405
+ * - [*"tagbox"*](https://surveyjs.io/form-library/documentation/questiontagboxmodel)
9319
9406
  * - [*"expression"*](https://surveyjs.io/Documentation/Library?id=questionexpressionmodel)
9320
9407
  * - [*"file"*](https://surveyjs.io/Documentation/Library?id=questionfilemodel)
9321
9408
  * - [*"html"*](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel)
@@ -9780,6 +9867,7 @@ export declare class QuestionCheckboxModel extends QuestionCheckboxBase {
9780
9867
  constructor(name: string);
9781
9868
  selectAllItemValue: ItemValue;
9782
9869
  invisibleOldValues: any;
9870
+ initialSelectedItemValues: any;
9783
9871
  protected getDefaultItemComponent(): string;
9784
9872
  get ariaRole(): string;
9785
9873
  getType(): string;
@@ -10098,8 +10186,8 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
10098
10186
  * This property returns `true` when all of the following conditions apply:
10099
10187
  *
10100
10188
  * - Users are allowed to add new rows (`allowAddRows` is `true`).
10101
- * - The question, panel, or survey is not in read-only state.
10102
- * - `rowCount` does not exceed `maxRowCount`
10189
+ * - The question, its parent panel, or survey is not in read-only state.
10190
+ * - `rowCount` is less than `maxRowCount`.
10103
10191
  */
10104
10192
  get canAddRow(): boolean;
10105
10193
  canRemoveRowsCallback: (allow: boolean) => boolean;
@@ -10109,8 +10197,8 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
10109
10197
  * This property returns `true` when all of the following conditions apply:
10110
10198
  *
10111
10199
  * - Users are allowed to delete rows (`allowRemoveRows` is `true`).
10112
- * - The question, panel, or survey is not in read-only state.
10113
- * - `rowCount` exceeds `minRowCount`
10200
+ * - The question, its parent panel, or survey is not in read-only state.
10201
+ * - `rowCount` exceeds `minRowCount`.
10114
10202
  */
10115
10203
  get canRemoveRows(): boolean;
10116
10204
  canRemoveRow(row: MatrixDropdownRowModelBase): boolean;
@@ -10286,6 +10374,8 @@ export declare class QuestionRankingModel extends QuestionCheckboxModel {
10286
10374
  }
10287
10375
  /*
10288
10376
  * A Model for a tagbox question
10377
+ *
10378
+ * [View Demo](https://surveyjs.io/form-library/examples/how-to-create-multiselect-tag-box/ (linkStyle))
10289
10379
  */
10290
10380
  export declare class QuestionTagboxModel extends QuestionCheckboxModel {
10291
10381
  constructor(name: string);