survey-react 1.9.55 → 1.9.56

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.56
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;
@@ -2801,11 +2818,11 @@ export declare class PopupModel<T = any> extends Base {
2801
2818
  displayMode: "popup" | "overlay";
2802
2819
  positionMode: any;
2803
2820
  onVisibilityChanged: EventBase<PopupModel<any>>;
2804
- onTargetModified: EventBase<Base>;
2821
+ onRecalculatePosition: EventBase<Base>;
2805
2822
  get isVisible(): boolean;
2806
2823
  set isVisible(val: boolean);
2807
2824
  toggleVisibility(): void;
2808
- targetModified(): void;
2825
+ recalculatePosition(isResetHeight: boolean): void;
2809
2826
  }
2810
2827
  /*
2811
2828
  * A Model for a survey running in the Popup Window.
@@ -2868,6 +2885,8 @@ export declare class PopupSurveyModel extends Base {
2868
2885
  get cssBody(): string;
2869
2886
  get cssHeaderRoot(): string;
2870
2887
  get cssHeaderTitle(): string;
2888
+ get renderedWidth(): string;
2889
+ width: string;
2871
2890
  protected createSurvey(jsonObj: any): SurveyModel;
2872
2891
  protected onSurveyComplete(): void;
2873
2892
  }
@@ -2905,6 +2924,7 @@ export declare class QuestionMatrixDropdownRenderedTable extends Base {
2905
2924
  isRequireReset(): boolean;
2906
2925
  get headerRow(): QuestionMatrixDropdownRenderedRow;
2907
2926
  get footerRow(): QuestionMatrixDropdownRenderedRow;
2927
+ get allowRowsDragAndDrop(): boolean;
2908
2928
  protected build(): void;
2909
2929
  updateShowTableAndAddRow(): void;
2910
2930
  onAddedRow(): void;
@@ -3476,7 +3496,6 @@ export declare class DropdownMultiSelectListModel extends DropdownListModel {
3476
3496
  closeOnSelect: boolean;
3477
3497
  protected override: any;
3478
3498
  createListModel(): MultiSelectListModel;
3479
- protected onSetFilterString(): void;
3480
3499
  selectAllItems(): void;
3481
3500
  selectNoneItem(): void;
3482
3501
  selectItem(id: string): void;
@@ -3562,6 +3581,7 @@ export declare class ListModel extends ActionContainer {
3562
3581
  onSelectionChanged: (item: Action, ...params: any) => void;
3563
3582
  allowSelection: boolean;
3564
3583
  listContainerHtmlElement: any;
3584
+ loadingIndicatorValue: Action;
3565
3585
  searchEnabled: boolean;
3566
3586
  showFilter: boolean;
3567
3587
  isExpanded: boolean;
@@ -3575,6 +3595,7 @@ export declare class ListModel extends ActionContainer {
3575
3595
  scrollHandler: (e?: any) => void;
3576
3596
  isItemVisible(item: Action): boolean;
3577
3597
  get visibleItems(): any;
3598
+ setItems(items: any, sortByVisibleIndex?: boolean): void;
3578
3599
  protected onSet(): void;
3579
3600
  protected getDefaultCssClasses(): any;
3580
3601
  protected updateItemActiveState(): void;
@@ -3587,6 +3608,8 @@ export declare class ListModel extends ActionContainer {
3587
3608
  get filterStringPlaceholder(): string;
3588
3609
  get emptyMessage(): string;
3589
3610
  get scrollableContainer(): any;
3611
+ get loadingText(): string;
3612
+ get loadingIndicator(): Action;
3590
3613
  goToItems(event: any): void;
3591
3614
  onMouseMove(event: any): void;
3592
3615
  onKeyDown(event: any): void;
@@ -3670,6 +3693,7 @@ export declare class PopupDropdownViewModel extends PopupBaseViewModel {
3670
3693
  popupDirection: string;
3671
3694
  pointerTarget: IPosition;
3672
3695
  updateOnShowing(): void;
3696
+ updatePosition(isResetHeight: boolean, isDelayUpdating?: boolean): void;
3673
3697
  updateOnHiding(): void;
3674
3698
  }
3675
3699
  export declare class PopupModalViewModel extends PopupBaseViewModel {
@@ -3927,7 +3951,7 @@ export declare class SurveyElement<E = any> extends SurveyElementCore implements
3927
3951
  getRenderer(name: string): string;
3928
3952
  getRendererContext(locStr: LocalizableString): any;
3929
3953
  getProcessedText(text: string): string;
3930
- protected getUseDisplayValuesInTitle(): boolean;
3954
+ protected getUseDisplayValuesInDynamicTexts(): boolean;
3931
3955
  protected removeSelfFromList(list: any): void;
3932
3956
  protected get textProcessor(): ITextProcessor;
3933
3957
  protected getProcessedHtml(html: string): string;
@@ -5201,7 +5225,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5201
5225
  *
5202
5226
  * If you want to skip empty answers, pass an object with the `includeEmpty` property set to `false`.
5203
5227
  */
5204
- getPlainData(options?: any): any;
5228
+ getPlainData(options?: any): Array<IQuestionPlainData>;
5205
5229
  getFilteredValues(): any;
5206
5230
  getFilteredProperties(): any;
5207
5231
  getDataValueCore(valuesHash: any, key: string): any;
@@ -6656,15 +6680,23 @@ export declare class Question extends SurveyElement<Question> implements IQuesti
6656
6680
  set visible(val: boolean);
6657
6681
  protected onVisibleChanged(): void;
6658
6682
  /*
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.
6683
+ * Specifies whether to use display names for question values in placeholders.
6662
6684
  *
6663
6685
  * Default value: `true`
6686
+ *
6687
+ * 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).
6688
+ *
6689
+ * You can use question values as placeholders in the following places:
6690
+ *
6691
+ * - Survey element titles and descriptions
6692
+ * - The [`expression`](https://surveyjs.io/form-library/documentation/questionexpressionmodel#expression) property of the [Expression](https://surveyjs.io/form-library/documentation/questionexpressionmodel) question
6693
+ * - The [`html`](https://surveyjs.io/form-library/documentation/questionhtmlmodel#html) property of the [HTML](https://surveyjs.io/form-library/documentation/questionhtmlmodel) question
6694
+ *
6695
+ * 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
6696
  */
6665
- get useDisplayValuesInTitle(): boolean;
6666
- set useDisplayValuesInTitle(val: boolean);
6667
- protected getUseDisplayValuesInTitle(): boolean;
6697
+ get useDisplayValuesInDynamicTexts(): boolean;
6698
+ set useDisplayValuesInDynamicTexts(val: boolean);
6699
+ protected getUseDisplayValuesInDynamicTexts(): boolean;
6668
6700
  /*
6669
6701
  * A Boolean expression. If it evaluates to `false`, this question becomes hidden.
6670
6702
  *
@@ -7019,7 +7051,7 @@ export declare class Question extends SurveyElement<Question> implements IQuesti
7019
7051
  *
7020
7052
  * Pass an object with the `includeEmpty` property set to `false` if you want to skip empty answers.
7021
7053
  */
7022
- getPlainData(options?: any): any;
7054
+ getPlainData(options?: any): IQuestionPlainData;
7023
7055
  /*
7024
7056
  * 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
7057
  */
@@ -7869,7 +7901,7 @@ export declare class QuestionFileModel extends Question {
7869
7901
  protected loadPreview(newValue: any): void;
7870
7902
  protected onCheckForErrors(errors: any, isOnValueChanged: boolean): void;
7871
7903
  protected stateChanged(state: string): void;
7872
- getPlainData(options?: any): any;
7904
+ getPlainData(options?: any): IQuestionPlainData;
7873
7905
  supportComment(): boolean;
7874
7906
  getChooseFileCss(): string;
7875
7907
  getReadOnlyFileCss(): string;
@@ -7979,7 +8011,9 @@ export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
7979
8011
  alternateRows: boolean;
7980
8012
  }
7981
8013
  /*
7982
- * A Model for a multiple text question.
8014
+ * A class that describes the Multiple Text question type.
8015
+ *
8016
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-multipletext/ (linkStyle))
7983
8017
  */
7984
8018
  export declare class QuestionMultipleTextModel extends Question implements IMultipleTextData, IPanel {
7985
8019
  constructor(name: string);
@@ -7993,12 +8027,12 @@ export declare class QuestionMultipleTextModel extends Question implements IMult
7993
8027
  setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
7994
8028
  onSurveyValueChanged(newValue: any): void;
7995
8029
  /*
7996
- * The list of input items.
8030
+ * An array of `MultipleTextItemModel` objects that represent input items.
7997
8031
  */
7998
8032
  get items(): any;
7999
8033
  set items(val: any);
8000
8034
  /*
8001
- * Add a new text item.
8035
+ * Adds a new input item.
8002
8036
  */
8003
8037
  addItem(name: string, title?: string): MultipleTextItemModel;
8004
8038
  getItemByName(name: string): MultipleTextItemModel;
@@ -8007,18 +8041,17 @@ export declare class QuestionMultipleTextModel extends Question implements IMult
8007
8041
  locStrsChanged(): void;
8008
8042
  supportGoNextPageAutomatic(): boolean;
8009
8043
  /*
8010
- * The number of columns. Items are rendred in one line if the value is 0.
8044
+ * The number of columns used to arrange input items. Accepts the following values: 1, 2, 3, 4, 5.
8045
+ *
8046
+ * Default value: 1
8011
8047
  */
8012
8048
  get colCount(): number;
8013
8049
  set colCount(val: number);
8014
8050
  /*
8015
- * The default text input size.
8051
+ * 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
8052
  */
8017
8053
  get itemSize(): number;
8018
8054
  set itemSize(val: number);
8019
- /*
8020
- * Returns the list of rendered rows.
8021
- */
8022
8055
  getRows(): Array<any>;
8023
8056
  isMultipleItemValueChanging: boolean;
8024
8057
  protected onValueChanged(): void;
@@ -8348,7 +8381,7 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8348
8381
  isSetPanelItemData: any;
8349
8382
  setPanelItemData(item: ISurveyData, name: string, val: any): void;
8350
8383
  getRootData(): ISurveyData;
8351
- getPlainData(options?: any): any;
8384
+ getPlainData(options?: any): IQuestionPlainData;
8352
8385
  updateElementCss(reNew?: boolean): void;
8353
8386
  get progressText(): string;
8354
8387
  get progress(): string;
@@ -8372,28 +8405,49 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
8372
8405
  updateFooterActionsCallback: any;
8373
8406
  }
8374
8407
  /*
8375
- * A Model for a rating question.
8408
+ * A class that describes the Rating question type.
8409
+ *
8410
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-rating/ (linkStyle))
8376
8411
  */
8377
8412
  export declare class QuestionRatingModel extends Question {
8378
8413
  constructor(name: string);
8379
8414
  endLoadingFromJson(): void;
8380
8415
  /*
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.
8416
+ * A list of rate values.
8417
+ *
8418
+ * This property accepts an array of objects with the following structure:
8419
+ *
8420
+ * ```js
8421
+ * {
8422
+ * "value": any, // A value to be saved in survey results
8423
+ * "text": String, // A display text. This property supports Markdown. When `text` is undefined, `value` is used.
8424
+ * }
8425
+ * ```
8426
+ *
8427
+ * 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.
8428
+ *
8429
+ * If you do not specify the `rateValues` property, rate values are generated automatically based upon the `rateMin`, `rateMax`, and `rateStep` property values.
8382
8430
  */
8383
8431
  get rateValues(): any;
8384
8432
  set rateValues(val: any);
8385
8433
  /*
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.
8434
+ * Specifies the first rate value in the generated sequence of rate values. Applies if the `rateValues` array is empty.
8435
+ *
8436
+ * Default value: 1
8387
8437
  */
8388
8438
  get rateMin(): number;
8389
8439
  set rateMin(val: number);
8390
8440
  /*
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.
8441
+ * Specifies the last rate value in the generated sequence of rate values. Applies if the `rateValues` array is empty.
8442
+ *
8443
+ * Default value: 5
8392
8444
  */
8393
8445
  get rateMax(): number;
8394
8446
  set rateMax(val: number);
8395
8447
  /*
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.
8448
+ * Specifies a step with which to generate rate values. Applies if the `rateValues` array is empty.
8449
+ *
8450
+ * Default value: 1
8397
8451
  */
8398
8452
  get rateStep(): number;
8399
8453
  set rateStep(val: number);
@@ -8408,13 +8462,13 @@ export declare class QuestionRatingModel extends Question {
8408
8462
  supportComment(): boolean;
8409
8463
  supportOther(): boolean;
8410
8464
  /*
8411
- * The description of minimum (first) item.
8465
+ * Specifies a description for the minimum (first) rate value.
8412
8466
  */
8413
8467
  get minRateDescription(): string;
8414
8468
  set minRateDescription(val: string);
8415
8469
  get locMinRateDescription(): LocalizableString;
8416
8470
  /*
8417
- * The description of maximum (last) item.
8471
+ * Specifies a description for the maximum (last) rate value.
8418
8472
  */
8419
8473
  get maxRateDescription(): string;
8420
8474
  set maxRateDescription(val: string);
@@ -8424,8 +8478,13 @@ export declare class QuestionRatingModel extends Question {
8424
8478
  get hasMinLabel(): boolean;
8425
8479
  get hasMaxLabel(): boolean;
8426
8480
  /*
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.
8481
+ * Specifies whether to display `minRateDescription` and `maxRateDescription` values as captions for buttons that correspond to the extreme (first and last) rate values.
8482
+ *
8483
+ * Default value: `false`
8484
+ *
8485
+ * If this property is disabled, the `minRateDescription` and `maxRateDescription` values are displayed as plain non-clickable texts.
8486
+ *
8487
+ * 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
8488
  */
8430
8489
  displayRateDescriptionsAsExtremeItems: boolean;
8431
8490
  /*
@@ -8439,9 +8498,6 @@ export declare class QuestionRatingModel extends Question {
8439
8498
  */
8440
8499
  displayMode: "dropdown" | "auto" | "buttons";
8441
8500
  protected valueToData(val: any): any;
8442
- /*
8443
- * Click value again to clear.
8444
- */
8445
8501
  setValueFromClick(value: any): void;
8446
8502
  get ratingRootCss(): string;
8447
8503
  getItemClass(item: ItemValue): string;
@@ -8687,7 +8743,7 @@ export declare class QuestionSelectBase extends Question {
8687
8743
  protected canShowOptionItem(item: ItemValue, isAddAll: boolean, hasItem: boolean): boolean;
8688
8744
  isItemInList(item: ItemValue): boolean;
8689
8745
  protected get isAddDefaultItems(): boolean;
8690
- getPlainData(options?: any): any;
8746
+ getPlainData(options?: any): IQuestionPlainData;
8691
8747
  protected getDisplayValueCore(keysAsText: boolean, value: any): any;
8692
8748
  protected getDisplayValueEmpty(): string;
8693
8749
  protected getChoicesDisplayValue(items: any, val: any): any;
@@ -8774,7 +8830,9 @@ export declare class QuestionSelectBase extends Question {
8774
8830
  set itemComponent(val: string);
8775
8831
  }
8776
8832
  /*
8777
- * A Model for signature pad question.
8833
+ * A class that describes the Signature Page question type.
8834
+ *
8835
+ * [View Demo](https://surveyjs.io/form-library/examples/signature-pad-widget-javascript/ (linkStyle))
8778
8836
  */
8779
8837
  export declare class QuestionSignaturePadModel extends Question {
8780
8838
  constructor(name: string);
@@ -8787,41 +8845,45 @@ export declare class QuestionSignaturePadModel extends Question {
8787
8845
  initSignaturePad(el: any): void;
8788
8846
  destroySignaturePad(el: any): void;
8789
8847
  /*
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
8848
+ * Specifies the format in which to store the signature image.
8849
+ *
8850
+ * Possible values:
8851
+ *
8852
+ * - `""` (default) - PNG
8853
+ * - `"image/jpeg"` - JPEG
8854
+ * - `"image/svg+xml"` - SVG
8792
8855
  */
8793
8856
  dataFormat: string;
8794
8857
  /*
8795
- * Use it to set the specific width for the signature pad.
8858
+ * Specifies the width of the signature area. Accepts positive integer numbers.
8796
8859
  */
8797
8860
  get signatureWidth(): number;
8798
8861
  set signatureWidth(val: number);
8799
8862
  /*
8800
- * Use it to set the specific height for the signature pad.
8863
+ * Specifies the height of the signature area. Accepts positive integer numbers.
8801
8864
  */
8802
8865
  get signatureHeight(): number;
8803
8866
  set signatureHeight(val: number);
8804
8867
  get height(): number;
8805
8868
  set height(val: number);
8806
8869
  /*
8807
- * Use it to clear content of the signature pad.
8870
+ * Specifies whether to display a button that clears the signature area.
8871
+ *
8872
+ * Default value: `true`
8808
8873
  */
8809
8874
  get allowClear(): boolean;
8810
8875
  set allowClear(val: boolean);
8811
8876
  get canShowClearButton(): boolean;
8812
8877
  /*
8813
- * Use it to set pen color for the signature pad.
8878
+ * Specifies a color for the pen. Accepts hexadecimal colors (`"#FF0000"`), RGB colors (`"rgb(255,0,0)"`), or color names (`"red"`).
8814
8879
  */
8815
8880
  get penColor(): string;
8816
8881
  set penColor(val: string);
8817
8882
  /*
8818
- * Use it to set background color for the signature pad.
8883
+ * Specifies a color for the signature area background. Accepts hexadecimal colors (`"#FF0000"`), RGB colors (`"rgb(255,0,0)"`), or color names (`"red"`).
8819
8884
  */
8820
8885
  get backgroundColor(): string;
8821
8886
  set backgroundColor(val: string);
8822
- /*
8823
- * The clear signature button caption.
8824
- */
8825
8887
  get clearButtonCaption(): string;
8826
8888
  needShowPlaceholder(): boolean;
8827
8889
  get placeHolderText(): string;
@@ -9051,6 +9113,7 @@ export declare class QuestionCustomModel extends QuestionCustomModelBase {
9051
9113
  export declare class QuestionDropdownModel extends QuestionSelectBase {
9052
9114
  constructor(name: string);
9053
9115
  dropdownListModel: DropdownListModel;
9116
+ lastSelectedItemValue: ItemValue;
9054
9117
  updateReadOnlyText(): void;
9055
9118
  locStrsChanged(): void;
9056
9119
  get showOptionsCaption(): boolean;
@@ -9106,11 +9169,8 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
9106
9169
  */
9107
9170
  get choicesStep(): number;
9108
9171
  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);
9172
+ get autocomplete(): string;
9173
+ set autocomplete(val: string);
9114
9174
  /*
9115
9175
  * Specifies whether to display a button that clears the selected value.
9116
9176
  */
@@ -9134,6 +9194,7 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
9134
9194
  protected onVisibleChoicesChanged(): void;
9135
9195
  protected getFirstInputElementId(): string;
9136
9196
  getInputId(): string;
9197
+ clearValue(): void;
9137
9198
  onClick(e: any): void;
9138
9199
  onKeyUp(event: any): void;
9139
9200
  }
@@ -9439,7 +9500,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9439
9500
  get optionsCaption(): string;
9440
9501
  set optionsCaption(val: string);
9441
9502
  /*
9442
- * An error message displayed when users enter a duplicate value into a column that accepts only unique values (`isUnique` is set to `true`).
9503
+ * 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
9504
  *
9444
9505
  * 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
9506
  */
@@ -9468,7 +9529,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9468
9529
  protected getRowValueCore(row: MatrixDropdownRowModelBase, questionValue: any, create?: boolean): any;
9469
9530
  protected getRowObj(row: MatrixDropdownRowModelBase): any;
9470
9531
  protected getRowDisplayValue(keysAsText: boolean, row: MatrixDropdownRowModelBase, rowValue: any): any;
9471
- getPlainData(options?: any): any;
9532
+ getPlainData(options?: any): IQuestionPlainData;
9472
9533
  addConditionObjectsByContext(objects: any, context: any): void;
9473
9534
  protected getConditionObjectRowName(index: number): string;
9474
9535
  protected getConditionObjectRowText(index: number): string;
@@ -9526,7 +9587,9 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9526
9587
  protected getIsTooltipErrorInsideSupported(): boolean;
9527
9588
  }
9528
9589
  /*
9529
- * A Model for a simple matrix question.
9590
+ * A class that describes the Single-Choice Matrix question type.
9591
+ *
9592
+ * [View Demo](https://surveyjs.io/form-library/examples/single-selection-matrix-table-question/ (linkStyle))
9530
9593
  */
9531
9594
  export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixRowModel, ItemValue> implements IMatrixData, IMatrixCellsOwner {
9532
9595
  constructor(name: string);
@@ -9535,21 +9598,23 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
9535
9598
  getType(): string;
9536
9599
  get hasSingleInput(): boolean;
9537
9600
  /*
9538
- * Set this property to true, if you want a user to answer all rows.
9601
+ * Specifies whether each row requires an answer. If a respondent skips a row, the question displays a validation error.
9539
9602
  */
9540
9603
  get isAllRowRequired(): boolean;
9541
9604
  set isAllRowRequired(val: boolean);
9542
- /*
9543
- * Returns true, if there is at least one row.
9544
- */
9545
9605
  get hasRows(): boolean;
9546
9606
  /*
9547
- * Use this property to render items in a specific order: "random" or "initial". Default is "initial".
9607
+ * Specifies a sort order for matrix rows.
9608
+ *
9609
+ * Possible values:
9610
+ *
9611
+ * - "initial" (default) - Preserves the original order of the `rows` array.
9612
+ * - "random" - Arranges matrix rows in random order each time the question is displayed.
9548
9613
  */
9549
9614
  get rowsOrder(): string;
9550
9615
  set rowsOrder(val: string);
9551
9616
  /*
9552
- * Set this property to true to hide the question if there is no visible rows in the matrix.
9617
+ * Specifies whether to hide the question when the matrix has no visible rows.
9553
9618
  */
9554
9619
  get hideIfRowsEmpty(): boolean;
9555
9620
  set hideIfRowsEmpty(val: boolean);
@@ -9564,9 +9629,6 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
9564
9629
  protected sortVisibleRows(array: any): Array<MatrixRowModel>;
9565
9630
  endLoadingFromJson(): void;
9566
9631
  protected processRowsOnSet(newRows: any): any;
9567
- /*
9568
- * Returns the list of visible rows as model objects.
9569
- */
9570
9632
  get visibleRows(): any;
9571
9633
  get cells(): MatrixCells;
9572
9634
  set cells(val: MatrixCells);
@@ -9585,7 +9647,7 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
9585
9647
  protected onMatrixRowCreated(row: MatrixRowModel): void;
9586
9648
  protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
9587
9649
  protected getDisplayValueCore(keysAsText: boolean, value: any): any;
9588
- getPlainData(options?: any): any;
9650
+ getPlainData(options?: any): IQuestionPlainData;
9589
9651
  addConditionObjectsByContext(objects: any, context: any): void;
9590
9652
  getConditionJson(operator?: string, path?: string): any;
9591
9653
  protected clearValueIfInvisibleCore(): void;
@@ -9599,7 +9661,9 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
9599
9661
  getRowHeaderWrapperComponentData(cell: ItemValue): any;
9600
9662
  }
9601
9663
  /*
9602
- * A Model for an input text question.
9664
+ * A class that describes the Text question type.
9665
+ *
9666
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-text/ (linkStyle))
9603
9667
  */
9604
9668
  export declare class QuestionTextModel extends QuestionTextBase {
9605
9669
  constructor(name: string);
@@ -9610,7 +9674,7 @@ export declare class QuestionTextModel extends QuestionTextBase {
9610
9674
  getType(): string;
9611
9675
  onSurveyLoad(): void;
9612
9676
  /*
9613
- * Use this property to change the default input type.
9677
+ * 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
9678
  */
9615
9679
  get inputType(): string;
9616
9680
  set inputType(val: string);
@@ -9618,7 +9682,7 @@ export declare class QuestionTextModel extends QuestionTextBase {
9618
9682
  getValidators(): Array<SurveyValidator>;
9619
9683
  isLayoutTypeSupported(layoutType: string): boolean;
9620
9684
  /*
9621
- * The text input size
9685
+ * 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
9686
  */
9623
9687
  get size(): number;
9624
9688
  set size(val: number);
@@ -9628,52 +9692,52 @@ export declare class QuestionTextModel extends QuestionTextBase {
9628
9692
  get inputWidth(): string;
9629
9693
  updateInputSize(): void;
9630
9694
  /*
9631
- * Text auto complete
9695
+ * 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
9696
  */
9633
- get autoComplete(): string;
9634
- set autoComplete(val: string);
9697
+ get autocomplete(): string;
9698
+ set autocomplete(val: string);
9635
9699
  /*
9636
- * The minimum value
9700
+ * 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
9701
  */
9638
9702
  get min(): string;
9639
9703
  set min(val: string);
9640
9704
  /*
9641
- * The maximum value
9705
+ * 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
9706
  */
9643
9707
  get max(): string;
9644
9708
  set max(val: string);
9645
9709
  /*
9646
- * The minimum value that you can setup as expression, for example today(-1) = yesterday;
9710
+ * The minimum value specified as an expression. For example, `"minValueExpression": "today(-1)"` sets the minimum value to yesterday.
9647
9711
  */
9648
9712
  get minValueExpression(): string;
9649
9713
  set minValueExpression(val: string);
9650
9714
  /*
9651
- * The maximum value that you can setup as expression, for example today(1) = tomorrow;
9715
+ * The maximum value specified as an expression. For example, `"maxValueExpression": "today(1)"` sets the maximum value to tomorrow.
9652
9716
  */
9653
9717
  get maxValueExpression(): string;
9654
9718
  set maxValueExpression(val: string);
9655
9719
  get renderedMin(): any;
9656
9720
  get renderedMax(): any;
9657
9721
  /*
9658
- * The text that shows when value is less than min property.
9722
+ * An error message to display when the question value is less than the minimum accepted value.
9659
9723
  */
9660
9724
  get minErrorText(): string;
9661
9725
  set minErrorText(val: string);
9662
9726
  get locMinErrorText(): LocalizableString;
9663
9727
  /*
9664
- * The text that shows when value is greater than man property.
9728
+ * An error message to display when the question value exceeds the maximum accepted value.
9665
9729
  */
9666
9730
  get maxErrorText(): string;
9667
9731
  set maxErrorText(val: string);
9668
9732
  get locMaxErrorText(): LocalizableString;
9669
9733
  /*
9670
- * Readonly property that returns true if the current inputType allows to set min and max properties
9734
+ * Returns `true` if the specified `inputType` supports the `min` and `max` properties.
9671
9735
  */
9672
9736
  get isMinMaxType(): boolean;
9673
9737
  protected onCheckForErrors(errors: any, isOnValueChanged: boolean): void;
9674
9738
  protected canSetValueToSurvey(): boolean;
9675
9739
  /*
9676
- * The step value
9740
+ * 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
9741
  */
9678
9742
  get step(): string;
9679
9743
  set step(val: string);
@@ -9681,7 +9745,7 @@ export declare class QuestionTextModel extends QuestionTextBase {
9681
9745
  supportGoNextPageAutomatic(): boolean;
9682
9746
  supportGoNextPageError(): boolean;
9683
9747
  /*
9684
- * The list of recommended options available to choose.
9748
+ * 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
9749
  */
9686
9750
  get dataList(): any;
9687
9751
  set dataList(val: any);
@@ -9902,26 +9966,28 @@ export declare class QuestionImagePickerModel extends QuestionCheckboxBase {
9902
9966
  afterRender(el: any): void;
9903
9967
  }
9904
9968
  /*
9905
- * A Model for a matrix dropdown question. You may use a dropdown, checkbox, radiogroup, text and comment questions as a cell editors.
9969
+ * 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.
9970
+ *
9971
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-matrixdropdown/ (linkStyle))
9906
9972
  */
9907
9973
  export declare class QuestionMatrixDropdownModel extends QuestionMatrixDropdownModelBase implements IMatrixDropdownData {
9908
9974
  constructor(name: string);
9909
9975
  getType(): string;
9910
9976
  /*
9911
- * Set this property to show it on the first column for the total row.
9977
+ * A title for the total row. Applies if at least one column displays total values.
9912
9978
  */
9913
9979
  get totalText(): string;
9914
9980
  set totalText(val: string);
9915
9981
  get locTotalText(): LocalizableString;
9916
9982
  getFooterText(): LocalizableString;
9917
9983
  /*
9918
- * The column width for the first column, row title column.
9984
+ * A width for the column that displays row titles (first column). Accepts CSS values.
9919
9985
  */
9920
9986
  get rowTitleWidth(): string;
9921
9987
  set rowTitleWidth(val: string);
9922
9988
  getRowTitleWidth(): string;
9923
9989
  /*
9924
- * Set this property to true to hide the question if there is no visible rows in the matrix.
9990
+ * Specifies whether to hide the question when the matrix has no visible rows.
9925
9991
  */
9926
9992
  get hideIfRowsEmpty(): boolean;
9927
9993
  set hideIfRowsEmpty(val: boolean);
@@ -9938,8 +10004,11 @@ export declare class QuestionMatrixDropdownModel extends QuestionMatrixDropdownM
9938
10004
  protected updateProgressInfoByValues(res: IProgressInfo): void;
9939
10005
  }
9940
10006
  /*
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.
10007
+ * A class that describes the Dynamic Matrix question type.
10008
+ *
10009
+ * 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.
10010
+ *
10011
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-matrixdynamic/ (linkStyle))
9943
10012
  */
9944
10013
  export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownModelBase implements IMatrixDropdownData {
9945
10014
  constructor(name: string);
@@ -9955,12 +10024,12 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
9955
10024
  getType(): string;
9956
10025
  get isRowsDynamic(): boolean;
9957
10026
  /*
9958
- * Set it to true, to show a confirmation dialog on removing a row
10027
+ * Specifies whether to display a confirmation dialog when a respondent wants to delete a row.
9959
10028
  */
9960
10029
  get confirmDelete(): boolean;
9961
10030
  set confirmDelete(val: boolean);
9962
10031
  /*
9963
- * Set it to a column name and the library shows duplication error, if there are same values in different rows in the column.
10032
+ * 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
10033
  */
9965
10034
  get keyName(): string;
9966
10035
  set keyName(val: string);
@@ -9970,8 +10039,9 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
9970
10039
  get defaultRowValue(): any;
9971
10040
  set defaultRowValue(val: any);
9972
10041
  /*
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.
10042
+ * Specifies whether default values for a new row/column should be copied from the last row/column.
10043
+ *
10044
+ * If you also specify `defaultValue`, it will be merged with the copied values.
9975
10045
  */
9976
10046
  get defaultValueFromLastRow(): boolean;
9977
10047
  set defaultValueFromLastRow(val: boolean);
@@ -9986,39 +10056,61 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
9986
10056
  set rowCount(val: number);
9987
10057
  protected updateProgressInfoByValues(res: IProgressInfo): void;
9988
10058
  /*
9989
- * Set this property to true, to allow rows drag and drop.
10059
+ * Specifies whether users can drag and drop matrix rows to reorder them.
10060
+ *
10061
+ * Default value: `false`
9990
10062
  */
9991
10063
  get allowRowsDragAndDrop(): boolean;
9992
10064
  set allowRowsDragAndDrop(val: boolean);
9993
10065
  get iconDragElement(): string;
9994
10066
  protected createRenderedTable(): QuestionMatrixDropdownRenderedTable;
9995
10067
  /*
9996
- * The minimum row count. A user could not delete a row if the rowCount equals to minRowCount
10068
+ * A minimum number of rows in the matrix. Users cannot delete rows if `rowCount` equals `minRowCount`.
10069
+ *
10070
+ * Default value: 0
9997
10071
  */
9998
10072
  get minRowCount(): number;
9999
10073
  set minRowCount(val: number);
10000
10074
  /*
10001
- * The maximum row count. A user could not add a row if the rowCount equals to maxRowCount
10075
+ * A maximum number of rows in the matrix. Users cannot add new rows if `rowCount` equals `maxRowCount`.
10076
+ *
10077
+ * Default value: 1000 (inherited from [`settings.matrixMaximumRowCount`](https://surveyjs.io/form-library/documentation/settings#matrixMaximumRowCount))
10002
10078
  */
10003
10079
  get maxRowCount(): number;
10004
10080
  set maxRowCount(val: number);
10005
10081
  /*
10006
- * Set this property to false to disable ability to add new rows. "Add new Row" button becomes invsible in UI
10082
+ * Specifies whether users are allowed to add new rows.
10083
+ *
10084
+ * Default value: `true`
10007
10085
  */
10008
10086
  get allowAddRows(): boolean;
10009
10087
  set allowAddRows(val: boolean);
10010
10088
  /*
10011
- * Set this property to false to disable ability to remove rows. "Remove" row buttons become invsible in UI
10089
+ * Specifies whether users are allowed to delete rows.
10090
+ *
10091
+ * Default value: `true`
10012
10092
  */
10013
10093
  get allowRemoveRows(): boolean;
10014
10094
  set allowRemoveRows(val: boolean);
10015
10095
  /*
10016
- * Returns true, if a new row can be added.
10096
+ * Indicates whether it is possible to add a new row.
10097
+ *
10098
+ * This property returns `true` when all of the following conditions apply:
10099
+ *
10100
+ * - 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`
10017
10103
  */
10018
10104
  get canAddRow(): boolean;
10019
10105
  canRemoveRowsCallback: (allow: boolean) => boolean;
10020
10106
  /*
10021
- * Returns true, if row can be removed.
10107
+ * Indicates whether it is possible to delete rows.
10108
+ *
10109
+ * This property returns `true` when all of the following conditions apply:
10110
+ *
10111
+ * - 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`
10022
10114
  */
10023
10115
  get canRemoveRows(): boolean;
10024
10116
  canRemoveRow(row: MatrixDropdownRowModelBase): boolean;
@@ -10031,7 +10123,7 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
10031
10123
  */
10032
10124
  addRow(): void;
10033
10125
  /*
10034
- * Set this property to true to show detail panel immediately on adding a new row.
10126
+ * Specifies whether to expand the detail section immediately when a respondent adds a new row.
10035
10127
  */
10036
10128
  get detailPanelShowOnAdding(): boolean;
10037
10129
  set detailPanelShowOnAdding(val: boolean);
@@ -10048,26 +10140,35 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
10048
10140
  */
10049
10141
  removeRow(index: number): void;
10050
10142
  /*
10051
- * Use this property to change the default text showing in the confirmation delete dialog on removing a row.
10143
+ * A message displayed in a confirmation dialog that appears when a respondent wants to delete a row.
10052
10144
  */
10053
10145
  get confirmDeleteText(): string;
10054
10146
  set confirmDeleteText(val: string);
10055
10147
  get locConfirmDeleteText(): LocalizableString;
10056
10148
  /*
10057
- * Use this property to change the default value of add row button text.
10149
+ * A caption for the Add Row button.
10058
10150
  */
10059
10151
  get addRowText(): string;
10060
10152
  set addRowText(val: string);
10061
10153
  get locAddRowText(): LocalizableString;
10062
10154
  /*
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).
10155
+ * Specifies the location of the Add Row button.
10156
+ *
10157
+ * Possible values:
10158
+ *
10159
+ * - `"top"` - Displays the Add Row button at the top of the matrix.
10160
+ * - `"bottom"` - Displays the Add Row button at the bottom of the matrix.
10161
+ * - `"topBottom"` - Displays the Add Row button at the top and bottom of the matrix.
10162
+ *
10163
+ * Default value: `"top"` if `columnLayout` is `vertical`; `"bottom"` if `columnLayout` is `"horizontal"` or the matrix is in compact mode.
10065
10164
  */
10066
10165
  get addRowLocation(): string;
10067
10166
  set addRowLocation(val: string);
10068
10167
  getAddRowLocation(): string;
10069
10168
  /*
10070
- * Set this property to true to hide matrix columns when there is no any row.
10169
+ * 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.
10170
+ *
10171
+ * Default value: `false`
10071
10172
  */
10072
10173
  get hideColumnsIfEmpty(): boolean;
10073
10174
  set hideColumnsIfEmpty(val: boolean);
@@ -10079,7 +10180,7 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
10079
10180
  set removeRowText(val: string);
10080
10181
  get locRemoveRowText(): LocalizableString;
10081
10182
  /*
10082
- * Use this property to change the default value of remove row button text.
10183
+ * A message displayed when the matrix does not contain any rows. Applies only if `hideColumnsIfEmpty` is enabled.
10083
10184
  */
10084
10185
  get emptyRowsText(): string;
10085
10186
  set emptyRowsText(val: string);
@@ -10102,7 +10203,9 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
10102
10203
  getRootCss(): string;
10103
10204
  }
10104
10205
  /*
10105
- * A Model for a radiogroup question.
10206
+ * A class that describes the Radiogroup question type.
10207
+ *
10208
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-radiogroup/ (linkStyle))
10106
10209
  */
10107
10210
  export declare class QuestionRadiogroupModel extends QuestionCheckboxBase {
10108
10211
  constructor(name: string);
@@ -10112,11 +10215,13 @@ export declare class QuestionRadiogroupModel extends QuestionCheckboxBase {
10112
10215
  get titleAriaLabel(): string;
10113
10216
  protected getFirstInputElementId(): string;
10114
10217
  /*
10115
- * Return the selected item in the radio group. Returns null if the value is empty
10218
+ * Returns the selected choice item. If no item is selected, returns `null`.
10116
10219
  */
10117
10220
  get selectedItem(): ItemValue;
10118
10221
  /*
10119
- * Show "clear button" flag.
10222
+ * Specifies whether to display a button that clears the question value.
10223
+ *
10224
+ * Default value: `false`
10120
10225
  */
10121
10226
  get showClearButton(): boolean;
10122
10227
  set showClearButton(val: boolean);
@@ -10127,7 +10232,9 @@ export declare class QuestionRadiogroupModel extends QuestionCheckboxBase {
10127
10232
  protected getDefaultTitleActions(): Array<Action>;
10128
10233
  }
10129
10234
  /*
10130
- * A Model for a ranking question
10235
+ * A class that describes the Ranking question type.
10236
+ *
10237
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-ranking/ (linkStyle))
10131
10238
  */
10132
10239
  export declare class QuestionRankingModel extends QuestionCheckboxModel {
10133
10240
  constructor(name: string);
@@ -10168,7 +10275,11 @@ export declare class QuestionRankingModel extends QuestionCheckboxModel {
10168
10275
  getIconHoverCss(): string;
10169
10276
  getIconFocusCss(): string;
10170
10277
  /*
10171
- * For mobile devices. Set this property to false, to disable the "long tap" before drag start. Default is true.
10278
+ * Specifies whether to use a long tap (press and hold) gesture to start dragging.
10279
+ *
10280
+ * Default value: `true`
10281
+ *
10282
+ * Disable this property if you want to start dragging when users perform a scroll gesture.
10172
10283
  */
10173
10284
  get longTap(): boolean;
10174
10285
  set longTap(val: boolean);
@@ -10482,6 +10593,7 @@ export declare var defaultActionBarCss: {
10482
10593
  export declare var defaultListCss: {
10483
10594
  root: string,
10484
10595
  item: string,
10596
+ loadingIndicator: string,
10485
10597
  itemSelected: string,
10486
10598
  itemWithIcon: string,
10487
10599
  itemDisabled: string,
@@ -11051,6 +11163,7 @@ export declare var defaultBootstrapCss: {
11051
11163
  root: string,
11052
11164
  selectWrapper: string,
11053
11165
  control: string,
11166
+ controlValue: string,
11054
11167
  other: string,
11055
11168
  cleanButton: string,
11056
11169
  cleanButtonSvg: string,
@@ -11389,6 +11502,7 @@ export declare var defaultBootstrapMaterialCss: {
11389
11502
  root: string,
11390
11503
  selectWrapper: string,
11391
11504
  control: string,
11505
+ controlValue: string,
11392
11506
  other: string,
11393
11507
  cleanButton: string,
11394
11508
  cleanButtonSvg: string,