survey-react 1.9.50 → 1.9.52

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.50
2
+ * Type definition for Survey JavaScript library for React v1.9.52
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
  */
@@ -451,6 +451,7 @@ export interface IElement extends IConditionRunner, ISurveyElement {
451
451
  isCollapsed: boolean;
452
452
  rightIndent: number;
453
453
  startWithNewLine: boolean;
454
+ registerPropertyChangedHandlers(propertyNames: any, handler: any, key: string): void;
454
455
  registerFunctionOnPropertyValueChanged(name: string, func: any, key: string): void;
455
456
  unRegisterFunctionOnPropertyValueChanged(name: string, key: string): void;
456
457
  getPanel(): IPanel;
@@ -819,7 +820,7 @@ export declare class Base {
819
820
  /*
820
821
  * Returns `true` if the object is included in a survey.
821
822
  *
822
- * This method may return `false`, for example, when you [create a survey model dynamically](https://surveyjs.io/form-library/documentation/design-survey-create-a-simple-survey#create-or-change-a-survey-model-dynamically).
823
+ * This property may return `false`, for example, when you [create a survey model dynamically](https://surveyjs.io/form-library/documentation/design-survey-create-a-simple-survey#create-or-change-a-survey-model-dynamically).
823
824
  */
824
825
  get inSurvey(): boolean;
825
826
  get bindings(): Bindings;
@@ -872,11 +873,6 @@ export declare class Base {
872
873
  get isEditingSurveyElement(): boolean;
873
874
  iteratePropertiesHash(func: (hash: any, key: any) => void): void;
874
875
  /*
875
- * set property value and before check if new property value is correct by calling JsonProperty onSettingValue function
876
- * If onSettingValue is not set in declaration, then this function works as `setPropertyValue`.
877
- */
878
- checkAndSetPropertyValue(name: string, val: any): void;
879
- /*
880
876
  * Assigns a new value to a specified property.
881
877
  */
882
878
  setPropertyValue(name: string, val: any): void;
@@ -895,20 +891,16 @@ export declare class Base {
895
891
  protected runConditionCore(values: any, properties: any): void;
896
892
  protected canRunConditions(): boolean;
897
893
  /*
898
- * Register a function that will be called on a property value changed.
894
+ * Register a function that will be called on a property value changed from the propertyNames list.
899
895
  */
900
- registerFunctionOnPropertyValueChanged(name: string, func: any, key?: string): void;
896
+ registerPropertyChangedHandlers(propertyNames: any, handler: any, key?: string): void;
901
897
  /*
902
- * Register a function that will be called on a property value changed from the names list.
898
+ * Unregister notification on property value changed for all properties in the propetyNames list.
903
899
  */
900
+ unregisterPropertyChangedHandlers(propertyNames: any, key?: string): void;
901
+ registerFunctionOnPropertyValueChanged(name: string, func: any, key?: string): void;
904
902
  registerFunctionOnPropertiesValueChanged(names: any, func: any, key?: string): void;
905
- /*
906
- * Unregister notification on property value changed
907
- */
908
903
  unRegisterFunctionOnPropertyValueChanged(name: string, key?: string): void;
909
- /*
910
- * Unregister notification on property value changed for all properties in the names list.
911
- */
912
904
  unRegisterFunctionOnPropertiesValueChanged(names: any, key?: string): void;
913
905
  createCustomLocalizableObj(name: string): void;
914
906
  getLocale(): string;
@@ -1130,6 +1122,12 @@ export declare class ExpressionRunnerBase {
1130
1122
  protected runCore(values: any, properties?: any): any;
1131
1123
  protected doOnComplete(res: any): void;
1132
1124
  }
1125
+ export declare class FileLoader {
1126
+ constructor(fileQuestion: QuestionFileModel, callback: (status: string, files: any) => void);
1127
+ loaded: any;
1128
+ load(files: any): void;
1129
+ dispose(): void;
1130
+ }
1133
1131
  export declare class FunctionFactory {
1134
1132
  static Instance: FunctionFactory;
1135
1133
  functionHash: any;
@@ -1163,6 +1161,8 @@ export declare class Helpers {
1163
1161
  static correctAfterMultiple(a: number, b: number, res: number): number;
1164
1162
  static convertArrayValueToObject(src: any, propName: string, dest?: any): Array<any>;
1165
1163
  static convertArrayObjectToValue(src: any, propName: string): Array<any>;
1164
+ static convertDateToString(date: any): string;
1165
+ static convertValToQuestionVal(val: any): any;
1166
1166
  }
1167
1167
  export declare class JsonError {
1168
1168
  constructor(type: string, message: string);
@@ -1422,11 +1422,13 @@ export declare class ResponsivityManager {
1422
1422
  separatorSize: number;
1423
1423
  separatorAddConst: number;
1424
1424
  paddingSizeConst: number;
1425
+ dotsSizeConst: number;
1425
1426
  protected recalcMinDimensionConst: boolean;
1426
1427
  getComputedStyle: (elt: JSX.Element) => any;
1427
1428
  protected getDimensions(element: any): IDimensions;
1428
1429
  protected getAvailableSpace(): number;
1429
1430
  protected calcItemSize(item: any): number;
1431
+ protected calcActionDimensions(currentAction: Action, item: any): void;
1430
1432
  dispose(): void;
1431
1433
  }
1432
1434
  export declare class Skeleton extends React.Component<any, any> {
@@ -2016,6 +2018,8 @@ export declare class DropdownListModel extends Base {
2016
2018
  protected getAvailableItems(): Array<Action>;
2017
2019
  protected createListModel(): ListModel;
2018
2020
  protected resetFilterString(): void;
2021
+ protected onSetFilterString(): void;
2022
+ setInputHasValue(newValue: boolean): void;
2019
2023
  searchEnabled: boolean;
2020
2024
  filterString: string;
2021
2025
  get popupModel(): any;
@@ -2024,6 +2028,7 @@ export declare class DropdownListModel extends Base {
2024
2028
  updateItems(): void;
2025
2029
  onClick(event: any): void;
2026
2030
  onClear(event: any): void;
2031
+ getSelectedAction(): Action;
2027
2032
  keyHandler(event: any): void;
2028
2033
  onBlur(event: any): void;
2029
2034
  scrollToFocusedItem(): void;
@@ -2714,6 +2719,7 @@ export declare class Popup extends SurveyElementBase<IPopupProps, any> {
2714
2719
  export declare class PopupBaseViewModel extends Base {
2715
2720
  constructor(model: any, targetElement?: any);
2716
2721
  targetElement: any;
2722
+ isAutoScroll: boolean;
2717
2723
  prevActiveElement: any;
2718
2724
  scrollEventCallBack: any;
2719
2725
  top: string;
@@ -3314,6 +3320,7 @@ export declare class VerticalResponsivityManager extends ResponsivityManager {
3314
3320
  protected getDimensions(): IDimensions;
3315
3321
  protected getAvailableSpace(): number;
3316
3322
  protected calcItemSize(item: any): number;
3323
+ protected calcActionDimensions(currentAction: Action, item: any): void;
3317
3324
  }
3318
3325
  export declare class WebRequestEmptyError extends SurveyError {
3319
3326
  constructor(text: string, errorOwner?: ISurveyErrorOwner);
@@ -3458,6 +3465,7 @@ export declare class DropdownMultiSelectListModel extends DropdownListModel {
3458
3465
  closeOnSelect: boolean;
3459
3466
  protected override: any;
3460
3467
  createListModel(): MultiSelectListModel;
3468
+ protected onSetFilterString(): void;
3461
3469
  selectAllItems(): void;
3462
3470
  selectNoneItem(): void;
3463
3471
  selectItem(id: string): void;
@@ -3712,8 +3720,9 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
3712
3720
  *
3713
3721
  * Possible values:
3714
3722
  *
3715
- * - `"collapsed"` - The survey element displays only `title` and `description`.
3716
- * - `"expanded"` - The survey element is displayed in full.
3723
+ * - `"default"` (default) - The survey element is displayed in full and cannot be collapsed in the UI.
3724
+ * - `"expanded"` - The survey element is displayed in full and can be collapsed in the UI.
3725
+ * - `"collapsed"` - The survey element displays only `title` and `description` and can be expanded in the UI.
3717
3726
  */
3718
3727
  get state(): string;
3719
3728
  set state(val: string);
@@ -3772,11 +3781,15 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
3772
3781
  get areInvisibleElementsShowing(): boolean;
3773
3782
  get isVisible(): boolean;
3774
3783
  /*
3775
- * Returns `true` if the survey element or its parent element is read-only.
3784
+ * Returns `true` if the survey element or its parent element is read-only.
3785
+ *
3786
+ * If you want to switch a survey element to the read-only state based on a condition, specify the [`enableIf`](https://surveyjs.io/form-library/documentation/question#enableIf) property. Refer to the following help topic for information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
3776
3787
  */
3777
3788
  get isReadOnly(): boolean;
3778
3789
  /*
3779
- * Makes the survey element read-only.
3790
+ * Makes the survey element read-only.
3791
+ *
3792
+ * If you want to switch a survey element to the read-only state based on a condition, specify the [`enableIf`](https://surveyjs.io/form-library/documentation/question#enableIf) property. Refer to the following help topic for information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
3780
3793
  */
3781
3794
  get readOnly(): boolean;
3782
3795
  set readOnly(val: boolean);
@@ -3813,7 +3826,7 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
3813
3826
  set errors(val: any);
3814
3827
  hasVisibleErrors: boolean;
3815
3828
  /*
3816
- * Returns `true` if the survey element or its child elements have a validation error.
3829
+ * Returns `true` if the survey element or its child elements have validation errors.
3817
3830
  *
3818
3831
  * This property contains the result of the most recent validation. This result may be outdated. Call the `hasErrors` method to get an up-to-date value.
3819
3832
  */
@@ -3843,7 +3856,14 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
3843
3856
  delete(): void;
3844
3857
  locOwner: ILocalizableOwner;
3845
3858
  /*
3846
- * Returns the survey's [locale](https://surveyjs.io/form-library/documentation/surveymodel#locale).
3859
+ * Returns the survey's [locale](https://surveyjs.io/form-library/documentation/surveymodel#locale).
3860
+ *
3861
+ * If a default locale is used, this method returns an empty string. To get the applied locale in this case, use the following code:
3862
+ *
3863
+ * ```js
3864
+ * import { surveyLocalization } from 'survey-core';
3865
+ * const defaultLocale = surveyLocalization.defaultLocale;
3866
+ * ```
3847
3867
  */
3848
3868
  getLocale(): string;
3849
3869
  getMarkdownHtml(text: string, name: string): string;
@@ -3927,7 +3947,7 @@ export declare class SurveyElementErrors extends ReactSurveyElement {
3927
3947
  protected renderElement(): JSX.Element;
3928
3948
  }
3929
3949
  /*
3930
- * The `Survey` object contains information about the survey, Pages, Questions, flow logic and etc.
3950
+ * The `SurveyModel` object contains properties and methods that allow you to control the survey and access its elements.
3931
3951
  */
3932
3952
  export declare class SurveyModel extends SurveyElementCore implements ISurvey, ISurveyData, ISurveyImpl, ISurveyTriggerOwner, ISurveyErrorOwner, ISurveyTimerText {
3933
3953
  constructor(jsonObj?: any, renderedElement?: any);
@@ -3964,12 +3984,15 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
3964
3984
  onCompleting: EventBase<SurveyModel>;
3965
3985
  /*
3966
3986
  * The event is fired after a user clicks the 'Complete' button and finishes a survey. Use this event to send the survey data to your web server.
3987
+ *
3967
3988
  * - `sender` - the survey object that fires the event.
3968
3989
  * - `options.showDataSaving(text)` - call this method to show that the survey is saving survey data on your server. The `text` is an optional parameter to show a custom message instead of default.
3969
3990
  * - `options.showDataSavingError(text)` - call this method to show that an error occurred while saving the data on your server. If you want to show a custom error, use an optional `text` parameter.
3970
3991
  * - `options.showDataSavingSuccess(text)` - call this method to show that the data was successfully saved on the server.
3971
3992
  * - `options.showDataSavingClear` - call this method to hide the text about the saving progress.
3972
3993
  * - `options.isCompleteOnTrigger` - returns true if the survey is completed on "complete" trigger.
3994
+ *
3995
+ * > NOTE: Do not disable the [`showCompletedPage`](https://surveyjs.io/form-library/documentation/surveymodel#showCompletedPage) property if you call one of the `options.showDataSaving...` methods described above. This is required because the UI that indicates data saving progress is integrated into the Complete page. If you hide the Complete page, the UI also becomes invisible.
3973
3996
  */
3974
3997
  onComplete: EventBase<SurveyModel>;
3975
3998
  /*
@@ -4778,12 +4801,14 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4778
4801
  get maxOthersLength(): number;
4779
4802
  set maxOthersLength(val: number);
4780
4803
  /*
4781
- * Gets or ses whether a user can navigate the next page automatically after answering all the questions on a page without pressing the "Next" button.
4804
+ * Gets or ses whether user proceeds to the next page without pressing the "Next" button after answering all page questions.
4782
4805
  * The available options:
4783
4806
  *
4784
- * - `true` - navigate the next page and submit survey data automatically.
4785
- * - `autogonext` - navigate the next page automatically but do not submit survey data.
4786
- * - `false` - do not navigate the next page and do not submit survey data automatically.
4807
+ * - `true` - navigate to the next page and submit survey data automatically.
4808
+ * - `autogonext` - navigate to the next page automatically but do not submit survey data.
4809
+ * - `false` - do not navigate to the next page and do not submit survey data automatically.
4810
+ *
4811
+ * > NOTE: If any of the following questions is answered last, the survey won't be switched to the next page: Checkbox, Boolean (rendered as Checkbox), Comment, Signature Pad, Image Picker (with Multi Select), File, Single-Choice Matrix (not all rows are answered), Dynamic Matrix, Panel Dynamic.
4787
4812
  */
4788
4813
  get goNextPageAutomatic(): boolean | "autogonext";
4789
4814
  set goNextPageAutomatic(val: boolean | "autogonext");
@@ -4865,7 +4890,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4865
4890
  getErrorCustomText(text: string, error: SurveyError): string;
4866
4891
  getSurveyErrorCustomText(obj: Base, text: string, error: SurveyError): string;
4867
4892
  /*
4868
- * Returns the text that is displayed when there are no any visible pages and questiona.
4893
+ * Returns the text displayed when a survey has no visible pages and questions.
4869
4894
  */
4870
4895
  get emptySurveyText(): string;
4871
4896
  /*
@@ -5000,9 +5025,6 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5000
5025
  get questionTitlePattern(): string;
5001
5026
  set questionTitlePattern(val: string);
5002
5027
  getQuestionTitlePatternOptions(): Array<any>;
5003
- /*
5004
- * Gets or sets a question title template. Obsolete, please use questionTitlePattern
5005
- */
5006
5028
  get questionTitleTemplate(): string;
5007
5029
  set questionTitleTemplate(val: string);
5008
5030
  get locQuestionTitleTemplate(): LocalizableString;
@@ -5056,15 +5078,11 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5056
5078
  */
5057
5079
  get processedTitle(): string;
5058
5080
  /*
5059
- * Gets or sets the question title location.
5081
+ * Gets or sets question title location relative to the input field: `"top"`, `"bottom"`, or `"left"`.
5060
5082
  *
5061
- * The following options are available:
5083
+ * > NOTE: Certain question types (Matrix, Multiple Text) do not support the `"left"` value. For them, the `"top"` value is used.
5062
5084
  *
5063
- * - `bottom` - show a question title to bottom
5064
- * - `left` - show a question title to left
5065
- * - `top` - show a question title to top.
5066
- *
5067
- * > Some questions, for example matrixes, do not support 'left' value. The title for them will be displayed to the top.
5085
+ * You can override this setting if you specify the `questionTitleLocation` property for an [individual page](https://surveyjs.io/form-library/documentation/pagemodel#questionTitleLocation) or [panel](https://surveyjs.io/form-library/documentation/panelmodel#questionTitleLocation) or set the `titleLocation` property for a [specific question](https://surveyjs.io/form-library/documentation/question#titleLocation).
5068
5086
  */
5069
5087
  get questionTitleLocation(): string;
5070
5088
  set questionTitleLocation(val: string);
@@ -5117,11 +5135,11 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5117
5135
  get isEditingSurveyElement(): boolean;
5118
5136
  getAllValues(): any;
5119
5137
  /*
5120
- * Returns survey result data as an array of plain objects: with question `title`, `name`, `value`, and `displayValue`.
5138
+ * Returns survey results as an array of objects in which the question name, title, value, and other parameters are stored as individual properties.
5121
5139
  *
5122
- * For complex questions (like matrix, etc.) `isNode` flag is set to `true` and data contains array of nested objects (rows).
5140
+ * If a question can have more than one value (Matrix, Multiple Text), its object enables the `isNode` flag and stores information about these values in the `data` property. Refer to the following help topic for more information: [Access Full Survey Results](https://surveyjs.io/form-library/documentation/handle-survey-results-access#access-full-survey-results).
5123
5141
  *
5124
- * Set `options.includeEmpty` to `false` if you want to skip empty answers.
5142
+ * If you want to skip empty answers, pass an object with the `includeEmpty` property set to `false`.
5125
5143
  */
5126
5144
  getPlainData(options?: any): any;
5127
5145
  getFilteredValues(): any;
@@ -5741,6 +5759,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5741
5759
  */
5742
5760
  get width(): string;
5743
5761
  set width(val: string);
5762
+ get renderedWidth(): string;
5744
5763
  get timerInfoText(): string;
5745
5764
  get timerModel(): SurveyTimerModel;
5746
5765
  /*
@@ -6196,7 +6215,8 @@ export declare class UrlConditionItem extends ExpressionItem {
6196
6215
  }
6197
6216
  export declare class Variable extends Const {
6198
6217
  constructor(variableName: string);
6199
- static DisableConversionChar: string;
6218
+ static get DisableConversionChar(): string;
6219
+ static set DisableConversionChar(val: string);
6200
6220
  valueInfo: any;
6201
6221
  useValueAsItIs: boolean;
6202
6222
  getType(): string;
@@ -6525,10 +6545,13 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6525
6545
  protected isReadyValue: boolean;
6526
6546
  commentElement: any;
6527
6547
  /*
6528
- * The event is fired when isReady property of question is changed.
6529
- * options.question - the question
6530
- * options.isReady - current value of isReady
6531
- * options.oldIsReady - old value of isReady
6548
+ * An event that is raised when the question's ready state has changed (expressions are evaluated, choices are loaded from a web resource specified by the `choicesByUrl` property, etc.).
6549
+ *
6550
+ * Parameters:
6551
+ *
6552
+ * - `sender` - A survey that contains the question whose ready state has changed.
6553
+ * - `options.isReady` - A Boolean value that indicates whether the question is ready.
6554
+ * - `options.oldIsReady` - A Boolean value that indicates the previous ready state.
6532
6555
  */
6533
6556
  onReadyChanged: EventBase<Question>;
6534
6557
  isReadOnlyRenderDiv(): boolean;
@@ -6537,29 +6560,21 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6537
6560
  getSurvey(live?: boolean): ISurvey;
6538
6561
  getValueName(): string;
6539
6562
  /*
6540
- * Use this property if you want to store the question result in the name different from the question name.
6541
- * Question name should be unique in the survey and valueName could be not unique. It allows to share data between several questions with the same valueName.
6542
- * The library set the value automatically if the question.name property is not valid. For example, if it contains the period '.' symbol.
6543
- * In this case if you set the question.name property to 'x.y' then the valueName becomes 'x y'.
6544
- * Please note, this property is hidden for questions without input, for example html question.
6563
+ * Specifies an object property that should store the question value.
6564
+ *
6565
+ * Refer to the [Merge Question Values](https://surveyjs.io/form-library/documentation/design-survey-merge-question-values) help topic for more information.
6545
6566
  */
6546
6567
  get valueName(): string;
6547
6568
  set valueName(val: string);
6548
6569
  protected onValueNameChanged(oldValue: string): void;
6549
6570
  protected onNameChanged(oldValue: string): void;
6550
6571
  get isReady(): boolean;
6551
- /*
6552
- * A11Y properties
6553
- */
6554
6572
  get ariaRequired(): "true" | "false";
6555
6573
  get ariaInvalid(): "true" | "false";
6556
6574
  get ariaDescribedBy(): string;
6557
- /*
6558
- * Get is question ready to use
6559
- */
6560
6575
  choicesLoaded(): void;
6561
6576
  /*
6562
- * Get/set the page where the question is located.
6577
+ * Returns a page to which the question belongs and allows you to move this question to a different page.
6563
6578
  */
6564
6579
  get page(): IPage;
6565
6580
  set page(val: IPage);
@@ -6569,25 +6584,36 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6569
6584
  getLayoutType(): string;
6570
6585
  isLayoutTypeSupported(layoutType: string): boolean;
6571
6586
  /*
6572
- * Use it to get/set the question visibility.
6587
+ * Gets or sets question visibility.
6588
+ *
6589
+ * If you want to display or hide a question based on a condition, specify the [`visibleIf`](https://surveyjs.io/form-library/documentation/question#visibleIf) property. Refer to the following help topic for information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
6573
6590
  */
6574
6591
  get visible(): boolean;
6575
6592
  set visible(val: boolean);
6576
6593
  protected onVisibleChanged(): void;
6577
6594
  /*
6578
- * Use it to choose how other question values will be rendered in title if referenced in {}.
6579
- * Please note, this property is hidden for question without input, for example html question.
6595
+ * Specifies whether to use display names for question values interpolated in the title. To interpolate question values, use curly brackets (`{}`).
6596
+ *
6597
+ * This property is useful when interpolated question values have both the `value` and `text` properties.
6598
+ *
6599
+ * Default value: `true`
6580
6600
  */
6581
6601
  get useDisplayValuesInTitle(): boolean;
6582
6602
  set useDisplayValuesInTitle(val: boolean);
6583
6603
  protected getUseDisplayValuesInTitle(): boolean;
6584
6604
  /*
6585
- * An expression that returns true or false. If it returns true the Question becomes visible and if it returns false the Question becomes invisible. The library runs the expression on survey start and on changing a question value. If the property is empty then visible property is used.
6605
+ * A Boolean expression. If it evaluates to `false`, this question becomes hidden.
6606
+ *
6607
+ * A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
6608
+ *
6609
+ * Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility)
6586
6610
  */
6587
6611
  get visibleIf(): string;
6588
6612
  set visibleIf(val: string);
6589
6613
  /*
6590
- * Returns true if the question is visible or survey is in design mode right now.
6614
+ * Returns `true` if the question is visible or the survey is currently in design mode.
6615
+ *
6616
+ * If you want to display or hide a question based on a condition, specify the [`visibleIf`](https://surveyjs.io/form-library/documentation/question#visibleIf) property. Refer to the following help topic for information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
6591
6617
  */
6592
6618
  get isVisible(): boolean;
6593
6619
  /*
@@ -6596,12 +6622,14 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6596
6622
  */
6597
6623
  get visibleIndex(): number;
6598
6624
  /*
6599
- * Set hideNumber to true to stop showing the number for this question. The question will not be counter
6625
+ * Hides the question number from the title and excludes the question from numbering.
6626
+ *
6627
+ * If you want to disable question numbering in the entire survey, set SurveyModel's `showQuestionNumbers` property to `false`.
6600
6628
  */
6601
6629
  get hideNumber(): boolean;
6602
6630
  set hideNumber(val: boolean);
6603
6631
  /*
6604
- * Returns true if the question may have a title located on the left
6632
+ * Returns `true` if the question can display its title to the left of the input field.
6605
6633
  */
6606
6634
  get isAllowTitleLeft(): boolean;
6607
6635
  /*
@@ -6630,40 +6658,48 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6630
6658
  */
6631
6659
  getType(): string;
6632
6660
  get isQuestion(): boolean;
6633
- /*
6634
- * Move question to a new container Page/Panel. Add as a last element if insertBefore parameter is not used or inserted into the given index,
6635
- * if insert parameter is number, or before the given element, if the insertBefore parameter is a question or panel
6636
- */
6637
6661
  moveTo(container: IPanel, insertBefore?: any): boolean;
6638
6662
  getProgressInfo(): IProgressInfo;
6639
6663
  setSurveyImpl(value: ISurveyImpl, isLight?: boolean): void;
6640
6664
  /*
6641
- * A parent element. It can be panel or page.
6665
+ * Returns a survey element (panel or page) that contains the question and allows you to move this question to a different survey element.
6642
6666
  */
6643
6667
  get parent(): IPanel;
6644
6668
  set parent(val: IPanel);
6645
6669
  parentQuestionValue: Question;
6646
6670
  /*
6647
- * A parent question. It can be a dynamic panel or dynamic/dropdown matrices. If the value is a matrix, it means that question is a cell question.
6648
- * This property is null for a stand alone question.
6671
+ * A Dynamic Panel, Dynamic Matrix, or Dropdown Matrix that includes the current question.
6672
+ *
6673
+ * This property is `null` for standalone questions.
6649
6674
  */
6650
6675
  get parentQuestion(): Question;
6651
6676
  setParentQuestion(val: Question): void;
6652
6677
  protected onParentQuestionChanged(): void;
6653
6678
  protected onParentChanged(): void;
6654
6679
  /*
6655
- * Returns false if the question doesn't have a title property, for example: QuestionHtmlModel, or titleLocation property equals to "hidden"
6680
+ * 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).
6681
+ *
6682
+ * If the `title` property is `undefined` or set to an empty string, the `hasTitle` property returns `true`, because the question uses its `name` as a title in this case.
6656
6683
  */
6657
6684
  get hasTitle(): boolean;
6658
6685
  /*
6659
- * Set this property different from "default" to set the specific question title location for this panel/page.
6660
- * Please note, this property is hidden for questions without input, for example html question.
6686
+ * Sets question title location relative to the input field. Overrides the `questionTitleLocation` property specified for the question's container (survey, page, or panel).
6687
+ *
6688
+ * Possible values:
6689
+ *
6690
+ * - `"default"` - Inherits the setting from the `questionTitleLocation` property specified for the question's container.
6691
+ * - `"top"` - Displays the title above the input field.
6692
+ * - `"bottom"` - Displays the title below the input field.
6693
+ * - `"left"` - Displays the title to the left of the input field.
6694
+ * - `"hidden"` - Hides the question title.
6695
+ *
6696
+ * > NOTE: Certain question types (Matrix, Multiple Text) do not support the `"left"` value. For them, the `"top"` value is used.
6661
6697
  */
6662
6698
  get titleLocation(): string;
6663
6699
  set titleLocation(val: string);
6664
6700
  getTitleOwner(): ITitleOwner;
6665
6701
  /*
6666
- * Return the title location based on question titleLocation property and QuestionTitleLocation of it's parents
6702
+ * Returns title location calculated based on the question's `titleLocation` property and the `questionTitleLocation` property of the question's containers (survey, page, or panel).
6667
6703
  */
6668
6704
  getTitleLocation(): string;
6669
6705
  protected getTitleLocationCore(): string;
@@ -6673,19 +6709,24 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6673
6709
  get hasTitleOnLeftTop(): boolean;
6674
6710
  get errorLocation(): string;
6675
6711
  /*
6676
- * Returns false if the question doesn't have an input element, for example: QuestionHtmlModel
6712
+ * Returns `false` if the question has no input fields ([HTML](https://surveyjs.io/form-library/documentation/questionhtmlmodel), [Image](https://surveyjs.io/form-library/documentation/questionimagemodel), and similar question types).
6677
6713
  */
6678
6714
  get hasInput(): boolean;
6679
6715
  /*
6680
- * Returns false if the question doesn't have an input element or have multiple inputs: matrices or panel dynamic
6716
+ * Returns `false` if the question has no input fields ([HTML](https://surveyjs.io/form-library/documentation/questionhtmlmodel), [Image](https://surveyjs.io/form-library/documentation/questionimagemodel)) or has multiple input fields ([Matrix](https://surveyjs.io/form-library/documentation/questionmatrixmodel), [Multiple Text](https://surveyjs.io/form-library/documentation/questionmultipletextmodel)).
6681
6717
  */
6682
6718
  get hasSingleInput(): boolean;
6683
6719
  get inputId(): string;
6684
6720
  protected getDefaultTitleValue(): string;
6685
6721
  protected getDefaultTitleTagName(): string;
6686
6722
  /*
6687
- * Question description location. By default, value is "default" and it depends on survey questionDescriptionLocation property
6688
- * You may change it to "underInput" to render it under question input or "underTitle" to rendered it under title.
6723
+ * Specifies where to display a question description.
6724
+ *
6725
+ * Possible values:
6726
+ *
6727
+ * - `"default"` (default) - Inherits the setting from the Survey's [`questionDescriptionLocation`](https://surveyjs.io/form-library/documentation/surveymodel#questionDescriptionLocation) property.
6728
+ * - `"underTitle"` - Displays the description under the question title.
6729
+ * - `"underInput"` - Displays the description under the interactive area.
6689
6730
  */
6690
6731
  get descriptionLocation(): string;
6691
6732
  set descriptionLocation(val: string);
@@ -6694,33 +6735,28 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6694
6735
  protected needClickTitleFunction(): boolean;
6695
6736
  protected processTitleClick(): boolean;
6696
6737
  /*
6697
- * The custom text that will be shown on required error. Use this property, if you do not want to show the default text.
6698
- * Please note, this property is hidden for question without input, for example html question.
6738
+ * Specifies a custom error message for a required form field.
6699
6739
  */
6700
6740
  get requiredErrorText(): string;
6701
6741
  set requiredErrorText(val: string);
6702
6742
  get locRequiredErrorText(): LocalizableString;
6703
6743
  /*
6704
- * Use it to get or set the comment value.
6744
+ * Specifies a caption displayed above the comment area. Applies when the `hasComment` property is `true`.
6705
6745
  */
6706
6746
  get commentText(): string;
6707
6747
  set commentText(val: string);
6708
6748
  get locCommentText(): LocalizableString;
6709
6749
  /*
6710
- * Use this property to set the place holder text for comment field .
6750
+ * A placeholder for the comment area. Applies when the `hasComment` property is `true`.
6711
6751
  */
6752
+ get commentPlaceholder(): string;
6753
+ set commentPlaceholder(val: string);
6754
+ get locCommentPlaceholder(): LocalizableString;
6712
6755
  get commentPlaceHolder(): string;
6713
6756
  set commentPlaceHolder(val: string);
6714
- get locCommentPlaceHolder(): LocalizableString;
6715
- get commentOrOtherPlaceHolder(): string;
6716
- /*
6717
- * Returns a copy of question errors survey. For some questions like matrix and panel dynamic it includes the errors of nested questions.
6718
- */
6757
+ get commentOrOtherPlaceholder(): string;
6719
6758
  getAllErrors(): Array<SurveyError>;
6720
6759
  getErrorByType(errorType: string): SurveyError;
6721
- /*
6722
- * The link to the custom widget.
6723
- */
6724
6760
  get customWidget(): QuestionCustomWidget;
6725
6761
  updateCustomWidget(): void;
6726
6762
  localeChanged(): void;
@@ -6731,20 +6767,14 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6731
6767
  afterRenderQuestionElement(el: any): void;
6732
6768
  afterRender(el: any): void;
6733
6769
  beforeDestroyQuestionElement(el: any): void;
6734
- /*
6735
- * Returns the rendred question title.
6736
- */
6737
6770
  get processedTitle(): string;
6738
- /*
6739
- * Returns the title after processing the question template.
6740
- */
6741
6771
  get fullTitle(): string;
6742
6772
  protected get titlePattern(): string;
6743
6773
  get isRequireTextOnStart(): boolean;
6744
6774
  get isRequireTextBeforeTitle(): boolean;
6745
6775
  get isRequireTextAfterTitle(): boolean;
6746
6776
  /*
6747
- * The Question renders on the new line if the property is true. If the property is false, the question tries to render on the same line/row with a previous question/panel.
6777
+ * Disable this property if you want to render the current question on the same line or row with the previous question or panel.
6748
6778
  */
6749
6779
  get startWithNewLine(): boolean;
6750
6780
  set startWithNewLine(val: boolean);
@@ -6781,7 +6811,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6781
6811
  protected getCssType(): string;
6782
6812
  get renderCssRoot(): string;
6783
6813
  /*
6784
- * Move the focus to the input of this question.
6814
+ * Moves focus to the input field of this question.
6785
6815
  */
6786
6816
  focus(onError?: boolean): void;
6787
6817
  focusIn: any;
@@ -6795,33 +6825,33 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6795
6825
  supportComment(): boolean;
6796
6826
  supportOther(): boolean;
6797
6827
  /*
6798
- * Set this property to true, to make the question a required. If a user doesn't answer the question then a validation error will be generated.
6799
- * Please note, this property is hidden for question without input, for example html question.
6828
+ * Makes the question required. If a respondent skips a required question, the survey displays a validation error.
6800
6829
  */
6801
6830
  get isRequired(): boolean;
6802
6831
  set isRequired(val: boolean);
6803
6832
  /*
6804
- * An expression that returns true or false. If it returns true the Question becomes required and an end-user has to answer it.
6805
- * If it returns false the Question then an end-user may not answer it the Question maybe empty.
6806
- * The library runs the expression on survey start and on changing a question value. If the property is empty then isRequired property is used.
6807
- * Please note, this property is hidden for question without input, for example html question.
6833
+ * A Boolean expression. If it evaluates to `true`, this question becomes required.
6834
+ *
6835
+ * A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
6836
+ *
6837
+ * Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility)
6808
6838
  */
6809
6839
  get requiredIf(): string;
6810
6840
  set requiredIf(val: string);
6811
6841
  /*
6812
- * Set it to true, to add a comment for the question.
6842
+ * Specifies whether to display a comment area. Incompatible with the `hasOther` property.
6813
6843
  */
6814
6844
  get hasComment(): boolean;
6815
6845
  set hasComment(val: boolean);
6816
6846
  /*
6817
- * The unique identificator. It is generated automatically.
6847
+ * A value to assign to the `id` attribute of the rendered HTML element. A default `id` is generated automatically.
6818
6848
  */
6819
6849
  get id(): string;
6820
6850
  set id(val: string);
6821
6851
  get ariaTitleId(): string;
6822
6852
  get ariaRole(): string;
6823
6853
  /*
6824
- * Specifies whether to display the "Other" choice item.
6854
+ * Specifies whether to display the "Other" choice item. Incompatible with the `hasComment` property.
6825
6855
  */
6826
6856
  get hasOther(): boolean;
6827
6857
  set hasOther(val: boolean);
@@ -6833,19 +6863,20 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6833
6863
  get renderedInputDisabled(): string;
6834
6864
  protected onReadOnlyChanged(): void;
6835
6865
  /*
6836
- * An expression that returns true or false. If it returns false the Question becomes read only and an end-user will not able to answer on the qustion. The library runs the expression on survey start and on changing a question value. If the property is empty then readOnly property is used.
6837
- * Please note, this property is hidden for question without input, for example html question.
6866
+ * A Boolean expression. If it evaluates to `false`, this question becomes read-only.
6867
+ *
6868
+ * A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
6869
+ *
6870
+ * Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility)
6838
6871
  */
6839
6872
  get enableIf(): string;
6840
6873
  set enableIf(val: string);
6841
6874
  surveyChoiceItemVisibilityChange(): void;
6842
- /*
6843
- * Run visibleIf and enableIf expressions. If visibleIf or/and enabledIf are not empty, then the results of performing the expression (true or false) set to the visible/readOnly properties.
6844
- */
6845
6875
  runCondition(values: any, properties: any): void;
6846
6876
  /*
6847
- * The property returns the question number. If question is invisible then it returns empty string.
6848
- * If visibleIndex is 1, then no is 2, or 'B' if survey.questionStartIndex is 'A'.
6877
+ * A question number or letter (depends on SurveyModel's `questionStartIndex` property).
6878
+ *
6879
+ * For invisible questions, this property returns an empty string.
6849
6880
  */
6850
6881
  get no(): string;
6851
6882
  protected getStartIndex(): string;
@@ -6855,13 +6886,13 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6855
6886
  protected initCommentFromSurvey(): void;
6856
6887
  protected runExpression(expression: string): any;
6857
6888
  /*
6858
- * Get/Set the question value.
6889
+ * Gets or sets the question value.
6859
6890
  */
6860
6891
  get value(): any;
6861
6892
  set value(val: any);
6862
6893
  get valueForSurvey(): any;
6863
6894
  /*
6864
- * Clear the question value. It clears the question comment as well.
6895
+ * Sets the question's `value` and `comment` properties to `undefined`.
6865
6896
  */
6866
6897
  clearValue(): void;
6867
6898
  unbindValue(): void;
@@ -6869,32 +6900,32 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6869
6900
  protected getUnbindValue(value: any): any;
6870
6901
  protected isValueSurveyElement(val: any): boolean;
6871
6902
  /*
6872
- * Return true if there is a parent (page or panel) and it is visible
6903
+ * Returns `true` if a parent element (page or panel) is visible.
6873
6904
  */
6874
6905
  get isParentVisible(): boolean;
6875
6906
  clearValueIfInvisible(reason?: string): void;
6876
6907
  protected clearValueIfInvisibleCore(): void;
6877
6908
  /*
6878
- * Gets or sets a value that specifies how invisible question clears the value. By default the behavior is define by Survey "clearInvisibleValues" property.
6909
+ * Specifies when to clear the question value if the question becomes invisible.
6879
6910
  *
6880
- * The following options are available:
6911
+ * Possible values:
6881
6912
  *
6882
- * - `default` (default) - Survey "clearInvisibleValues" property defines the behavior.
6883
- * - `none` - do not clear invisible value.
6884
- * - `onHidden` - clear the question value when it becomes invisible. If a question has value and it was invisible initially then survey clears the value on completing.
6885
- * - `onComplete` - clear invisible question value on survey complete.
6913
+ * - `"default"` (default) - Inherits the setting from the Survey's [`clearInvisibleValues`](https://surveyjs.io/form-library/documentation/surveymodel#clearInvisibleValues) property.
6914
+ * - `"onHidden"` - Clears the value when the question becomes invisible. If a question is invisible on startup and has an initial value, this value will be cleared when the survey is complete.
6915
+ * - `"onComplete"` - Clears the value when the survey is complete.
6916
+ * - `"none"` - Never clears the value of an invisible question.
6886
6917
  */
6887
6918
  get clearIfInvisible(): string;
6888
6919
  set clearIfInvisible(val: string);
6889
6920
  get displayValue(): any;
6890
6921
  /*
6891
- * Return the question value as a display text. For example, for dropdown, it would return the item text instead of item value.
6922
+ * Returns a display text that corresponds to the question value. For example, if you call this method for a Dropdown question, it returns an item text instead of an item value.
6892
6923
  */
6893
6924
  getDisplayValue(keysAsText: boolean, value?: any): any;
6894
6925
  protected getDisplayValueCore(keyAsText: boolean, value: any): any;
6895
6926
  protected getDisplayValueEmpty(): string;
6896
6927
  /*
6897
- * A default value for the question. Ignored for question types that cannot have a [value](https://surveyjs.io/Documentation/Library?id=Question#value) (for example, HTML).
6928
+ * A default value for the question. Ignored for question types that cannot have a [value](https://surveyjs.io/form-library/documentation/question#value) (for example, HTML).
6898
6929
  *
6899
6930
  * The default value is used as a question value in the following cases:
6900
6931
  *
@@ -6905,9 +6936,9 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6905
6936
  get defaultValue(): any;
6906
6937
  set defaultValue(val: any);
6907
6938
  /*
6908
- * An expression used to calculate the [defaultValue](https://surveyjs.io/Documentation/Library?id=Question#defaultValue).
6939
+ * An expression used to calculate the [defaultValue](https://surveyjs.io/form-library/documentation/question#defaultValue).
6909
6940
  *
6910
- * This expression applies until the question [value](https://surveyjs.io/Documentation/Library?id=Question#value) is specified by an end user or programmatically.
6941
+ * This expression applies until the question [value](https://surveyjs.io/form-library/documentation/question#value) is specified by an end user or programmatically.
6911
6942
  *
6912
6943
  * An expression can reference other questions as follows:
6913
6944
  *
@@ -6915,26 +6946,27 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6915
6946
  * - `{panel.other_question_name}` (to access questions inside the same dynamic panel)
6916
6947
  * - `{row.other_question_name}` (to access questions inside the same dynamic matrix or multi-column dropdown)
6917
6948
  *
6918
- * An expression can also include built-in and custom functions for advanced calculations. For example, if the `defaultValue` should be today's date, set the `defaultValueExpression` to `"today()"`, and the corresponding built-in function will be executed each time the survey is loaded. Refer to the following help topic for more information: [Use Functions in Expressions](https://surveyjs.io/Documentation/Library#conditions-functions).
6949
+ * An expression can also include built-in and custom functions for advanced calculations. For example, if the `defaultValue` should be today's date, set the `defaultValueExpression` to `"today()"`, and the corresponding built-in function will be executed each time the survey is loaded. Refer to the following help topic for more information: [Built-In Functions](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#built-in-functions).
6919
6950
  */
6920
6951
  get defaultValueExpression(): any;
6921
6952
  set defaultValueExpression(val: any);
6922
6953
  get resizeStyle(): "none" | "both";
6923
6954
  /*
6924
- * Returns question answer data as a plain object: with question title, name, value and displayValue.
6925
- * For complex questions (like matrix, etc.) isNode flag is set to true and data contains array of nested objects (rows)
6926
- * set options.includeEmpty to false if you want to skip empty answers
6955
+ * Returns the question value as an object in which the question name, title, value, and other parameters are stored as individual properties.
6956
+ *
6957
+ * If the question can have more than one value (Matrix, Multiple Text), the object enables the `isNode` flag and stores information about these values in the `data` property. Refer to the following help topic for more information: [Access Full Survey Results](https://surveyjs.io/form-library/documentation/handle-survey-results-access#access-full-survey-results).
6958
+ *
6959
+ * Pass an object with the `includeEmpty` property set to `false` if you want to skip empty answers.
6927
6960
  */
6928
6961
  getPlainData(options?: any): any;
6929
6962
  /*
6930
- * The correct answer on the question. Set this value if you are doing a quiz.
6931
- * Please note, this property is hidden for question without input, for example html question.
6963
+ * A correct answer to this question. Specify this property if you want to [create a quiz](https://surveyjs.io/form-library/documentation/design-survey-create-a-quiz).
6932
6964
  */
6933
6965
  get correctAnswer(): any;
6934
6966
  set correctAnswer(val: any);
6935
6967
  protected convertDefaultValue(val: any): any;
6936
6968
  /*
6937
- * Returns questions count: 1 for the non-matrix questions and all inner visible questions that has input(s) widgets for question of matrix types.
6969
+ * The number of quiz questions. A question counts if it is visible, has an input field, and specifies `correctAnswer`.
6938
6970
  */
6939
6971
  get quizQuestionCount(): number;
6940
6972
  get correctAnswerCount(): number;
@@ -6951,14 +6983,14 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6951
6983
  protected isValueExpression(val: any): boolean;
6952
6984
  protected setValueAndRunExpression(runner: ExpressionRunner, defaultValue: any, setFunc: (val: any) => void, values?: any, properties?: any): void;
6953
6985
  /*
6954
- * The question comment value.
6986
+ * A comment to the selected question value. Enable the `hasComment` property to allow users to leave comments.
6955
6987
  */
6956
6988
  get comment(): string;
6957
6989
  set comment(val: string);
6958
6990
  protected getQuestionComment(): string;
6959
6991
  protected setQuestionComment(newValue: string): void;
6960
6992
  /*
6961
- * Returns true if the question value is empty
6993
+ * Returns `true` if the question value is an empty string, array, or object or if it equals `undefined` or `null`.
6962
6994
  */
6963
6995
  isEmpty(): boolean;
6964
6996
  get isAnswered(): boolean;
@@ -6966,8 +6998,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6966
6998
  protected updateIsAnswered(): void;
6967
6999
  protected getIsAnswered(): boolean;
6968
7000
  /*
6969
- * The list of question validators.
6970
- * Please note, this property is hidden for question without input, for example html question.
7001
+ * Question validators.
6971
7002
  */
6972
7003
  get validators(): any;
6973
7004
  set validators(val: any);
@@ -6979,21 +7010,12 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6979
7010
  * Returns true if there is a validation error(s) in the question.
6980
7011
  */
6981
7012
  hasErrors(fireCallback?: boolean, rec?: any): boolean;
6982
- /*
6983
- * Returns the validation errors count.
6984
- */
6985
7013
  get currentErrorCount(): number;
6986
7014
  /*
6987
- * Returns the char/string for a required question.
7015
+ * Returns a character or text string that indicates a required question.
6988
7016
  */
6989
7017
  get requiredText(): string;
6990
- /*
6991
- * Add error into the question error list.
6992
- */
6993
7018
  addError(error: string | SurveyError): void;
6994
- /*
6995
- * Remove a particular error from the question error list.
6996
- */
6997
7019
  removeError(error: SurveyError): void;
6998
7020
  protected canCollectErrors(): boolean;
6999
7021
  protected canRunValidators(isOnValueChanged: boolean): boolean;
@@ -7030,13 +7052,16 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
7030
7052
  supportGoNextPageAutomatic(): boolean;
7031
7053
  supportGoNextPageError(): boolean;
7032
7054
  /*
7033
- * Call this function to remove values from the current question, that end-user will not be able to enter.
7034
- * For example the value that doesn't exists in a radigroup/dropdown/checkbox choices or matrix rows/columns.
7055
+ * Removes values that cannot be assigned to this question, for example, choices unlisted in the `choices` array.
7056
+ *
7057
+ * Call this method after you assign new question values in code to ensure that they are acceptable.
7058
+ *
7059
+ * > NOTE: This method does not remove values that do not pass validation. Call the `hasErrors()` method to validate newly assigned values.
7035
7060
  */
7036
7061
  clearIncorrectValues(): void;
7037
7062
  clearOnDeletingContainer(): void;
7038
7063
  /*
7039
- * Call this function to clear all errors in the question
7064
+ * Empties the `errors` array.
7040
7065
  */
7041
7066
  clearErrors(): void;
7042
7067
  clearUnusedValues(): void;
@@ -7125,6 +7150,7 @@ export declare class SurveyQuestionDropdownBase<T> extends SurveyQuestionUncontr
7125
7150
  protected setValueCore(newValue: any): void;
7126
7151
  protected getValueCore(): any;
7127
7152
  protected renderSelect(cssClasses: any): JSX.Element;
7153
+ renderValueElement(dropdownListModel: any): JSX.Element;
7128
7154
  protected renderInput(dropdownListModel: any): JSX.Element;
7129
7155
  createClearButton(): JSX.Element;
7130
7156
  protected renderOther(cssClasses: any): JSX.Element;
@@ -7359,10 +7385,6 @@ export declare class PanelModel extends PanelModelBase implements IElement {
7359
7385
  get page(): IPage;
7360
7386
  set page(val: IPage);
7361
7387
  delete(): void;
7362
- /*
7363
- * Move panel to a new container Page/Panel. Add as a last element if insertBefore parameter is not used or inserted into the given index,
7364
- * if insert parameter is number, or before the given element, if the insertBefore parameter is a question or panel
7365
- */
7366
7388
  moveTo(container: IPanel, insertBefore?: any): boolean;
7367
7389
  /*
7368
7390
  * Returns the visible index of the panel in the survey. Commonly it is -1 and it doesn't show.
@@ -7772,6 +7794,7 @@ export declare class QuestionFileModel extends Question {
7772
7794
  */
7773
7795
  loadFiles(files: any): void;
7774
7796
  canPreviewImage(fileItem: any): boolean;
7797
+ protected loadPreview(newValue: any): void;
7775
7798
  protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
7776
7799
  protected onCheckForErrors(errors: any, isOnValueChanged: boolean): void;
7777
7800
  protected stateChanged(state: string): void;
@@ -8305,7 +8328,16 @@ export declare class QuestionRatingModel extends Question {
8305
8328
  * When the `displayRateDescriptionsAsExtremeItems` property is disabled, the texts defined through the [minRateDescription](https://surveyjs.io/Documentation/Library?id=questionratingmodel#minRateDescription) and [maxRateDescription](https://surveyjs.io/Documentation/Library?id=questionratingmodel#maxRateDescription) properties are displayed as plain non-clickable texts.
8306
8329
  */
8307
8330
  displayRateDescriptionsAsExtremeItems: boolean;
8308
- useDropdown: "auto" | "always" | "never";
8331
+ /*
8332
+ * Specifies how a Rating question displays rate values.
8333
+ *
8334
+ * Possible values:
8335
+ *
8336
+ * - `"buttons"` - Displays rate values as buttons in a row.
8337
+ * - `"dropdown"` - Displays rate values as items in a drop-down list.
8338
+ * - `"auto"` (default) - Selects between the `"buttons"` and `"dropdown"` modes based on the available width. When the width is insufficient to display buttons, the question displays a dropdown.
8339
+ */
8340
+ displayMode: "dropdown" | "auto" | "buttons";
8309
8341
  protected valueToData(val: any): any;
8310
8342
  /*
8311
8343
  * Click value again to clear.
@@ -8484,9 +8516,11 @@ export declare class QuestionSelectBase extends Question {
8484
8516
  /*
8485
8517
  * Use this property to set the place holder text for other or comment field .
8486
8518
  */
8519
+ get otherPlaceholder(): string;
8520
+ set otherPlaceholder(val: string);
8521
+ get locOtherPlaceholder(): LocalizableString;
8487
8522
  get otherPlaceHolder(): string;
8488
8523
  set otherPlaceHolder(val: string);
8489
- get locOtherPlaceHolder(): LocalizableString;
8490
8524
  /*
8491
8525
  * The text that shows when the other item is choosed by the other input is empty.
8492
8526
  */
@@ -8592,6 +8626,12 @@ export declare class QuestionSelectBase extends Question {
8592
8626
  afterRender(el: any): void;
8593
8627
  prevIsOtherSelected: boolean;
8594
8628
  protected onValueChanged(): void;
8629
+ protected getDefaultItemComponent(): string;
8630
+ /*
8631
+ * The name of a component used to render items.
8632
+ */
8633
+ get itemComponent(): string;
8634
+ set itemComponent(val: string);
8595
8635
  }
8596
8636
  /*
8597
8637
  * A Model for signature pad question.
@@ -8856,6 +8896,8 @@ export declare class QuestionCustomModel extends QuestionCustomModelBase {
8856
8896
  export declare class QuestionDropdownModel extends QuestionSelectBase {
8857
8897
  constructor(name: string);
8858
8898
  dropdownListModel: DropdownListModel;
8899
+ updateReadOnlyText(): void;
8900
+ locStrsChanged(): void;
8859
8901
  get showOptionsCaption(): boolean;
8860
8902
  set showOptionsCaption(val: boolean);
8861
8903
  get optionsCaption(): string;
@@ -8897,10 +8939,6 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
8897
8939
  */
8898
8940
  allowClear: boolean;
8899
8941
  /*
8900
- * The name of a component used to render drop-down menu items.
8901
- */
8902
- itemComponent: string;
8903
- /*
8904
8942
  * Specifies whether users can enter a value into the input field to filter the drop-down list.
8905
8943
  */
8906
8944
  searchEnabled: boolean;
@@ -8910,8 +8948,13 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
8910
8948
  get cleanButtonCaption(): string;
8911
8949
  set cleanButtonCaption(val: string);
8912
8950
  get locCleanButtonCaption(): LocalizableString;
8951
+ inputHasValue: boolean;
8952
+ readOnlyText: string;
8913
8953
  getControlClass(): string;
8914
- get readOnlyText(): string;
8954
+ get selectedItemLocText(): LocalizableString;
8955
+ get inputFieldComponentName(): string;
8956
+ get showSelectedItemLocText(): boolean;
8957
+ get showInputFieldComponent(): boolean;
8915
8958
  get popupModel(): any;
8916
8959
  onOpened: EventBase<QuestionDropdownModel>;
8917
8960
  onOpenedCallBack(): void;
@@ -9436,6 +9479,7 @@ export declare class QuestionCheckboxModel extends QuestionCheckboxBase {
9436
9479
  constructor(name: string);
9437
9480
  selectAllItemValue: ItemValue;
9438
9481
  invisibleOldValues: any;
9482
+ protected getDefaultItemComponent(): string;
9439
9483
  get ariaRole(): string;
9440
9484
  getType(): string;
9441
9485
  protected onCreating(): void;
@@ -9806,6 +9850,7 @@ export declare class QuestionMatrixDynamicModel extends QuestionMatrixDropdownMo
9806
9850
  */
9807
9851
  export declare class QuestionRadiogroupModel extends QuestionCheckboxBase {
9808
9852
  constructor(name: string);
9853
+ protected getDefaultItemComponent(): string;
9809
9854
  getType(): string;
9810
9855
  get ariaRole(): string;
9811
9856
  get titleAriaLabel(): string;
@@ -9831,6 +9876,7 @@ export declare class QuestionRadiogroupModel extends QuestionCheckboxBase {
9831
9876
  export declare class QuestionRankingModel extends QuestionCheckboxModel {
9832
9877
  constructor(name: string);
9833
9878
  domNode: any;
9879
+ protected getDefaultItemComponent(): string;
9834
9880
  getType(): string;
9835
9881
  get rootClass(): string;
9836
9882
  protected getItemClassCore(item: ItemValue, options: any): string;
@@ -9876,6 +9922,7 @@ export declare class QuestionRankingModel extends QuestionCheckboxModel {
9876
9922
  export declare class QuestionTagboxModel extends QuestionCheckboxModel {
9877
9923
  constructor(name: string);
9878
9924
  dropdownListModel: DropdownMultiSelectListModel;
9925
+ protected getDefaultItemComponent(): string;
9879
9926
  get readOnlyText(): any;
9880
9927
  onSurveyLoad(): void;
9881
9928
  /*
@@ -9887,10 +9934,6 @@ export declare class QuestionTagboxModel extends QuestionCheckboxModel {
9887
9934
  */
9888
9935
  searchEnabled: boolean;
9889
9936
  /*
9890
- * The name of a component used to render drop-down menu items.
9891
- */
9892
- itemComponent: string;
9893
- /*
9894
9937
  * Specifies whether to remove selected items from the drop-down list.
9895
9938
  */
9896
9939
  hideSelectedItems: boolean;
@@ -9945,6 +9988,7 @@ export declare var settings: {
9945
9988
  trimStrings: boolean,
9946
9989
  caseSensitive: boolean,
9947
9990
  },
9991
+ expressionDisableConversionChar: string,
9948
9992
  /*
9949
9993
  * Set this value to false, if you want to have UTC fuctions, for example setUTCHours inside our functions, like today.
9950
9994
  * By default it uses setHours function, with local date
@@ -10042,6 +10086,10 @@ export declare var settings: {
10042
10086
  */
10043
10087
  executeCompleteTriggerOnValueChanged: boolean,
10044
10088
  /*
10089
+ * Set this property to false to stop showing "Compete" button when the complete trigger is going to be executed.
10090
+ */
10091
+ changeNavigationButtonsOnCompleteTrigger: boolean,
10092
+ /*
10045
10093
  * Set this property to false to execute the skip trigger on next page instead of on value change.
10046
10094
  */
10047
10095
  executeSkipTriggerOnValueChanged: boolean,
@@ -10343,6 +10391,7 @@ export declare var defaultStandardCss: {
10343
10391
  dropdown: {
10344
10392
  root: string,
10345
10393
  control: string,
10394
+ controlInputFieldComponent: string,
10346
10395
  selectWrapper: string,
10347
10396
  other: string,
10348
10397
  cleanButton: string,
@@ -10728,10 +10777,12 @@ export declare var defaultBootstrapCss: {
10728
10777
  root: string,
10729
10778
  selectWrapper: string,
10730
10779
  control: string,
10780
+ controlValue: string,
10731
10781
  other: string,
10732
10782
  cleanButton: string,
10733
10783
  cleanButtonSvg: string,
10734
10784
  cleanButtonIconId: string,
10785
+ filterStringInput: string,
10735
10786
  },
10736
10787
  tagbox: {
10737
10788
  root: string,
@@ -10741,6 +10792,7 @@ export declare var defaultBootstrapCss: {
10741
10792
  cleanButton: string,
10742
10793
  cleanButtonSvg: string,
10743
10794
  cleanButtonIconId: string,
10795
+ filterStringInput: string,
10744
10796
  },
10745
10797
  html: {
10746
10798
  root: string,
@@ -11062,10 +11114,12 @@ export declare var defaultBootstrapMaterialCss: {
11062
11114
  root: string,
11063
11115
  selectWrapper: string,
11064
11116
  control: string,
11117
+ controlValue: string,
11065
11118
  other: string,
11066
11119
  cleanButton: string,
11067
11120
  cleanButtonSvg: string,
11068
11121
  cleanButtonIconId: string,
11122
+ filterStringInput: string,
11069
11123
  },
11070
11124
  tagbox: {
11071
11125
  root: string,
@@ -11075,6 +11129,7 @@ export declare var defaultBootstrapMaterialCss: {
11075
11129
  cleanButton: string,
11076
11130
  cleanButtonSvg: string,
11077
11131
  cleanButtonIconId: string,
11132
+ filterStringInput: string,
11078
11133
  },
11079
11134
  html: {
11080
11135
  root: string,
@@ -11527,6 +11582,7 @@ export declare var defaultV2Css: {
11527
11582
  cleanButtonSvg: string,
11528
11583
  cleanButtonIconId: string,
11529
11584
  control: string,
11585
+ controlInputFieldComponent: string,
11530
11586
  controlValue: string,
11531
11587
  controlDisabled: string,
11532
11588
  controlEmpty: string,
@@ -12057,6 +12113,7 @@ export declare var modernCss: {
12057
12113
  cleanButtonIconId: string,
12058
12114
  filterStringInput: string,
12059
12115
  controlValue: string,
12116
+ controlInputFieldComponent: string,
12060
12117
  },
12061
12118
  tagbox: {
12062
12119
  root: string,