survey-react 1.9.37 → 1.9.40

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.37
2
+ * Type definition for Survey JavaScript library for React v1.9.40
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
  */
@@ -184,10 +184,15 @@ export interface IAction {
184
184
  * If you set it to `false`, the `title` hides when the screen space is limited, and the item displays only the icon.
185
185
  */
186
186
  disableShrink?: boolean;
187
+ disableHide?: boolean;
187
188
  mode?: any;
188
189
  visibleIndex?: number;
189
190
  needSpace?: boolean;
190
191
  }
192
+ export interface IAttachKey2clickOptions {
193
+ processEsc?: boolean;
194
+ disableTabStop?: boolean;
195
+ }
191
196
  export interface IDimensions {
192
197
  scroll: number;
193
198
  offset: number;
@@ -362,7 +367,7 @@ export interface ISurvey extends ITextProcessor, ISurveyErrorOwner {
362
367
  isValidateOnValueChanging: boolean;
363
368
  isValidateOnValueChanged: boolean;
364
369
  matrixCellValidate(question: IQuestion, options: any): SurveyError;
365
- dynamicPanelAdded(question: IQuestion): any;
370
+ dynamicPanelAdded(question: IQuestion, panelIndex?: number, panel?: IPanel): any;
366
371
  dynamicPanelRemoved(question: IQuestion, panelIndex: number, panel: IPanel): any;
367
372
  dynamicPanelItemValueChanged(question: IQuestion, options: any): any;
368
373
  dragAndDropAllow(options: any): boolean;
@@ -530,6 +535,129 @@ export interface IQuestionPanelDynamicData {
530
535
  getSurvey(): ISurvey;
531
536
  getRootData(): ISurveyData;
532
537
  }
538
+ /*
539
+ * An interface used to create custom question types.
540
+ *
541
+ * Refer to the following articles for more information:
542
+ *
543
+ * - [Create Specialized Question Types](https://surveyjs.io/Documentation/Survey-Creator?id=create-specialized-question-types)
544
+ * - [Create Composite Question Types](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types)
545
+ */
546
+ export interface ICustomQuestionTypeConfiguration {
547
+ /*
548
+ * A name used to identify a custom question type.
549
+ */
550
+ name: string;
551
+ /*
552
+ * A title used for this custom question type in the UI. When `title` is not specified, the `name` property value is used.
553
+ */
554
+ title?: string;
555
+ /*
556
+ * An icon for the custom question type.
557
+ */
558
+ icon?: string;
559
+ /*
560
+ * A function that is called when the custom question type is initialized. Use it to add, remove, or modify the type's properties (see [Override Base Question Properties](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types#override-base-question-properties)).
561
+ */
562
+ onInit(): void;
563
+ /*
564
+ * Specifies whether the custom question type is available in the Toolbox and the Add Question menu.
565
+ *
566
+ * Default value: `true`
567
+ *
568
+ * Set this property to `false` if your custom question type is used only to customize Property Grid content and is not meant for a survey.
569
+ */
570
+ showInToolbox?: boolean;
571
+ /*
572
+ * A function that is called when the custom question is created. Use it to access questions nested within a [composite question type](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types).
573
+ *
574
+ * Parameters:
575
+ *
576
+ * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The custom question.
577
+ */
578
+ onCreated(question: Question): void;
579
+ /*
580
+ * A function that is called when JSON definitions are loaded.
581
+ *
582
+ * Parameters:
583
+ *
584
+ * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The custom question.
585
+ */
586
+ onLoaded(question: Question): void;
587
+ /*
588
+ * A function that is called after the entire question is rendered.
589
+ *
590
+ * Parameters:
591
+ *
592
+ * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The custom question.
593
+ * - `htmlElement`: any - An HTML element that represents the custom question.
594
+ */
595
+ onAfterRender(question: Question, htmlElement: any): void;
596
+ /*
597
+ * A function that is called each time a question nested within a [composite question](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types) is rendered.
598
+ *
599
+ * Parameters:
600
+ *
601
+ * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The composite question.
602
+ * - `element`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - A nested question.
603
+ * - `htmlElement`: any - An HTML element that represents the nested question.
604
+ */
605
+ onAfterRenderContentElement(question: Question, element: Question, htmlElement: any): void;
606
+ /*
607
+ * A function that is called when a custom question type property is changed. Use it to handle property changes.
608
+ *
609
+ * Parameters:
610
+ *
611
+ * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The custom question.
612
+ * - `propertyName`: string - The name of the changed property.
613
+ * - `newValue`: any - A new value for the property.
614
+ */
615
+ onPropertyChanged(question: Question, propertyName: string, newValue: any): void;
616
+ /*
617
+ * A function that is called when the question value is changed.
618
+ *
619
+ * Parameters:
620
+ *
621
+ * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The custom question.
622
+ * - `name`: string - The question's [name](https://surveyjs.io/Documentation/Library?id=Question#name).
623
+ * - `newValue`: any - A new value for the question.
624
+ */
625
+ onValueChanged(question: Question, name: string, newValue: any): void;
626
+ /*
627
+ * A function that is called when an [ItemValue](https://surveyjs.io/Documentation/Library?id=itemvalue) property is changed.
628
+ *
629
+ * Parameters:
630
+ *
631
+ * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The custom question.
632
+ * - `options.obj`: [ItemValue](https://surveyjs.io/Documentation/Library?id=itemvalue) - An `ItemValue` object.
633
+ * - `options.propertyName`: string - The name of the property to which an array of `ItemValue` objects is assigned (for example, `"choices"` or `"rows"`).
634
+ * - `options.name`: string - The name of the changed property: `"text"` or `"value"`.
635
+ * - `options.newValue`: any - A new value for the property.
636
+ */
637
+ onItemValuePropertyChanged(question: Question, options: any): void;
638
+ /*
639
+ * A function that allows you to override the default `getDisplayValue()` implementation.
640
+ */
641
+ getDisplayValue?: any;
642
+ /*
643
+ * JSON definitions of nested questions. Specify this property to create a [composite question type](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types).
644
+ */
645
+ elementsJSON?: any;
646
+ /*
647
+ * A function that allows you to create nested questions if you do not specify the `elementsJSON` property.
648
+ */
649
+ createElements?: any;
650
+ /*
651
+ * A JSON definition for a built-in question type on which the custom question type is based.
652
+ *
653
+ * Refer to the [Create Specialized Question Types](https://surveyjs.io/Documentation/Survey-Creator?id=create-specialized-question-types) help topic for more information.
654
+ */
655
+ questionJSON?: any;
656
+ /*
657
+ * A function that allows you to create a custom question if you do not specify the `questionJSON` property.
658
+ */
659
+ createQuestion?: any;
660
+ }
533
661
  export interface IActionBarItemProps {
534
662
  item: any;
535
663
  }
@@ -716,6 +844,11 @@ export declare class Base {
716
844
  get isEditingSurveyElement(): boolean;
717
845
  iteratePropertiesHash(func: (hash: any, key: any) => void): void;
718
846
  /*
847
+ * set property value and before check if new property value is correct by calling JsonProperty onSettingValue function
848
+ * If onSettingValue is not set in declaration, then this function works as `setPropertyValue`.
849
+ */
850
+ checkAndSetPropertyValue(name: string, val: any): void;
851
+ /*
719
852
  * set property value
720
853
  */
721
854
  setPropertyValue(name: string, val: any): void;
@@ -786,6 +919,11 @@ export declare class Bindings {
786
919
  getJson(): any;
787
920
  setJson(value: any): void;
788
921
  }
922
+ export declare class BrandInfo extends React.Component<any, any> {
923
+ constructor(props: any);
924
+ constructor(props: any, context: any);
925
+ render(): JSX.Element;
926
+ }
789
927
  export declare class ButtonGroupItemModel {
790
928
  constructor(question: QuestionButtonGroupModel, item: ItemValue, index: number);
791
929
  question: QuestionButtonGroupModel;
@@ -812,7 +950,7 @@ export declare class ComponentCollection {
812
950
  onCreateComposite: (name: string, questionJSON: ComponentQuestionJSON) => QuestionCompositeModel;
813
951
  onCreateCustom: (name: string, questionJSON: ComponentQuestionJSON) => QuestionCustomModel;
814
952
  onAddingJson: (name: string, isComposite: boolean) => void;
815
- add(json: any): void;
953
+ add(json: ICustomQuestionTypeConfiguration): void;
816
954
  get items(): any;
817
955
  getCustomQuestionByName(name: string): ComponentQuestionJSON;
818
956
  clear(): void;
@@ -821,9 +959,9 @@ export declare class ComponentCollection {
821
959
  protected createCustomModel(name: string, questionJSON: ComponentQuestionJSON): QuestionCustomModel;
822
960
  }
823
961
  export declare class ComponentQuestionJSON {
824
- constructor(name: string, json: any);
962
+ constructor(name: string, json: ICustomQuestionTypeConfiguration);
825
963
  name: string;
826
- json: any;
964
+ json: ICustomQuestionTypeConfiguration;
827
965
  onInit(): void;
828
966
  onCreated(question: Question): void;
829
967
  onLoaded(question: Question): void;
@@ -943,6 +1081,8 @@ export declare class Event<T, Options> {
943
1081
  onCallbacksChanged: any;
944
1082
  protected callbacks: any;
945
1083
  get isEmpty(): boolean;
1084
+ get length(): number;
1085
+ fireByCreatingOptions(sender: any, createOptions: any): void;
946
1086
  fire(sender: any, options: any): void;
947
1087
  clear(): void;
948
1088
  add(func: T): void;
@@ -1502,6 +1642,7 @@ export declare class Action extends Base implements IAction {
1502
1642
  mode: any;
1503
1643
  disableTabStop: boolean;
1504
1644
  disableShrink: boolean;
1645
+ disableHide: boolean;
1505
1646
  needSpace: boolean;
1506
1647
  locTitle: any;
1507
1648
  titleValue: string;
@@ -1772,6 +1913,16 @@ export declare class DragDropCore<T> extends Base {
1772
1913
  protected clear: any;
1773
1914
  protected doClear(): void;
1774
1915
  }
1916
+ export declare class DropdownListModel extends Base {
1917
+ constructor(question: Question);
1918
+ _popupModel: any;
1919
+ get popupModel(): any;
1920
+ updateItems(): void;
1921
+ onClick(event: any): void;
1922
+ onClear(event: any): void;
1923
+ onKeyUp(event: any): void;
1924
+ onBlur(event: any): void;
1925
+ }
1775
1926
  export declare class EventBase<T> extends Event<any, any> {
1776
1927
  }
1777
1928
  export declare class ExceedSizeError extends SurveyError {
@@ -1955,6 +2106,7 @@ export declare class JsonObjectProperty implements IObject {
1955
2106
  dataListValue: any;
1956
2107
  layout: string;
1957
2108
  onGetValue: (obj: any) => any;
2109
+ onSettingValue: (obj: any, value: any) => any;
1958
2110
  onSetValue: (obj: any, value: any, jsonConv: JsonObject) => any;
1959
2111
  visibleIf: (obj: any) => boolean;
1960
2112
  onExecuteExpression: (obj: any, res: any) => any;
@@ -1975,6 +2127,7 @@ export declare class JsonObjectProperty implements IObject {
1975
2127
  getValue(obj: any): any;
1976
2128
  getPropertyValue(obj: any): any;
1977
2129
  get hasToUseSetValue(): any;
2130
+ settingValue(obj: any, value: any): any;
1978
2131
  setValue(obj: any, value: any, jsonConv: JsonObject): void;
1979
2132
  getObjType(objType: string): any;
1980
2133
  getClassName(className: string): string;
@@ -2055,6 +2208,7 @@ export declare class LocalizableString implements ILocalizableString {
2055
2208
  localizationName: string;
2056
2209
  onGetTextCallback: (str: string) => string;
2057
2210
  onGetDefaultTextCallback: any;
2211
+ storeDefaultText: boolean;
2058
2212
  onGetLocalizationTextCallback: (str: string) => string;
2059
2213
  onStrChanged: (oldValue: string, newValue: string) => void;
2060
2214
  onSearchChanged: any;
@@ -2149,6 +2303,9 @@ export declare class MatrixDropdownColumn extends Base implements ILocalizableOw
2149
2303
  get fullTitle(): string;
2150
2304
  get isRequired(): boolean;
2151
2305
  set isRequired(val: boolean);
2306
+ get isRenderedRequired(): boolean;
2307
+ set isRenderedRequired(val: boolean);
2308
+ updateIsRenderedRequired(val: boolean): void;
2152
2309
  get requiredText(): string;
2153
2310
  get requiredErrorText(): string;
2154
2311
  set requiredErrorText(val: string);
@@ -2450,7 +2607,7 @@ export declare class PopupBaseViewModel extends Base {
2450
2607
  top: string;
2451
2608
  left: string;
2452
2609
  height: string;
2453
- width: string;
2610
+ minWidth: string;
2454
2611
  isVisible: boolean;
2455
2612
  popupDirection: string;
2456
2613
  pointerTarget: IPosition;
@@ -2511,7 +2668,6 @@ export declare class PopupModel<T = any> extends Base {
2511
2668
  cssClass: string;
2512
2669
  title: string;
2513
2670
  displayMode: "popup" | "overlay";
2514
- widthMode: "contentWidth" | "fixedWidth";
2515
2671
  onVisibilityChanged: EventBase<PopupModel<any>>;
2516
2672
  get isVisible(): boolean;
2517
2673
  set isVisible(val: boolean);
@@ -3391,6 +3547,7 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
3391
3547
  get titleActions(): any;
3392
3548
  isTitleActionRequested: boolean;
3393
3549
  getTitleActions(): Array<any>;
3550
+ protected getDefaultTitleActions(): Array<IAction>;
3394
3551
  get hasTitleActions(): boolean;
3395
3552
  get hasTitleEvents(): boolean;
3396
3553
  get titleTabIndex(): number;
@@ -3578,39 +3735,39 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
3578
3735
  navigationBarValue: any;
3579
3736
  /*
3580
3737
  * The event is fired after a trigger has been executed
3581
- * `sender` - the survey object that fires the event.
3582
- * `options.trigger` - An instance of a trigger that has been just perform it's action.
3738
+ * - `sender` - the survey object that fires the event.
3739
+ * - `options.trigger` - An instance of a trigger that has been just perform it's action.
3583
3740
  */
3584
3741
  onTriggerExecuted: EventBase<SurveyModel>;
3585
3742
  /*
3586
3743
  * The event is fired before the survey is completed and the `onComplete` event is fired. You can prevent the survey from completing by setting `options.allowComplete` to `false`
3587
- * `sender` - the survey object that fires the event.
3588
- * `options.allowComplete` - Specifies whether a user can complete a survey. Set this property to `false` to prevent the survey from completing. The default value is `true`.
3589
- * `options.isCompleteOnTrigger` - returns true if the survey is completing on "complete" trigger.
3744
+ * - `sender` - the survey object that fires the event.
3745
+ * - `options.allowComplete` - Specifies whether a user can complete a survey. Set this property to `false` to prevent the survey from completing. The default value is `true`.
3746
+ * - `options.isCompleteOnTrigger` - returns true if the survey is completing on "complete" trigger.
3590
3747
  */
3591
3748
  onCompleting: EventBase<SurveyModel>;
3592
3749
  /*
3593
3750
  * 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.
3594
- * `sender` - the survey object that fires the event.
3595
- * `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.
3596
- * `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.
3597
- * `options.showDataSavingSuccess(text)` - call this method to show that the data was successfully saved on the server.
3598
- * `options.showDataSavingClear` - call this method to hide the text about the saving progress.
3599
- * `options.isCompleteOnTrigger` - returns true if the survey is completed on "complete" trigger.
3751
+ * - `sender` - the survey object that fires the event.
3752
+ * - `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.
3753
+ * - `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.
3754
+ * - `options.showDataSavingSuccess(text)` - call this method to show that the data was successfully saved on the server.
3755
+ * - `options.showDataSavingClear` - call this method to hide the text about the saving progress.
3756
+ * - `options.isCompleteOnTrigger` - returns true if the survey is completed on "complete" trigger.
3600
3757
  */
3601
3758
  onComplete: EventBase<SurveyModel>;
3602
3759
  /*
3603
3760
  * The event is fired before the survey is going to preview mode, state equals to `preview`. It happens when a user click on "Preview" button. It shows when "showPreviewBeforeComplete" proeprty equals to "showAllQuestions" or "showAnsweredQuestions".
3604
3761
  * You can prevent showing it by setting allowShowPreview to `false`.
3605
- * `sender` - the survey object that fires the event.
3606
- * `options.allowShowPreview` - Specifies whether a user can see a preview. Set this property to `false` to prevent from showing the preview. The default value is `true`.
3762
+ * - `sender` - the survey object that fires the event.
3763
+ * - `options.allowShowPreview` - Specifies whether a user can see a preview. Set this property to `false` to prevent from showing the preview. The default value is `true`.
3607
3764
  */
3608
3765
  onShowingPreview: EventBase<SurveyModel>;
3609
3766
  /*
3610
3767
  * The event is fired after a user clicks the 'Complete' button. The event allows you to specify the URL opened after completing a survey.
3611
3768
  * Specify the `navigateToUrl` property to make survey navigate to another url.
3612
- * `sender` - the survey object that fires the event.
3613
- * `options.url` - Specifies a URL opened after completing a survey. Set this property to an empty string to cancel the navigation and show the completed survey page.
3769
+ * - `sender` - the survey object that fires the event.
3770
+ * - `options.url` - Specifies a URL opened after completing a survey. Set this property to an empty string to cancel the navigation and show the completed survey page.
3614
3771
  */
3615
3772
  onNavigateToUrl: EventBase<SurveyModel>;
3616
3773
  /*
@@ -3620,73 +3777,73 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
3620
3777
  onStarted: EventBase<SurveyModel>;
3621
3778
  /*
3622
3779
  * The event is fired on clicking the 'Next' button if the `sendResultOnPageNext` is set to `true`. You can use it to save the intermediate results, for example, if your survey is large enough.
3623
- * `sender` - the survey object that fires the event.
3780
+ * - `sender` - the survey object that fires the event.
3624
3781
  */
3625
3782
  onPartialSend: EventBase<SurveyModel>;
3626
3783
  /*
3627
3784
  * The event is fired before the current page changes to another page. Typically it happens when a user click the 'Next' or 'Prev' buttons.
3628
- * `sender` - the survey object that fires the event.
3629
- * `option.oldCurrentPage` - the previous current/active page.
3630
- * `option.newCurrentPage` - a new current/active page.
3631
- * `option.allowChanging` - set it to `false` to disable the current page changing. It is `true` by default.
3632
- * `option.isNextPage` - commonly means, that end-user press the next page button. In general, it means that options.newCurrentPage is the next page after options.oldCurrentPage
3633
- * `option.isPrevPage` - commonly means, that end-user press the previous page button. In general, it means that options.newCurrentPage is the previous page before options.oldCurrentPage
3785
+ * - `sender` - the survey object that fires the event.
3786
+ * - `option.oldCurrentPage` - the previous current/active page.
3787
+ * - `option.newCurrentPage` - a new current/active page.
3788
+ * - `option.allowChanging` - set it to `false` to disable the current page changing. It is `true` by default.
3789
+ * - `option.isNextPage` - commonly means, that end-user press the next page button. In general, it means that options.newCurrentPage is the next page after options.oldCurrentPage
3790
+ * - `option.isPrevPage` - commonly means, that end-user press the previous page button. In general, it means that options.newCurrentPage is the previous page before options.oldCurrentPage
3634
3791
  */
3635
3792
  onCurrentPageChanging: EventBase<SurveyModel>;
3636
3793
  /*
3637
3794
  * The event is fired when the current page has been changed to another page. Typically it happens when a user click on 'Next' or 'Prev' buttons.
3638
- * `sender` - the survey object that fires the event.
3639
- * `option.oldCurrentPage` - a previous current/active page.
3640
- * `option.newCurrentPage` - a new current/active page.
3641
- * `option.isNextPage` - commonly means, that end-user press the next page button. In general, it means that options.newCurrentPage is the next page after options.oldCurrentPage
3642
- * `option.isPrevPage` - commonly means, that end-user press the previous page button. In general, it means that options.newCurrentPage is the previous page before options.oldCurrentPage
3795
+ * - `sender` - the survey object that fires the event.
3796
+ * - `option.oldCurrentPage` - a previous current/active page.
3797
+ * - `option.newCurrentPage` - a new current/active page.
3798
+ * - `option.isNextPage` - commonly means, that end-user press the next page button. In general, it means that options.newCurrentPage is the next page after options.oldCurrentPage
3799
+ * - `option.isPrevPage` - commonly means, that end-user press the previous page button. In general, it means that options.newCurrentPage is the previous page before options.oldCurrentPage
3643
3800
  */
3644
3801
  onCurrentPageChanged: EventBase<SurveyModel>;
3645
3802
  /*
3646
3803
  * The event is fired before the question value (answer) is changed. It can be done via UI by a user or programmatically on calling the `setValue` method.
3647
- * `sender` - the survey object that fires the event.
3648
- * `options.name` - the value name that has being changed.
3649
- * `options.question` - a question which `question.name` equals to the value name. If there are several questions with the same name, the first question is used. If there is no such questions, the `options.question` is null.
3650
- * `options.oldValue` - an old, previous value.
3651
- * `options.value` - a new value. You can change it.
3804
+ * - `sender` - the survey object that fires the event.
3805
+ * - `options.name` - the value name that has being changed.
3806
+ * - `options.question` - a question which `question.name` equals to the value name. If there are several questions with the same name, the first question is used. If there is no such questions, the `options.question` is null.
3807
+ * - `options.oldValue` - an old, previous value.
3808
+ * - `options.value` - a new value. You can change it.
3652
3809
  */
3653
3810
  onValueChanging: EventBase<SurveyModel>;
3654
3811
  /*
3655
3812
  * The event is fired when the question value (i.e., answer) has been changed. The question value can be changed in UI (by a user) or programmatically (on calling `setValue` method).
3656
3813
  * Use the `onDynamicPanelItemValueChanged` and `onMatrixCellValueChanged` events to handle changes in a question in the Panel Dynamic and a cell question in matrices.
3657
- * `sender` - the survey object that fires the event.
3658
- * `options.name` - the value name that has been changed.
3659
- * `options.question` - a question which `question.name` equals to the value name. If there are several questions with the same name, the first question is used. If there is no such questions, the `options.question` is `null`.
3660
- * `options.value` - a new value.
3814
+ * - `sender` - the survey object that fires the event.
3815
+ * - `options.name` - the value name that has been changed.
3816
+ * - `options.question` - a question which `question.name` equals to the value name. If there are several questions with the same name, the first question is used. If there is no such questions, the `options.question` is `null`.
3817
+ * - `options.value` - a new value.
3661
3818
  */
3662
3819
  onValueChanged: EventBase<SurveyModel>;
3663
3820
  /*
3664
3821
  * The event is fired when setVariable function is called. It can be called on changing a calculated value.
3665
- * `sender` - the survey object that fires the event.
3666
- * `options.name` - the variable name that has been changed.
3667
- * `options.value` - a new value.
3822
+ * - `sender` - the survey object that fires the event.
3823
+ * - `options.name` - the variable name that has been changed.
3824
+ * - `options.value` - a new value.
3668
3825
  */
3669
3826
  onVariableChanged: EventBase<SurveyModel>;
3670
3827
  /*
3671
3828
  * The event is fired when a question visibility has been changed.
3672
- * `sender` - the survey object that fires the event.
3673
- * `options.question` - a question which visibility has been changed.
3674
- * `options.name` - a question name.
3675
- * `options.visible` - a question `visible` boolean value.
3829
+ * - `sender` - the survey object that fires the event.
3830
+ * - `options.question` - a question which visibility has been changed.
3831
+ * - `options.name` - a question name.
3832
+ * - `options.visible` - a question `visible` boolean value.
3676
3833
  */
3677
3834
  onVisibleChanged: EventBase<SurveyModel>;
3678
3835
  /*
3679
3836
  * The event is fired on changing a page visibility.
3680
- * `sender` - the survey object that fires the event.
3681
- * `options.page` - a page which visibility has been changed.
3682
- * `options.visible` - a page `visible` boolean value.
3837
+ * - `sender` - the survey object that fires the event.
3838
+ * - `options.page` - a page which visibility has been changed.
3839
+ * - `options.visible` - a page `visible` boolean value.
3683
3840
  */
3684
3841
  onPageVisibleChanged: EventBase<SurveyModel>;
3685
3842
  /*
3686
3843
  * The event is fired on changing a panel visibility.
3687
- * `sender` - the survey object that fires the event.
3688
- * `options.panel` - a panel which visibility has been changed.
3689
- * `options.visible` - a panel `visible` boolean value.
3844
+ * - `sender` - the survey object that fires the event.
3845
+ * - `options.panel` - a panel which visibility has been changed.
3846
+ * - `options.visible` - a panel `visible` boolean value.
3690
3847
  */
3691
3848
  onPanelVisibleChanged: EventBase<SurveyModel>;
3692
3849
  /*
@@ -3695,88 +3852,88 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
3695
3852
  * or inside a matrix cell or it can be a text question in multiple text items or inside a panel of a panel dynamic.
3696
3853
  * You can use this event to set up properties to a question based on it's type for all questions, regardless where they are located, on the page or inside a matrix cell.
3697
3854
  * Please note: If you want to use this event for questions loaded from JSON then you have to create survey with empty/null JSON parameter, assign the event and call survey.fromJSON(yourJSON) function.
3698
- * `sender` - the survey object that fires the event.
3699
- * `options.question` - a newly created question object.
3855
+ * - `sender` - the survey object that fires the event.
3856
+ * - `options.question` - a newly created question object.
3700
3857
  */
3701
3858
  onQuestionCreated: EventBase<SurveyModel>;
3702
3859
  /*
3703
3860
  * The event is fired on adding a new question into survey.
3704
- * `sender` - the survey object that fires the event.
3705
- * `options.question` - a newly added question object.
3706
- * `options.name` - a question name.
3707
- * `options.index` - an index of the question in the container (page or panel).
3708
- * `options.parentPanel` - a container where a new question is located. It can be a page or panel.
3709
- * `options.rootPanel` - typically, it is a page.
3861
+ * - `sender` - the survey object that fires the event.
3862
+ * - `options.question` - a newly added question object.
3863
+ * - `options.name` - a question name.
3864
+ * - `options.index` - an index of the question in the container (page or panel).
3865
+ * - `options.parentPanel` - a container where a new question is located. It can be a page or panel.
3866
+ * - `options.rootPanel` - typically, it is a page.
3710
3867
  */
3711
3868
  onQuestionAdded: EventBase<SurveyModel>;
3712
3869
  /*
3713
3870
  * The event is fired on removing a question from survey.
3714
- * `sender` - the survey object that fires the event.
3715
- * `options.question` - a removed question object.
3716
- * `options.name` - a question name.
3871
+ * - `sender` - the survey object that fires the event.
3872
+ * - `options.question` - a removed question object.
3873
+ * - `options.name` - a question name.
3717
3874
  */
3718
3875
  onQuestionRemoved: EventBase<SurveyModel>;
3719
3876
  /*
3720
3877
  * The event is fired on adding a panel into survey.
3721
- * `sender` - the survey object that fires the event.
3722
- * `options.panel` - a newly added panel object.
3723
- * `options.name` - a panel name.
3724
- * `options.index` - an index of the panel in the container (a page or panel).
3725
- * `options.parentPanel` - a container (a page or panel) where a new panel is located.
3726
- * `options.rootPanel` - a root container, typically it is a page.
3878
+ * - `sender` - the survey object that fires the event.
3879
+ * - `options.panel` - a newly added panel object.
3880
+ * - `options.name` - a panel name.
3881
+ * - `options.index` - an index of the panel in the container (a page or panel).
3882
+ * - `options.parentPanel` - a container (a page or panel) where a new panel is located.
3883
+ * - `options.rootPanel` - a root container, typically it is a page.
3727
3884
  */
3728
3885
  onPanelAdded: EventBase<SurveyModel>;
3729
3886
  /*
3730
3887
  * The event is fired on removing a panel from survey.
3731
- * `sender` - the survey object that fires the event.
3732
- * `options.panel` - a removed panel object.
3733
- * `options.name` - a panel name.
3888
+ * - `sender` - the survey object that fires the event.
3889
+ * - `options.panel` - a removed panel object.
3890
+ * - `options.name` - a panel name.
3734
3891
  */
3735
3892
  onPanelRemoved: EventBase<SurveyModel>;
3736
3893
  /*
3737
3894
  * The event is fired on adding a page into survey.
3738
- * `sender` - the survey object that fires the event.
3739
- * `options.page` - a newly added `panel` object.
3895
+ * - `sender` - the survey object that fires the event.
3896
+ * - `options.page` - a newly added `panel` object.
3740
3897
  */
3741
3898
  onPageAdded: EventBase<SurveyModel>;
3742
3899
  /*
3743
3900
  * The event is fired on validating value in a question. You can specify a custom error message using `options.error`. The survey blocks completing the survey or going to the next page when the error messages are displayed.
3744
- * `sender` - the survey object that fires the event.
3745
- * `options.question` - a validated question.
3746
- * `options.name` - a question name.
3747
- * `options.value` - the current question value (answer).
3748
- * `options.error` - an error string. It is empty by default.
3901
+ * - `sender` - the survey object that fires the event.
3902
+ * - `options.question` - a validated question.
3903
+ * - `options.name` - a question name.
3904
+ * - `options.value` - the current question value (answer).
3905
+ * - `options.error` - an error string. It is empty by default.
3749
3906
  */
3750
3907
  onValidateQuestion: EventBase<SurveyModel>;
3751
3908
  /*
3752
3909
  * The event is fired before errors are assigned to a question. You may add/remove/modify errors for a question.
3753
- * `sender` - the survey object that fires the event.
3754
- * `options.question` - a validated question.
3755
- * `options.errors` - the list of errors. The list is empty by default and remains empty if a validated question has no errors.
3910
+ * - `sender` - the survey object that fires the event.
3911
+ * - `options.question` - a validated question.
3912
+ * - `options.errors` - the list of errors. The list is empty by default and remains empty if a validated question has no errors.
3756
3913
  */
3757
3914
  onSettingQuestionErrors: EventBase<SurveyModel>;
3758
3915
  /*
3759
3916
  * Use this event to validate data on your server.
3760
- * `sender` - the survey object that fires the event.
3761
- * `options.data` - the values of all non-empty questions on the current page. You can get a question value as `options.data["myQuestionName"]`.
3762
- * `options.errors` - set your errors to this object as: `options.errors["myQuestionName"] = "Error text";`. It will be shown as a question error.
3763
- * `options.complete()` - call this function to tell survey that your server callback has been processed.
3917
+ * - `sender` - the survey object that fires the event.
3918
+ * - `options.data` - the values of all non-empty questions on the current page. You can get a question value as `options.data["myQuestionName"]`.
3919
+ * - `options.errors` - set your errors to this object as: `options.errors["myQuestionName"] = "Error text";`. It will be shown as a question error.
3920
+ * - `options.complete()` - call this function to tell survey that your server callback has been processed.
3764
3921
  */
3765
3922
  onServerValidateQuestions: any;
3766
3923
  /*
3767
3924
  * The event is fired on validating a panel. Set your error to `options.error` and survey will show the error for the panel and block completing the survey or going to the next page.
3768
- * `sender` - the survey object that fires the event.
3769
- * `options.name` - a panel name.
3770
- * `options.error` - an error string. It is empty by default.
3925
+ * - `sender` - the survey object that fires the event.
3926
+ * - `options.name` - a panel name.
3927
+ * - `options.error` - an error string. It is empty by default.
3771
3928
  */
3772
3929
  onValidatePanel: EventBase<SurveyModel>;
3773
3930
  /*
3774
3931
  * Use the event to change the default error text.
3775
- * `sender` - the survey object that fires the event.
3776
- * `options.text` - an error text.
3777
- * `options.error` - an instance of the `SurveyError` object.
3778
- * `options.obj` - an instance of Question, Panel or Survey object to where error is located.
3779
- * `options.name` - the error name. The following error names are available:
3932
+ * - `sender` - the survey object that fires the event.
3933
+ * - `options.text` - an error text.
3934
+ * - `options.error` - an instance of the `SurveyError` object.
3935
+ * - `options.obj` - an instance of Question, Panel or Survey object to where error is located.
3936
+ * - `options.name` - the error name. The following error names are available:
3780
3937
  * required, requireoneanswer, requirenumeric, exceedsize, webrequest, webrequestempty, otherempty,
3781
3938
  * uploadingfile, requiredinallrowserror, minrowcounterror, keyduplicationerror, custom
3782
3939
  */
@@ -3790,206 +3947,206 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
3790
3947
  onValidatedErrorsOnCurrentPage: EventBase<SurveyModel>;
3791
3948
  /*
3792
3949
  * Use this event to modify the HTML content before rendering, for example `completeHtml` or `loadingHtml`.
3793
- * `options.html` - specifies the modified HTML content.
3950
+ * - `options.html` - specifies the modified HTML content.
3794
3951
  */
3795
3952
  onProcessHtml: EventBase<SurveyModel>;
3796
3953
  /*
3797
3954
  * Use this event to change the question title in code. If you want to remove question numbering then set showQuestionNumbers to "off".
3798
- * `sender` - the survey object that fires the event.
3799
- * `options.title` - a calculated question title, based on question `title`, `name`.
3800
- * `options.question` - a question object.
3955
+ * - `sender` - the survey object that fires the event.
3956
+ * - `options.title` - a calculated question title, based on question `title`, `name`.
3957
+ * - `options.question` - a question object.
3801
3958
  */
3802
3959
  onGetQuestionTitle: EventBase<SurveyModel>;
3803
3960
  /*
3804
3961
  * Use this event to change the element title tag name that renders by default.
3805
- * `sender` - the survey object that fires the event.
3806
- * `options.element` - an element (question, panel, page and survey) that SurveyJS is going to render.
3807
- * `options.tagName` - an element title tagName that are used to render a title. You can change it from the default value.
3962
+ * - `sender` - the survey object that fires the event.
3963
+ * - `options.element` - an element (question, panel, page and survey) that SurveyJS is going to render.
3964
+ * - `options.tagName` - an element title tagName that are used to render a title. You can change it from the default value.
3808
3965
  */
3809
3966
  onGetTitleTagName: EventBase<SurveyModel>;
3810
3967
  /*
3811
3968
  * Use this event to change the question no in code. If you want to remove question numbering then set showQuestionNumbers to "off".
3812
- * `sender` - the survey object that fires the event.
3813
- * `options.no` - a calculated question no, based on question `visibleIndex`, survey `.questionStartIndex` properties. You can change it.
3814
- * `options.question` - a question object.
3969
+ * - `sender` - the survey object that fires the event.
3970
+ * - `options.no` - a calculated question no, based on question `visibleIndex`, survey `.questionStartIndex` properties. You can change it.
3971
+ * - `options.question` - a question object.
3815
3972
  */
3816
3973
  onGetQuestionNo: EventBase<SurveyModel>;
3817
3974
  /*
3818
3975
  * Use this event to change the progress text in code.
3819
- * `sender` - the survey object that fires the event.
3820
- * `options.text` - a progress text, that SurveyJS will render in progress bar.
3821
- * `options.questionCount` - a number of questions that have input(s). We do not count html or expression questions
3822
- * `options.answeredQuestionCount` - a number of questions that have input(s) and an user has answered.
3823
- * `options.requiredQuestionCount` - a number of required questions that have input(s). We do not count html or expression questions
3824
- * `options.requiredAnsweredQuestionCount` - a number of required questions that have input(s) and an user has answered.
3976
+ * - `sender` - the survey object that fires the event.
3977
+ * - `options.text` - a progress text, that SurveyJS will render in progress bar.
3978
+ * - `options.questionCount` - a number of questions that have input(s). We do not count html or expression questions
3979
+ * - `options.answeredQuestionCount` - a number of questions that have input(s) and an user has answered.
3980
+ * - `options.requiredQuestionCount` - a number of required questions that have input(s). We do not count html or expression questions
3981
+ * - `options.requiredAnsweredQuestionCount` - a number of required questions that have input(s) and an user has answered.
3825
3982
  */
3826
3983
  onProgressText: EventBase<SurveyModel>;
3827
3984
  /*
3828
3985
  * Use this event to process the markdown text.
3829
- * `sender` - the survey object that fires the event.
3830
- * `options.element` - SurveyJS element (a question, panel, page, or survey) where the string is going to be rendered.
3831
- * `options.name` - a property name is going to be rendered.
3832
- * `options.text` - a text that is going to be rendered.
3833
- * `options.html` - an HTML content. It is `null` by default. Use this property to specify the HTML content rendered instead of `options.text`.
3986
+ * - `sender` - the survey object that fires the event.
3987
+ * - `options.element` - SurveyJS element (a question, panel, page, or survey) where the string is going to be rendered.
3988
+ * - `options.name` - a property name is going to be rendered.
3989
+ * - `options.text` - a text that is going to be rendered.
3990
+ * - `options.html` - an HTML content. It is `null` by default. Use this property to specify the HTML content rendered instead of `options.text`.
3834
3991
  */
3835
3992
  onTextMarkdown: EventBase<SurveyModel>;
3836
3993
  /*
3837
3994
  * Use this event to specity render component name used for text rendering.
3838
- * `sender` - the survey object that fires the event.
3839
- * `options.element` - SurveyJS element (a question, panel, page, or survey) where the string is going to be rendered.
3840
- * `options.name` - a property name is going to be rendered.
3841
- * `options.renderAs` - a component name used for text rendering.
3995
+ * - `sender` - the survey object that fires the event.
3996
+ * - `options.element` - SurveyJS element (a question, panel, page, or survey) where the string is going to be rendered.
3997
+ * - `options.name` - a property name is going to be rendered.
3998
+ * - `options.renderAs` - a component name used for text rendering.
3842
3999
  */
3843
4000
  onTextRenderAs: EventBase<SurveyModel>;
3844
4001
  /*
3845
4002
  * The event fires when it gets response from the [api.surveyjs.io](https://api.surveyjs.io) service on saving survey results. Use it to find out if the results have been saved successfully.
3846
- * `sender` - the survey object that fires the event.
3847
- * `options.success` - it is `true` if the results has been sent to the service successfully.
3848
- * `options.response` - a response from the service.
4003
+ * - `sender` - the survey object that fires the event.
4004
+ * - `options.success` - it is `true` if the results has been sent to the service successfully.
4005
+ * - `options.response` - a response from the service.
3849
4006
  */
3850
4007
  onSendResult: EventBase<SurveyModel>;
3851
4008
  /*
3852
4009
  * Use it to get results after calling the `getResult` method. It returns a simple analytics from [api.surveyjs.io](https://api.surveyjs.io) service.
3853
- * `sender` - the survey object that fires the event.
3854
- * `options.success` - it is `true` if the results were got from the service successfully.
3855
- * `options.data` - the object `{AnswersCount, QuestionResult : {} }`. `AnswersCount` is the number of posted survey results. `QuestionResult` is an object with all possible unique answers to the question and number of these answers.
3856
- * `options.dataList` - an array of objects `{name, value}`, where `name` is a unique value/answer to the question and `value` is a number/count of such answers.
3857
- * `options.response` - the server response.
4010
+ * - `sender` - the survey object that fires the event.
4011
+ * - `options.success` - it is `true` if the results were got from the service successfully.
4012
+ * - `options.data` - the object `{AnswersCount, QuestionResult : {} }`. `AnswersCount` is the number of posted survey results. `QuestionResult` is an object with all possible unique answers to the question and number of these answers.
4013
+ * - `options.dataList` - an array of objects `{name, value}`, where `name` is a unique value/answer to the question and `value` is a number/count of such answers.
4014
+ * - `options.response` - the server response.
3858
4015
  */
3859
4016
  onGetResult: EventBase<SurveyModel>;
3860
4017
  /*
3861
4018
  * The event is fired on uploading the file in QuestionFile when `storeDataAsText` is set to `false`. Use this event to change the uploaded file name or to prevent a particular file from being uploaded.
3862
- * `sender` - the survey object that fires the event.
3863
- * `options.question` - the file question instance.
3864
- * `options.name` - the question name.
3865
- * `options.files` - the Javascript File objects array to upload.
3866
- * `options.callback` - a callback function to get the file upload status and the updloaded file content.
4019
+ * - `sender` - the survey object that fires the event.
4020
+ * - `options.question` - the file question instance.
4021
+ * - `options.name` - the question name.
4022
+ * - `options.files` - the Javascript File objects array to upload.
4023
+ * - `options.callback` - a callback function to get the file upload status and the updloaded file content.
3867
4024
  */
3868
4025
  onUploadFiles: EventBase<SurveyModel>;
3869
4026
  /*
3870
4027
  * The event is fired on downloading a file in QuestionFile. Use this event to pass the file to a preview.
3871
- * `sender` - the survey object that fires the event.
3872
- * `options.name` - the question name.
3873
- * `options.content` - the file content.
3874
- * `options.fileValue` - single file question value.
3875
- * `options.callback` - a callback function to get the file downloading status and the downloaded file content.
4028
+ * - `sender` - the survey object that fires the event.
4029
+ * - `options.name` - the question name.
4030
+ * - `options.content` - the file content.
4031
+ * - `options.fileValue` - single file question value.
4032
+ * - `options.callback` - a callback function to get the file downloading status and the downloaded file content.
3876
4033
  */
3877
4034
  onDownloadFile: EventBase<SurveyModel>;
3878
4035
  /*
3879
4036
  * This event is fired on clearing the value in a QuestionFile. Use this event to remove files stored on your server.
3880
- * `sender` - the survey object that fires the event.
3881
- * `question` - the question instance.
3882
- * `options.name` - the question name.
3883
- * `options.value` - the question value.
3884
- * `options.fileName` - a removed file's name, set it to `null` to clear all files.
3885
- * `options.callback` - a callback function to get the operation status.
4037
+ * - `sender` - the survey object that fires the event.
4038
+ * - `question` - the question instance.
4039
+ * - `options.name` - the question name.
4040
+ * - `options.value` - the question value.
4041
+ * - `options.fileName` - a removed file's name, set it to `null` to clear all files.
4042
+ * - `options.callback` - a callback function to get the operation status.
3886
4043
  */
3887
4044
  onClearFiles: EventBase<SurveyModel>;
3888
4045
  /*
3889
4046
  * The event is fired after choices for radiogroup, checkbox, and dropdown has been loaded from a RESTful service and before they are assigned to a question.
3890
4047
  * You may change the choices, before they are assigned or disable/enabled make visible/invisible question, based on loaded results.
3891
- * `sender` - the survey object that fires the event.
3892
- * `question` - the question where loaded choices are going to be assigned.
3893
- * `choices` - the loaded choices. You can change the loaded choices to before they are assigned to question.
3894
- * `serverResult` - a result that comes from the server as it is.
4048
+ * - `sender` - the survey object that fires the event.
4049
+ * - `question` - the question where loaded choices are going to be assigned.
4050
+ * - `choices` - the loaded choices. You can change the loaded choices to before they are assigned to question.
4051
+ * - `serverResult` - a result that comes from the server as it is.
3895
4052
  */
3896
4053
  onLoadChoicesFromServer: EventBase<SurveyModel>;
3897
4054
  /*
3898
4055
  * The event is fired after survey is loaded from api.surveyjs.io service.
3899
4056
  * You can use this event to perform manipulation with the survey model after it was loaded from the web service.
3900
- * `sender` - the survey object that fires the event.
4057
+ * - `sender` - the survey object that fires the event.
3901
4058
  */
3902
4059
  onLoadedSurveyFromService: EventBase<SurveyModel>;
3903
4060
  /*
3904
4061
  * The event is fired on processing the text when it finds a text in brackets: `{somevalue}`. By default, it uses the value of survey question values and variables.
3905
4062
  * For example, you may use the text processing in loading choices from the web. If your `choicesByUrl.url` equals to "UrlToServiceToGetAllCities/{country}/{state}",
3906
4063
  * you may set on this event `options.value` to "all" or empty string when the "state" value/question is non selected by a user.
3907
- * `sender` - the survey object that fires the event.
3908
- * `options.name` - the name of the processing value, for example, "state" in our example.
3909
- * `options.value` - the value of the processing text.
3910
- * `options.isExists` - a boolean value. Set it to `true` if you want to use the value and set it to `false` if you don't.
4064
+ * - `sender` - the survey object that fires the event.
4065
+ * - `options.name` - the name of the processing value, for example, "state" in our example.
4066
+ * - `options.value` - the value of the processing text.
4067
+ * - `options.isExists` - a boolean value. Set it to `true` if you want to use the value and set it to `false` if you don't.
3911
4068
  */
3912
4069
  onProcessTextValue: EventBase<SurveyModel>;
3913
4070
  /*
3914
4071
  * The event is fired before rendering a question. Use it to override the default question CSS classes.
3915
- * `sender` - the survey object that fires the event.
3916
- * `options.question` - a question for which you can change the CSS classes.
3917
- * `options.cssClasses` - an object with CSS classes. For example `{root: "table", button: "button"}`. You can change them to your own CSS classes.
4072
+ * - `sender` - the survey object that fires the event.
4073
+ * - `options.question` - a question for which you can change the CSS classes.
4074
+ * - `options.cssClasses` - an object with CSS classes. For example `{root: "table", button: "button"}`. You can change them to your own CSS classes.
3918
4075
  */
3919
4076
  onUpdateQuestionCssClasses: EventBase<SurveyModel>;
3920
4077
  /*
3921
4078
  * The event is fired before rendering a panel. Use it to override the default panel CSS classes.
3922
- * `sender` - the survey object that fires the event.
3923
- * `options.panel` - a panel for which you can change the CSS classes.
3924
- * `options.cssClasses` - an object with CSS classes. For example `{title: "sv_p_title", description: "small"}`. You can change them to your own CSS classes.
4079
+ * - `sender` - the survey object that fires the event.
4080
+ * - `options.panel` - a panel for which you can change the CSS classes.
4081
+ * - `options.cssClasses` - an object with CSS classes. For example `{title: "sv_p_title", description: "small"}`. You can change them to your own CSS classes.
3925
4082
  */
3926
4083
  onUpdatePanelCssClasses: EventBase<SurveyModel>;
3927
4084
  /*
3928
4085
  * The event is fired before rendering a page. Use it to override the default page CSS classes.
3929
- * `sender` - the survey object that fires the event.
3930
- * `options.page` - a page for which you can change the CSS classes.
3931
- * `options.cssClasses` - an object with CSS classes. For example `{title: "sv_p_title", description: "small"}`. You can change them to your own CSS classes.
4086
+ * - `sender` - the survey object that fires the event.
4087
+ * - `options.page` - a page for which you can change the CSS classes.
4088
+ * - `options.cssClasses` - an object with CSS classes. For example `{title: "sv_p_title", description: "small"}`. You can change them to your own CSS classes.
3932
4089
  */
3933
4090
  onUpdatePageCssClasses: EventBase<SurveyModel>;
3934
4091
  /*
3935
4092
  * The event is fired before rendering a choice item in radiogroup, checkbox or dropdown questions. Use it to override the default choice item css.
3936
- * `sender` - the survey object that fires the event.
3937
- * `options.question` - a question where choice item is rendered.
3938
- * `options.item` - a choice item of ItemValue type. You can get value or text choice properties as options.item.value or options.choice.text
3939
- * `options.css` - a string with css classes divided by space. You can change it.
4093
+ * - `sender` - the survey object that fires the event.
4094
+ * - `options.question` - a question where choice item is rendered.
4095
+ * - `options.item` - a choice item of ItemValue type. You can get value or text choice properties as options.item.value or options.choice.text
4096
+ * - `options.css` - a string with css classes divided by space. You can change it.
3940
4097
  */
3941
4098
  onUpdateChoiceItemCss: EventBase<SurveyModel>;
3942
4099
  /*
3943
4100
  * The event is fired right after survey is rendered in DOM.
3944
- * `sender` - the survey object that fires the event.
3945
- * `options.htmlElement` - a root HTML element bound to the survey object.
4101
+ * - `sender` - the survey object that fires the event.
4102
+ * - `options.htmlElement` - a root HTML element bound to the survey object.
3946
4103
  */
3947
4104
  onAfterRenderSurvey: EventBase<SurveyModel>;
3948
4105
  /*
3949
4106
  * The event is fired right after a page is rendered in DOM. Use it to modify HTML elements.
3950
- * `sender` - the survey object that fires the event.
3951
- * `options.htmlElement` - an HTML element bound to the survey header object.
4107
+ * - `sender` - the survey object that fires the event.
4108
+ * - `options.htmlElement` - an HTML element bound to the survey header object.
3952
4109
  */
3953
4110
  onAfterRenderHeader: EventBase<SurveyModel>;
3954
4111
  /*
3955
4112
  * The event is fired right after a page is rendered in DOM. Use it to modify HTML elements.
3956
- * `sender` - the survey object that fires the event.
3957
- * `options.page` - a page object for which the event is fired. Typically the current/active page.
3958
- * `options.htmlElement` - an HTML element bound to the page object.
4113
+ * - `sender` - the survey object that fires the event.
4114
+ * - `options.page` - a page object for which the event is fired. Typically the current/active page.
4115
+ * - `options.htmlElement` - an HTML element bound to the page object.
3959
4116
  */
3960
4117
  onAfterRenderPage: EventBase<SurveyModel>;
3961
4118
  /*
3962
4119
  * The event is fired right after a question is rendered in DOM. Use it to modify HTML elements.
3963
- * `sender` - the survey object that fires the event.
3964
- * `options.question` - a question object for which the event is fired.
3965
- * `options.htmlElement` - an HTML element bound to the question object.
4120
+ * - `sender` - the survey object that fires the event.
4121
+ * - `options.question` - a question object for which the event is fired.
4122
+ * - `options.htmlElement` - an HTML element bound to the question object.
3966
4123
  */
3967
4124
  onAfterRenderQuestion: EventBase<SurveyModel>;
3968
4125
  /*
3969
4126
  * The event is fired right after a non-composite question (text, comment, dropdown, radiogroup, checkbox) is rendered in DOM. Use it to modify HTML elements.
3970
4127
  * This event is not fired for matrices, panels, multiple text and image picker.
3971
- * `sender` - the survey object that fires the event.
3972
- * `options.question` - a question object for which the event is fired.
3973
- * `options.htmlElement` - an HTML element bound to the question object.
4128
+ * - `sender` - the survey object that fires the event.
4129
+ * - `options.question` - a question object for which the event is fired.
4130
+ * - `options.htmlElement` - an HTML element bound to the question object.
3974
4131
  */
3975
4132
  onAfterRenderQuestionInput: EventBase<SurveyModel>;
3976
4133
  /*
3977
4134
  * The event is fired right after a panel is rendered in DOM. Use it to modify HTML elements.
3978
- * `sender` - the survey object that fires the event
3979
- * `options.panel` - a panel object for which the event is fired
3980
- * `options.htmlElement` - an HTML element bound to the panel object
4135
+ * - `sender` - the survey object that fires the event
4136
+ * - `options.panel` - a panel object for which the event is fired
4137
+ * - `options.htmlElement` - an HTML element bound to the panel object
3981
4138
  */
3982
4139
  onAfterRenderPanel: EventBase<SurveyModel>;
3983
4140
  /*
3984
4141
  * The event occurs when an element within a question gets focus.
3985
- * `sender` - A [survey](https://surveyjs.io/Documentation/Library?id=surveymodel) object that fires the event.
3986
- * `options.question` - A [question](https://surveyjs.io/Documentation/Library?id=Question) whose child element gets focus.
4142
+ * - `sender` - A [survey](https://surveyjs.io/Documentation/Library?id=surveymodel) object that fires the event.
4143
+ * - `options.question` - A [question](https://surveyjs.io/Documentation/Library?id=Question) whose child element gets focus.
3987
4144
  */
3988
4145
  onFocusInQuestion: EventBase<SurveyModel>;
3989
4146
  /*
3990
4147
  * The event occurs when an element within a panel gets focus.
3991
- * `sender` - A [survey](https://surveyjs.io/Documentation/Library?id=surveymodel) object that fires the event.
3992
- * `options.panel` - A [panel](https://surveyjs.io/Documentation/Library?id=PanelModelBase) whose child element gets focus.
4148
+ * - `sender` - A [survey](https://surveyjs.io/Documentation/Library?id=surveymodel) object that fires the event.
4149
+ * - `options.panel` - A [panel](https://surveyjs.io/Documentation/Library?id=PanelModelBase) whose child element gets focus.
3993
4150
  */
3994
4151
  onFocusInPanel: EventBase<SurveyModel>;
3995
4152
  /*
@@ -4005,123 +4162,123 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4005
4162
  onShowingChoiceItem: EventBase<SurveyModel>;
4006
4163
  /*
4007
4164
  * The event is fired on adding a new row in Matrix Dynamic question.
4008
- * `sender` - the survey object that fires the event
4009
- * `options.question` - a matrix question.
4010
- * `options.row` - a new added row.
4165
+ * - `sender` - the survey object that fires the event
4166
+ * - `options.question` - a matrix question.
4167
+ * - `options.row` - a new added row.
4011
4168
  */
4012
4169
  onMatrixRowAdded: EventBase<SurveyModel>;
4013
4170
  /*
4014
4171
  * The event is fired before adding a new row in Matrix Dynamic question.
4015
- * `sender` - the survey object that fires the event
4016
- * `options.question` - a matrix question.
4017
- * `options.canAddRow` - specifies whether a new row can be added
4172
+ * - `sender` - the survey object that fires the event
4173
+ * - `options.question` - a matrix question.
4174
+ * - `options.canAddRow` - specifies whether a new row can be added
4018
4175
  */
4019
4176
  onMatrixBeforeRowAdded: EventBase<SurveyModel>;
4020
4177
  /*
4021
4178
  * The event is fired before removing a row from Matrix Dynamic question. You can disable removing and clear the data instead.
4022
- * `sender` - the survey object that fires the event
4023
- * `options.question` - a matrix question.
4024
- * `options.rowIndex` - a row index.
4025
- * `options.row` - a row object.
4026
- * `options.allow` - a boolean property. Set it to `false` to disable the row removing.
4179
+ * - `sender` - the survey object that fires the event
4180
+ * - `options.question` - a matrix question.
4181
+ * - `options.rowIndex` - a row index.
4182
+ * - `options.row` - a row object.
4183
+ * - `options.allow` - a boolean property. Set it to `false` to disable the row removing.
4027
4184
  */
4028
4185
  onMatrixRowRemoving: EventBase<SurveyModel>;
4029
4186
  /*
4030
4187
  * The event is fired on removing a row from Matrix Dynamic question.
4031
- * `sender` - the survey object that fires the event
4032
- * `options.question` - a matrix question
4033
- * `options.rowIndex` - a removed row index
4034
- * `options.row` - a removed row object
4188
+ * - `sender` - the survey object that fires the event
4189
+ * - `options.question` - a matrix question
4190
+ * - `options.rowIndex` - a removed row index
4191
+ * - `options.row` - a removed row object
4035
4192
  */
4036
4193
  onMatrixRowRemoved: EventBase<SurveyModel>;
4037
4194
  /*
4038
4195
  * The event is fired before rendering "Remove" button for removing a row from Matrix Dynamic question.
4039
- * `sender` - the survey object that fires the event
4040
- * `options.question` - a matrix question.
4041
- * `options.rowIndex` - a row index.
4042
- * `options.row` - a row object.
4043
- * `options.allow` - a boolean property. Set it to `false` to disable the row removing.
4196
+ * - `sender` - the survey object that fires the event
4197
+ * - `options.question` - a matrix question.
4198
+ * - `options.rowIndex` - a row index.
4199
+ * - `options.row` - a row object.
4200
+ * - `options.allow` - a boolean property. Set it to `false` to disable the row removing.
4044
4201
  */
4045
4202
  onMatrixAllowRemoveRow: EventBase<SurveyModel>;
4046
4203
  /*
4047
4204
  * The event is fired before creating cell question in the matrix. You can change the cell question type by setting different options.cellType.
4048
- * `sender` - the survey object that fires the event.
4049
- * `options.question` - the matrix question.
4050
- * `options.cellType` - the cell question type. You can change it.
4051
- * `options.rowValue` - the value of the current row. To access a particular column's value within the current row, use: `options.rowValue["columnValue"]`.
4052
- * `options.column` - the matrix column object.
4053
- * `options.columnName` - the matrix column name.
4054
- * `options.row` - the matrix row object.
4205
+ * - `sender` - the survey object that fires the event.
4206
+ * - `options.question` - the matrix question.
4207
+ * - `options.cellType` - the cell question type. You can change it.
4208
+ * - `options.rowValue` - the value of the current row. To access a particular column's value within the current row, use: `options.rowValue["columnValue"]`.
4209
+ * - `options.column` - the matrix column object.
4210
+ * - `options.columnName` - the matrix column name.
4211
+ * - `options.row` - the matrix row object.
4055
4212
  */
4056
4213
  onMatrixCellCreating: EventBase<SurveyModel>;
4057
4214
  /*
4058
4215
  * The event is fired for every cell created in Matrix Dynamic and Matrix Dropdown questions.
4059
- * `sender` - the survey object that fires the event.
4060
- * `options.question` - the matrix question.
4061
- * `options.cell` - the matrix cell.
4062
- * `options.cellQuestion` - the question/editor in the cell. You may customize it, change it's properties, like choices or visible.
4063
- * `options.rowValue` - the value of the current row. To access a particular column's value within the current row, use: `options.rowValue["columnValue"]`.
4064
- * `options.column` - the matrix column object.
4065
- * `options.columnName` - the matrix column name.
4066
- * `options.row` - the matrix row object.
4216
+ * - `sender` - the survey object that fires the event.
4217
+ * - `options.question` - the matrix question.
4218
+ * - `options.cell` - the matrix cell.
4219
+ * - `options.cellQuestion` - the question/editor in the cell. You may customize it, change it's properties, like choices or visible.
4220
+ * - `options.rowValue` - the value of the current row. To access a particular column's value within the current row, use: `options.rowValue["columnValue"]`.
4221
+ * - `options.column` - the matrix column object.
4222
+ * - `options.columnName` - the matrix column name.
4223
+ * - `options.row` - the matrix row object.
4067
4224
  */
4068
4225
  onMatrixCellCreated: EventBase<SurveyModel>;
4069
4226
  /*
4070
4227
  * The event is fired for every cell after is has been rendered in DOM.
4071
- * `sender` - the survey object that fires the event.
4072
- * `options.question` - the matrix question.
4073
- * `options.cell` - the matrix cell.
4074
- * `options.cellQuestion` - the question/editor in the cell.
4075
- * `options.htmlElement` - an HTML element bound to the `cellQuestion` object.
4076
- * `options.column` - the matrix column object.
4077
- * `options.row` - the matrix row object.
4228
+ * - `sender` - the survey object that fires the event.
4229
+ * - `options.question` - the matrix question.
4230
+ * - `options.cell` - the matrix cell.
4231
+ * - `options.cellQuestion` - the question/editor in the cell.
4232
+ * - `options.htmlElement` - an HTML element bound to the `cellQuestion` object.
4233
+ * - `options.column` - the matrix column object.
4234
+ * - `options.row` - the matrix row object.
4078
4235
  */
4079
4236
  onMatrixAfterCellRender: EventBase<SurveyModel>;
4080
4237
  /*
4081
4238
  * The event is fired when cell value is changed in Matrix Dynamic and Matrix Dropdown questions.
4082
- * `sender` - the survey object that fires the event.
4083
- * `options.question` - the matrix question.
4084
- * `options.columnName` - the matrix column name.
4085
- * `options.value` - a new value.
4086
- * `options.row` - the matrix row object.
4087
- * `options.getCellQuestion(columnName)` - the function that returns the cell question by column name.
4239
+ * - `sender` - the survey object that fires the event.
4240
+ * - `options.question` - the matrix question.
4241
+ * - `options.columnName` - the matrix column name.
4242
+ * - `options.value` - a new value.
4243
+ * - `options.row` - the matrix row object.
4244
+ * - `options.getCellQuestion(columnName)` - the function that returns the cell question by column name.
4088
4245
  */
4089
4246
  onMatrixCellValueChanged: EventBase<SurveyModel>;
4090
4247
  /*
4091
4248
  * The event is fired on changing cell value in Matrix Dynamic and Matrix Dropdown questions. You may change the `options.value` property to change a cell value.
4092
- * `sender` - the survey object that fires the event.
4093
- * `options.question` - the matrix question.
4094
- * `options.columnName` - the matrix column name.
4095
- * `options.value` - a new value.
4096
- * `options.oldValue` - the old value.
4097
- * `options.row` - the matrix row object.
4098
- * `options.getCellQuestion(columnName)` - the function that returns a cell question by column name.
4249
+ * - `sender` - the survey object that fires the event.
4250
+ * - `options.question` - the matrix question.
4251
+ * - `options.columnName` - the matrix column name.
4252
+ * - `options.value` - a new value.
4253
+ * - `options.oldValue` - the old value.
4254
+ * - `options.row` - the matrix row object.
4255
+ * - `options.getCellQuestion(columnName)` - the function that returns a cell question by column name.
4099
4256
  */
4100
4257
  onMatrixCellValueChanging: EventBase<SurveyModel>;
4101
4258
  /*
4102
4259
  * The event is fired when Matrix Dynamic and Matrix Dropdown questions validate the cell value.
4103
- * `sender` - the survey object that fires the event.
4104
- * `options.error` - an error string. It is empty by default.
4105
- * `options.question` - the matrix question.
4106
- * `options.columnName` - the matrix column name.
4107
- * `options.value` - a cell value.
4108
- * `options.row` - the matrix row object.
4109
- * `options.getCellQuestion(columnName)` - the function that returns the cell question by column name.
4260
+ * - `sender` - the survey object that fires the event.
4261
+ * - `options.error` - an error string. It is empty by default.
4262
+ * - `options.question` - the matrix question.
4263
+ * - `options.columnName` - the matrix column name.
4264
+ * - `options.value` - a cell value.
4265
+ * - `options.row` - the matrix row object.
4266
+ * - `options.getCellQuestion(columnName)` - the function that returns the cell question by column name.
4110
4267
  */
4111
4268
  onMatrixCellValidate: EventBase<SurveyModel>;
4112
4269
  /*
4113
4270
  * The event is fired on adding a new panel in Panel Dynamic question.
4114
- * `sender` - the survey object that fires the event.
4115
- * `options.question` - a panel question.
4116
- * `options.panel` - an added panel.
4271
+ * - `sender` - the survey object that fires the event.
4272
+ * - `options.question` - a panel question.
4273
+ * - `options.panel` - an added panel.
4117
4274
  */
4118
4275
  onDynamicPanelAdded: EventBase<SurveyModel>;
4119
4276
  /*
4120
4277
  * The event is fired on removing a panel from Panel Dynamic question.
4121
- * `sender` - the survey object that fires the event.
4122
- * `options.question` - a panel question.
4123
- * `options.panelIndex` - a removed panel index.
4124
- * `options.panel` - a removed panel.
4278
+ * - `sender` - the survey object that fires the event.
4279
+ * - `options.question` - a panel question.
4280
+ * - `options.panelIndex` - a removed panel index.
4281
+ * - `options.panel` - a removed panel.
4125
4282
  */
4126
4283
  onDynamicPanelRemoved: EventBase<SurveyModel>;
4127
4284
  /*
@@ -4130,92 +4287,92 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4130
4287
  onTimer: EventBase<SurveyModel>;
4131
4288
  /*
4132
4289
  * The event is fired before displaying a new information in the Timer Panel. Use it to change the default text.
4133
- * `sender` - the survey object that fires the event.
4134
- * `options.text` - the timer panel info text.
4290
+ * - `sender` - the survey object that fires the event.
4291
+ * - `options.text` - the timer panel info text.
4135
4292
  */
4136
4293
  onTimerPanelInfoText: EventBase<SurveyModel>;
4137
4294
  /*
4138
4295
  * The event is fired when item value is changed in Panel Dynamic question.
4139
- * `sender` - the survey object that fires the event.
4140
- * `options.question` - the panel question.
4141
- * `options.panel` - the dynamic panel item.
4142
- * `options.name` - the item name.
4143
- * `options.value` - a new value.
4144
- * `options.itemIndex` - the panel item index.
4145
- * `options.itemValue` - the panel item object.
4296
+ * - `sender` - the survey object that fires the event.
4297
+ * - `options.question` - the panel question.
4298
+ * - `options.panel` - the dynamic panel item.
4299
+ * - `options.name` - the item name.
4300
+ * - `options.value` - a new value.
4301
+ * - `options.itemIndex` - the panel item index.
4302
+ * - `options.itemValue` - the panel item object.
4146
4303
  */
4147
4304
  onDynamicPanelItemValueChanged: EventBase<SurveyModel>;
4148
4305
  /*
4149
4306
  * Use this event to define, whether an answer to a question is correct or not.
4150
- * `sender` - the survey object that fires the event.
4151
- * `options.question` - a question on which you have to decide if the answer is correct or not.
4152
- * `options.result` - returns `true`, if an answer is correct, or `false`, if the answer is not correct. Use questions' `value` and `correctAnswer` properties to return the correct value.
4153
- * `options.correctAnswers` - you may change the default number of correct or incorrect answers in the question, for example for matrix, where each row is a quiz question.
4307
+ * - `sender` - the survey object that fires the event.
4308
+ * - `options.question` - a question on which you have to decide if the answer is correct or not.
4309
+ * - `options.result` - returns `true`, if an answer is correct, or `false`, if the answer is not correct. Use questions' `value` and `correctAnswer` properties to return the correct value.
4310
+ * - `options.correctAnswers` - you may change the default number of correct or incorrect answers in the question, for example for matrix, where each row is a quiz question.
4154
4311
  */
4155
4312
  onIsAnswerCorrect: EventBase<SurveyModel>;
4156
4313
  /*
4157
4314
  * Use this event to control drag&drop operations during design mode.
4158
- * `sender` - the survey object that fires the event.
4159
- * `options.allow` - set it to `false` to disable dragging.
4160
- * `options.target` - a target element that is dragged.
4161
- * `options.source` - a source element. It can be `null`, if it is a new element, dragging from toolbox.
4162
- * `options.parent` - a page or panel where target element is dragging.
4163
- * `options.insertBefore` - an element before the target element is dragging. It can be `null` if parent container (page or panel) is empty or dragging an element after the last element in a container.
4164
- * `options.insertAfter` - an element after the target element is dragging. It can be `null` if parent container (page or panel) is empty or dragging element to the first position within the parent container.
4315
+ * - `sender` - the survey object that fires the event.
4316
+ * - `options.allow` - set it to `false` to disable dragging.
4317
+ * - `options.target` - a target element that is dragged.
4318
+ * - `options.source` - a source element. It can be `null`, if it is a new element, dragging from toolbox.
4319
+ * - `options.parent` - a page or panel where target element is dragging.
4320
+ * - `options.insertBefore` - an element before the target element is dragging. It can be `null` if parent container (page or panel) is empty or dragging an element after the last element in a container.
4321
+ * - `options.insertAfter` - an element after the target element is dragging. It can be `null` if parent container (page or panel) is empty or dragging element to the first position within the parent container.
4165
4322
  */
4166
4323
  onDragDropAllow: EventBase<SurveyModel>;
4167
4324
  /*
4168
4325
  * Use this event to control scrolling element to top. You can cancel the default behavior by setting options.cancel property to true.
4169
- * `sender` - the survey object that fires the event.
4170
- * `options.element` - an element that is going to be scrolled on top.
4171
- * `options.question` - a question that is going to be scrolled on top. It can be null if options.page is not null.
4172
- * `options.page` - a page that is going to be scrolled on top. It can be null if options.question is not null.
4173
- * `options.elementId` - the unique element DOM Id.
4174
- * `options.cancel` - set this property to true to cancel the default scrolling.
4326
+ * - `sender` - the survey object that fires the event.
4327
+ * - `options.element` - an element that is going to be scrolled on top.
4328
+ * - `options.question` - a question that is going to be scrolled on top. It can be null if options.page is not null.
4329
+ * - `options.page` - a page that is going to be scrolled on top. It can be null if options.question is not null.
4330
+ * - `options.elementId` - the unique element DOM Id.
4331
+ * - `options.cancel` - set this property to true to cancel the default scrolling.
4175
4332
  */
4176
4333
  onScrollingElementToTop: EventBase<SurveyModel>;
4177
4334
  onLocaleChangedEvent: EventBase<SurveyModel>;
4178
4335
  /*
4179
4336
  * Use this event to create/customize actions to be displayed in a question's title.
4180
- * `sender` - A [Survey](https://surveyjs.io/Documentation/Library?id=SurveyModel) object that fires the event.
4181
- * `options.question` - A [Question](https://surveyjs.io/Documentation/Library?id=Question) object for which the event is fired.
4182
- * `options.titleActions` - A list of actions ([IAction](https://surveyjs.io/Documentation/Library?id=IAction) objects) associated with the processed question.
4337
+ * - `sender` - A [Survey](https://surveyjs.io/Documentation/Library?id=SurveyModel) object that fires the event.
4338
+ * - `options.question` - A [Question](https://surveyjs.io/Documentation/Library?id=Question) object for which the event is fired.
4339
+ * - `options.titleActions` - A list of actions ([IAction](https://surveyjs.io/Documentation/Library?id=IAction) objects) associated with the processed question.
4183
4340
  */
4184
4341
  onGetQuestionTitleActions: EventBase<SurveyModel>;
4185
4342
  /*
4186
4343
  * Use this event to create/customize actions to be displayed in a panel's title.
4187
- * `sender` - A survey object that fires the event.
4188
- * `options.panel` - A panel ([PanelModel](https://surveyjs.io/Documentation/Library?id=panelmodel) object) for which the event is fired.
4189
- * `options.titleActions` - A list of actions ([IAction](https://surveyjs.io/Documentation/Library?id=IAction) objects) associated with the processed panel.
4344
+ * - `sender` - A survey object that fires the event.
4345
+ * - `options.panel` - A panel ([PanelModel](https://surveyjs.io/Documentation/Library?id=panelmodel) object) for which the event is fired.
4346
+ * - `options.titleActions` - A list of actions ([IAction](https://surveyjs.io/Documentation/Library?id=IAction) objects) associated with the processed panel.
4190
4347
  */
4191
4348
  onGetPanelTitleActions: EventBase<SurveyModel>;
4192
4349
  /*
4193
4350
  * Use this event to create/customize actions to be displayed in a page's title.
4194
- * `sender` - A survey object that fires the event.
4195
- * `options.page` - A page ([PageModel](https://surveyjs.io/Documentation/Library?id=pagemodel) object) for which the event is fired.
4196
- * `options.titleActions` - A list of actions ([IAction](https://surveyjs.io/Documentation/Library?id=IAction) objects) associated with the processed page.
4351
+ * - `sender` - A survey object that fires the event.
4352
+ * - `options.page` - A page ([PageModel](https://surveyjs.io/Documentation/Library?id=pagemodel) object) for which the event is fired.
4353
+ * - `options.titleActions` - A list of actions ([IAction](https://surveyjs.io/Documentation/Library?id=IAction) objects) associated with the processed page.
4197
4354
  */
4198
4355
  onGetPageTitleActions: EventBase<SurveyModel>;
4199
4356
  /*
4200
4357
  * Use this event to create/customize actions to be displayed in a matrix question's row.
4201
- * `sender` - A survey object that fires the event.
4202
- * `options.question` - A matrix question ([QuestionMatrixBaseModel](https://surveyjs.io/Documentation/Library?id=questionmatrixbasemodel) object) for which the event is fired.
4203
- * `options.row` - A matrix row for which the event is fired.
4204
- * `options.actions` - A list of actions ([IAction](https://surveyjs.io/Documentation/Library?id=IAction) objects) associated with the processed matrix question and row.
4358
+ * - `sender` - A survey object that fires the event.
4359
+ * - `options.question` - A matrix question ([QuestionMatrixBaseModel](https://surveyjs.io/Documentation/Library?id=questionmatrixbasemodel) object) for which the event is fired.
4360
+ * - `options.row` - A matrix row for which the event is fired.
4361
+ * - `options.actions` - A list of actions ([IAction](https://surveyjs.io/Documentation/Library?id=IAction) objects) associated with the processed matrix question and row.
4205
4362
  */
4206
4363
  onGetMatrixRowActions: EventBase<SurveyModel>;
4207
4364
  /*
4208
4365
  * The event is fired after the survey element content was collapsed or expanded.
4209
- * `sender` - the survey object that fires the event.
4210
- * `options.element` - Specifies which survey element content was collapsed or expanded.
4366
+ * - `sender` - the survey object that fires the event.
4367
+ * - `options.element` - Specifies which survey element content was collapsed or expanded.
4211
4368
  */
4212
4369
  onElementContentVisibilityChanged: EventBase<SurveyModel>;
4213
4370
  /*
4214
4371
  * The event is fired before expression question convert it's value into display value for rendering.
4215
- * `sender` - the survey object that fires the event.
4216
- * `options.question` - The expression question.
4217
- * `options.value` - The question value.
4218
- * `options.displayValue` - the display value that you can change before rendering.
4372
+ * - `sender` - the survey object that fires the event.
4373
+ * - `options.question` - The expression question.
4374
+ * - `options.value` - The question value.
4375
+ * - `options.displayValue` - the display value that you can change before rendering.
4219
4376
  */
4220
4377
  onGetExpressionDisplayValue: EventBase<SurveyModel>;
4221
4378
  /*
@@ -4248,6 +4405,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4248
4405
  get completedStateCss(): string;
4249
4406
  getCompletedStateCss(): string;
4250
4407
  lazyRenderingValue: boolean;
4408
+ showBrandInfo: boolean;
4251
4409
  /*
4252
4410
  * By default all rows are rendered no matters if they are visible or not.
4253
4411
  * Set it true, and survey markup rows will be rendered only if they are visible in viewport.
@@ -5032,6 +5190,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5032
5190
  * Gets whether the question values on the current page are validating on the server at the current moment.
5033
5191
  */
5034
5192
  get isValidatingOnServer(): boolean;
5193
+ serverValidationEventCount: number;
5035
5194
  protected onIsValidatingOnServerChanged(): void;
5036
5195
  protected doServerValidation(doComplete: boolean, isPreview?: boolean): boolean;
5037
5196
  protected doNextPage(): void;
@@ -5089,7 +5248,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5089
5248
  get isValidateOnValueChanging(): boolean;
5090
5249
  get isValidateOnValueChanged(): boolean;
5091
5250
  matrixCellValidate(question: IQuestion, options: any): SurveyError;
5092
- dynamicPanelAdded(question: IQuestion): void;
5251
+ dynamicPanelAdded(question: IQuestion, panelIndex?: number, panel?: IPanel): void;
5093
5252
  dynamicPanelRemoved(question: IQuestion, panelIndex: number, panel: IPanel): void;
5094
5253
  dynamicPanelItemValueChanged(question: IQuestion, options: any): void;
5095
5254
  dragAndDropAllow(options: any): boolean;
@@ -5605,6 +5764,13 @@ export declare class SurveyQuestionMatrixDynamicRemoveButton extends ReactSurvey
5605
5764
  handleOnRowRemoveClick(event: any): void;
5606
5765
  protected renderElement(): JSX.Element;
5607
5766
  }
5767
+ export declare class SurveyQuestionMatrixHeaderRequired extends ReactSurveyElement {
5768
+ constructor(props: any);
5769
+ get column(): MatrixDropdownColumn;
5770
+ get question(): any;
5771
+ protected getStateElement(): Base;
5772
+ protected renderElement(): JSX.Element;
5773
+ }
5608
5774
  export declare class SurveyQuestionMatrixRow extends ReactSurveyElement {
5609
5775
  constructor(props: any);
5610
5776
  handleOnChange(event: any): void;
@@ -5622,6 +5788,8 @@ export declare class SurveyQuestionMultipleText extends SurveyQuestionElementBas
5622
5788
  }
5623
5789
  export declare class SurveyQuestionOptionItem extends ReactSurveyElement {
5624
5790
  constructor(props: any);
5791
+ componentDidUpdate(prevProps: any, prevState: any): void;
5792
+ componentWillUnmount(): void;
5625
5793
  protected getStateElement(): Base;
5626
5794
  protected canRender(): boolean;
5627
5795
  protected renderElement(): JSX.Element;
@@ -6691,10 +6859,14 @@ export declare class SurveyQuestionCustom extends SurveyQuestionUncontrolledElem
6691
6859
  }
6692
6860
  export declare class SurveyQuestionDropdownBase<T> extends SurveyQuestionUncontrolledElement<T> {
6693
6861
  constructor(props: any);
6694
- onClick: (event: any) => void;
6862
+ click: (event: any) => void;
6863
+ clear: (event: any) => void;
6864
+ keyup: (event: any) => void;
6865
+ blur: (event: any) => void;
6695
6866
  protected setValueCore(newValue: any): void;
6696
6867
  protected getValueCore(): any;
6697
6868
  protected renderSelect(cssClasses: any): JSX.Element;
6869
+ createClearButton(): JSX.Element;
6698
6870
  }
6699
6871
  export declare class SurveyQuestionMatrixDropdown extends SurveyQuestionMatrixDropdownBase {
6700
6872
  constructor(props: any);
@@ -6718,7 +6890,6 @@ export declare class SurveyQuestionPanelDynamicItem extends SurveyPanel {
6718
6890
  constructor(props: any);
6719
6891
  protected getSurvey(): SurveyModel;
6720
6892
  protected getCss(): any;
6721
- handleOnPanelRemoveClick(event: any): void;
6722
6893
  render(): JSX.Element;
6723
6894
  protected renderButton(): JSX.Element;
6724
6895
  }
@@ -6736,6 +6907,11 @@ export declare class SurveyQuestionPanelDynamicProgressText extends SurveyQuesti
6736
6907
  constructor(props: any);
6737
6908
  protected renderElement(): JSX.Element;
6738
6909
  }
6910
+ export declare class SurveyQuestionPanelDynamicRemoveButton extends SurveyQuestionPanelDynamicAction {
6911
+ constructor(props: any);
6912
+ protected handleClick: (event: any) => void;
6913
+ protected renderElement(): JSX.Element;
6914
+ }
6739
6915
  export declare class SurveyQuestionText extends SurveyQuestionUncontrolledElement<QuestionTextModel> {
6740
6916
  constructor(props: any);
6741
6917
  _isWaitingForEnter: boolean;
@@ -7354,6 +7530,7 @@ export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
7354
7530
  visibleRowsChangedCallback: any;
7355
7531
  protected createColumnValues(): any;
7356
7532
  getType(): string;
7533
+ endLoadingFromJson(): void;
7357
7534
  get isCompositeQuestion(): boolean;
7358
7535
  /*
7359
7536
  * Set this property to false, to hide table header. The default value is true.
@@ -7391,6 +7568,7 @@ export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
7391
7568
  protected filterItems(): boolean;
7392
7569
  protected onColumnsChanged(): void;
7393
7570
  protected onRowsChanged(): void;
7571
+ protected updateVisibilityBasedOnRows(): void;
7394
7572
  protected shouldRunColumnExpression(): boolean;
7395
7573
  protected hasRowsAsItems(): boolean;
7396
7574
  protected runItemsCondition(values: any, properties: any): boolean;
@@ -7865,10 +8043,10 @@ export declare class QuestionRatingModel extends Question {
7865
8043
  get ratingRootCss(): string;
7866
8044
  getItemClass(item: ItemValue): string;
7867
8045
  getControlClass(): string;
7868
- get optionsCaption(): string;
7869
- set optionsCaption(val: string);
7870
- get locOptionsCaption(): LocalizableString;
7871
- get showOptionsCaption(): boolean;
8046
+ get placeholder(): string;
8047
+ set placeholder(val: string);
8048
+ get locPlaceholder(): LocalizableString;
8049
+ get allowClear(): boolean;
7872
8050
  get renderedValue(): boolean;
7873
8051
  set renderedValue(val: boolean);
7874
8052
  get visibleChoices(): any;
@@ -8386,17 +8564,17 @@ export declare class QuestionCustomModel extends QuestionCustomModelBase {
8386
8564
  */
8387
8565
  export declare class QuestionDropdownModel extends QuestionSelectBase {
8388
8566
  constructor(name: string);
8389
- /*
8390
- * This flag controls whether to show options caption item ('Choose...').
8391
- */
8567
+ dropdownListModel: DropdownListModel;
8392
8568
  get showOptionsCaption(): boolean;
8393
8569
  set showOptionsCaption(val: boolean);
8394
- /*
8395
- * Use this property to set the options caption different from the default value. The default value is taken from localization strings.
8396
- */
8397
8570
  get optionsCaption(): string;
8398
8571
  set optionsCaption(val: string);
8399
- get locOptionsCaption(): LocalizableString;
8572
+ /*
8573
+ * The input place holder.
8574
+ */
8575
+ get placeholder(): string;
8576
+ set placeholder(val: string);
8577
+ get locPlaceholder(): LocalizableString;
8400
8578
  getType(): string;
8401
8579
  get selectedItem(): ItemValue;
8402
8580
  supportGoNextPageAutomatic(): boolean;
@@ -8423,19 +8601,20 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
8423
8601
  */
8424
8602
  get autoComplete(): string;
8425
8603
  set autoComplete(val: string);
8426
- showClearButton: boolean;
8604
+ /*
8605
+ * Use it to clear the question value.
8606
+ */
8607
+ allowClear: boolean;
8427
8608
  itemComponent: string;
8428
8609
  denySearch: boolean;
8429
- dropdownWidthMode: "contentWidth" | "editorWidth";
8430
8610
  getControlClass(): string;
8431
8611
  get readOnlyText(): any;
8432
- onClear(event: any): void;
8433
- protected onVisibleChoicesChanged(): void;
8434
- _popupModel: any;
8435
8612
  get popupModel(): any;
8436
8613
  onOpened: EventBase<QuestionDropdownModel>;
8437
8614
  onOpenedCallBack(): void;
8438
- onClick(event: any): void;
8615
+ protected onVisibleChoicesChanged(): void;
8616
+ onClick(e: any): void;
8617
+ onKeyUp(event: any): void;
8439
8618
  }
8440
8619
  /*
8441
8620
  * A Model for html question. Unlike other questions it doesn't have value and title.
@@ -8512,6 +8691,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
8512
8691
  static set defaultCellType(val: string);
8513
8692
  static addDefaultColumns(matrix: QuestionMatrixDropdownModelBase): void;
8514
8693
  detailPanelValue: PanelModel;
8694
+ isUniqueCaseSensitiveValue: boolean;
8515
8695
  protected isRowChanging: boolean;
8516
8696
  columnsChangedCallback: any;
8517
8697
  onRenderedTableResetCallback: any;
@@ -8521,6 +8701,8 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
8521
8701
  onHasDetailPanelCallback: (row: MatrixDropdownRowModelBase) => boolean;
8522
8702
  onCreateDetailPanelCallback: (row: MatrixDropdownRowModelBase, panel: PanelModel) => void;
8523
8703
  onCreateDetailPanelRenderedRowCallback: (renderedRow: QuestionMatrixDropdownRenderedRow) => void;
8704
+ onAddColumn: (column: MatrixDropdownColumn) => void;
8705
+ onRemoveColumn: (column: MatrixDropdownColumn) => void;
8524
8706
  protected createColumnValues(): any;
8525
8707
  /*
8526
8708
  * Returns the type of the object as a string as it represents in the json.
@@ -8547,6 +8729,12 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
8547
8729
  */
8548
8730
  get isColumnLayoutHorizontal(): boolean;
8549
8731
  /*
8732
+ * 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.
8733
+ * It doesn't allow by default.
8734
+ */
8735
+ get isUniqueCaseSensitive(): boolean;
8736
+ set isUniqueCaseSensitive(val: boolean);
8737
+ /*
8550
8738
  * Set the value to "underRow" to show the detailPanel under the row.
8551
8739
  */
8552
8740
  get detailPanelMode(): string;
@@ -8642,11 +8830,13 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
8642
8830
  get choices(): any;
8643
8831
  set choices(val: any);
8644
8832
  /*
8645
- * The default options caption for dropdown cell type.
8833
+ * The default placeholder for dropdown cell type.
8646
8834
  */
8835
+ get placeholder(): string;
8836
+ set placeholder(val: string);
8837
+ get locPlaceholder(): LocalizableString;
8647
8838
  get optionsCaption(): string;
8648
8839
  set optionsCaption(val: string);
8649
- get locOptionsCaption(): LocalizableString;
8650
8840
  /*
8651
8841
  * The duplication value error text. Set it to show the text different from the default.
8652
8842
  */
@@ -8796,7 +8986,6 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
8796
8986
  getConditionJson(operator?: string, path?: string): any;
8797
8987
  protected clearValueIfInvisibleCore(): void;
8798
8988
  protected getFirstInputElementId(): string;
8799
- protected onRowsChanged(): void;
8800
8989
  onMatrixRowChanged(row: MatrixRowModel): void;
8801
8990
  getCorrectedRowValue(value: any): any;
8802
8991
  protected getSearchableItemValueKeys(keys: any): void;
@@ -8904,7 +9093,6 @@ export declare class QuestionTextModel extends QuestionTextBase {
8904
9093
  export declare class SurveyQuestionDropdownSelect extends SurveyQuestionDropdown {
8905
9094
  constructor(props: any);
8906
9095
  protected renderSelect(cssClasses: any): JSX.Element;
8907
- createClearButton(): JSX.Element;
8908
9096
  }
8909
9097
  /*
8910
9098
  * A Model for a button group question.
@@ -9103,6 +9291,11 @@ export declare class QuestionMatrixDropdownModel extends QuestionMatrixDropdownM
9103
9291
  get rowTitleWidth(): string;
9104
9292
  set rowTitleWidth(val: string);
9105
9293
  getRowTitleWidth(): string;
9294
+ /*
9295
+ * Set this property to true to hide the question if there is no visible rows in the matrix.
9296
+ */
9297
+ get hideIfRowsEmpty(): boolean;
9298
+ set hideIfRowsEmpty(val: boolean);
9106
9299
  protected getDisplayValueCore(keysAsText: boolean, value: any): any;
9107
9300
  protected getConditionObjectRowName(index: number): string;
9108
9301
  protected getConditionObjectRowText(index: number): string;
@@ -9298,6 +9491,8 @@ export declare class QuestionRadiogroupModel extends QuestionCheckboxBase {
9298
9491
  get canShowClearButton(): boolean;
9299
9492
  get clearButtonCaption(): string;
9300
9493
  supportGoNextPageAutomatic(): boolean;
9494
+ get showClearButtonInContent(): boolean;
9495
+ protected getDefaultTitleActions(): Array<Action>;
9301
9496
  }
9302
9497
  /*
9303
9498
  * A Model for a ranking question
@@ -9350,7 +9545,7 @@ export declare function getSize(value: any): any;
9350
9545
  export declare function createPopupModalViewModel(componentName: string, data: any, onApply: any, onCancel?: any, onHide?: any, onShow?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): PopupBaseViewModel;
9351
9546
  export declare function getCurrecyCodes(): Array<any>;
9352
9547
  export declare function showModal(componentName: string, data: any, onApply: any, onCancel?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): void;
9353
- export declare function attachKey2click(element: JSX.Element, viewModel?: any, options?: any): JSX.Element;
9548
+ export declare function attachKey2click(element: JSX.Element, viewModel?: any, options?: IAttachKey2clickOptions): JSX.Element;
9354
9549
  /*
9355
9550
  * Global survey settings
9356
9551
  */
@@ -9550,6 +9745,10 @@ export declare var settings: {
9550
9745
  panel: string,
9551
9746
  question: string,
9552
9747
  },
9748
+ questions: {
9749
+ inputTypes: any,
9750
+ dataList: any,
9751
+ },
9553
9752
  };
9554
9753
  export declare var surveyLocalization: {
9555
9754
  currentLocaleValue: string,
@@ -10636,6 +10835,7 @@ export declare var defaultV2Css: {
10636
10835
  titleCollapsed: string,
10637
10836
  titleOnExpand: string,
10638
10837
  titleOnError: string,
10838
+ titleBar: string,
10639
10839
  description: string,
10640
10840
  container: string,
10641
10841
  withFrame: string,
@@ -10646,6 +10846,7 @@ export declare var defaultV2Css: {
10646
10846
  requiredText: string,
10647
10847
  header: string,
10648
10848
  collapsed: string,
10849
+ expanded: string,
10649
10850
  nested: string,
10650
10851
  invisible: string,
10651
10852
  navigationButton: string,
@@ -10720,6 +10921,7 @@ export declare var defaultV2Css: {
10720
10921
  titleExpandable: string,
10721
10922
  titleExpanded: string,
10722
10923
  titleCollapsed: string,
10924
+ titleBar: string,
10723
10925
  requiredText: string,
10724
10926
  number: string,
10725
10927
  description: string,
@@ -10733,6 +10935,7 @@ export declare var defaultV2Css: {
10733
10935
  formGroup: string,
10734
10936
  hasError: string,
10735
10937
  collapsed: string,
10938
+ expanded: string,
10736
10939
  nested: string,
10737
10940
  invisible: string,
10738
10941
  },
@@ -10880,7 +11083,6 @@ export declare var defaultV2Css: {
10880
11083
  itemControl: string,
10881
11084
  image: string,
10882
11085
  itemText: string,
10883
- clearButton: string,
10884
11086
  other: string,
10885
11087
  itemNoImage: string,
10886
11088
  itemNoImageSvgIcon: string,
@@ -10982,6 +11184,7 @@ export declare var defaultV2Css: {
10982
11184
  maxText: string,
10983
11185
  itemDisabled: string,
10984
11186
  control: string,
11187
+ controlValue: string,
10985
11188
  controlDisabled: string,
10986
11189
  controlEmpty: string,
10987
11190
  onError: string,
@@ -11062,6 +11265,7 @@ export declare var defaultV2Css: {
11062
11265
  rootMobileMod: string,
11063
11266
  rootDragMod: string,
11064
11267
  rootDisabled: string,
11268
+ rootDesignMode: string,
11065
11269
  item: string,
11066
11270
  itemContent: string,
11067
11271
  itemIndex: string,