survey-react 1.9.55 → 1.9.57

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.55
2
+ * Type definition for Survey JavaScript library for React v1.9.57
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
  */
@@ -260,6 +260,17 @@ export interface IConditionObject {
260
260
  question: Question;
261
261
  context?: Question;
262
262
  }
263
+ export interface IQuestionPlainData {
264
+ name: string | number;
265
+ title: string;
266
+ value: any;
267
+ displayValue: any;
268
+ isNode: boolean;
269
+ isComment?: boolean;
270
+ questionType?: string;
271
+ data?: any;
272
+ getString: (val: any) => string;
273
+ }
263
274
  export interface IMatrixColumnOwner extends ILocalizableOwner {
264
275
  getRequiredText(): string;
265
276
  hasChoices(): boolean;
@@ -1835,6 +1846,7 @@ export declare class CalculatedValue extends Base {
1835
1846
  * titleName: "title", // Specifies which field contains display texts for choice values.
1836
1847
  * imageLinkName: "imageUrl", // Specifies which field contains image URLs. Used in Image Picker questions.
1837
1848
  * // Path to the array of choices. Specify `path` only if the array of choices is nested within the object returned by the service.
1849
+ * // The following path separators are allowed: semicolon `;`, comma `,`.
1838
1850
  * path: "myNestedArray"
1839
1851
  * }
1840
1852
  * ```
@@ -1892,7 +1904,7 @@ export declare class ChoicesRestful extends Base {
1892
1904
  get url(): string;
1893
1905
  set url(val: string);
1894
1906
  /*
1895
- * Path to the array of choices.
1907
+ * Path to the array of choices. The following path separators are allowed: semicolon `;`, comma `,`.
1896
1908
  *
1897
1909
  * Specify this property only if the array of choices is nested within the object returned by the service. For example, the service returns the following object:
1898
1910
  *
@@ -2012,14 +2024,19 @@ export declare class DragDropCore<T> extends Base {
2012
2024
  }
2013
2025
  export declare class DropdownListModel extends Base {
2014
2026
  constructor(question: Question, onSelectionChanged?: (item: IAction, ...params: any) => void);
2027
+ minPageSize: any;
2028
+ loadingItemHeight: any;
2015
2029
  _popupModel: any;
2016
2030
  focusFirstInputSelector: string;
2017
2031
  itemsSettings: any;
2032
+ isRunningLoadQuestionChoices: boolean;
2018
2033
  protected listModel: ListModel;
2019
2034
  protected popupCssClasses: string;
2035
+ protected popupRecalculatePosition(isResetHeight: boolean): void;
2020
2036
  protected onHidePopup(): void;
2021
2037
  protected getAvailableItems(): Array<Action>;
2022
2038
  protected createListModel(): ListModel;
2039
+ protected updateAfterListModelCreated(model: ListModel): void;
2023
2040
  protected resetFilterString(): void;
2024
2041
  protected onSetFilterString(): void;
2025
2042
  setInputHasValue(newValue: boolean): void;
@@ -2620,6 +2637,7 @@ export declare class MultipleTextItemModel extends Base implements IValidatorOwn
2620
2637
  get editor(): QuestionTextModel;
2621
2638
  protected createEditor(name: string): QuestionTextModel;
2622
2639
  addUsedLocales(locales: any): void;
2640
+ localeChanged(): void;
2623
2641
  locStrsChanged(): void;
2624
2642
  setData(data: IMultipleTextData): void;
2625
2643
  /*
@@ -2801,14 +2819,16 @@ export declare class PopupModel<T = any> extends Base {
2801
2819
  displayMode: "popup" | "overlay";
2802
2820
  positionMode: any;
2803
2821
  onVisibilityChanged: EventBase<PopupModel<any>>;
2804
- onTargetModified: EventBase<Base>;
2822
+ onRecalculatePosition: EventBase<Base>;
2805
2823
  get isVisible(): boolean;
2806
2824
  set isVisible(val: boolean);
2807
2825
  toggleVisibility(): void;
2808
- targetModified(): void;
2826
+ recalculatePosition(isResetHeight: boolean): void;
2809
2827
  }
2810
2828
  /*
2811
2829
  * A Model for a survey running in the Popup Window.
2830
+ *
2831
+ * [View Demo](https://surveyjs.io/form-library/examples/popup-survey/ (linkStyle))
2812
2832
  */
2813
2833
  export declare class PopupSurveyModel extends Base {
2814
2834
  constructor(jsonObj: any, initialModel?: SurveyModel);
@@ -2868,6 +2888,8 @@ export declare class PopupSurveyModel extends Base {
2868
2888
  get cssBody(): string;
2869
2889
  get cssHeaderRoot(): string;
2870
2890
  get cssHeaderTitle(): string;
2891
+ get renderedWidth(): string;
2892
+ width: string;
2871
2893
  protected createSurvey(jsonObj: any): SurveyModel;
2872
2894
  protected onSurveyComplete(): void;
2873
2895
  }
@@ -2905,6 +2927,7 @@ export declare class QuestionMatrixDropdownRenderedTable extends Base {
2905
2927
  isRequireReset(): boolean;
2906
2928
  get headerRow(): QuestionMatrixDropdownRenderedRow;
2907
2929
  get footerRow(): QuestionMatrixDropdownRenderedRow;
2930
+ get allowRowsDragAndDrop(): boolean;
2908
2931
  protected build(): void;
2909
2932
  updateShowTableAndAddRow(): void;
2910
2933
  onAddedRow(): void;
@@ -3476,7 +3499,6 @@ export declare class DropdownMultiSelectListModel extends DropdownListModel {
3476
3499
  closeOnSelect: boolean;
3477
3500
  protected override: any;
3478
3501
  createListModel(): MultiSelectListModel;
3479
- protected onSetFilterString(): void;
3480
3502
  selectAllItems(): void;
3481
3503
  selectNoneItem(): void;
3482
3504
  selectItem(id: string): void;
@@ -3562,6 +3584,7 @@ export declare class ListModel extends ActionContainer {
3562
3584
  onSelectionChanged: (item: Action, ...params: any) => void;
3563
3585
  allowSelection: boolean;
3564
3586
  listContainerHtmlElement: any;
3587
+ loadingIndicatorValue: Action;
3565
3588
  searchEnabled: boolean;
3566
3589
  showFilter: boolean;
3567
3590
  isExpanded: boolean;
@@ -3575,6 +3598,7 @@ export declare class ListModel extends ActionContainer {
3575
3598
  scrollHandler: (e?: any) => void;
3576
3599
  isItemVisible(item: Action): boolean;
3577
3600
  get visibleItems(): any;
3601
+ setItems(items: any, sortByVisibleIndex?: boolean): void;
3578
3602
  protected onSet(): void;
3579
3603
  protected getDefaultCssClasses(): any;
3580
3604
  protected updateItemActiveState(): void;
@@ -3587,6 +3611,8 @@ export declare class ListModel extends ActionContainer {
3587
3611
  get filterStringPlaceholder(): string;
3588
3612
  get emptyMessage(): string;
3589
3613
  get scrollableContainer(): any;
3614
+ get loadingText(): string;
3615
+ get loadingIndicator(): Action;
3590
3616
  goToItems(event: any): void;
3591
3617
  onMouseMove(event: any): void;
3592
3618
  onKeyDown(event: any): void;
@@ -3670,6 +3696,7 @@ export declare class PopupDropdownViewModel extends PopupBaseViewModel {
3670
3696
  popupDirection: string;
3671
3697
  pointerTarget: IPosition;
3672
3698
  updateOnShowing(): void;
3699
+ updatePosition(isResetHeight: boolean, isDelayUpdating?: boolean): void;
3673
3700
  updateOnHiding(): void;
3674
3701
  }
3675
3702
  export declare class PopupModalViewModel extends PopupBaseViewModel {
@@ -3927,7 +3954,7 @@ export declare class SurveyElement<E = any> extends SurveyElementCore implements
3927
3954
  getRenderer(name: string): string;
3928
3955
  getRendererContext(locStr: LocalizableString): any;
3929
3956
  getProcessedText(text: string): string;
3930
- protected getUseDisplayValuesInTitle(): boolean;
3957
+ protected getUseDisplayValuesInDynamicTexts(): boolean;
3931
3958
  protected removeSelfFromList(list: any): void;
3932
3959
  protected get textProcessor(): ITextProcessor;
3933
3960
  protected getProcessedHtml(html: string): string;
@@ -4007,6 +4034,8 @@ export declare class SurveyElementErrors extends ReactSurveyElement {
4007
4034
  }
4008
4035
  /*
4009
4036
  * The `SurveyModel` object contains properties and methods that allow you to control the survey and access its elements.
4037
+ *
4038
+ * [View Demo](https://surveyjs.io/form-library/examples/nps-question/ (linkStyle))
4010
4039
  */
4011
4040
  export declare class SurveyModel extends SurveyElementCore implements ISurvey, ISurveyData, ISurveyImpl, ISurveyTriggerOwner, ISurveyErrorOwner, ISurveyTimerText {
4012
4041
  constructor(jsonObj?: any, renderedElement?: any);
@@ -4286,6 +4315,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4286
4315
  * - `options.name` - a property name is going to be rendered.
4287
4316
  * - `options.text` - a text that is going to be rendered.
4288
4317
  * - `options.html` - an HTML content. It is `null` by default. Use this property to specify the HTML content rendered instead of `options.text`.
4318
+ *
4319
+ * [View Demo](https://surveyjs.io/form-library/examples/edit-survey-questions-markdown/ (linkStyle))
4289
4320
  */
4290
4321
  onTextMarkdown: EventBase<SurveyModel>;
4291
4322
  /*
@@ -4371,6 +4402,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4371
4402
  * - `sender` - the survey object that fires the event.
4372
4403
  * - `options.question` - a question for which you can change the CSS classes.
4373
4404
  * - `options.cssClasses` - an object with CSS classes. For example `{root: "table", button: "button"}`. You can change them to your own CSS classes.
4405
+ *
4406
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-cssclasses/ (linkStyle))
4374
4407
  */
4375
4408
  onUpdateQuestionCssClasses: EventBase<SurveyModel>;
4376
4409
  /*
@@ -4412,6 +4445,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4412
4445
  * - `sender` - the survey object that fires the event.
4413
4446
  * - `options.page` - a page object for which the event is fired. Typically the current/active page.
4414
4447
  * - `options.htmlElement` - an HTML element bound to the page object.
4448
+ *
4449
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-afterrender/ (linkStyle))
4415
4450
  */
4416
4451
  onAfterRenderPage: EventBase<SurveyModel>;
4417
4452
  /*
@@ -4419,6 +4454,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4419
4454
  * - `sender` - the survey object that fires the event.
4420
4455
  * - `options.question` - a question object for which the event is fired.
4421
4456
  * - `options.htmlElement` - an HTML element bound to the question object.
4457
+ *
4458
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-afterrender/ (linkStyle))
4422
4459
  */
4423
4460
  onAfterRenderQuestion: EventBase<SurveyModel>;
4424
4461
  /*
@@ -4723,6 +4760,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4723
4760
  * By default all rows are rendered no matters if they are visible or not.
4724
4761
  * Set it true, and survey markup rows will be rendered only if they are visible in viewport.
4725
4762
  * This feature is experimantal and might do not support all the use cases.
4763
+ *
4764
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-lazy/ (linkStyle))
4726
4765
  */
4727
4766
  get lazyRendering(): boolean;
4728
4767
  set lazyRendering(val: boolean);
@@ -5036,6 +5075,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5036
5075
  /*
5037
5076
  * Adds a custom navigation item similar to the Previous Page, Next Page, and Complete buttons.
5038
5077
  * Accepts an object described in the [IAction](https://surveyjs.io/Documentation/Library?id=IAction) help section.
5078
+ *
5079
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-changenavigation/ (linkStyle))
5039
5080
  */
5040
5081
  addNavigationItem(val: IAction): Action;
5041
5082
  /*
@@ -5092,6 +5133,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5092
5133
  getUpdatedQuestionNo(question: IQuestion, no: string): string;
5093
5134
  /*
5094
5135
  * Gets or sets whether the survey displays page numbers on pages titles.
5136
+ *
5137
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-options/ (linkStyle))
5095
5138
  */
5096
5139
  get showPageNumbers(): boolean;
5097
5140
  set showPageNumbers(val: boolean);
@@ -5103,6 +5146,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5103
5146
  * - `on` - display question numbers
5104
5147
  * - `onpage` - display question numbers, start numbering on every page
5105
5148
  * - `off` - turn off the numbering for questions titles
5149
+ *
5150
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-options/ (linkStyle))
5106
5151
  */
5107
5152
  get showQuestionNumbers(): string;
5108
5153
  set showQuestionNumbers(val: string);
@@ -5115,6 +5160,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5115
5160
  * - `top` - show progress bar in the top
5116
5161
  * - `bottom` - show progress bar in the bottom
5117
5162
  * - `both` - show progress bar in both sides: top and bottom.
5163
+ *
5164
+ * [View Demo](https://surveyjs.io/form-library/examples/navigation-default/ (linkStyle))
5118
5165
  */
5119
5166
  get showProgressBar(): string;
5120
5167
  set showProgressBar(val: string);
@@ -5128,6 +5175,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5128
5175
  * - `requiredQuestions`,
5129
5176
  * - `correctQuestions`,
5130
5177
  * - `buttons`
5178
+ *
5179
+ * [View Demo](https://surveyjs.io/form-library/examples/navigation-buttons/ (linkStyle))
5131
5180
  */
5132
5181
  get progressBarType(): string;
5133
5182
  set progressBarType(val: string);
@@ -5174,6 +5223,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5174
5223
  *
5175
5224
  * - `edit` (default) - make a survey editable,
5176
5225
  * - `display` - make a survey read-only.
5226
+ *
5227
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-displaymode/ (linkStyle))
5177
5228
  */
5178
5229
  get mode(): string;
5179
5230
  set mode(val: string);
@@ -5201,7 +5252,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5201
5252
  *
5202
5253
  * If you want to skip empty answers, pass an object with the `includeEmpty` property set to `false`.
5203
5254
  */
5204
- getPlainData(options?: any): any;
5255
+ getPlainData(options?: any): Array<IQuestionPlainData>;
5205
5256
  getFilteredValues(): any;
5206
5257
  getFilteredProperties(): any;
5207
5258
  getDataValueCore(valuesHash: any, key: string): any;
@@ -5257,6 +5308,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5257
5308
  get isShowingPage(): boolean;
5258
5309
  /*
5259
5310
  * The zero-based index of the current page in the visible pages array.
5311
+ *
5312
+ * [View Demo](https://surveyjs.io/form-library/examples/survey-editprevious/ (linkStyle))
5260
5313
  */
5261
5314
  get currentPageNo(): number;
5262
5315
  set currentPageNo(val: number);
@@ -5451,7 +5504,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5451
5504
  * Set this property to "showAllQuestions" or "showAnsweredQuestions" to allow respondents to preview answers before submitting the survey results.
5452
5505
  *
5453
5506
  * Details: [Preview State](https://surveyjs.io/Documentation/Library#states-preview)
5454
- * Example: [Show Preview Before Complete](https://surveyjs.io/Examples/Library?id=survey-showpreview)
5507
+ * [View Demo](https://surveyjs.io/Examples/Library?id=survey-showpreview (linkStyle))
5455
5508
  */
5456
5509
  get showPreviewBeforeComplete(): string;
5457
5510
  set showPreviewBeforeComplete(val: string);
@@ -6320,6 +6373,8 @@ export declare class MultiSelectListModel extends ListModel {
6320
6373
  }
6321
6374
  /*
6322
6375
  * A base class for a Panel and Page objects.
6376
+ *
6377
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-panel/ (linkStyle))
6323
6378
  */
6324
6379
  export declare class PanelModelBase extends SurveyElement<Question> implements IPanel, IConditionRunner, ISurveyErrorOwner, ITitleOwner {
6325
6380
  constructor(name?: string);
@@ -6656,15 +6711,23 @@ export declare class Question extends SurveyElement<Question> implements IQuesti
6656
6711
  set visible(val: boolean);
6657
6712
  protected onVisibleChanged(): void;
6658
6713
  /*
6659
- * Specifies whether to use display names for question values interpolated in the title. To interpolate question values, use curly brackets (`{}`).
6660
- *
6661
- * This property is useful when interpolated question values have both the `value` and `text` properties.
6714
+ * Specifies whether to use display names for question values in placeholders.
6662
6715
  *
6663
6716
  * Default value: `true`
6717
+ *
6718
+ * This property applies to questions whose values are defined as objects with the `value` and `text` properties (for example, [choice items](https://surveyjs.io/form-library/documentation/questionradiogroupmodel#choices) in Radiogroup, Checkbox, and Dropdown questions).
6719
+ *
6720
+ * You can use question values as placeholders in the following places:
6721
+ *
6722
+ * - Survey element titles and descriptions
6723
+ * - The [`expression`](https://surveyjs.io/form-library/documentation/questionexpressionmodel#expression) property of the [Expression](https://surveyjs.io/form-library/documentation/questionexpressionmodel) question
6724
+ * - The [`html`](https://surveyjs.io/form-library/documentation/questionhtmlmodel#html) property of the [HTML](https://surveyjs.io/form-library/documentation/questionhtmlmodel) question
6725
+ *
6726
+ * To use a question value as a placeholder, specify the question `name` in curly brackets: `{questionName}`. Refer to the following help topic for more information: [Dynamic Texts - Question Values](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#question-values).
6664
6727
  */
6665
- get useDisplayValuesInTitle(): boolean;
6666
- set useDisplayValuesInTitle(val: boolean);
6667
- protected getUseDisplayValuesInTitle(): boolean;
6728
+ get useDisplayValuesInDynamicTexts(): boolean;
6729
+ set useDisplayValuesInDynamicTexts(val: boolean);
6730
+ protected getUseDisplayValuesInDynamicTexts(): boolean;
6668
6731
  /*
6669
6732
  * A Boolean expression. If it evaluates to `false`, this question becomes hidden.
6670
6733
  *
@@ -6703,6 +6766,7 @@ export declare class Question extends SurveyElement<Question> implements IQuesti
6703
6766
  * - [*"checkbox"*](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel)
6704
6767
  * - [*"comment"*](https://surveyjs.io/Documentation/Library?id=questioncommentmodel)
6705
6768
  * - [*"dropdown"*](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel)
6769
+ * - [*"tagbox"*](https://surveyjs.io/form-library/documentation/questiontagboxmodel)
6706
6770
  * - [*"expression"*](https://surveyjs.io/Documentation/Library?id=questionexpressionmodel)
6707
6771
  * - [*"file"*](https://surveyjs.io/Documentation/Library?id=questionfilemodel)
6708
6772
  * - [*"html"*](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel)
@@ -7019,7 +7083,7 @@ export declare class Question extends SurveyElement<Question> implements IQuesti
7019
7083
  *
7020
7084
  * Pass an object with the `includeEmpty` property set to `false` if you want to skip empty answers.
7021
7085
  */
7022
- getPlainData(options?: any): any;
7086
+ getPlainData(options?: any): IQuestionPlainData;
7023
7087
  /*
7024
7088
  * A correct answer to this question. Specify this property if you want to [create a quiz](https://surveyjs.io/form-library/documentation/design-survey-create-a-quiz).
7025
7089
  */
@@ -7869,7 +7933,7 @@ export declare class QuestionFileModel extends Question {
7869
7933
  protected loadPreview(newValue: any): void;
7870
7934
  protected onCheckForErrors(errors: any, isOnValueChanged: boolean): void;
7871
7935
  protected stateChanged(state: string): void;
7872
- getPlainData(options?: any): any;
7936
+ getPlainData(options?: any): IQuestionPlainData;
7873
7937
  supportComment(): boolean;
7874
7938
  getChooseFileCss(): string;
7875
7939
  getReadOnlyFileCss(): string;
@@ -7979,7 +8043,9 @@ export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
7979
8043
  alternateRows: boolean;
7980
8044
  }
7981
8045
  /*
7982
- * A Model for a multiple text question.
8046
+ * A class that describes the Multiple Text question type.
8047
+ *
8048
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-multipletext/ (linkStyle))
7983
8049
  */
7984
8050
  export declare class QuestionMultipleTextModel extends Question implements IMultipleTextData, IPanel {
7985
8051
  constructor(name: string);
@@ -7993,32 +8059,32 @@ export declare class QuestionMultipleTextModel extends Question implements IMult
7993
8059
  setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
7994
8060
  onSurveyValueChanged(newValue: any): void;
7995
8061
  /*
7996
- * The list of input items.
8062
+ * An array of `MultipleTextItemModel` objects that represent input items.
7997
8063
  */
7998
8064
  get items(): any;
7999
8065
  set items(val: any);
8000
8066
  /*
8001
- * Add a new text item.
8067
+ * Adds a new input item.
8002
8068
  */
8003
8069
  addItem(name: string, title?: string): MultipleTextItemModel;
8004
8070
  getItemByName(name: string): MultipleTextItemModel;
8005
8071
  addConditionObjectsByContext(objects: any, context: any): void;
8006
8072
  getConditionJson(operator?: string, path?: string): any;
8007
8073
  locStrsChanged(): void;
8074
+ localeChanged(): void;
8008
8075
  supportGoNextPageAutomatic(): boolean;
8009
8076
  /*
8010
- * The number of columns. Items are rendred in one line if the value is 0.
8077
+ * The number of columns used to arrange input items. Accepts the following values: 1, 2, 3, 4, 5.
8078
+ *
8079
+ * Default value: 1
8011
8080
  */
8012
8081
  get colCount(): number;
8013
8082
  set colCount(val: number);
8014
8083
  /*
8015
- * The default text input size.
8084
+ * A value passed on to the [`size`](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/size) attribute of the underlying `<input>` elements.
8016
8085
  */
8017
8086
  get itemSize(): number;
8018
8087
  set itemSize(val: number);
8019
- /*
8020
- * Returns the list of rendered rows.
8021
- */
8022
8088
  getRows(): Array<any>;
8023
8089
  isMultipleItemValueChanging: boolean;
8024
8090
  protected onValueChanged(): void;
@@ -8071,8 +8137,11 @@ export declare class QuestionNonValue extends Question {
8071
8137
  getConditionJson(operator?: string, path?: string): any;
8072
8138
  }
8073
8139
  /*
8074
- * 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.
8075
- * An end-user may dynamically add/remove panels, unless you forbidden this.
8140
+ * A class that describes the Dynamic Panel question type.
8141
+ *
8142
+ * 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.
8143
+ *
8144
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-paneldynamic/ (linkStyle))
8076
8145
  */
8077
8146
  export declare class QuestionPanelDynamicModel extends Question implements IQuestionPanelDynamicData {
8078
8147
  constructor(name: string);
@@ -8093,82 +8162,88 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8093
8162
  get isAllowTitleLeft(): boolean;
8094
8163
  removeElement(element: IElement): boolean;
8095
8164
  /*
8096
- * The template Panel. This panel is used as a template on creatign dynamic panels
8165
+ * A `PanelModel` object used as a template to create dynamic panels.
8097
8166
  */
8098
8167
  get template(): PanelModel;
8099
8168
  getPanel(): IPanel;
8100
8169
  /*
8101
- * The template Panel elements, questions and panels.
8170
+ * An array of questions and panels included in the template panel.
8102
8171
  */
8103
8172
  get templateElements(): any;
8104
8173
  /*
8105
- * The template Panel title property.
8174
+ * A title for the template panel.
8106
8175
  */
8107
8176
  get templateTitle(): string;
8108
8177
  set templateTitle(val: string);
8109
8178
  get locTemplateTitle(): LocalizableString;
8110
8179
  /*
8111
- * The template Panel description property.
8180
+ * A description for the template panel.
8112
8181
  */
8113
8182
  get templateDescription(): string;
8114
8183
  set templateDescription(val: string);
8115
8184
  get locTemplateDescription(): LocalizableString;
8116
8185
  protected get items(): any;
8117
8186
  /*
8118
- * The array of dynamic panels created based on panel template
8187
+ * An array of `PanelModel` objects created based on the template panel.
8119
8188
  */
8120
8189
  get panels(): any;
8121
8190
  /*
8122
- * 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.
8191
+ * A zero-based index of the currently displayed panel.
8192
+ *
8193
+ * When `renderMode` is `"list"` or Dynamic Panel is empty (`panelCount` is 0), this property contains -1.
8123
8194
  */
8124
8195
  get currentIndex(): number;
8125
8196
  set currentIndex(val: number);
8126
8197
  /*
8127
- * 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.
8198
+ * A `PanelModel` object that is the currently displayed panel.
8199
+ *
8200
+ * When `renderMode` is `"list"` or Dynamic Panel is empty (`panelCount` is 0), this property contains `null`.
8128
8201
  */
8129
8202
  get currentPanel(): PanelModel;
8130
8203
  /*
8131
- * Set it to true, to show a confirmation dialog on removing a panel
8204
+ * Specifies whether to display a confirmation dialog when a respondent wants to delete a panel.
8132
8205
  */
8133
8206
  get confirmDelete(): boolean;
8134
8207
  set confirmDelete(val: boolean);
8135
8208
  /*
8136
- * 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.
8209
+ * 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.
8137
8210
  */
8138
8211
  get keyName(): string;
8139
8212
  set keyName(val: string);
8140
8213
  /*
8141
- * Use this property to change the default text showing in the confirmation delete dialog on removing a panel.
8214
+ * A message displayed in a confirmation dialog that appears when a respondent wants to delete a panel.
8142
8215
  */
8143
8216
  get confirmDeleteText(): string;
8144
8217
  set confirmDeleteText(val: string);
8145
8218
  get locConfirmDeleteText(): LocalizableString;
8146
8219
  /*
8147
- * The duplication value error text. Set it to show the text different from the default.
8220
+ * 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).
8221
+ *
8222
+ * 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).
8148
8223
  */
8149
8224
  get keyDuplicationError(): string;
8150
8225
  set keyDuplicationError(val: string);
8151
8226
  get locKeyDuplicationError(): LocalizableString;
8152
8227
  /*
8153
- * 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".
8228
+ * A caption for the Previous button. Applies only if `renderMode` is different from `"list"`.
8154
8229
  */
8155
8230
  get panelPrevText(): string;
8156
8231
  set panelPrevText(val: string);
8157
8232
  get locPanelPrevText(): LocalizableString;
8158
8233
  /*
8159
- * 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".
8234
+ * A caption for the Next button. Applies only if `renderMode` is different from `"list"`.
8160
8235
  */
8161
8236
  get panelNextText(): string;
8162
8237
  set panelNextText(val: string);
8163
8238
  get locPanelNextText(): LocalizableString;
8164
8239
  /*
8165
- * Use this property to change the default value of add panel button text.
8240
+ * A caption for the Add Panel button.
8166
8241
  */
8167
8242
  get panelAddText(): string;
8168
8243
  set panelAddText(val: string);
8169
8244
  get locPanelAddText(): LocalizableString;
8170
8245
  /*
8171
- * Use this property to change the default value of remove panel button text.
8246
+ * A caption for the Delete Panel button.
8172
8247
  */
8173
8248
  get panelRemoveText(): string;
8174
8249
  set panelRemoveText(val: string);
@@ -8182,11 +8257,11 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8182
8257
  */
8183
8258
  get isProgressBottomShowing(): boolean;
8184
8259
  /*
8185
- * Returns true when currentIndex is more than 0.
8260
+ * Indicates whether the Previous button is visible.
8186
8261
  */
8187
8262
  get isPrevButtonShowing(): boolean;
8188
8263
  /*
8189
- * Returns true when currentIndex is more than or equal 0 and less than panelCount - 1.
8264
+ * Indicates whether the Next button is visible.
8190
8265
  */
8191
8266
  get isNextButtonShowing(): boolean;
8192
8267
  /*
@@ -8200,41 +8275,58 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8200
8275
  protected getValueCore(): any;
8201
8276
  protected setValueCore(newValue: any): void;
8202
8277
  /*
8203
- * Use this property to get/set the number of dynamic panels.
8278
+ * The number of panels in Dynamic Panel.
8204
8279
  */
8205
8280
  get panelCount(): number;
8206
8281
  set panelCount(val: number);
8207
8282
  /*
8208
- * 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:
8209
- * default - the default value. User can't collapse/expand panels
8210
- * expanded - User can collapse/expand panels and all panels are expanded by default
8211
- * collapsed - User can collapse/expand panels and all panels are collapsed by default
8212
- * firstExpanded - User can collapse/expand panels. The first panel is expanded and others are collapsed
8283
+ * Specifies whether users can expand and collapse panels. Applies if `renderMode` is `"list"` and the `templateTitle` property is specified.
8284
+ *
8285
+ * Possible values:
8286
+ *
8287
+ * - `"default"` (default) - All panels are displayed in full and cannot be collapsed.
8288
+ * - `"expanded"` - All panels are displayed in full and can be collapsed in the UI.
8289
+ * - `"collapsed"` - All panels display only their titles and descriptions and can be expanded in the UI.
8290
+ * - `"firstExpanded"` - Only the first panel is displayed in full; other panels are collapsed and can be expanded in the UI.
8213
8291
  */
8214
8292
  get panelsState(): string;
8215
8293
  set panelsState(val: string);
8216
8294
  /*
8217
- * The minimum panel count. A user could not delete a panel if the panelCount equals to minPanelCount
8295
+ * A minimum number of panels in Dynamic Panel. Users cannot delete panels if `panelCount` equals `minPanelCount`.
8296
+ *
8297
+ * Default value: 0
8218
8298
  */
8219
8299
  get minPanelCount(): number;
8220
8300
  set minPanelCount(val: number);
8221
8301
  /*
8222
- * The maximum panel count. A user could not add a panel if the panelCount equals to maxPanelCount
8302
+ * A maximum number of panels in Dynamic Panel. Users cannot add new panels if `panelCount` equals `maxPanelCount`.
8303
+ *
8304
+ * Default value: 100 (inherited from [`settings.panelMaximumPanelCount`](https://surveyjs.io/form-library/documentation/settings#panelMaximumPanelCount))
8223
8305
  */
8224
8306
  get maxPanelCount(): number;
8225
8307
  set maxPanelCount(val: number);
8226
8308
  /*
8227
- * Set this property to false to hide the 'Add New' button
8309
+ * Specifies whether users are allowed to add new panels.
8310
+ *
8311
+ * Default value: `true`
8228
8312
  */
8229
8313
  get allowAddPanel(): boolean;
8230
8314
  set allowAddPanel(val: boolean);
8231
8315
  /*
8232
- * Set this property to false to hide the 'Remove' button
8316
+ * Specifies whether users are allowed to delete panels.
8317
+ *
8318
+ * Default value: `true`
8233
8319
  */
8234
8320
  get allowRemovePanel(): boolean;
8235
8321
  set allowRemovePanel(val: boolean);
8236
8322
  /*
8237
- * Set this property different from "default" to set the specific question title location for the template questions.
8323
+ * Gets or sets the location of question titles within the template panel relative to their input fields.
8324
+ *
8325
+ * - `"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).
8326
+ * - `"top"` - Displays question titles above input fields.
8327
+ * - `"bottom"` - Displays question titles below input fields.
8328
+ * - `"left"` - Displays question titles to the left of input fields.
8329
+ * - `"hidden"` - Hides question titles.
8238
8330
  */
8239
8331
  get templateTitleLocation(): string;
8240
8332
  set templateTitleLocation(val: string);
@@ -8245,8 +8337,12 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8245
8337
  get showQuestionNumbers(): string;
8246
8338
  set showQuestionNumbers(val: string);
8247
8339
  /*
8248
- * Use this property to change the location of the remove button relative to the panel.
8249
- * By default the value is "bottom". You may set it to "right" and remove button will appear to the right of the panel.
8340
+ * Specifies the location of the Delete Panel button relative to panel content.
8341
+ *
8342
+ * Possible values:
8343
+ *
8344
+ * - `"bottom"` (default) - Displays the Delete Panel button below panel content.
8345
+ * - `"right"` - Displays the Delete Panel button to the right of panel content.
8250
8346
  */
8251
8347
  get panelRemoveButtonLocation(): string;
8252
8348
  set panelRemoveButtonLocation(val: string);
@@ -8260,18 +8356,26 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8260
8356
  */
8261
8357
  get renderMode(): string;
8262
8358
  set renderMode(val: string);
8263
- /*
8264
- * Returns true when renderMode equals to "list".
8265
- */
8266
8359
  get isRenderModeList(): boolean;
8267
8360
  setVisibleIndex(value: number): number;
8268
8361
  /*
8269
- * Returns true when an end user may add a new panel. The question is not read only and panelCount less than maxPanelCount
8270
- * and renderMode is "list" or the current panel doesn't have any errors
8362
+ * Indicates whether it is possible to add a new panel.
8363
+ *
8364
+ * This property returns `true` when all of the following conditions apply:
8365
+ *
8366
+ * - Users are allowed to add new panels (`allowAddPanel` is `true`).
8367
+ * - Dynamic Panel or its parent survey is not in read-only state.
8368
+ * - `panelCount` is less than `maxPanelCount`.
8271
8369
  */
8272
8370
  get canAddPanel(): boolean;
8273
8371
  /*
8274
- * Returns true when an end user may remove a panel. The question is not read only and panelCount is more than minPanelCount
8372
+ * Indicates whether it is possible to delete panels.
8373
+ *
8374
+ * This property returns `true` when all of the following conditions apply:
8375
+ *
8376
+ * - Users are allowed to delete panels (`allowRemovePanel` is `true`).
8377
+ * - Dynamic Panel or its parent survey is not in read-only state.
8378
+ * - `panelCount` exceeds `minPanelCount`.
8275
8379
  */
8276
8380
  get canRemovePanel(): boolean;
8277
8381
  protected rebuildPanels(): void;
@@ -8281,8 +8385,9 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8281
8385
  get defaultPanelValue(): any;
8282
8386
  set defaultPanelValue(val: any);
8283
8387
  /*
8284
- * 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,
8285
- * then the value for new added panel is merging.
8388
+ * Specifies whether default values for a new panel should be copied from the last panel.
8389
+ *
8390
+ * If you also specify `defaultValue`, it will be merged with the copied values.
8286
8391
  */
8287
8392
  get defaultValueFromLastPanel(): boolean;
8288
8393
  set defaultValueFromLastPanel(val: boolean);
@@ -8304,12 +8409,11 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8304
8409
  */
8305
8410
  removePanelUI(value: any): void;
8306
8411
  /*
8307
- * Goes to the next panel in the PanelDynamic
8308
- * 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.
8412
+ * 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.
8309
8413
  */
8310
8414
  goToNextPanel(): boolean;
8311
8415
  /*
8312
- * Goes to the previous panel in the PanelDynamic
8416
+ * Switches Dynamic Panel to the previous panel.
8313
8417
  */
8314
8418
  goToPrevPanel(): void;
8315
8419
  /*
@@ -8342,13 +8446,15 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8342
8446
  protected createNewPanelObject(): PanelModel;
8343
8447
  setQuestionValue(newValue: any): void;
8344
8448
  onSurveyValueChanged(newValue: any): void;
8449
+ onReadyChangedCallback: any;
8450
+ recalculateIsReadyValue(): void;
8345
8451
  protected onSetData(): void;
8346
8452
  getItemIndex(item: ISurveyData): number;
8347
8453
  getPanelItemData(item: ISurveyData): any;
8348
8454
  isSetPanelItemData: any;
8349
8455
  setPanelItemData(item: ISurveyData, name: string, val: any): void;
8350
8456
  getRootData(): ISurveyData;
8351
- getPlainData(options?: any): any;
8457
+ getPlainData(options?: any): IQuestionPlainData;
8352
8458
  updateElementCss(reNew?: boolean): void;
8353
8459
  get progressText(): string;
8354
8460
  get progress(): string;
@@ -8359,7 +8465,7 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8359
8465
  getPrevButtonCss(): string;
8360
8466
  getNextButtonCss(): string;
8361
8467
  /*
8362
- * A text displayed when the dynamic panel contains no entries. Applies only in the Default V2 theme.
8468
+ * A text displayed when Dynamic Panel contains no entries. Applies only in the Default V2 theme.
8363
8469
  */
8364
8470
  get noEntriesText(): string;
8365
8471
  set noEntriesText(val: string);
@@ -8373,27 +8479,48 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8373
8479
  }
8374
8480
  /*
8375
8481
  * A Model for a rating question.
8482
+ *
8483
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-rating/ (linkStyle))
8376
8484
  */
8377
8485
  export declare class QuestionRatingModel extends Question {
8378
8486
  constructor(name: string);
8379
8487
  endLoadingFromJson(): void;
8380
8488
  /*
8381
- * The list of rate items. Every item has value and text. If text is empty, the value is rendered. The item text supports markdown. If it is empty the array is generated by using rateMin, rateMax and rateStep properties.
8489
+ * A list of rate values.
8490
+ *
8491
+ * This property accepts an array of objects with the following structure:
8492
+ *
8493
+ * ```js
8494
+ * {
8495
+ * "value": any, // A value to be saved in survey results
8496
+ * "text": String, // A display text. This property supports Markdown. When `text` is undefined, `value` is used.
8497
+ * }
8498
+ * ```
8499
+ *
8500
+ * If you need to specify only the `value` property, you can set the `rateValues` property to an array of numbers, for example, `[ 3, 6, 10 ]`. These values are both saved in survey results and used as display text.
8501
+ *
8502
+ * If you do not specify the `rateValues` property, rate values are generated automatically based upon the `rateMin`, `rateMax`, and `rateStep` property values.
8382
8503
  */
8383
8504
  get rateValues(): any;
8384
8505
  set rateValues(val: any);
8385
8506
  /*
8386
- * This property is used to generate rate values if rateValues array is empty. It is the first value in the rating. The default value is 1.
8507
+ * Specifies the first rate value in the generated sequence of rate values. Applies if the `rateValues` array is empty.
8508
+ *
8509
+ * Default value: 1
8387
8510
  */
8388
8511
  get rateMin(): number;
8389
8512
  set rateMin(val: number);
8390
8513
  /*
8391
- * This property is used to generate rate values if rateValues array is empty. It is the last value in the rating. The default value is 5.
8514
+ * Specifies the last rate value in the generated sequence of rate values. Applies if the `rateValues` array is empty.
8515
+ *
8516
+ * Default value: 5
8392
8517
  */
8393
8518
  get rateMax(): number;
8394
8519
  set rateMax(val: number);
8395
8520
  /*
8396
- * This property is used to generate rate values if rateValues array is empty. It is the step value. The number of rate values are (rateMax - rateMin) / rateStep. The default value is 1.
8521
+ * Specifies a step with which to generate rate values. Applies if the `rateValues` array is empty.
8522
+ *
8523
+ * Default value: 1
8397
8524
  */
8398
8525
  get rateStep(): number;
8399
8526
  set rateStep(val: number);
@@ -8408,13 +8535,13 @@ export declare class QuestionRatingModel extends Question {
8408
8535
  supportComment(): boolean;
8409
8536
  supportOther(): boolean;
8410
8537
  /*
8411
- * The description of minimum (first) item.
8538
+ * Specifies a description for the minimum (first) rate value.
8412
8539
  */
8413
8540
  get minRateDescription(): string;
8414
8541
  set minRateDescription(val: string);
8415
8542
  get locMinRateDescription(): LocalizableString;
8416
8543
  /*
8417
- * The description of maximum (last) item.
8544
+ * Specifies a description for the maximum (last) rate value.
8418
8545
  */
8419
8546
  get maxRateDescription(): string;
8420
8547
  set maxRateDescription(val: string);
@@ -8424,8 +8551,13 @@ export declare class QuestionRatingModel extends Question {
8424
8551
  get hasMinLabel(): boolean;
8425
8552
  get hasMaxLabel(): boolean;
8426
8553
  /*
8427
- * Specifies whether a Rating question displays the [minRateDescription](https://surveyjs.io/Documentation/Library?id=questionratingmodel#minRateDescription) and [maxRateDescription](https://surveyjs.io/Documentation/Library?id=questionratingmodel#maxRateDescription) property texts as buttons that correspond to the extreme (first and last) rate items. If any of these properties is empty, the corresponding rate item's value/text is used for display.
8428
- * When the `displayRateDescriptionsAsExtremeItems` property is disabled, the texts defined through the [minRateDescription](https://surveyjs.io/Documentation/Library?id=questionratingmodel#minRateDescription) and [maxRateDescription](https://surveyjs.io/Documentation/Library?id=questionratingmodel#maxRateDescription) properties are displayed as plain non-clickable texts.
8554
+ * Specifies whether to display `minRateDescription` and `maxRateDescription` values as captions for buttons that correspond to the extreme (first and last) rate values.
8555
+ *
8556
+ * Default value: `false`
8557
+ *
8558
+ * If this property is disabled, the `minRateDescription` and `maxRateDescription` values are displayed as plain non-clickable texts.
8559
+ *
8560
+ * If any of the `minRateDescription` and `maxRateDescription` properties is empty, the corresponding rate value's `value` or `text` is displayed as a button caption.
8429
8561
  */
8430
8562
  displayRateDescriptionsAsExtremeItems: boolean;
8431
8563
  /*
@@ -8439,9 +8571,6 @@ export declare class QuestionRatingModel extends Question {
8439
8571
  */
8440
8572
  displayMode: "dropdown" | "auto" | "buttons";
8441
8573
  protected valueToData(val: any): any;
8442
- /*
8443
- * Click value again to clear.
8444
- */
8445
8574
  setValueFromClick(value: any): void;
8446
8575
  get ratingRootCss(): string;
8447
8576
  getItemClass(item: ItemValue): string;
@@ -8450,6 +8579,7 @@ export declare class QuestionRatingModel extends Question {
8450
8579
  set placeholder(val: string);
8451
8580
  get locPlaceholder(): LocalizableString;
8452
8581
  get allowClear(): boolean;
8582
+ get searchEnabled(): boolean;
8453
8583
  get renderedValue(): boolean;
8454
8584
  set renderedValue(val: boolean);
8455
8585
  get visibleChoices(): any;
@@ -8496,6 +8626,7 @@ export declare class QuestionSelectBase extends Question {
8496
8626
  * Returns `true` if the "Other" choice item is selected.
8497
8627
  */
8498
8628
  get isOtherSelected(): boolean;
8629
+ get isNoneSelected(): boolean;
8499
8630
  /*
8500
8631
  * Specifies whether to display the "None" choice item.
8501
8632
  *
@@ -8687,7 +8818,7 @@ export declare class QuestionSelectBase extends Question {
8687
8818
  protected canShowOptionItem(item: ItemValue, isAddAll: boolean, hasItem: boolean): boolean;
8688
8819
  isItemInList(item: ItemValue): boolean;
8689
8820
  protected get isAddDefaultItems(): boolean;
8690
- getPlainData(options?: any): any;
8821
+ getPlainData(options?: any): IQuestionPlainData;
8691
8822
  protected getDisplayValueCore(keysAsText: boolean, value: any): any;
8692
8823
  protected getDisplayValueEmpty(): string;
8693
8824
  protected getChoicesDisplayValue(items: any, val: any): any;
@@ -8774,7 +8905,9 @@ export declare class QuestionSelectBase extends Question {
8774
8905
  set itemComponent(val: string);
8775
8906
  }
8776
8907
  /*
8777
- * A Model for signature pad question.
8908
+ * A class that describes the Signature Page question type.
8909
+ *
8910
+ * [View Demo](https://surveyjs.io/form-library/examples/signature-pad-widget-javascript/ (linkStyle))
8778
8911
  */
8779
8912
  export declare class QuestionSignaturePadModel extends Question {
8780
8913
  constructor(name: string);
@@ -8787,41 +8920,45 @@ export declare class QuestionSignaturePadModel extends Question {
8787
8920
  initSignaturePad(el: any): void;
8788
8921
  destroySignaturePad(el: any): void;
8789
8922
  /*
8790
- * Use it to set the specific dataFormat for the signature pad image data.
8791
- * formats: "" (default) - png, "image/jpeg" - jpeg, "image/svg+xml" - svg
8923
+ * Specifies the format in which to store the signature image.
8924
+ *
8925
+ * Possible values:
8926
+ *
8927
+ * - `""` (default) - PNG
8928
+ * - `"image/jpeg"` - JPEG
8929
+ * - `"image/svg+xml"` - SVG
8792
8930
  */
8793
8931
  dataFormat: string;
8794
8932
  /*
8795
- * Use it to set the specific width for the signature pad.
8933
+ * Specifies the width of the signature area. Accepts positive integer numbers.
8796
8934
  */
8797
8935
  get signatureWidth(): number;
8798
8936
  set signatureWidth(val: number);
8799
8937
  /*
8800
- * Use it to set the specific height for the signature pad.
8938
+ * Specifies the height of the signature area. Accepts positive integer numbers.
8801
8939
  */
8802
8940
  get signatureHeight(): number;
8803
8941
  set signatureHeight(val: number);
8804
8942
  get height(): number;
8805
8943
  set height(val: number);
8806
8944
  /*
8807
- * Use it to clear content of the signature pad.
8945
+ * Specifies whether to display a button that clears the signature area.
8946
+ *
8947
+ * Default value: `true`
8808
8948
  */
8809
8949
  get allowClear(): boolean;
8810
8950
  set allowClear(val: boolean);
8811
8951
  get canShowClearButton(): boolean;
8812
8952
  /*
8813
- * Use it to set pen color for the signature pad.
8953
+ * Specifies a color for the pen. Accepts hexadecimal colors (`"#FF0000"`), RGB colors (`"rgb(255,0,0)"`), or color names (`"red"`).
8814
8954
  */
8815
8955
  get penColor(): string;
8816
8956
  set penColor(val: string);
8817
8957
  /*
8818
- * Use it to set background color for the signature pad.
8958
+ * Specifies a color for the signature area background. Accepts hexadecimal colors (`"#FF0000"`), RGB colors (`"rgb(255,0,0)"`), or color names (`"red"`).
8819
8959
  */
8820
8960
  get backgroundColor(): string;
8821
8961
  set backgroundColor(val: string);
8822
- /*
8823
- * The clear signature button caption.
8824
- */
8825
8962
  get clearButtonCaption(): string;
8826
8963
  needShowPlaceholder(): boolean;
8827
8964
  get placeHolderText(): string;
@@ -9051,6 +9188,7 @@ export declare class QuestionCustomModel extends QuestionCustomModelBase {
9051
9188
  export declare class QuestionDropdownModel extends QuestionSelectBase {
9052
9189
  constructor(name: string);
9053
9190
  dropdownListModel: DropdownListModel;
9191
+ lastSelectedItemValue: ItemValue;
9054
9192
  updateReadOnlyText(): void;
9055
9193
  locStrsChanged(): void;
9056
9194
  get showOptionsCaption(): boolean;
@@ -9106,11 +9244,8 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
9106
9244
  */
9107
9245
  get choicesStep(): number;
9108
9246
  set choicesStep(val: number);
9109
- /*
9110
- * An [autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) attribute value for the underlying `<input>` element.
9111
- */
9112
- get autoComplete(): string;
9113
- set autoComplete(val: string);
9247
+ get autocomplete(): string;
9248
+ set autocomplete(val: string);
9114
9249
  /*
9115
9250
  * Specifies whether to display a button that clears the selected value.
9116
9251
  */
@@ -9134,6 +9269,7 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
9134
9269
  protected onVisibleChoicesChanged(): void;
9135
9270
  protected getFirstInputElementId(): string;
9136
9271
  getInputId(): string;
9272
+ clearValue(): void;
9137
9273
  onClick(e: any): void;
9138
9274
  onKeyUp(event: any): void;
9139
9275
  }
@@ -9255,6 +9391,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9255
9391
  * - [*"checkbox"*](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel)
9256
9392
  * - [*"comment"*](https://surveyjs.io/Documentation/Library?id=questioncommentmodel)
9257
9393
  * - [*"dropdown"*](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel)
9394
+ * - [*"tagbox"*](https://surveyjs.io/form-library/documentation/questiontagboxmodel)
9258
9395
  * - [*"expression"*](https://surveyjs.io/Documentation/Library?id=questionexpressionmodel)
9259
9396
  * - [*"file"*](https://surveyjs.io/Documentation/Library?id=questionfilemodel)
9260
9397
  * - [*"html"*](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel)
@@ -9439,7 +9576,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9439
9576
  get optionsCaption(): string;
9440
9577
  set optionsCaption(val: string);
9441
9578
  /*
9442
- * An error message displayed when users enter a duplicate value into a column that accepts only unique values (`isUnique` is set to `true`).
9579
+ * An error message displayed when users enter a duplicate value into a column that accepts only unique values (`isUnique` is set to `true` or `keyName` is specified).
9443
9580
  *
9444
9581
  * 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).
9445
9582
  */
@@ -9468,7 +9605,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9468
9605
  protected getRowValueCore(row: MatrixDropdownRowModelBase, questionValue: any, create?: boolean): any;
9469
9606
  protected getRowObj(row: MatrixDropdownRowModelBase): any;
9470
9607
  protected getRowDisplayValue(keysAsText: boolean, row: MatrixDropdownRowModelBase, rowValue: any): any;
9471
- getPlainData(options?: any): any;
9608
+ getPlainData(options?: any): IQuestionPlainData;
9472
9609
  addConditionObjectsByContext(objects: any, context: any): void;
9473
9610
  protected getConditionObjectRowName(index: number): string;
9474
9611
  protected getConditionObjectRowText(index: number): string;
@@ -9526,7 +9663,9 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9526
9663
  protected getIsTooltipErrorInsideSupported(): boolean;
9527
9664
  }
9528
9665
  /*
9529
- * A Model for a simple matrix question.
9666
+ * A class that describes the Single-Choice Matrix question type.
9667
+ *
9668
+ * [View Demo](https://surveyjs.io/form-library/examples/single-selection-matrix-table-question/ (linkStyle))
9530
9669
  */
9531
9670
  export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixRowModel, ItemValue> implements IMatrixData, IMatrixCellsOwner {
9532
9671
  constructor(name: string);
@@ -9535,21 +9674,23 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
9535
9674
  getType(): string;
9536
9675
  get hasSingleInput(): boolean;
9537
9676
  /*
9538
- * Set this property to true, if you want a user to answer all rows.
9677
+ * Specifies whether each row requires an answer. If a respondent skips a row, the question displays a validation error.
9539
9678
  */
9540
9679
  get isAllRowRequired(): boolean;
9541
9680
  set isAllRowRequired(val: boolean);
9542
- /*
9543
- * Returns true, if there is at least one row.
9544
- */
9545
9681
  get hasRows(): boolean;
9546
9682
  /*
9547
- * Use this property to render items in a specific order: "random" or "initial". Default is "initial".
9683
+ * Specifies a sort order for matrix rows.
9684
+ *
9685
+ * Possible values:
9686
+ *
9687
+ * - "initial" (default) - Preserves the original order of the `rows` array.
9688
+ * - "random" - Arranges matrix rows in random order each time the question is displayed.
9548
9689
  */
9549
9690
  get rowsOrder(): string;
9550
9691
  set rowsOrder(val: string);
9551
9692
  /*
9552
- * Set this property to true to hide the question if there is no visible rows in the matrix.
9693
+ * Specifies whether to hide the question when the matrix has no visible rows.
9553
9694
  */
9554
9695
  get hideIfRowsEmpty(): boolean;
9555
9696
  set hideIfRowsEmpty(val: boolean);
@@ -9564,9 +9705,6 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
9564
9705
  protected sortVisibleRows(array: any): Array<MatrixRowModel>;
9565
9706
  endLoadingFromJson(): void;
9566
9707
  protected processRowsOnSet(newRows: any): any;
9567
- /*
9568
- * Returns the list of visible rows as model objects.
9569
- */
9570
9708
  get visibleRows(): any;
9571
9709
  get cells(): MatrixCells;
9572
9710
  set cells(val: MatrixCells);
@@ -9585,7 +9723,7 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
9585
9723
  protected onMatrixRowCreated(row: MatrixRowModel): void;
9586
9724
  protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
9587
9725
  protected getDisplayValueCore(keysAsText: boolean, value: any): any;
9588
- getPlainData(options?: any): any;
9726
+ getPlainData(options?: any): IQuestionPlainData;
9589
9727
  addConditionObjectsByContext(objects: any, context: any): void;
9590
9728
  getConditionJson(operator?: string, path?: string): any;
9591
9729
  protected clearValueIfInvisibleCore(): void;
@@ -9599,7 +9737,9 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
9599
9737
  getRowHeaderWrapperComponentData(cell: ItemValue): any;
9600
9738
  }
9601
9739
  /*
9602
- * A Model for an input text question.
9740
+ * A class that describes the Text question type.
9741
+ *
9742
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-text/ (linkStyle))
9603
9743
  */
9604
9744
  export declare class QuestionTextModel extends QuestionTextBase {
9605
9745
  constructor(name: string);
@@ -9610,7 +9750,7 @@ export declare class QuestionTextModel extends QuestionTextBase {
9610
9750
  getType(): string;
9611
9751
  onSurveyLoad(): void;
9612
9752
  /*
9613
- * Use this property to change the default input type.
9753
+ * A value passed on to the [`type`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types) attribute of the underlying `<input>` element.
9614
9754
  */
9615
9755
  get inputType(): string;
9616
9756
  set inputType(val: string);
@@ -9618,7 +9758,7 @@ export declare class QuestionTextModel extends QuestionTextBase {
9618
9758
  getValidators(): Array<SurveyValidator>;
9619
9759
  isLayoutTypeSupported(layoutType: string): boolean;
9620
9760
  /*
9621
- * The text input size
9761
+ * A value passed on to the [`size`](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/size) attribute of the underlying `<input>` element.
9622
9762
  */
9623
9763
  get size(): number;
9624
9764
  set size(val: number);
@@ -9628,52 +9768,52 @@ export declare class QuestionTextModel extends QuestionTextBase {
9628
9768
  get inputWidth(): string;
9629
9769
  updateInputSize(): void;
9630
9770
  /*
9631
- * Text auto complete
9771
+ * A value passed on to the [`autocomplete`](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) attribute of the underlying `<input>` element.
9632
9772
  */
9633
- get autoComplete(): string;
9634
- set autoComplete(val: string);
9773
+ get autocomplete(): string;
9774
+ set autocomplete(val: string);
9635
9775
  /*
9636
- * The minimum value
9776
+ * A value passed on to the [`min`](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/min) attribute of the underlying `<input>` element.
9637
9777
  */
9638
9778
  get min(): string;
9639
9779
  set min(val: string);
9640
9780
  /*
9641
- * The maximum value
9781
+ * A value passed on to the [`max`](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/max) attribute of the underlying `<input>` element.
9642
9782
  */
9643
9783
  get max(): string;
9644
9784
  set max(val: string);
9645
9785
  /*
9646
- * The minimum value that you can setup as expression, for example today(-1) = yesterday;
9786
+ * The minimum value specified as an expression. For example, `"minValueExpression": "today(-1)"` sets the minimum value to yesterday.
9647
9787
  */
9648
9788
  get minValueExpression(): string;
9649
9789
  set minValueExpression(val: string);
9650
9790
  /*
9651
- * The maximum value that you can setup as expression, for example today(1) = tomorrow;
9791
+ * The maximum value specified as an expression. For example, `"maxValueExpression": "today(1)"` sets the maximum value to tomorrow.
9652
9792
  */
9653
9793
  get maxValueExpression(): string;
9654
9794
  set maxValueExpression(val: string);
9655
9795
  get renderedMin(): any;
9656
9796
  get renderedMax(): any;
9657
9797
  /*
9658
- * The text that shows when value is less than min property.
9798
+ * An error message to display when the question value is less than the minimum accepted value.
9659
9799
  */
9660
9800
  get minErrorText(): string;
9661
9801
  set minErrorText(val: string);
9662
9802
  get locMinErrorText(): LocalizableString;
9663
9803
  /*
9664
- * The text that shows when value is greater than man property.
9804
+ * An error message to display when the question value exceeds the maximum accepted value.
9665
9805
  */
9666
9806
  get maxErrorText(): string;
9667
9807
  set maxErrorText(val: string);
9668
9808
  get locMaxErrorText(): LocalizableString;
9669
9809
  /*
9670
- * Readonly property that returns true if the current inputType allows to set min and max properties
9810
+ * Returns `true` if the specified `inputType` supports the `min` and `max` properties.
9671
9811
  */
9672
9812
  get isMinMaxType(): boolean;
9673
9813
  protected onCheckForErrors(errors: any, isOnValueChanged: boolean): void;
9674
9814
  protected canSetValueToSurvey(): boolean;
9675
9815
  /*
9676
- * The step value
9816
+ * A value passed on to the [`step`](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/step) attribute of the underlying `<input>` element.
9677
9817
  */
9678
9818
  get step(): string;
9679
9819
  set step(val: string);
@@ -9681,7 +9821,7 @@ export declare class QuestionTextModel extends QuestionTextBase {
9681
9821
  supportGoNextPageAutomatic(): boolean;
9682
9822
  supportGoNextPageError(): boolean;
9683
9823
  /*
9684
- * The list of recommended options available to choose.
9824
+ * An array of predefined options from which users can select. This property configures an HTML [`<datalist>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/datalist) element and associates it with the underlying `input` element.
9685
9825
  */
9686
9826
  get dataList(): any;
9687
9827
  set dataList(val: any);
@@ -9902,26 +10042,28 @@ export declare class QuestionImagePickerModel extends QuestionCheckboxBase {
9902
10042
  afterRender(el: any): void;
9903
10043
  }
9904
10044
  /*
9905
- * A Model for a matrix dropdown question. You may use a dropdown, checkbox, radiogroup, text and comment questions as a cell editors.
10045
+ * A class that describes the Multiple-Choice Matrix question type. Multiple-Choice Matrix allows you to use the [Dropdown](https://surveyjs.io/form-library/documentation/questiondropdownmodel), [Checkbox](https://surveyjs.io/form-library/documentation/questioncheckboxmodel), [Radiogroup](https://surveyjs.io/form-library/documentation/questionradiogroupmodel), [Text](https://surveyjs.io/form-library/documentation/questiontextmodel), and [Comment](https://surveyjs.io/form-library/documentation/questioncommentmodel) question types as cell editors.
10046
+ *
10047
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-matrixdropdown/ (linkStyle))
9906
10048
  */
9907
10049
  export declare class QuestionMatrixDropdownModel extends QuestionMatrixDropdownModelBase implements IMatrixDropdownData {
9908
10050
  constructor(name: string);
9909
10051
  getType(): string;
9910
10052
  /*
9911
- * Set this property to show it on the first column for the total row.
10053
+ * A title for the total row. Applies if at least one column displays total values.
9912
10054
  */
9913
10055
  get totalText(): string;
9914
10056
  set totalText(val: string);
9915
10057
  get locTotalText(): LocalizableString;
9916
10058
  getFooterText(): LocalizableString;
9917
10059
  /*
9918
- * The column width for the first column, row title column.
10060
+ * A width for the column that displays row titles (first column). Accepts CSS values.
9919
10061
  */
9920
10062
  get rowTitleWidth(): string;
9921
10063
  set rowTitleWidth(val: string);
9922
10064
  getRowTitleWidth(): string;
9923
10065
  /*
9924
- * Set this property to true to hide the question if there is no visible rows in the matrix.
10066
+ * Specifies whether to hide the question when the matrix has no visible rows.
9925
10067
  */
9926
10068
  get hideIfRowsEmpty(): boolean;
9927
10069
  set hideIfRowsEmpty(val: boolean);
@@ -9938,8 +10080,11 @@ export declare class QuestionMatrixDropdownModel extends QuestionMatrixDropdownM
9938
10080
  protected updateProgressInfoByValues(res: IProgressInfo): void;
9939
10081
  }
9940
10082
  /*
9941
- * A Model for a matrix dymanic question. You may use a dropdown, checkbox, radiogroup, text and comment questions as a cell editors.
9942
- * An end-user may dynamically add/remove rows, unlike in matrix dropdown question.
10083
+ * A class that describes the Dynamic Matrix question type.
10084
+ *
10085
+ * Dynamic Matrix allows respondents to add and delete matrix rows. You can use the [Dropdown](https://surveyjs.io/form-library/documentation/questiondropdownmodel), [Checkbox](https://surveyjs.io/form-library/documentation/questioncheckboxmodel), [Radiogroup](https://surveyjs.io/form-library/documentation/questionradiogroupmodel), [Text](https://surveyjs.io/form-library/documentation/questiontextmodel), and [Comment](https://surveyjs.io/form-library/documentation/questioncommentmodel) question types as cell editors.
10086
+ *
10087
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-matrixdynamic/ (linkStyle))
9943
10088
  */
9944
10089
  export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownModelBase implements IMatrixDropdownData {
9945
10090
  constructor(name: string);
@@ -9955,12 +10100,12 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
9955
10100
  getType(): string;
9956
10101
  get isRowsDynamic(): boolean;
9957
10102
  /*
9958
- * Set it to true, to show a confirmation dialog on removing a row
10103
+ * Specifies whether to display a confirmation dialog when a respondent wants to delete a row.
9959
10104
  */
9960
10105
  get confirmDelete(): boolean;
9961
10106
  set confirmDelete(val: boolean);
9962
10107
  /*
9963
- * Set it to a column name and the library shows duplication error, if there are same values in different rows in the column.
10108
+ * Specifies a key column. Set this property to a column name, and the question will display `keyDuplicationError` if a user tries to enter a duplicate value in this column.
9964
10109
  */
9965
10110
  get keyName(): string;
9966
10111
  set keyName(val: string);
@@ -9970,8 +10115,9 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
9970
10115
  get defaultRowValue(): any;
9971
10116
  set defaultRowValue(val: any);
9972
10117
  /*
9973
- * Set it to true to copy the value into new added row from the last row. If defaultRowValue is set and this property equals to true,
9974
- * then the value for new added row is merging.
10118
+ * Specifies whether default values for a new row/column should be copied from the last row/column.
10119
+ *
10120
+ * If you also specify `defaultValue`, it will be merged with the copied values.
9975
10121
  */
9976
10122
  get defaultValueFromLastRow(): boolean;
9977
10123
  set defaultValueFromLastRow(val: boolean);
@@ -9986,39 +10132,61 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
9986
10132
  set rowCount(val: number);
9987
10133
  protected updateProgressInfoByValues(res: IProgressInfo): void;
9988
10134
  /*
9989
- * Set this property to true, to allow rows drag and drop.
10135
+ * Specifies whether users can drag and drop matrix rows to reorder them.
10136
+ *
10137
+ * Default value: `false`
9990
10138
  */
9991
10139
  get allowRowsDragAndDrop(): boolean;
9992
10140
  set allowRowsDragAndDrop(val: boolean);
9993
10141
  get iconDragElement(): string;
9994
10142
  protected createRenderedTable(): QuestionMatrixDropdownRenderedTable;
9995
10143
  /*
9996
- * The minimum row count. A user could not delete a row if the rowCount equals to minRowCount
10144
+ * A minimum number of rows in the matrix. Users cannot delete rows if `rowCount` equals `minRowCount`.
10145
+ *
10146
+ * Default value: 0
9997
10147
  */
9998
10148
  get minRowCount(): number;
9999
10149
  set minRowCount(val: number);
10000
10150
  /*
10001
- * The maximum row count. A user could not add a row if the rowCount equals to maxRowCount
10151
+ * A maximum number of rows in the matrix. Users cannot add new rows if `rowCount` equals `maxRowCount`.
10152
+ *
10153
+ * Default value: 1000 (inherited from [`settings.matrixMaximumRowCount`](https://surveyjs.io/form-library/documentation/settings#matrixMaximumRowCount))
10002
10154
  */
10003
10155
  get maxRowCount(): number;
10004
10156
  set maxRowCount(val: number);
10005
10157
  /*
10006
- * Set this property to false to disable ability to add new rows. "Add new Row" button becomes invsible in UI
10158
+ * Specifies whether users are allowed to add new rows.
10159
+ *
10160
+ * Default value: `true`
10007
10161
  */
10008
10162
  get allowAddRows(): boolean;
10009
10163
  set allowAddRows(val: boolean);
10010
10164
  /*
10011
- * Set this property to false to disable ability to remove rows. "Remove" row buttons become invsible in UI
10165
+ * Specifies whether users are allowed to delete rows.
10166
+ *
10167
+ * Default value: `true`
10012
10168
  */
10013
10169
  get allowRemoveRows(): boolean;
10014
10170
  set allowRemoveRows(val: boolean);
10015
10171
  /*
10016
- * Returns true, if a new row can be added.
10172
+ * Indicates whether it is possible to add a new row.
10173
+ *
10174
+ * This property returns `true` when all of the following conditions apply:
10175
+ *
10176
+ * - Users are allowed to add new rows (`allowAddRows` is `true`).
10177
+ * - The question, its parent panel, or survey is not in read-only state.
10178
+ * - `rowCount` is less than `maxRowCount`.
10017
10179
  */
10018
10180
  get canAddRow(): boolean;
10019
10181
  canRemoveRowsCallback: (allow: boolean) => boolean;
10020
10182
  /*
10021
- * Returns true, if row can be removed.
10183
+ * Indicates whether it is possible to delete rows.
10184
+ *
10185
+ * This property returns `true` when all of the following conditions apply:
10186
+ *
10187
+ * - Users are allowed to delete rows (`allowRemoveRows` is `true`).
10188
+ * - The question, its parent panel, or survey is not in read-only state.
10189
+ * - `rowCount` exceeds `minRowCount`.
10022
10190
  */
10023
10191
  get canRemoveRows(): boolean;
10024
10192
  canRemoveRow(row: MatrixDropdownRowModelBase): boolean;
@@ -10031,7 +10199,7 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
10031
10199
  */
10032
10200
  addRow(): void;
10033
10201
  /*
10034
- * Set this property to true to show detail panel immediately on adding a new row.
10202
+ * Specifies whether to expand the detail section immediately when a respondent adds a new row.
10035
10203
  */
10036
10204
  get detailPanelShowOnAdding(): boolean;
10037
10205
  set detailPanelShowOnAdding(val: boolean);
@@ -10048,26 +10216,35 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
10048
10216
  */
10049
10217
  removeRow(index: number): void;
10050
10218
  /*
10051
- * Use this property to change the default text showing in the confirmation delete dialog on removing a row.
10219
+ * A message displayed in a confirmation dialog that appears when a respondent wants to delete a row.
10052
10220
  */
10053
10221
  get confirmDeleteText(): string;
10054
10222
  set confirmDeleteText(val: string);
10055
10223
  get locConfirmDeleteText(): LocalizableString;
10056
10224
  /*
10057
- * Use this property to change the default value of add row button text.
10225
+ * A caption for the Add Row button.
10058
10226
  */
10059
10227
  get addRowText(): string;
10060
10228
  set addRowText(val: string);
10061
10229
  get locAddRowText(): LocalizableString;
10062
10230
  /*
10063
- * By default the 'Add Row' button is shown on bottom if columnLayout is horizontal and on top if columnLayout is vertical.
10064
- * You may set it to "top", "bottom" or "topBottom" (to show on top and bottom).
10231
+ * Specifies the location of the Add Row button.
10232
+ *
10233
+ * Possible values:
10234
+ *
10235
+ * - `"top"` - Displays the Add Row button at the top of the matrix.
10236
+ * - `"bottom"` - Displays the Add Row button at the bottom of the matrix.
10237
+ * - `"topBottom"` - Displays the Add Row button at the top and bottom of the matrix.
10238
+ *
10239
+ * Default value: `"top"` if `columnLayout` is `vertical`; `"bottom"` if `columnLayout` is `"horizontal"` or the matrix is in compact mode.
10065
10240
  */
10066
10241
  get addRowLocation(): string;
10067
10242
  set addRowLocation(val: string);
10068
10243
  getAddRowLocation(): string;
10069
10244
  /*
10070
- * Set this property to true to hide matrix columns when there is no any row.
10245
+ * Specifies whether to hide columns when the matrix does not contain any rows. If you enable this property, the matrix displays the `emptyRowsText` message and the Add Row button.
10246
+ *
10247
+ * Default value: `false`
10071
10248
  */
10072
10249
  get hideColumnsIfEmpty(): boolean;
10073
10250
  set hideColumnsIfEmpty(val: boolean);
@@ -10079,7 +10256,7 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
10079
10256
  set removeRowText(val: string);
10080
10257
  get locRemoveRowText(): LocalizableString;
10081
10258
  /*
10082
- * Use this property to change the default value of remove row button text.
10259
+ * A message displayed when the matrix does not contain any rows. Applies only if `hideColumnsIfEmpty` is enabled.
10083
10260
  */
10084
10261
  get emptyRowsText(): string;
10085
10262
  set emptyRowsText(val: string);
@@ -10102,7 +10279,9 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
10102
10279
  getRootCss(): string;
10103
10280
  }
10104
10281
  /*
10105
- * A Model for a radiogroup question.
10282
+ * A class that describes the Radiogroup question type.
10283
+ *
10284
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-radiogroup/ (linkStyle))
10106
10285
  */
10107
10286
  export declare class QuestionRadiogroupModel extends QuestionCheckboxBase {
10108
10287
  constructor(name: string);
@@ -10112,11 +10291,13 @@ export declare class QuestionRadiogroupModel extends QuestionCheckboxBase {
10112
10291
  get titleAriaLabel(): string;
10113
10292
  protected getFirstInputElementId(): string;
10114
10293
  /*
10115
- * Return the selected item in the radio group. Returns null if the value is empty
10294
+ * Returns the selected choice item. If no item is selected, returns `null`.
10116
10295
  */
10117
10296
  get selectedItem(): ItemValue;
10118
10297
  /*
10119
- * Show "clear button" flag.
10298
+ * Specifies whether to display a button that clears the question value.
10299
+ *
10300
+ * Default value: `false`
10120
10301
  */
10121
10302
  get showClearButton(): boolean;
10122
10303
  set showClearButton(val: boolean);
@@ -10127,7 +10308,9 @@ export declare class QuestionRadiogroupModel extends QuestionCheckboxBase {
10127
10308
  protected getDefaultTitleActions(): Array<Action>;
10128
10309
  }
10129
10310
  /*
10130
- * A Model for a ranking question
10311
+ * A class that describes the Ranking question type.
10312
+ *
10313
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-ranking/ (linkStyle))
10131
10314
  */
10132
10315
  export declare class QuestionRankingModel extends QuestionCheckboxModel {
10133
10316
  constructor(name: string);
@@ -10168,13 +10351,19 @@ export declare class QuestionRankingModel extends QuestionCheckboxModel {
10168
10351
  getIconHoverCss(): string;
10169
10352
  getIconFocusCss(): string;
10170
10353
  /*
10171
- * For mobile devices. Set this property to false, to disable the "long tap" before drag start. Default is true.
10354
+ * Specifies whether to use a long tap (press and hold) gesture to start dragging.
10355
+ *
10356
+ * Default value: `true`
10357
+ *
10358
+ * Disable this property if you want to start dragging when users perform a scroll gesture.
10172
10359
  */
10173
10360
  get longTap(): boolean;
10174
10361
  set longTap(val: boolean);
10175
10362
  }
10176
10363
  /*
10177
10364
  * A Model for a tagbox question
10365
+ *
10366
+ * [View Demo](https://surveyjs.io/form-library/examples/how-to-create-multiselect-tag-box/ (linkStyle))
10178
10367
  */
10179
10368
  export declare class QuestionTagboxModel extends QuestionCheckboxModel {
10180
10369
  constructor(name: string);
@@ -10482,6 +10671,7 @@ export declare var defaultActionBarCss: {
10482
10671
  export declare var defaultListCss: {
10483
10672
  root: string,
10484
10673
  item: string,
10674
+ loadingIndicator: string,
10485
10675
  itemSelected: string,
10486
10676
  itemWithIcon: string,
10487
10677
  itemDisabled: string,
@@ -11051,6 +11241,7 @@ export declare var defaultBootstrapCss: {
11051
11241
  root: string,
11052
11242
  selectWrapper: string,
11053
11243
  control: string,
11244
+ controlValue: string,
11054
11245
  other: string,
11055
11246
  cleanButton: string,
11056
11247
  cleanButtonSvg: string,
@@ -11389,6 +11580,7 @@ export declare var defaultBootstrapMaterialCss: {
11389
11580
  root: string,
11390
11581
  selectWrapper: string,
11391
11582
  control: string,
11583
+ controlValue: string,
11392
11584
  other: string,
11393
11585
  cleanButton: string,
11394
11586
  cleanButtonSvg: string,