survey-react 1.9.53 → 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.53
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;
@@ -891,11 +892,11 @@ export declare class Base {
891
892
  protected runConditionCore(values: any, properties: any): void;
892
893
  protected canRunConditions(): boolean;
893
894
  /*
894
- * Register a function that will be called on a property value changed from the propertyNames list.
895
+ * Registers a function to call when a property value changes.
895
896
  */
896
897
  registerPropertyChangedHandlers(propertyNames: any, handler: any, key?: string): void;
897
898
  /*
898
- * Unregister notification on property value changed for all properties in the propetyNames list.
899
+ * Unregisters value change event handlers for the specified properties.
899
900
  */
900
901
  unregisterPropertyChangedHandlers(propertyNames: any, key?: string): void;
901
902
  registerFunctionOnPropertyValueChanged(name: string, func: any, key?: string): void;
@@ -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);
@@ -3725,7 +3744,7 @@ export declare class SurveyCustomWidget extends SurveyQuestionElementBase {
3725
3744
  /*
3726
3745
  * A base class for all survey elements.
3727
3746
  */
3728
- export declare class SurveyElement extends SurveyElementCore implements ISurveyElement {
3747
+ export declare class SurveyElement<E = any> extends SurveyElementCore implements ISurveyElement {
3729
3748
  constructor(name: string);
3730
3749
  stateChangedCallback: any;
3731
3750
  static getProgressInfoByElements(children: any, isRequired: boolean): IProgressInfo;
@@ -3733,7 +3752,7 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
3733
3752
  surveyDataValue: ISurveyData;
3734
3753
  surveyValue: ISurvey;
3735
3754
  textProcessorValue: ITextProcessor;
3736
- selectedElementInDesignValue: SurveyElement;
3755
+ selectedElementInDesignValue: any;
3737
3756
  dragTypeOverMe: DragTypeOverMeEnum;
3738
3757
  isDragMe: boolean;
3739
3758
  readOnlyChangedCallback: any;
@@ -3744,6 +3763,15 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
3744
3763
  disableDesignActions: boolean;
3745
3764
  protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
3746
3765
  protected getSkeletonComponentNameCore(): string;
3766
+ parentQuestionValue: any;
3767
+ /*
3768
+ * A Dynamic Panel, Dynamic Matrix, or Dropdown Matrix that includes the current question.
3769
+ *
3770
+ * This property is `null` for standalone questions.
3771
+ */
3772
+ get parentQuestion(): any;
3773
+ setParentQuestion(val: any): void;
3774
+ protected onParentQuestionChanged(): void;
3747
3775
  get skeletonComponentName(): string;
3748
3776
  /*
3749
3777
  * Gets and sets the survey element's expand state.
@@ -3863,8 +3891,8 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
3863
3891
  get containsErrors(): boolean;
3864
3892
  updateContainsErrors(): void;
3865
3893
  protected getContainsErrors(): boolean;
3866
- get selectedElementInDesign(): SurveyElement;
3867
- set selectedElementInDesign(val: SurveyElement);
3894
+ get selectedElementInDesign(): any;
3895
+ set selectedElementInDesign(val: any);
3868
3896
  updateCustomWidgets(): void;
3869
3897
  onSurveyLoad(): void;
3870
3898
  onFirstRendering(): void;
@@ -3910,9 +3938,11 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
3910
3938
  protected moveToBase(parent: IPanel, container: IPanel, insertBefore?: any): boolean;
3911
3939
  protected setPage(parent: IPanel, newPage: IPage): void;
3912
3940
  protected getSearchableLocKeys(keys: any): void;
3913
- protected get isDefaultV2Theme(): boolean;
3941
+ get isDefaultV2Theme(): boolean;
3914
3942
  get isErrorsModeTooltip(): boolean;
3915
3943
  protected getIsErrorsModeTooltip(): boolean;
3944
+ protected getIsTooltipErrorSupportedByParent(): boolean;
3945
+ protected getIsTooltipErrorInsideSupported(): boolean;
3916
3946
  get hasParent(): boolean;
3917
3947
  isSingleInRow: boolean;
3918
3948
  protected get hasFrameV2(): boolean;
@@ -4429,6 +4459,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4429
4459
  * - `options.visible` - A Boolean value that specifies the item visibility. Set it to `false` to hide the item.
4430
4460
  */
4431
4461
  onShowingChoiceItem: EventBase<SurveyModel>;
4462
+ onChoicesLazyLoad: EventBase<SurveyModel>;
4432
4463
  /*
4433
4464
  * The event is fired on adding a new row in Matrix Dynamic question.
4434
4465
  * - `sender` - the survey object that fires the event
@@ -5512,6 +5543,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5512
5543
  whenPanelFocusIn(panel: IPanel): void;
5513
5544
  canChangeChoiceItemsVisibility(): boolean;
5514
5545
  getChoiceItemVisibility(question: IQuestion, item: any, val: boolean): boolean;
5546
+ loadQuestionChoices(options: any): void;
5515
5547
  matrixBeforeRowAdded(options: any): void;
5516
5548
  matrixRowAdded(question: IQuestion, row: any): void;
5517
5549
  getQuestionByValueNameFromArray(valueName: string, name: string, index: number): IQuestion;
@@ -5779,6 +5811,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5779
5811
  */
5780
5812
  get widthMode(): string;
5781
5813
  set widthMode(val: string);
5814
+ calculatedWidthModeUpdater: any;
5815
+ setCalculatedWidthModeUpdater(): void;
5782
5816
  calculatedWidthMode: string;
5783
5817
  calculateWidthMode(): string;
5784
5818
  /*
@@ -6287,7 +6321,7 @@ export declare class MultiSelectListModel extends ListModel {
6287
6321
  /*
6288
6322
  * A base class for a Panel and Page objects.
6289
6323
  */
6290
- export declare class PanelModelBase extends SurveyElement implements IPanel, IConditionRunner, ISurveyErrorOwner, ITitleOwner {
6324
+ export declare class PanelModelBase extends SurveyElement<Question> implements IPanel, IConditionRunner, ISurveyErrorOwner, ITitleOwner {
6291
6325
  constructor(name?: string);
6292
6326
  static panelCounter: number;
6293
6327
  elementsValue: any;
@@ -6419,7 +6453,7 @@ export declare class PanelModelBase extends SurveyElement implements IPanel, ICo
6419
6453
  protected hasErrorsCore(rec: any): void;
6420
6454
  protected getContainsErrors(): boolean;
6421
6455
  updateElementVisibility(): void;
6422
- getFirstQuestionToFocus(withError?: boolean): Question;
6456
+ getFirstQuestionToFocus(withError?: boolean, ignoreCollapseState?: boolean): Question;
6423
6457
  /*
6424
6458
  * Call it to focus the input on the first question
6425
6459
  */
@@ -6549,7 +6583,7 @@ export declare class PanelModelBase extends SurveyElement implements IPanel, ICo
6549
6583
  /*
6550
6584
  * A base class for all questions.
6551
6585
  */
6552
- export declare class Question extends SurveyElement implements IQuestion, IConditionRunner, IValidatorOwner, ITitleOwner {
6586
+ export declare class Question extends SurveyElement<Question> implements IQuestion, IConditionRunner, IValidatorOwner, ITitleOwner {
6553
6587
  constructor(name: string);
6554
6588
  static TextPreprocessorValuesMap: any;
6555
6589
  static questionCounter: number;
@@ -6696,15 +6730,6 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6696
6730
  */
6697
6731
  get parent(): IPanel;
6698
6732
  set parent(val: IPanel);
6699
- parentQuestionValue: Question;
6700
- /*
6701
- * A Dynamic Panel, Dynamic Matrix, or Dropdown Matrix that includes the current question.
6702
- *
6703
- * This property is `null` for standalone questions.
6704
- */
6705
- get parentQuestion(): Question;
6706
- setParentQuestion(val: Question): void;
6707
- protected onParentQuestionChanged(): void;
6708
6733
  protected onParentChanged(): void;
6709
6734
  /*
6710
6735
  * Returns `false` if the `titleLocation` property is set to `"hidden"` or if the question cannot have a title (for example, an [HTML](https://surveyjs.io/form-library/documentation/questionhtmlmodel) question).
@@ -6728,6 +6753,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6728
6753
  get titleLocation(): string;
6729
6754
  set titleLocation(val: string);
6730
6755
  getTitleOwner(): ITitleOwner;
6756
+ protected getIsTitleRenderedAsString(): boolean;
6731
6757
  /*
6732
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).
6733
6759
  */
@@ -6771,13 +6797,13 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6771
6797
  set requiredErrorText(val: string);
6772
6798
  get locRequiredErrorText(): LocalizableString;
6773
6799
  /*
6774
- * Specifies a caption displayed above the comment area. Applies when the `hasComment` property is `true`.
6800
+ * Specifies a caption displayed above the comment area. Applies when the `showCommentArea` property is `true`.
6775
6801
  */
6776
6802
  get commentText(): string;
6777
6803
  set commentText(val: string);
6778
6804
  get locCommentText(): LocalizableString;
6779
6805
  /*
6780
- * A placeholder for the comment area. Applies when the `hasComment` property is `true`.
6806
+ * A placeholder for the comment area. Applies when the `showCommentArea` property is `true`.
6781
6807
  */
6782
6808
  get commentPlaceholder(): string;
6783
6809
  set commentPlaceholder(val: string);
@@ -6828,6 +6854,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6828
6854
  showErrorOnCore(location: string): boolean;
6829
6855
  get showErrorOnTop(): boolean;
6830
6856
  get showErrorOnBottom(): boolean;
6857
+ protected getIsTooltipErrorSupportedByParent(): boolean;
6831
6858
  get showErrorsAboveQuestion(): boolean;
6832
6859
  get showErrorsBelowQuestion(): boolean;
6833
6860
  get cssError(): string;
@@ -6883,7 +6910,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6883
6910
  get ariaTitleId(): string;
6884
6911
  get ariaRole(): string;
6885
6912
  /*
6886
- * Specifies whether to display the "Other" choice item. Incompatible with the `hasComment` property.
6913
+ * Specifies whether to display the "Other" choice item. Incompatible with the `showCommentArea` property.
6887
6914
  */
6888
6915
  get showOtherItem(): boolean;
6889
6916
  set showOtherItem(val: boolean);
@@ -7017,7 +7044,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
7017
7044
  protected isValueExpression(val: any): boolean;
7018
7045
  protected setValueAndRunExpression(runner: ExpressionRunner, defaultValue: any, setFunc: (val: any) => void, values?: any, properties?: any): void;
7019
7046
  /*
7020
- * A comment to the selected question value. Enable the `hasComment` property to allow users to leave comments.
7047
+ * A comment to the selected question value. Enable the `showCommentArea` property to allow users to leave comments.
7021
7048
  */
7022
7049
  get comment(): string;
7023
7050
  set comment(val: string);
@@ -7079,6 +7106,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
7079
7106
  protected getValidName(name: string): string;
7080
7107
  updateValueFromSurvey(newValue: any): void;
7081
7108
  updateCommentFromSurvey(newValue: any): any;
7109
+ protected onChangeQuestionValue(newValue: any): void;
7082
7110
  protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
7083
7111
  onSurveyValueChanged(newValue: any): void;
7084
7112
  setVisibleIndex(val: number): number;
@@ -7256,6 +7284,7 @@ export declare class SurveyTriggerComplete extends SurveyTrigger {
7256
7284
  */
7257
7285
  export declare class SurveyTriggerCopyValue extends SurveyTrigger {
7258
7286
  constructor();
7287
+ protected canBeExecuted(isOnNextPage: boolean): boolean;
7259
7288
  get setToName(): string;
7260
7289
  set setToName(val: string);
7261
7290
  get fromName(): string;
@@ -7281,6 +7310,7 @@ export declare class SurveyTriggerRunExpression extends SurveyTrigger {
7281
7310
  export declare class SurveyTriggerSetValue extends SurveyTrigger {
7282
7311
  constructor();
7283
7312
  getType(): string;
7313
+ protected canBeExecuted(isOnNextPage: boolean): boolean;
7284
7314
  protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
7285
7315
  get setToName(): string;
7286
7316
  set setToName(val: string);
@@ -7511,19 +7541,18 @@ export declare class QuestionBooleanModel extends Question {
7511
7541
  */
7512
7542
  get booleanValue(): any;
7513
7543
  set booleanValue(val: any);
7514
- /*
7515
- * Obsolete, please use booleanValue property
7516
- */
7517
7544
  get checkedValue(): any;
7518
7545
  set checkedValue(val: any);
7519
7546
  get defaultValue(): any;
7520
7547
  set defaultValue(val: any);
7521
7548
  getDefaultValue(): any;
7522
7549
  get locTitle(): LocalizableString;
7550
+ showTitle: boolean;
7523
7551
  get label(): string;
7524
7552
  set label(val: string);
7525
7553
  get locLabel(): LocalizableString;
7526
- get locDisplayLabel(): LocalizableString;
7554
+ get isLabelRendered(): boolean;
7555
+ get canRenderLabelDescription(): boolean;
7527
7556
  /*
7528
7557
  * Gets or sets a text label that corresponds to a positive answer.
7529
7558
  *
@@ -7541,7 +7570,6 @@ export declare class QuestionBooleanModel extends Question {
7541
7570
  get labelFalse(): any;
7542
7571
  set labelFalse(val: any);
7543
7572
  get locLabelFalse(): LocalizableString;
7544
- showTitle: boolean;
7545
7573
  /*
7546
7574
  * A value to save in survey results when respondents give a positive answer.
7547
7575
  *
@@ -7580,7 +7608,7 @@ export declare class QuestionCustomModelBase extends Question implements ISurvey
7580
7608
  itemValuePropertyChanged(item: ItemValue, name: string, oldValue: any, newValue: any): void;
7581
7609
  onFirstRendering(): void;
7582
7610
  protected getElement(): SurveyElement;
7583
- protected initElement(el: SurveyElement): void;
7611
+ protected initElement(el: any): void;
7584
7612
  setSurveyImpl(value: ISurveyImpl, isLight?: boolean): void;
7585
7613
  onSurveyLoad(): void;
7586
7614
  afterRenderQuestionElement(el: any): void;
@@ -7701,38 +7729,48 @@ export declare class QuestionExpressionModel extends Question {
7701
7729
  protected getValueAsStr(val: any): string;
7702
7730
  }
7703
7731
  /*
7704
- * A Model for a file question
7732
+ * A class that describes the File question type.
7733
+ *
7734
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-file/ (linkStyle))
7705
7735
  */
7706
7736
  export declare class QuestionFileModel extends Question {
7707
7737
  constructor(name: string);
7708
7738
  isUploading: boolean;
7709
7739
  isDragging: boolean;
7710
7740
  /*
7711
- * The event is fired after question state has been changed.
7712
- * sender the question object that fires the event
7713
- * options.state new question state value.
7741
+ * An event that is raised after the upload state has changed.
7742
+ *
7743
+ * Parameters:
7744
+ *
7745
+ * - `sender` - A question instance that raised the event.
7746
+ * - `options.state` - Current upload state: `"empty"`, `"loading"`, `"loaded"`, or `"error"`.
7714
7747
  */
7748
+ onUploadStateChanged: EventBase<QuestionFileModel>;
7715
7749
  onStateChanged: EventBase<QuestionFileModel>;
7716
7750
  previewValue: any;
7717
7751
  currentState: string;
7718
7752
  indexToShow: number;
7719
7753
  containsMultiplyFiles: boolean;
7720
7754
  mobileFileNavigator: any;
7721
- prevFileAction: Action;
7722
- nextFileAction: Action;
7723
- fileIndexAction: Action;
7755
+ protected prevFileAction: Action;
7756
+ protected nextFileAction: Action;
7757
+ protected fileIndexAction: Action;
7724
7758
  get mobileFileNavigatorVisible(): boolean;
7725
7759
  protected updateElementCssCore(cssClasses: any): void;
7726
7760
  isPreviewVisible(index: number): boolean;
7727
7761
  getType(): string;
7728
7762
  clearOnDeletingContainer(): void;
7729
7763
  /*
7730
- * Set it to true, to show the preview for the image files.
7764
+ * Disable this property only to implement a custom preview.
7765
+ *
7766
+ * [View "Custom Preview" Demo](https://surveyjs.io/form-library/examples/file-custom-preview/ (linkStyle))
7731
7767
  */
7732
7768
  get showPreview(): boolean;
7733
7769
  set showPreview(val: boolean);
7734
7770
  /*
7735
- * Set it to true, to allow select multiple files.
7771
+ * Specifies whether users can upload multiple files.
7772
+ *
7773
+ * Default value: `false`
7736
7774
  */
7737
7775
  get allowMultiple(): boolean;
7738
7776
  set allowMultiple(val: boolean);
@@ -7747,116 +7785,88 @@ export declare class QuestionFileModel extends Question {
7747
7785
  get imageWidth(): string;
7748
7786
  set imageWidth(val: string);
7749
7787
  /*
7750
- * Accepted file types. Passed to the 'accept' attribute of the file input tag. See https://www.w3schools.com/tags/att_input_accept.asp for more details.
7788
+ * An [accept](https://www.w3schools.com/tags/att_input_accept.asp) attribute value for the underlying `<input>` element.
7751
7789
  */
7752
7790
  get acceptedTypes(): string;
7753
7791
  set acceptedTypes(val: string);
7754
7792
  /*
7755
- * Set it to false if you do not want to serialize file content as text in the survey.data.
7756
- * In this case, you have to write the code onUploadFiles event to store the file content.
7793
+ * Specifies whether to store file content as text in `SurveyModel`'s [`data`](https://surveyjs.io/form-library/documentation/surveymodel#data) property.
7794
+ *
7795
+ * If you disable this property, implement `SurveyModel`'s [`onUploadFiles`](https://surveyjs.io/form-library/documentation/surveymodel#onUploadFiles) event handler to specify how to store file content.
7757
7796
  */
7758
7797
  get storeDataAsText(): boolean;
7759
7798
  set storeDataAsText(val: boolean);
7760
7799
  /*
7761
- * Set it to true if you want to wait until files will be uploaded to your server.
7800
+ * Enable this property if you want to wait until files are uploaded to complete the survey.
7801
+ *
7802
+ * Default value: `false`
7762
7803
  */
7763
7804
  get waitForUpload(): boolean;
7764
7805
  set waitForUpload(val: boolean);
7765
7806
  /*
7766
- * Set it to false if you want to disable images preview.
7807
+ * Specifies whether to show a preview of image files.
7767
7808
  */
7768
7809
  get allowImagesPreview(): boolean;
7769
7810
  set allowImagesPreview(val: boolean);
7770
7811
  /*
7771
- * Use this property to setup the maximum allowed file size.
7812
+ * Maximum allowed file size, measured in bytes.
7813
+ *
7814
+ * Default value: 0 (unlimited)
7772
7815
  */
7773
7816
  get maxSize(): number;
7774
7817
  set maxSize(val: number);
7775
7818
  /*
7776
- * Use this property to setup confirmation to remove file.
7819
+ * Specifies whether users should confirm file deletion.
7820
+ *
7821
+ * Default value: `false`
7777
7822
  */
7778
7823
  get needConfirmRemoveFile(): boolean;
7779
7824
  set needConfirmRemoveFile(val: boolean);
7780
- /*
7781
- * The remove file confirmation message.
7782
- */
7783
7825
  getConfirmRemoveMessage(fileName: string): string;
7784
- /*
7785
- * The remove file confirmation message template.
7786
- */
7787
7826
  get confirmRemoveMessage(): string;
7788
7827
  set confirmRemoveMessage(val: string);
7789
7828
  get locConfirmRemoveMessage(): LocalizableString;
7790
- /*
7791
- * The remove all files confirmation message.
7792
- */
7793
7829
  get confirmRemoveAllMessage(): string;
7794
7830
  set confirmRemoveAllMessage(val: string);
7795
7831
  get locConfirmRemoveAllMessage(): LocalizableString;
7796
- /*
7797
- * The no file chosen caption for modern theme.
7798
- */
7799
7832
  get noFileChosenCaption(): string;
7800
7833
  set noFileChosenCaption(val: string);
7801
7834
  get locNoFileChosenCaption(): LocalizableString;
7802
- /*
7803
- * The choose files button caption for modern theme.
7804
- */
7805
7835
  get chooseButtonCaption(): string;
7806
7836
  set chooseButtonCaption(val: string);
7807
7837
  get locChooseButtonCaption(): LocalizableString;
7808
- /*
7809
- * The clean files button caption.
7810
- */
7811
- get cleanButtonCaption(): string;
7812
- set cleanButtonCaption(val: string);
7813
- get locCleanButtonCaption(): LocalizableString;
7814
- /*
7815
- * The remove file button caption.
7816
- */
7838
+ get clearButtonCaption(): string;
7839
+ set clearButtonCaption(val: string);
7840
+ get locClearButtonCaption(): LocalizableString;
7817
7841
  get removeFileCaption(): string;
7818
7842
  set removeFileCaption(val: string);
7819
7843
  get locRemoveFileCaption(): LocalizableString;
7820
- /*
7821
- * The loading file input title.
7822
- */
7823
7844
  get loadingFileTitle(): string;
7824
7845
  set loadingFileTitle(val: string);
7825
7846
  get locLoadingFileTitle(): LocalizableString;
7826
- /*
7827
- * The choose file input title.
7828
- */
7829
7847
  get chooseFileTitle(): string;
7830
7848
  set chooseFileTitle(val: string);
7831
7849
  get locChooseFileTitle(): LocalizableString;
7832
7850
  get dragAreaPlaceholder(): string;
7833
7851
  set dragAreaPlaceholder(val: string);
7834
7852
  get locDragAreaPlaceholder(): LocalizableString;
7835
- /*
7836
- * The input title value.
7837
- */
7838
7853
  get inputTitle(): string;
7839
- /*
7840
- * Clear value programmatically.
7841
- */
7842
7854
  clear(doneCallback?: any): void;
7843
7855
  get multipleRendered(): string;
7844
7856
  get showRemoveButton(): any;
7845
7857
  get showRemoveButtonBottom(): any;
7846
7858
  defaultImage(data: any): boolean;
7847
- get imageWidthRendered(): string;
7848
7859
  /*
7849
- * Remove file item programmatically.
7860
+ * Removes a file with a specified name.
7850
7861
  */
7851
7862
  removeFile(name: string): void;
7852
7863
  protected removeFileByContent(content: any): void;
7853
7864
  /*
7854
- * Load multiple files programmatically.
7865
+ * Loads multiple files into the question.
7855
7866
  */
7856
7867
  loadFiles(files: any): void;
7857
7868
  canPreviewImage(fileItem: any): boolean;
7858
7869
  protected loadPreview(newValue: any): void;
7859
- protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
7860
7870
  protected onCheckForErrors(errors: any, isOnValueChanged: boolean): void;
7861
7871
  protected stateChanged(state: string): void;
7862
7872
  getPlainData(options?: any): any;
@@ -7865,6 +7875,11 @@ export declare class QuestionFileModel extends Question {
7865
7875
  getReadOnlyFileCss(): string;
7866
7876
  get fileRootCss(): string;
7867
7877
  getFileDecoratorCss(): string;
7878
+ protected onChangeQuestionValue(newValue: any): void;
7879
+ rootElement: any;
7880
+ afterRender(el: any): void;
7881
+ dragCounter: number;
7882
+ onDragEnter: (event: any) => void;
7868
7883
  onDragOver: (event: any) => boolean;
7869
7884
  onDrop: (event: any) => void;
7870
7885
  onDragLeave: (event: any) => void;
@@ -7874,7 +7889,7 @@ export declare class QuestionFileModel extends Question {
7874
7889
  doDownloadFile: (event: any, data: any) => void;
7875
7890
  }
7876
7891
  /*
7877
- * A Model for a matrix base question.
7892
+ * A base class for all matrix question types.
7878
7893
  */
7879
7894
  export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
7880
7895
  constructor(name: string);
@@ -7888,34 +7903,56 @@ export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
7888
7903
  endLoadingFromJson(): void;
7889
7904
  get isCompositeQuestion(): boolean;
7890
7905
  /*
7891
- * 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`
7892
7909
  */
7893
7910
  get showHeader(): boolean;
7894
7911
  set showHeader(val: boolean);
7895
7912
  /*
7896
- * 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))
7897
7918
  */
7898
7919
  get columns(): any;
7899
7920
  set columns(val: any);
7900
7921
  get visibleColumns(): any;
7901
7922
  /*
7902
- * 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))
7903
7928
  */
7904
7929
  get rows(): any;
7905
7930
  set rows(val: any);
7906
7931
  protected processRowsOnSet(newRows: any): any;
7907
7932
  protected getVisibleRows(): Array<TRow>;
7908
7933
  /*
7909
- * Returns the list of visible rows as model objects.
7934
+ * Returns an array of visible matrix rows.
7910
7935
  */
7911
7936
  get visibleRows(): any;
7912
7937
  /*
7913
- * 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).
7914
7945
  */
7915
7946
  get rowsVisibleIf(): string;
7916
7947
  set rowsVisibleIf(val: string);
7917
7948
  /*
7918
- * 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).
7919
7956
  */
7920
7957
  get columnsVisibleIf(): string;
7921
7958
  set columnsVisibleIf(val: string);
@@ -8013,9 +8050,12 @@ export declare class QuestionMultipleTextModel extends Question implements IMult
8013
8050
  getItemLabelCss(item: MultipleTextItemModel): string;
8014
8051
  getItemCss(): string;
8015
8052
  getItemTitleCss(): string;
8053
+ protected getIsTooltipErrorInsideSupported(): boolean;
8016
8054
  }
8017
8055
  /*
8018
- * A Model for non value question. This question doesn't add any new functionality. It hides some properties, including the value.
8056
+ * A base class for question types that cannot have a value ([Html](https://surveyjs.io/form-library/documentation/questionhtmlmodel), [Image](https://surveyjs.io/form-library/documentation/questionimagemodel)).
8057
+ *
8058
+ * This class does not implement new functionality&mdash;it only redefines default values of certain properties inherited from the [`Question`](https://surveyjs.io/form-library/documentation/question) class.
8019
8059
  */
8020
8060
  export declare class QuestionNonValue extends Question {
8021
8061
  constructor(name: string);
@@ -8618,7 +8658,7 @@ export declare class QuestionSelectBase extends Question {
8618
8658
  */
8619
8659
  separateSpecialChoices: boolean;
8620
8660
  /*
8621
- * A placeholder for the comment area. Applies when the `hasOther` or `hasComment` property is `true`.
8661
+ * A placeholder for the comment area. Applies when the `showOtherItem` or `showCommentArea` property is `true`.
8622
8662
  */
8623
8663
  get otherPlaceholder(): string;
8624
8664
  set otherPlaceholder(val: string);
@@ -8998,7 +9038,7 @@ export declare class QuestionCustomModel extends QuestionCustomModelBase {
8998
9038
  protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
8999
9039
  onSurveyValueChanged(newValue: any): void;
9000
9040
  protected getValueCore(): any;
9001
- protected initElement(el: SurveyElement): void;
9041
+ protected initElement(el: any): void;
9002
9042
  updateElementCss(reNew?: boolean): void;
9003
9043
  protected updateElementCssCore(cssClasses: any): void;
9004
9044
  protected getDisplayValueCore(keyAsText: boolean, value: any): any;
@@ -9023,9 +9063,9 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
9023
9063
  get placeholder(): string;
9024
9064
  set placeholder(val: string);
9025
9065
  get locPlaceholder(): LocalizableString;
9026
- get cleanCaption(): string;
9027
- set cleanCaption(val: string);
9028
- get locCleanCaption(): LocalizableString;
9066
+ get clearCaption(): string;
9067
+ set clearCaption(val: string);
9068
+ get locClearCaption(): LocalizableString;
9029
9069
  getType(): string;
9030
9070
  get selectedItem(): ItemValue;
9031
9071
  supportGoNextPageAutomatic(): boolean;
@@ -9081,6 +9121,8 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
9081
9121
  searchEnabled: boolean;
9082
9122
  inputHasValue: boolean;
9083
9123
  readOnlyText: string;
9124
+ choicesLazyLoadEnabled: boolean;
9125
+ choicesLazyLoadPageSize: number;
9084
9126
  getControlClass(): string;
9085
9127
  get selectedItemLocText(): LocalizableString;
9086
9128
  get inputFieldComponentName(): string;
@@ -9096,7 +9138,9 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
9096
9138
  onKeyUp(event: any): void;
9097
9139
  }
9098
9140
  /*
9099
- * 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))
9100
9144
  */
9101
9145
  export declare class QuestionHtmlModel extends QuestionNonValue {
9102
9146
  constructor(name: string);
@@ -9105,7 +9149,9 @@ export declare class QuestionHtmlModel extends QuestionNonValue {
9105
9149
  get isCompositeQuestion(): boolean;
9106
9150
  getProcessedText(text: string): string;
9107
9151
  /*
9108
- * 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.
9109
9155
  */
9110
9156
  get html(): string;
9111
9157
  set html(val: string);
@@ -9113,7 +9159,9 @@ export declare class QuestionHtmlModel extends QuestionNonValue {
9113
9159
  get processedHtml(): string;
9114
9160
  }
9115
9161
  /*
9116
- * 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))
9117
9165
  */
9118
9166
  export declare class QuestionImageModel extends QuestionNonValue {
9119
9167
  constructor(name: string);
@@ -9121,48 +9169,65 @@ export declare class QuestionImageModel extends QuestionNonValue {
9121
9169
  get isCompositeQuestion(): boolean;
9122
9170
  onSurveyLoad(): void;
9123
9171
  /*
9124
- * The image URL.
9172
+ * Specifies an image or video URL.
9125
9173
  */
9126
9174
  get imageLink(): string;
9127
9175
  set imageLink(val: string);
9128
9176
  get locImageLink(): LocalizableString;
9129
9177
  /*
9130
- * The image alt text.
9178
+ * Specifies a value for the `alt` attribute of the underlying `<img>` element.
9131
9179
  */
9132
- get text(): string;
9133
- set text(val: string);
9134
- get locText(): LocalizableString;
9180
+ get altText(): string;
9181
+ set altText(val: string);
9182
+ get locAltText(): LocalizableString;
9135
9183
  /*
9136
- * 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.
9137
9189
  */
9138
9190
  get imageHeight(): string;
9139
9191
  set imageHeight(val: string);
9140
9192
  get renderedHeight(): string;
9141
9193
  /*
9142
- * 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.
9143
9199
  */
9144
9200
  get imageWidth(): string;
9145
9201
  set imageWidth(val: string);
9146
9202
  get renderedWidth(): string;
9147
9203
  /*
9148
- * 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.
9149
9207
  */
9150
9208
  get imageFit(): string;
9151
9209
  set imageFit(val: string);
9152
9210
  /*
9153
- * 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.
9154
9219
  */
9155
9220
  get contentMode(): string;
9156
9221
  set contentMode(val: string);
9157
9222
  /*
9158
- * The rendered mode.
9223
+ * Returns the type of content that the Image question displays: `"image"`, `"video"`, or `"youtube"`.
9159
9224
  */
9160
9225
  get renderedMode(): string;
9161
9226
  getImageCss(): string;
9162
9227
  protected calculateRenderedMode(): void;
9163
9228
  }
9164
9229
  /*
9165
- * 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.
9166
9231
  */
9167
9232
  export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseModel<MatrixDropdownRowModelBase, MatrixDropdownColumn> implements IMatrixDropdownData {
9168
9233
  constructor(name: string);
@@ -9218,34 +9283,53 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9218
9283
  protected updateColumnsAndRows(): void;
9219
9284
  itemValuePropertyChanged(item: ItemValue, name: string, oldValue: any, newValue: any): void;
9220
9285
  /*
9221
- * 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"`
9222
9289
  */
9223
9290
  get columnLayout(): string;
9224
9291
  set columnLayout(val: string);
9225
9292
  get columnsLocation(): string;
9226
9293
  set columnsLocation(val: string);
9227
9294
  /*
9228
- * 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.
9229
9298
  */
9230
9299
  get isColumnLayoutHorizontal(): boolean;
9231
9300
  /*
9232
- * 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.
9233
- * 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`
9234
9306
  */
9235
9307
  get isUniqueCaseSensitive(): boolean;
9236
9308
  set isUniqueCaseSensitive(val: boolean);
9237
9309
  /*
9238
- * 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.
9239
9319
  */
9240
9320
  get detailPanelMode(): string;
9241
9321
  set detailPanelMode(val: string);
9242
9322
  /*
9243
- * 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.
9244
9324
  */
9245
9325
  get detailPanel(): PanelModel;
9246
9326
  getPanel(): IPanel;
9247
9327
  /*
9248
- * 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.
9249
9333
  */
9250
9334
  get detailElements(): any;
9251
9335
  protected createNewDetailPanel(): PanelModel;
@@ -9267,12 +9351,27 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9267
9351
  protected createRenderedTable(): QuestionMatrixDropdownRenderedTable;
9268
9352
  protected onMatrixRowCreated(row: MatrixDropdownRowModelBase): void;
9269
9353
  /*
9270
- * 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))
9271
9368
  */
9272
9369
  get cellType(): string;
9273
9370
  set cellType(val: string);
9274
9371
  /*
9275
- * 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)
9276
9375
  */
9277
9376
  get columnColCount(): number;
9278
9377
  set columnColCount(val: number);
@@ -9281,14 +9380,8 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9281
9380
  */
9282
9381
  get columnMinWidth(): string;
9283
9382
  set columnMinWidth(val: string);
9284
- /*
9285
- * Set this property to true to show the horizontal scroll.
9286
- */
9287
9383
  get horizontalScroll(): boolean;
9288
9384
  set horizontalScroll(val: boolean);
9289
- /*
9290
- * The Matrix toolbar and inner panel toolbars get adaptive if the property is set to true.
9291
- */
9292
9385
  get allowAdaptiveActions(): boolean;
9293
9386
  set allowAdaptiveActions(val: boolean);
9294
9387
  getRequiredText(): string;
@@ -9316,21 +9409,29 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9316
9409
  protected runTotalsCondition(values: any, properties: any): void;
9317
9410
  locStrsChanged(): void;
9318
9411
  /*
9319
- * 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.
9320
9413
  */
9321
9414
  getColumnByName(columnName: string): MatrixDropdownColumn;
9322
9415
  getColumnName(columnName: string): MatrixDropdownColumn;
9323
- /*
9324
- * Returns the column width.
9325
- */
9326
9416
  getColumnWidth(column: MatrixDropdownColumn): string;
9327
9417
  /*
9328
- * 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.
9329
9430
  */
9330
9431
  get choices(): any;
9331
9432
  set choices(val: any);
9332
9433
  /*
9333
- * The default placeholder for dropdown cell type.
9434
+ * A placeholder for Dropdown matrix cells.
9334
9435
  */
9335
9436
  get placeholder(): string;
9336
9437
  set placeholder(val: string);
@@ -9338,7 +9439,9 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9338
9439
  get optionsCaption(): string;
9339
9440
  set optionsCaption(val: string);
9340
9441
  /*
9341
- * 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).
9342
9445
  */
9343
9446
  get keyDuplicationError(): string;
9344
9447
  set keyDuplicationError(val: string);
@@ -9351,12 +9454,12 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9351
9454
  get visibleTotalRow(): MatrixDropdownRowModelBase;
9352
9455
  onSurveyLoad(): void;
9353
9456
  /*
9354
- * 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.
9355
9458
  */
9356
9459
  getRowValue(rowIndex: number): any;
9357
9460
  checkIfValueInRowDuplicated(checkedRow: MatrixDropdownRowModelBase, cellQuestion: Question): boolean;
9358
9461
  /*
9359
- * Set the row value.
9462
+ * Assigns values to a row.
9360
9463
  */
9361
9464
  setRowValue(rowIndex: number, rowValue: any): any;
9362
9465
  protected generateRows(): Array<MatrixDropdownRowModelBase>;
@@ -9420,6 +9523,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
9420
9523
  getRowHeaderWrapperComponentData(cell: MatrixDropdownCell): any;
9421
9524
  get showHorizontalScroll(): boolean;
9422
9525
  getRootCss(): string;
9526
+ protected getIsTooltipErrorInsideSupported(): boolean;
9423
9527
  }
9424
9528
  /*
9425
9529
  * A Model for a simple matrix question.
@@ -9703,7 +9807,9 @@ export declare class QuestionCheckboxModel extends QuestionCheckboxBase {
9703
9807
  get checkBoxSvgPath(): string;
9704
9808
  }
9705
9809
  /*
9706
- * 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))
9707
9813
  */
9708
9814
  export declare class QuestionImagePickerModel extends QuestionCheckboxBase {
9709
9815
  constructor(name: string);
@@ -9716,18 +9822,17 @@ export declare class QuestionImagePickerModel extends QuestionCheckboxBase {
9716
9822
  supportNone(): boolean;
9717
9823
  isAnswerCorrect(): boolean;
9718
9824
  /*
9719
- * 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`
9720
9828
  */
9721
9829
  get multiSelect(): boolean;
9722
9830
  set multiSelect(val: boolean);
9723
- /*
9724
- * Returns true if item is checked
9725
- */
9726
9831
  isItemSelected(item: ItemValue): boolean;
9727
9832
  clearIncorrectValues(): void;
9728
9833
  protected getDisplayValueCore(keysAsText: boolean, value: any): any;
9729
9834
  /*
9730
- * 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.
9731
9836
  */
9732
9837
  get showLabel(): boolean;
9733
9838
  set showLabel(val: boolean);
@@ -9736,26 +9841,43 @@ export declare class QuestionImagePickerModel extends QuestionCheckboxBase {
9736
9841
  protected renderedValueFromDataCore(val: any): any;
9737
9842
  protected rendredValueToDataCore(val: any): any;
9738
9843
  /*
9739
- * 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.
9740
9849
  */
9741
9850
  get imageHeight(): number;
9742
9851
  set imageHeight(val: number);
9743
9852
  responsiveImageHeight: number;
9744
9853
  get renderedImageHeight(): string;
9745
9854
  /*
9746
- * 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.
9747
9860
  */
9748
9861
  get imageWidth(): number;
9749
9862
  set imageWidth(val: number);
9750
9863
  responsiveImageWidth: number;
9751
9864
  get renderedImageWidth(): string;
9752
9865
  /*
9753
- * 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.
9754
9869
  */
9755
9870
  get imageFit(): string;
9756
9871
  set imageFit(val: string);
9757
9872
  /*
9758
- * 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.
9759
9881
  */
9760
9882
  get contentMode(): string;
9761
9883
  set contentMode(val: string);
@@ -10072,15 +10194,17 @@ export declare class QuestionTagboxModel extends QuestionCheckboxModel {
10072
10194
  * Specifies whether to remove selected items from the drop-down list.
10073
10195
  */
10074
10196
  hideSelectedItems: boolean;
10197
+ choicesLazyLoadEnabled: boolean;
10198
+ choicesLazyLoadPageSize: number;
10075
10199
  /*
10076
10200
  * A text displayed in the input field when it doesn't have a value.
10077
10201
  */
10078
10202
  get placeholder(): string;
10079
10203
  set placeholder(val: string);
10080
10204
  get locPlaceholder(): LocalizableString;
10081
- get cleanCaption(): string;
10082
- set cleanCaption(val: string);
10083
- get locCleanCaption(): LocalizableString;
10205
+ get clearCaption(): string;
10206
+ set clearCaption(val: string);
10207
+ get locClearCaption(): LocalizableString;
10084
10208
  getType(): string;
10085
10209
  get popupModel(): any;
10086
10210
  getControlClass(): string;
@@ -10105,8 +10229,8 @@ export declare function getCurrecyCodes(): Array<any>;
10105
10229
  export declare function createPopupModalViewModel(options: IDialogOptions): PopupBaseViewModel;
10106
10230
  export declare function createPopupViewModel(model: any, targetElement: any): PopupBaseViewModel;
10107
10231
  export declare function checkLibraryVersion(ver: string, libraryName: string): void;
10108
- export declare function showModal(componentName: string, data: any, onApply: any, onCancel?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): void;
10109
- export declare function showDialog(dialogOptions: any): void;
10232
+ export declare function showModal(componentName: string, data: any, onApply: any, onCancel?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): PopupBaseViewModel;
10233
+ export declare function showDialog(dialogOptions: any): PopupBaseViewModel;
10110
10234
  export declare function attachKey2click(element: JSX.Element, viewModel?: any, options?: IAttachKey2clickOptions): JSX.Element;
10111
10235
  /*
10112
10236
  * Global survey settings
@@ -10744,6 +10868,7 @@ export declare var matrixDropdownColumnTypes: {
10744
10868
  radiogroup: {
10745
10869
  onCellQuestionUpdate: (cellQuestion: any, column: any, question: any, data: any) => void,
10746
10870
  },
10871
+ tagbox: any,
10747
10872
  text: any,
10748
10873
  comment: any,
10749
10874
  boolean: {
@@ -10835,6 +10960,7 @@ export declare var defaultBootstrapCss: {
10835
10960
  hasError: string,
10836
10961
  indent: number,
10837
10962
  formGroup: string,
10963
+ disabled: string,
10838
10964
  },
10839
10965
  panel: {
10840
10966
  title: string,
@@ -11172,6 +11298,7 @@ export declare var defaultBootstrapMaterialCss: {
11172
11298
  hasError: string,
11173
11299
  indent: number,
11174
11300
  formGroup: string,
11301
+ disabled: string,
11175
11302
  },
11176
11303
  panel: {
11177
11304
  title: string,
@@ -11450,6 +11577,7 @@ export declare var defaultBootstrapMaterialCss: {
11450
11577
  export declare var defaultV2Css: {
11451
11578
  root: string,
11452
11579
  rootMobile: string,
11580
+ rootReadOnly: string,
11453
11581
  container: string,
11454
11582
  header: string,
11455
11583
  body: string,
@@ -11478,6 +11606,7 @@ export declare var defaultV2Css: {
11478
11606
  titleExpandable: string,
11479
11607
  titleExpanded: string,
11480
11608
  titleCollapsed: string,
11609
+ titleDisabled: string,
11481
11610
  titleOnExpand: string,
11482
11611
  titleOnError: string,
11483
11612
  titleBar: string,
@@ -11567,6 +11696,7 @@ export declare var defaultV2Css: {
11567
11696
  titleExpandable: string,
11568
11697
  titleExpanded: string,
11569
11698
  titleCollapsed: string,
11699
+ titleDisabled: string,
11570
11700
  titleBar: string,
11571
11701
  requiredText: string,
11572
11702
  number: string,
@@ -11585,6 +11715,7 @@ export declare var defaultV2Css: {
11585
11715
  nested: string,
11586
11716
  invisible: string,
11587
11717
  composite: string,
11718
+ disabled: string,
11588
11719
  },
11589
11720
  image: {
11590
11721
  mainRoot: string,
@@ -11865,6 +11996,8 @@ export declare var defaultV2Css: {
11865
11996
  fileSign: string,
11866
11997
  fileList: string,
11867
11998
  fileSignBottom: string,
11999
+ dragArea: string,
12000
+ dragAreaActive: string,
11868
12001
  fileDecorator: string,
11869
12002
  onError: string,
11870
12003
  fileDecoratorDrag: string,