survey-react 1.9.54 → 1.9.55

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.54
2
+ * Type definition for Survey JavaScript library for React v1.9.55
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
  */
@@ -388,6 +388,7 @@ export interface ISurvey extends ITextProcessor, ISurveyErrorOwner {
388
388
  getQuestionByValueNameFromArray(valueName: string, name: string, index: number): IQuestion;
389
389
  canChangeChoiceItemsVisibility(): boolean;
390
390
  getChoiceItemVisibility(question: IQuestion, item: any, val: boolean): boolean;
391
+ loadQuestionChoices(options: any): void;
391
392
  matrixRowAdded(question: IQuestion, row: any): any;
392
393
  matrixBeforeRowAdded(options: any): any;
393
394
  matrixRowRemoved(question: IQuestion, rowIndex: number, row: any): any;
@@ -1459,6 +1460,7 @@ export declare class SurveyActionBarSeparator extends React.Component<any, any>
1459
1460
  export declare class SurveyElementBase<P, S> extends React.Component<P, S> {
1460
1461
  constructor(props: any);
1461
1462
  static renderLocString(locStr: any, style?: any, key?: string): JSX.Element;
1463
+ static renderQuestionDescription(question: any): JSX.Element;
1462
1464
  changedStatePropNameValue: string;
1463
1465
  componentDidMount(): void;
1464
1466
  componentWillUnmount(): void;
@@ -1484,7 +1486,6 @@ export declare class SurveyElementHeader extends React.Component<any, any> {
1484
1486
  constructor(props: any);
1485
1487
  constructor(props: any, context: any);
1486
1488
  render(): JSX.Element;
1487
- protected renderDescription(): JSX.Element;
1488
1489
  }
1489
1490
  export declare class SurveyError {
1490
1491
  constructor(text?: string, errorOwner?: ISurveyErrorOwner);
@@ -2013,6 +2014,7 @@ export declare class DropdownListModel extends Base {
2013
2014
  constructor(question: Question, onSelectionChanged?: (item: IAction, ...params: any) => void);
2014
2015
  _popupModel: any;
2015
2016
  focusFirstInputSelector: string;
2017
+ itemsSettings: any;
2016
2018
  protected listModel: ListModel;
2017
2019
  protected popupCssClasses: string;
2018
2020
  protected onHidePopup(): void;
@@ -2023,6 +2025,7 @@ export declare class DropdownListModel extends Base {
2023
2025
  setInputHasValue(newValue: boolean): void;
2024
2026
  searchEnabled: boolean;
2025
2027
  filterString: string;
2028
+ hasScroll: boolean;
2026
2029
  get popupModel(): any;
2027
2030
  get inputReadOnly(): boolean;
2028
2031
  setSearchEnabled(newValue: boolean): void;
@@ -2031,6 +2034,7 @@ export declare class DropdownListModel extends Base {
2031
2034
  onClear(event: any): void;
2032
2035
  getSelectedAction(): Action;
2033
2036
  keyHandler(event: any): void;
2037
+ onScroll(event: any): void;
2034
2038
  onBlur(event: any): void;
2035
2039
  scrollToFocusedItem(): void;
2036
2040
  }
@@ -2283,10 +2287,12 @@ export declare class KeyDuplicationError extends SurveyError {
2283
2287
  }
2284
2288
  export declare class List extends SurveyElementBase<IListProps, any> {
2285
2289
  constructor(props: any);
2290
+ listContainerRef: any;
2286
2291
  get model(): any;
2287
2292
  handleKeydown: (event: any) => void;
2288
2293
  handleMouseMove: (event: any) => void;
2289
2294
  getStateElement(): any;
2295
+ componentDidMount(): void;
2290
2296
  renderElement(): JSX.Element;
2291
2297
  renderItems(): any;
2292
2298
  searchElementContent(): JSX.Element;
@@ -2299,6 +2305,7 @@ export declare class ListItem extends SurveyElementBase<IListItemProps, any> {
2299
2305
  handleKeydown: (event: any) => void;
2300
2306
  getStateElement(): any;
2301
2307
  render(): JSX.Element;
2308
+ componentDidMount(): void;
2302
2309
  }
2303
2310
  /*
2304
2311
  * The class represents the string that supports multi-languages and markdown.
@@ -3111,6 +3118,7 @@ export declare class SurveyElementCore extends Base implements ILocalizableOwner
3111
3118
  getTitleToolbar(): AdaptiveActionContainer;
3112
3119
  getTitleOwner(): ITitleOwner;
3113
3120
  get isTitleOwner(): boolean;
3121
+ get isTitleRenderedAsString(): boolean;
3114
3122
  toggleState(): boolean;
3115
3123
  get cssClasses(): any;
3116
3124
  get cssTitle(): string;
@@ -3119,6 +3127,7 @@ export declare class SurveyElementCore extends Base implements ILocalizableOwner
3119
3127
  get titleAriaExpanded(): boolean;
3120
3128
  get ariaLabel(): string;
3121
3129
  get titleAriaLabel(): string;
3130
+ protected getIsTitleRenderedAsString(): boolean;
3122
3131
  getLocale(): string;
3123
3132
  getMarkdownHtml(text: string, name: string): string;
3124
3133
  getRenderer(name: string): string;
@@ -3552,14 +3561,18 @@ export declare class ListModel extends ActionContainer {
3552
3561
  constructor(items: any, onSelectionChanged: (item: Action, ...params: any) => void, allowSelection: boolean, selectedItem?: IAction, onFilterStringChangedCallback?: (text: string) => void);
3553
3562
  onSelectionChanged: (item: Action, ...params: any) => void;
3554
3563
  allowSelection: boolean;
3564
+ listContainerHtmlElement: any;
3555
3565
  searchEnabled: boolean;
3556
3566
  showFilter: boolean;
3557
3567
  isExpanded: boolean;
3558
3568
  selectedItem: IAction;
3559
3569
  focusedItem: Action;
3560
3570
  filterString: string;
3571
+ hasVerticalScroller: boolean;
3572
+ isAllDataLoaded: boolean;
3561
3573
  static INDENT: number;
3562
3574
  static MINELEMENTCOUNT: number;
3575
+ scrollHandler: (e?: any) => void;
3563
3576
  isItemVisible(item: Action): boolean;
3564
3577
  get visibleItems(): any;
3565
3578
  protected onSet(): void;
@@ -3573,6 +3586,7 @@ export declare class ListModel extends ActionContainer {
3573
3586
  getItemIndent: (itemValue: any) => string;
3574
3587
  get filterStringPlaceholder(): string;
3575
3588
  get emptyMessage(): string;
3589
+ get scrollableContainer(): any;
3576
3590
  goToItems(event: any): void;
3577
3591
  onMouseMove(event: any): void;
3578
3592
  onKeyDown(event: any): void;
@@ -3585,6 +3599,11 @@ export declare class ListModel extends ActionContainer {
3585
3599
  focusNextVisibleItem(): void;
3586
3600
  focusPrevVisibleItem(): void;
3587
3601
  selectFocusedItem(): void;
3602
+ initListContainerHtmlElement(htmlElement: any): void;
3603
+ onLastItemRended(item: Action): void;
3604
+ scrollToFocusedItem(): void;
3605
+ addScrollEventListener(handler: (e?: any) => void): void;
3606
+ removeScrollEventListener(): void;
3588
3607
  }
3589
3608
  export declare class MatrixDropdownRowModel extends MatrixDropdownRowModelBase {
3590
3609
  constructor(name: string, item: ItemValue, data: IMatrixDropdownData, value: any);
@@ -3919,7 +3938,7 @@ export declare class SurveyElement<E = any> extends SurveyElementCore implements
3919
3938
  protected moveToBase(parent: IPanel, container: IPanel, insertBefore?: any): boolean;
3920
3939
  protected setPage(parent: IPanel, newPage: IPage): void;
3921
3940
  protected getSearchableLocKeys(keys: any): void;
3922
- protected get isDefaultV2Theme(): boolean;
3941
+ get isDefaultV2Theme(): boolean;
3923
3942
  get isErrorsModeTooltip(): boolean;
3924
3943
  protected getIsErrorsModeTooltip(): boolean;
3925
3944
  protected getIsTooltipErrorSupportedByParent(): boolean;
@@ -4440,6 +4459,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4440
4459
  * - `options.visible` - A Boolean value that specifies the item visibility. Set it to `false` to hide the item.
4441
4460
  */
4442
4461
  onShowingChoiceItem: EventBase<SurveyModel>;
4462
+ onChoicesLazyLoad: EventBase<SurveyModel>;
4443
4463
  /*
4444
4464
  * The event is fired on adding a new row in Matrix Dynamic question.
4445
4465
  * - `sender` - the survey object that fires the event
@@ -5523,6 +5543,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5523
5543
  whenPanelFocusIn(panel: IPanel): void;
5524
5544
  canChangeChoiceItemsVisibility(): boolean;
5525
5545
  getChoiceItemVisibility(question: IQuestion, item: any, val: boolean): boolean;
5546
+ loadQuestionChoices(options: any): void;
5526
5547
  matrixBeforeRowAdded(options: any): void;
5527
5548
  matrixRowAdded(question: IQuestion, row: any): void;
5528
5549
  getQuestionByValueNameFromArray(valueName: string, name: string, index: number): IQuestion;
@@ -5790,6 +5811,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5790
5811
  */
5791
5812
  get widthMode(): string;
5792
5813
  set widthMode(val: string);
5814
+ calculatedWidthModeUpdater: any;
5815
+ setCalculatedWidthModeUpdater(): void;
5793
5816
  calculatedWidthMode: string;
5794
5817
  calculateWidthMode(): string;
5795
5818
  /*
@@ -6730,6 +6753,7 @@ export declare class Question extends SurveyElement<Question> implements IQuesti
6730
6753
  get titleLocation(): string;
6731
6754
  set titleLocation(val: string);
6732
6755
  getTitleOwner(): ITitleOwner;
6756
+ protected getIsTitleRenderedAsString(): boolean;
6733
6757
  /*
6734
6758
  * Returns title location calculated based on the question's `titleLocation` property and the `questionTitleLocation` property of the question's containers (survey, page, or panel).
6735
6759
  */
@@ -7082,6 +7106,7 @@ export declare class Question extends SurveyElement<Question> implements IQuesti
7082
7106
  protected getValidName(name: string): string;
7083
7107
  updateValueFromSurvey(newValue: any): void;
7084
7108
  updateCommentFromSurvey(newValue: any): any;
7109
+ protected onChangeQuestionValue(newValue: any): void;
7085
7110
  protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
7086
7111
  onSurveyValueChanged(newValue: any): void;
7087
7112
  setVisibleIndex(val: number): number;
@@ -7522,10 +7547,12 @@ export declare class QuestionBooleanModel extends Question {
7522
7547
  set defaultValue(val: any);
7523
7548
  getDefaultValue(): any;
7524
7549
  get locTitle(): LocalizableString;
7550
+ showTitle: boolean;
7525
7551
  get label(): string;
7526
7552
  set label(val: string);
7527
7553
  get locLabel(): LocalizableString;
7528
- get locDisplayLabel(): LocalizableString;
7554
+ get isLabelRendered(): boolean;
7555
+ get canRenderLabelDescription(): boolean;
7529
7556
  /*
7530
7557
  * Gets or sets a text label that corresponds to a positive answer.
7531
7558
  *
@@ -7543,7 +7570,6 @@ export declare class QuestionBooleanModel extends Question {
7543
7570
  get labelFalse(): any;
7544
7571
  set labelFalse(val: any);
7545
7572
  get locLabelFalse(): LocalizableString;
7546
- showTitle: boolean;
7547
7573
  /*
7548
7574
  * A value to save in survey results when respondents give a positive answer.
7549
7575
  *
@@ -7719,6 +7745,7 @@ export declare class QuestionFileModel extends Question {
7719
7745
  * - `sender` - A question instance that raised the event.
7720
7746
  * - `options.state` - Current upload state: `"empty"`, `"loading"`, `"loaded"`, or `"error"`.
7721
7747
  */
7748
+ onUploadStateChanged: EventBase<QuestionFileModel>;
7722
7749
  onStateChanged: EventBase<QuestionFileModel>;
7723
7750
  previewValue: any;
7724
7751
  currentState: string;
@@ -7829,7 +7856,6 @@ export declare class QuestionFileModel extends Question {
7829
7856
  get showRemoveButton(): any;
7830
7857
  get showRemoveButtonBottom(): any;
7831
7858
  defaultImage(data: any): boolean;
7832
- get imageWidthRendered(): string;
7833
7859
  /*
7834
7860
  * Removes a file with a specified name.
7835
7861
  */
@@ -7841,7 +7867,6 @@ export declare class QuestionFileModel extends Question {
7841
7867
  loadFiles(files: any): void;
7842
7868
  canPreviewImage(fileItem: any): boolean;
7843
7869
  protected loadPreview(newValue: any): void;
7844
- protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
7845
7870
  protected onCheckForErrors(errors: any, isOnValueChanged: boolean): void;
7846
7871
  protected stateChanged(state: string): void;
7847
7872
  getPlainData(options?: any): any;
@@ -7850,6 +7875,7 @@ export declare class QuestionFileModel extends Question {
7850
7875
  getReadOnlyFileCss(): string;
7851
7876
  get fileRootCss(): string;
7852
7877
  getFileDecoratorCss(): string;
7878
+ protected onChangeQuestionValue(newValue: any): void;
7853
7879
  rootElement: any;
7854
7880
  afterRender(el: any): void;
7855
7881
  dragCounter: number;
@@ -7863,7 +7889,7 @@ export declare class QuestionFileModel extends Question {
7863
7889
  doDownloadFile: (event: any, data: any) => void;
7864
7890
  }
7865
7891
  /*
7866
- * A Model for a matrix base question.
7892
+ * A base class for all matrix question types.
7867
7893
  */
7868
7894
  export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
7869
7895
  constructor(name: string);
@@ -7877,34 +7903,56 @@ export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
7877
7903
  endLoadingFromJson(): void;
7878
7904
  get isCompositeQuestion(): boolean;
7879
7905
  /*
7880
- * Set this property to false, to hide table header. The default value is true.
7906
+ * Specifies whether to display the table header that contains column captions.
7907
+ *
7908
+ * Default value: `true`
7881
7909
  */
7882
7910
  get showHeader(): boolean;
7883
7911
  set showHeader(val: boolean);
7884
7912
  /*
7885
- * The list of columns. A column has a value and an optional text
7913
+ * An array of matrix columns.
7914
+ *
7915
+ * This array can contain primitive values or objects with the `text` (display value) and `value` (value to be saved in survey results) properties.
7916
+ *
7917
+ * [View Demo](https://surveyjs.io/form-library/examples/single-selection-matrix-table-question/ (linkStyle))
7886
7918
  */
7887
7919
  get columns(): any;
7888
7920
  set columns(val: any);
7889
7921
  get visibleColumns(): any;
7890
7922
  /*
7891
- * The list of rows. A row has a value and an optional text
7923
+ * An array of matrix rows.
7924
+ *
7925
+ * This array can contain primitive values or objects with the `text` (display value) and `value` (value to be saved in survey results) properties.
7926
+ *
7927
+ * [View Demo](https://surveyjs.io/form-library/examples/single-selection-matrix-table-question/ (linkStyle))
7892
7928
  */
7893
7929
  get rows(): any;
7894
7930
  set rows(val: any);
7895
7931
  protected processRowsOnSet(newRows: any): any;
7896
7932
  protected getVisibleRows(): Array<TRow>;
7897
7933
  /*
7898
- * Returns the list of visible rows as model objects.
7934
+ * Returns an array of visible matrix rows.
7899
7935
  */
7900
7936
  get visibleRows(): any;
7901
7937
  /*
7902
- * An expression that returns true or false. It runs against each row item and if for this item it returns true, then the item is visible otherwise the item becomes invisible. Please use {item} to get the current item value in the expression.
7938
+ * A Boolean expression that is evaluated against each matrix row. If the expression evaluates to `false`, the row becomes hidden.
7939
+ *
7940
+ * A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
7941
+ *
7942
+ * Use the `{item}` placeholder to reference the current row in the expression.
7943
+ *
7944
+ * Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
7903
7945
  */
7904
7946
  get rowsVisibleIf(): string;
7905
7947
  set rowsVisibleIf(val: string);
7906
7948
  /*
7907
- * An expression that returns true or false. It runs against each column item and if for this item it returns true, then the item is visible otherwise the item becomes invisible. Please use {item} to get the current item value in the expression.
7949
+ * A Boolean expression that is evaluated against each matrix column. If the expression evaluates to `false`, the column becomes hidden.
7950
+ *
7951
+ * A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
7952
+ *
7953
+ * Use the `{item}` placeholder to reference the current column in the expression.
7954
+ *
7955
+ * Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
7908
7956
  */
7909
7957
  get columnsVisibleIf(): string;
7910
7958
  set columnsVisibleIf(val: string);
@@ -9073,6 +9121,8 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
9073
9121
  searchEnabled: boolean;
9074
9122
  inputHasValue: boolean;
9075
9123
  readOnlyText: string;
9124
+ choicesLazyLoadEnabled: boolean;
9125
+ choicesLazyLoadPageSize: number;
9076
9126
  getControlClass(): string;
9077
9127
  get selectedItemLocText(): LocalizableString;
9078
9128
  get inputFieldComponentName(): string;
@@ -9088,7 +9138,9 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
9088
9138
  onKeyUp(event: any): void;
9089
9139
  }
9090
9140
  /*
9091
- * A Model for html question. Unlike other questions it doesn't have value and title.
9141
+ * A class that describes the Html question type. Unlike other question types, Html cannot have a title or value.
9142
+ *
9143
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-html/ (linkStyle))
9092
9144
  */
9093
9145
  export declare class QuestionHtmlModel extends QuestionNonValue {
9094
9146
  constructor(name: string);
@@ -9097,7 +9149,9 @@ export declare class QuestionHtmlModel extends QuestionNonValue {
9097
9149
  get isCompositeQuestion(): boolean;
9098
9150
  getProcessedText(text: string): string;
9099
9151
  /*
9100
- * Set html to display it
9152
+ * HTML markup to display.
9153
+ *
9154
+ * > IMPORTANT: If you get the markup from a third party, ensure that it does not contain malicious code.
9101
9155
  */
9102
9156
  get html(): string;
9103
9157
  set html(val: string);
@@ -9105,7 +9159,9 @@ export declare class QuestionHtmlModel extends QuestionNonValue {
9105
9159
  get processedHtml(): string;
9106
9160
  }
9107
9161
  /*
9108
- * A Model for image question. This question hasn't any functionality and can be used to improve the appearance of the survey.
9162
+ * A class that describes the Image question type. Unlike other question types, Image cannot have a title or value.
9163
+ *
9164
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-image/ (linkStyle))
9109
9165
  */
9110
9166
  export declare class QuestionImageModel extends QuestionNonValue {
9111
9167
  constructor(name: string);
@@ -9113,48 +9169,65 @@ export declare class QuestionImageModel extends QuestionNonValue {
9113
9169
  get isCompositeQuestion(): boolean;
9114
9170
  onSurveyLoad(): void;
9115
9171
  /*
9116
- * The image URL.
9172
+ * Specifies an image or video URL.
9117
9173
  */
9118
9174
  get imageLink(): string;
9119
9175
  set imageLink(val: string);
9120
9176
  get locImageLink(): LocalizableString;
9121
9177
  /*
9122
- * The image alt text.
9178
+ * Specifies a value for the `alt` attribute of the underlying `<img>` element.
9123
9179
  */
9124
9180
  get altText(): string;
9125
9181
  set altText(val: string);
9126
9182
  get locAltText(): LocalizableString;
9127
9183
  /*
9128
- * The image height.
9184
+ * Specifies the height of a container for the image or video. Accepts positive numbers and CSS values.
9185
+ *
9186
+ * Default value: 150
9187
+ *
9188
+ * Use the `imageFit` property to specify how to fit the image or video into the container.
9129
9189
  */
9130
9190
  get imageHeight(): string;
9131
9191
  set imageHeight(val: string);
9132
9192
  get renderedHeight(): string;
9133
9193
  /*
9134
- * The image width.
9194
+ * Specifies the width of a container for the image or video. Accepts positive numbers and CSS values.
9195
+ *
9196
+ * Default value: 200
9197
+ *
9198
+ * Use the `imageFit` property to specify how to fit the image or video into the container.
9135
9199
  */
9136
9200
  get imageWidth(): string;
9137
9201
  set imageWidth(val: string);
9138
9202
  get renderedWidth(): string;
9139
9203
  /*
9140
- * The image fit mode.
9204
+ * Specifies how to resize the image or video to fit it into its container.
9205
+ *
9206
+ * Refer to the [`object-fit`](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit) CSS property description for information on accepted values.
9141
9207
  */
9142
9208
  get imageFit(): string;
9143
9209
  set imageFit(val: string);
9144
9210
  /*
9145
- * The content mode.
9211
+ * Specifies the type of content that the Image question displays.
9212
+ *
9213
+ * Possible values:
9214
+ *
9215
+ * - `"image"` - An image in one of the following formats: JPEG, GIF, PNG, APNG, SVG, BMP, ICO.
9216
+ * - `"video"` - A video in one of the following formats: MP4, MOV, WMV, FLV, AVI, MKV.
9217
+ * - `"youtube"` - A link to a YouTube video.
9218
+ * - `"auto"` (default) - Selects one of the above based on the [`imageLink`](https://surveyjs.io/form-library/documentation/questionimagemodel#imageLink) property.
9146
9219
  */
9147
9220
  get contentMode(): string;
9148
9221
  set contentMode(val: string);
9149
9222
  /*
9150
- * The rendered mode.
9223
+ * Returns the type of content that the Image question displays: `"image"`, `"video"`, or `"youtube"`.
9151
9224
  */
9152
9225
  get renderedMode(): string;
9153
9226
  getImageCss(): string;
9154
9227
  protected calculateRenderedMode(): void;
9155
9228
  }
9156
9229
  /*
9157
- * A base class for matrix dropdown and matrix dynamic questions.
9230
+ * A base class for the [QuestionMatrixDropdownModel](https://surveyjs.io/form-library/documentation/questionmatrixdropdownmodel) and [QuestionMatrixDynamicModel](https://surveyjs.io/form-library/documentation/questionmatrixdynamicmodel) classes.
9158
9231
  */
9159
9232
  export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseModel<MatrixDropdownRowModelBase, MatrixDropdownColumn> implements IMatrixDropdownData {
9160
9233
  constructor(name: string);
@@ -9210,34 +9283,53 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9210
9283
  protected updateColumnsAndRows(): void;
9211
9284
  itemValuePropertyChanged(item: ItemValue, name: string, oldValue: any, newValue: any): void;
9212
9285
  /*
9213
- * Set columnLayout to 'vertical' to place columns vertically and rows horizontally. It makes sense when we have many columns and few rows.
9286
+ * Specifies the matrix layout. Set this property to `"vertical"` if you want to display columns instead of rows and rows instead of columns.
9287
+ *
9288
+ * Default value: `"horizontal"`
9214
9289
  */
9215
9290
  get columnLayout(): string;
9216
9291
  set columnLayout(val: string);
9217
9292
  get columnsLocation(): string;
9218
9293
  set columnsLocation(val: string);
9219
9294
  /*
9220
- * Returns true if columns are located horizontally
9295
+ * Returns `true` if columns are placed in the horizontal direction and rows in the vertical direction.
9296
+ *
9297
+ * To specify the layout, use the `columnLayout` property. If you set it to `"vertical"`, the survey applies it only when the screen has enough space. Otherwise, the survey falls back to the horizontal layout, but the `columnLayout` property remains set to `"vertical"`. Unlike `columnLayout`, the `isColumnLayoutHorizontal` property always indicates the current layout.
9221
9298
  */
9222
9299
  get isColumnLayoutHorizontal(): boolean;
9223
9300
  /*
9224
- * Set this property to true if you want to differ case sensitive values in unique columns, for example to allow enter "ABC" into the first row and "abc" into the second.
9225
- * It doesn't allow by default.
9301
+ * Enables case-sensitive comparison in columns with the `isUnique` property set to `true`.
9302
+ *
9303
+ * When this property is `true`, `"ABC"` and `"abc"` are considered different values.
9304
+ *
9305
+ * Default value: `false`
9226
9306
  */
9227
9307
  get isUniqueCaseSensitive(): boolean;
9228
9308
  set isUniqueCaseSensitive(val: boolean);
9229
9309
  /*
9230
- * Set the value to "underRow" to show the detailPanel under the row.
9310
+ * Specifies the location of detail sections.
9311
+ *
9312
+ * Possible values:
9313
+ *
9314
+ * - `"underRow"` - Displays detail sections under their respective rows. Users can expand any number of detail sections.
9315
+ * - `"underRowSingle"` - Displays detail sections under their respective rows, but only one detail section can be expanded at a time.
9316
+ * - `"none"` (default) - Hides detail sections.
9317
+ *
9318
+ * Use the `detailElements` property to specify content of detail sections.
9231
9319
  */
9232
9320
  get detailPanelMode(): string;
9233
9321
  set detailPanelMode(val: string);
9234
9322
  /*
9235
- * The detail template Panel. This panel is used as a template on creating detail panel for a row.
9323
+ * Contains a [`PanelModel`](https://surveyjs.io/form-library/documentation/panelmodel) instance that represents a detail section template.
9236
9324
  */
9237
9325
  get detailPanel(): PanelModel;
9238
9326
  getPanel(): IPanel;
9239
9327
  /*
9240
- * The template Panel elements, questions and panels.
9328
+ * An array of survey elements (questions and panels) to be displayed in detail sections.
9329
+ *
9330
+ * Detail sections are expandable panels displayed under each matrix row. You can use them to display questions that do not fit into the row.
9331
+ *
9332
+ * Set the `detailPanelMode` property to `"underRow"` or `"underRowSingle"` to display detail sections.
9241
9333
  */
9242
9334
  get detailElements(): any;
9243
9335
  protected createNewDetailPanel(): PanelModel;
@@ -9259,12 +9351,27 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9259
9351
  protected createRenderedTable(): QuestionMatrixDropdownRenderedTable;
9260
9352
  protected onMatrixRowCreated(row: MatrixDropdownRowModelBase): void;
9261
9353
  /*
9262
- * Use this property to change the default cell type.
9354
+ * Specifies the type of matrix cells. You can override this property for individual columns.
9355
+ *
9356
+ * Possible values:
9357
+ *
9358
+ * - `"dropdown"`
9359
+ * - `"checkbox"`
9360
+ * - `"radiogroup"`
9361
+ * - `"text"`
9362
+ * - `"comment"`
9363
+ * - `"boolean"`
9364
+ * - `"expression"`
9365
+ * - `"rating"`
9366
+ *
9367
+ * Default value: "dropdown" (inherited from [`settings.matrixDefaultCellType`](https://surveyjs.io/form-library/documentation/settings#matrixDefaultCellType))
9263
9368
  */
9264
9369
  get cellType(): string;
9265
9370
  set cellType(val: string);
9266
9371
  /*
9267
- * The default column count for radiogroup and checkbox cell types.
9372
+ * Specifies the number of columns in Radiogroup and Checkbox cells.
9373
+ *
9374
+ * Default value: 0 (the number of columns is selected automatically based on the available column width)
9268
9375
  */
9269
9376
  get columnColCount(): number;
9270
9377
  set columnColCount(val: number);
@@ -9273,14 +9380,8 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9273
9380
  */
9274
9381
  get columnMinWidth(): string;
9275
9382
  set columnMinWidth(val: string);
9276
- /*
9277
- * Set this property to true to show the horizontal scroll.
9278
- */
9279
9383
  get horizontalScroll(): boolean;
9280
9384
  set horizontalScroll(val: boolean);
9281
- /*
9282
- * The Matrix toolbar and inner panel toolbars get adaptive if the property is set to true.
9283
- */
9284
9385
  get allowAdaptiveActions(): boolean;
9285
9386
  set allowAdaptiveActions(val: boolean);
9286
9387
  getRequiredText(): string;
@@ -9308,21 +9409,29 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9308
9409
  protected runTotalsCondition(values: any, properties: any): void;
9309
9410
  locStrsChanged(): void;
9310
9411
  /*
9311
- * Returns the column by it's name. Returns null if a column with this name doesn't exist.
9412
+ * Returns a matrix column with a given `name` or `null` if a column with this is not found.
9312
9413
  */
9313
9414
  getColumnByName(columnName: string): MatrixDropdownColumn;
9314
9415
  getColumnName(columnName: string): MatrixDropdownColumn;
9315
- /*
9316
- * Returns the column width.
9317
- */
9318
9416
  getColumnWidth(column: MatrixDropdownColumn): string;
9319
9417
  /*
9320
- * The default choices for dropdown, checkbox and radiogroup cell types.
9418
+ * Gets or sets choice items for Dropdown, Checkbox, and Radiogroup matrix cells. You can override this property for individual columns.
9419
+ *
9420
+ * This property accepts an array of objects with the following structure:
9421
+ *
9422
+ * ```js
9423
+ * {
9424
+ * "value": any, // A value to be saved in survey results
9425
+ * "text": String, // A display text. This property supports Markdown. When `text` is undefined, `value` is used.
9426
+ * }
9427
+ * ```
9428
+ *
9429
+ * If you need to specify only the `value` property, you can set the `choices` property to an array of primitive values, for example, `[ "item1", "item2", "item3" ]`. These values are both saved in survey results and used as display text.
9321
9430
  */
9322
9431
  get choices(): any;
9323
9432
  set choices(val: any);
9324
9433
  /*
9325
- * The default placeholder for dropdown cell type.
9434
+ * A placeholder for Dropdown matrix cells.
9326
9435
  */
9327
9436
  get placeholder(): string;
9328
9437
  set placeholder(val: string);
@@ -9330,7 +9439,9 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9330
9439
  get optionsCaption(): string;
9331
9440
  set optionsCaption(val: string);
9332
9441
  /*
9333
- * The duplication value error text. Set it to show the text different from the default.
9442
+ * An error message displayed when users enter a duplicate value into a column that accepts only unique values (`isUnique` is set to `true`).
9443
+ *
9444
+ * 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).
9334
9445
  */
9335
9446
  get keyDuplicationError(): string;
9336
9447
  set keyDuplicationError(val: string);
@@ -9343,12 +9454,12 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9343
9454
  get visibleTotalRow(): MatrixDropdownRowModelBase;
9344
9455
  onSurveyLoad(): void;
9345
9456
  /*
9346
- * Returns the row value. If the row value is empty, the object is empty: {}.
9457
+ * Returns an object with row values. If a row has no answers, this method returns an empty object.
9347
9458
  */
9348
9459
  getRowValue(rowIndex: number): any;
9349
9460
  checkIfValueInRowDuplicated(checkedRow: MatrixDropdownRowModelBase, cellQuestion: Question): boolean;
9350
9461
  /*
9351
- * Set the row value.
9462
+ * Assigns values to a row.
9352
9463
  */
9353
9464
  setRowValue(rowIndex: number, rowValue: any): any;
9354
9465
  protected generateRows(): Array<MatrixDropdownRowModelBase>;
@@ -9696,7 +9807,9 @@ export declare class QuestionCheckboxModel extends QuestionCheckboxBase {
9696
9807
  get checkBoxSvgPath(): string;
9697
9808
  }
9698
9809
  /*
9699
- * A Model for a select image question.
9810
+ * A class that describes the Image Picker question type.
9811
+ *
9812
+ * [View Demo](https://surveyjs.io/form-library/examples/image-picker-question/ (linkStyle))
9700
9813
  */
9701
9814
  export declare class QuestionImagePickerModel extends QuestionCheckboxBase {
9702
9815
  constructor(name: string);
@@ -9709,18 +9822,17 @@ export declare class QuestionImagePickerModel extends QuestionCheckboxBase {
9709
9822
  supportNone(): boolean;
9710
9823
  isAnswerCorrect(): boolean;
9711
9824
  /*
9712
- * Multi select option. If set to true, then allows to select multiple images.
9825
+ * Specifies whether users can select multiple images or videos.
9826
+ *
9827
+ * Default value: `false`
9713
9828
  */
9714
9829
  get multiSelect(): boolean;
9715
9830
  set multiSelect(val: boolean);
9716
- /*
9717
- * Returns true if item is checked
9718
- */
9719
9831
  isItemSelected(item: ItemValue): boolean;
9720
9832
  clearIncorrectValues(): void;
9721
9833
  protected getDisplayValueCore(keysAsText: boolean, value: any): any;
9722
9834
  /*
9723
- * Show label under the image.
9835
+ * Specifies whether to display labels under images or videos. Labels text are taken from the `text` property of each object in the `choices` array.
9724
9836
  */
9725
9837
  get showLabel(): boolean;
9726
9838
  set showLabel(val: boolean);
@@ -9729,26 +9841,43 @@ export declare class QuestionImagePickerModel extends QuestionCheckboxBase {
9729
9841
  protected renderedValueFromDataCore(val: any): any;
9730
9842
  protected rendredValueToDataCore(val: any): any;
9731
9843
  /*
9732
- * The image height.
9844
+ * Specifies the height of containers for images or videos. Accepts positive numbers and CSS values.
9845
+ *
9846
+ * Default value: undefined
9847
+ *
9848
+ * Use the `imageFit` property to specify how to fit the images or videos into their containers.
9733
9849
  */
9734
9850
  get imageHeight(): number;
9735
9851
  set imageHeight(val: number);
9736
9852
  responsiveImageHeight: number;
9737
9853
  get renderedImageHeight(): string;
9738
9854
  /*
9739
- * The image width.
9855
+ * Specifies the width of containers for images or videos. Accepts positive numbers and CSS values.
9856
+ *
9857
+ * Default value: 200
9858
+ *
9859
+ * Use the `imageFit` property to specify how to fit the images or videos into their containers.
9740
9860
  */
9741
9861
  get imageWidth(): number;
9742
9862
  set imageWidth(val: number);
9743
9863
  responsiveImageWidth: number;
9744
9864
  get renderedImageWidth(): string;
9745
9865
  /*
9746
- * The image fit mode.
9866
+ * Specifies how to resize images or videos to fit them into their containers.
9867
+ *
9868
+ * Refer to the [`object-fit`](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit) CSS property description for information on accepted values.
9747
9869
  */
9748
9870
  get imageFit(): string;
9749
9871
  set imageFit(val: string);
9750
9872
  /*
9751
- * The content mode.
9873
+ * Specifies the type of content that choice items display.
9874
+ *
9875
+ * Possible values:
9876
+ *
9877
+ * - `"image"` - Images in one of the following formats: JPEG, GIF, PNG, APNG, SVG, BMP, ICO.
9878
+ * - `"video"` - Videos in one of the following formats: MP4, MOV, WMV, FLV, AVI, MKV.
9879
+ * - `"youtube"` - Links to YouTube videos.
9880
+ * - `"auto"` (default) - Selects one of the above based on the `imageLink` property value of each choice item.
9752
9881
  */
9753
9882
  get contentMode(): string;
9754
9883
  set contentMode(val: string);
@@ -10065,6 +10194,8 @@ export declare class QuestionTagboxModel extends QuestionCheckboxModel {
10065
10194
  * Specifies whether to remove selected items from the drop-down list.
10066
10195
  */
10067
10196
  hideSelectedItems: boolean;
10197
+ choicesLazyLoadEnabled: boolean;
10198
+ choicesLazyLoadPageSize: number;
10068
10199
  /*
10069
10200
  * A text displayed in the input field when it doesn't have a value.
10070
10201
  */
@@ -10737,6 +10868,7 @@ export declare var matrixDropdownColumnTypes: {
10737
10868
  radiogroup: {
10738
10869
  onCellQuestionUpdate: (cellQuestion: any, column: any, question: any, data: any) => void,
10739
10870
  },
10871
+ tagbox: any,
10740
10872
  text: any,
10741
10873
  comment: any,
10742
10874
  boolean: {