survey-react 1.9.37 → 1.9.38

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.38
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,6 +184,7 @@ 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;
@@ -1502,6 +1503,7 @@ export declare class Action extends Base implements IAction {
1502
1503
  mode: any;
1503
1504
  disableTabStop: boolean;
1504
1505
  disableShrink: boolean;
1506
+ disableHide: boolean;
1505
1507
  needSpace: boolean;
1506
1508
  locTitle: any;
1507
1509
  titleValue: string;
@@ -1707,6 +1709,7 @@ export declare class ConditionRunner extends ExpressionRunnerBase {
1707
1709
  export declare class Const extends Operand {
1708
1710
  constructor(value: any);
1709
1711
  getType(): string;
1712
+ setValue(val: any): void;
1710
1713
  toString(func?: (op: Operand) => string): string;
1711
1714
  get correctValue(): any;
1712
1715
  evaluate(): any;
@@ -3391,6 +3394,7 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
3391
3394
  get titleActions(): any;
3392
3395
  isTitleActionRequested: boolean;
3393
3396
  getTitleActions(): Array<any>;
3397
+ protected getDefaultTitleActions(): Array<IAction>;
3394
3398
  get hasTitleActions(): boolean;
3395
3399
  get hasTitleEvents(): boolean;
3396
3400
  get titleTabIndex(): number;
@@ -3578,39 +3582,39 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
3578
3582
  navigationBarValue: any;
3579
3583
  /*
3580
3584
  * 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.
3585
+ * - `sender` - the survey object that fires the event.
3586
+ * - `options.trigger` - An instance of a trigger that has been just perform it's action.
3583
3587
  */
3584
3588
  onTriggerExecuted: EventBase<SurveyModel>;
3585
3589
  /*
3586
3590
  * 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.
3591
+ * - `sender` - the survey object that fires the event.
3592
+ * - `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`.
3593
+ * - `options.isCompleteOnTrigger` - returns true if the survey is completing on "complete" trigger.
3590
3594
  */
3591
3595
  onCompleting: EventBase<SurveyModel>;
3592
3596
  /*
3593
3597
  * 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.
3598
+ * - `sender` - the survey object that fires the event.
3599
+ * - `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.
3600
+ * - `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.
3601
+ * - `options.showDataSavingSuccess(text)` - call this method to show that the data was successfully saved on the server.
3602
+ * - `options.showDataSavingClear` - call this method to hide the text about the saving progress.
3603
+ * - `options.isCompleteOnTrigger` - returns true if the survey is completed on "complete" trigger.
3600
3604
  */
3601
3605
  onComplete: EventBase<SurveyModel>;
3602
3606
  /*
3603
3607
  * 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
3608
  * 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`.
3609
+ * - `sender` - the survey object that fires the event.
3610
+ * - `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
3611
  */
3608
3612
  onShowingPreview: EventBase<SurveyModel>;
3609
3613
  /*
3610
3614
  * 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
3615
  * 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.
3616
+ * - `sender` - the survey object that fires the event.
3617
+ * - `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
3618
  */
3615
3619
  onNavigateToUrl: EventBase<SurveyModel>;
3616
3620
  /*
@@ -3620,73 +3624,73 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
3620
3624
  onStarted: EventBase<SurveyModel>;
3621
3625
  /*
3622
3626
  * 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.
3627
+ * - `sender` - the survey object that fires the event.
3624
3628
  */
3625
3629
  onPartialSend: EventBase<SurveyModel>;
3626
3630
  /*
3627
3631
  * 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
3632
+ * - `sender` - the survey object that fires the event.
3633
+ * - `option.oldCurrentPage` - the previous current/active page.
3634
+ * - `option.newCurrentPage` - a new current/active page.
3635
+ * - `option.allowChanging` - set it to `false` to disable the current page changing. It is `true` by default.
3636
+ * - `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
3637
+ * - `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
3638
  */
3635
3639
  onCurrentPageChanging: EventBase<SurveyModel>;
3636
3640
  /*
3637
3641
  * 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
3642
+ * - `sender` - the survey object that fires the event.
3643
+ * - `option.oldCurrentPage` - a previous current/active page.
3644
+ * - `option.newCurrentPage` - a new current/active page.
3645
+ * - `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
3646
+ * - `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
3647
  */
3644
3648
  onCurrentPageChanged: EventBase<SurveyModel>;
3645
3649
  /*
3646
3650
  * 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.
3651
+ * - `sender` - the survey object that fires the event.
3652
+ * - `options.name` - the value name that has being changed.
3653
+ * - `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.
3654
+ * - `options.oldValue` - an old, previous value.
3655
+ * - `options.value` - a new value. You can change it.
3652
3656
  */
3653
3657
  onValueChanging: EventBase<SurveyModel>;
3654
3658
  /*
3655
3659
  * 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
3660
  * 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.
3661
+ * - `sender` - the survey object that fires the event.
3662
+ * - `options.name` - the value name that has been changed.
3663
+ * - `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`.
3664
+ * - `options.value` - a new value.
3661
3665
  */
3662
3666
  onValueChanged: EventBase<SurveyModel>;
3663
3667
  /*
3664
3668
  * 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.
3669
+ * - `sender` - the survey object that fires the event.
3670
+ * - `options.name` - the variable name that has been changed.
3671
+ * - `options.value` - a new value.
3668
3672
  */
3669
3673
  onVariableChanged: EventBase<SurveyModel>;
3670
3674
  /*
3671
3675
  * 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.
3676
+ * - `sender` - the survey object that fires the event.
3677
+ * - `options.question` - a question which visibility has been changed.
3678
+ * - `options.name` - a question name.
3679
+ * - `options.visible` - a question `visible` boolean value.
3676
3680
  */
3677
3681
  onVisibleChanged: EventBase<SurveyModel>;
3678
3682
  /*
3679
3683
  * 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.
3684
+ * - `sender` - the survey object that fires the event.
3685
+ * - `options.page` - a page which visibility has been changed.
3686
+ * - `options.visible` - a page `visible` boolean value.
3683
3687
  */
3684
3688
  onPageVisibleChanged: EventBase<SurveyModel>;
3685
3689
  /*
3686
3690
  * 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.
3691
+ * - `sender` - the survey object that fires the event.
3692
+ * - `options.panel` - a panel which visibility has been changed.
3693
+ * - `options.visible` - a panel `visible` boolean value.
3690
3694
  */
3691
3695
  onPanelVisibleChanged: EventBase<SurveyModel>;
3692
3696
  /*
@@ -3695,88 +3699,88 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
3695
3699
  * 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
3700
  * 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
3701
  * 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.
3702
+ * - `sender` - the survey object that fires the event.
3703
+ * - `options.question` - a newly created question object.
3700
3704
  */
3701
3705
  onQuestionCreated: EventBase<SurveyModel>;
3702
3706
  /*
3703
3707
  * 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.
3708
+ * - `sender` - the survey object that fires the event.
3709
+ * - `options.question` - a newly added question object.
3710
+ * - `options.name` - a question name.
3711
+ * - `options.index` - an index of the question in the container (page or panel).
3712
+ * - `options.parentPanel` - a container where a new question is located. It can be a page or panel.
3713
+ * - `options.rootPanel` - typically, it is a page.
3710
3714
  */
3711
3715
  onQuestionAdded: EventBase<SurveyModel>;
3712
3716
  /*
3713
3717
  * 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.
3718
+ * - `sender` - the survey object that fires the event.
3719
+ * - `options.question` - a removed question object.
3720
+ * - `options.name` - a question name.
3717
3721
  */
3718
3722
  onQuestionRemoved: EventBase<SurveyModel>;
3719
3723
  /*
3720
3724
  * 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.
3725
+ * - `sender` - the survey object that fires the event.
3726
+ * - `options.panel` - a newly added panel object.
3727
+ * - `options.name` - a panel name.
3728
+ * - `options.index` - an index of the panel in the container (a page or panel).
3729
+ * - `options.parentPanel` - a container (a page or panel) where a new panel is located.
3730
+ * - `options.rootPanel` - a root container, typically it is a page.
3727
3731
  */
3728
3732
  onPanelAdded: EventBase<SurveyModel>;
3729
3733
  /*
3730
3734
  * 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.
3735
+ * - `sender` - the survey object that fires the event.
3736
+ * - `options.panel` - a removed panel object.
3737
+ * - `options.name` - a panel name.
3734
3738
  */
3735
3739
  onPanelRemoved: EventBase<SurveyModel>;
3736
3740
  /*
3737
3741
  * 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.
3742
+ * - `sender` - the survey object that fires the event.
3743
+ * - `options.page` - a newly added `panel` object.
3740
3744
  */
3741
3745
  onPageAdded: EventBase<SurveyModel>;
3742
3746
  /*
3743
3747
  * 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.
3748
+ * - `sender` - the survey object that fires the event.
3749
+ * - `options.question` - a validated question.
3750
+ * - `options.name` - a question name.
3751
+ * - `options.value` - the current question value (answer).
3752
+ * - `options.error` - an error string. It is empty by default.
3749
3753
  */
3750
3754
  onValidateQuestion: EventBase<SurveyModel>;
3751
3755
  /*
3752
3756
  * 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.
3757
+ * - `sender` - the survey object that fires the event.
3758
+ * - `options.question` - a validated question.
3759
+ * - `options.errors` - the list of errors. The list is empty by default and remains empty if a validated question has no errors.
3756
3760
  */
3757
3761
  onSettingQuestionErrors: EventBase<SurveyModel>;
3758
3762
  /*
3759
3763
  * 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.
3764
+ * - `sender` - the survey object that fires the event.
3765
+ * - `options.data` - the values of all non-empty questions on the current page. You can get a question value as `options.data["myQuestionName"]`.
3766
+ * - `options.errors` - set your errors to this object as: `options.errors["myQuestionName"] = "Error text";`. It will be shown as a question error.
3767
+ * - `options.complete()` - call this function to tell survey that your server callback has been processed.
3764
3768
  */
3765
3769
  onServerValidateQuestions: any;
3766
3770
  /*
3767
3771
  * 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.
3772
+ * - `sender` - the survey object that fires the event.
3773
+ * - `options.name` - a panel name.
3774
+ * - `options.error` - an error string. It is empty by default.
3771
3775
  */
3772
3776
  onValidatePanel: EventBase<SurveyModel>;
3773
3777
  /*
3774
3778
  * 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:
3779
+ * - `sender` - the survey object that fires the event.
3780
+ * - `options.text` - an error text.
3781
+ * - `options.error` - an instance of the `SurveyError` object.
3782
+ * - `options.obj` - an instance of Question, Panel or Survey object to where error is located.
3783
+ * - `options.name` - the error name. The following error names are available:
3780
3784
  * required, requireoneanswer, requirenumeric, exceedsize, webrequest, webrequestempty, otherempty,
3781
3785
  * uploadingfile, requiredinallrowserror, minrowcounterror, keyduplicationerror, custom
3782
3786
  */
@@ -3790,206 +3794,206 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
3790
3794
  onValidatedErrorsOnCurrentPage: EventBase<SurveyModel>;
3791
3795
  /*
3792
3796
  * Use this event to modify the HTML content before rendering, for example `completeHtml` or `loadingHtml`.
3793
- * `options.html` - specifies the modified HTML content.
3797
+ * - `options.html` - specifies the modified HTML content.
3794
3798
  */
3795
3799
  onProcessHtml: EventBase<SurveyModel>;
3796
3800
  /*
3797
3801
  * 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.
3802
+ * - `sender` - the survey object that fires the event.
3803
+ * - `options.title` - a calculated question title, based on question `title`, `name`.
3804
+ * - `options.question` - a question object.
3801
3805
  */
3802
3806
  onGetQuestionTitle: EventBase<SurveyModel>;
3803
3807
  /*
3804
3808
  * 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.
3809
+ * - `sender` - the survey object that fires the event.
3810
+ * - `options.element` - an element (question, panel, page and survey) that SurveyJS is going to render.
3811
+ * - `options.tagName` - an element title tagName that are used to render a title. You can change it from the default value.
3808
3812
  */
3809
3813
  onGetTitleTagName: EventBase<SurveyModel>;
3810
3814
  /*
3811
3815
  * 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.
3816
+ * - `sender` - the survey object that fires the event.
3817
+ * - `options.no` - a calculated question no, based on question `visibleIndex`, survey `.questionStartIndex` properties. You can change it.
3818
+ * - `options.question` - a question object.
3815
3819
  */
3816
3820
  onGetQuestionNo: EventBase<SurveyModel>;
3817
3821
  /*
3818
3822
  * 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.
3823
+ * - `sender` - the survey object that fires the event.
3824
+ * - `options.text` - a progress text, that SurveyJS will render in progress bar.
3825
+ * - `options.questionCount` - a number of questions that have input(s). We do not count html or expression questions
3826
+ * - `options.answeredQuestionCount` - a number of questions that have input(s) and an user has answered.
3827
+ * - `options.requiredQuestionCount` - a number of required questions that have input(s). We do not count html or expression questions
3828
+ * - `options.requiredAnsweredQuestionCount` - a number of required questions that have input(s) and an user has answered.
3825
3829
  */
3826
3830
  onProgressText: EventBase<SurveyModel>;
3827
3831
  /*
3828
3832
  * 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`.
3833
+ * - `sender` - the survey object that fires the event.
3834
+ * - `options.element` - SurveyJS element (a question, panel, page, or survey) where the string is going to be rendered.
3835
+ * - `options.name` - a property name is going to be rendered.
3836
+ * - `options.text` - a text that is going to be rendered.
3837
+ * - `options.html` - an HTML content. It is `null` by default. Use this property to specify the HTML content rendered instead of `options.text`.
3834
3838
  */
3835
3839
  onTextMarkdown: EventBase<SurveyModel>;
3836
3840
  /*
3837
3841
  * 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.
3842
+ * - `sender` - the survey object that fires the event.
3843
+ * - `options.element` - SurveyJS element (a question, panel, page, or survey) where the string is going to be rendered.
3844
+ * - `options.name` - a property name is going to be rendered.
3845
+ * - `options.renderAs` - a component name used for text rendering.
3842
3846
  */
3843
3847
  onTextRenderAs: EventBase<SurveyModel>;
3844
3848
  /*
3845
3849
  * 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.
3850
+ * - `sender` - the survey object that fires the event.
3851
+ * - `options.success` - it is `true` if the results has been sent to the service successfully.
3852
+ * - `options.response` - a response from the service.
3849
3853
  */
3850
3854
  onSendResult: EventBase<SurveyModel>;
3851
3855
  /*
3852
3856
  * 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.
3857
+ * - `sender` - the survey object that fires the event.
3858
+ * - `options.success` - it is `true` if the results were got from the service successfully.
3859
+ * - `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.
3860
+ * - `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.
3861
+ * - `options.response` - the server response.
3858
3862
  */
3859
3863
  onGetResult: EventBase<SurveyModel>;
3860
3864
  /*
3861
3865
  * 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.
3866
+ * - `sender` - the survey object that fires the event.
3867
+ * - `options.question` - the file question instance.
3868
+ * - `options.name` - the question name.
3869
+ * - `options.files` - the Javascript File objects array to upload.
3870
+ * - `options.callback` - a callback function to get the file upload status and the updloaded file content.
3867
3871
  */
3868
3872
  onUploadFiles: EventBase<SurveyModel>;
3869
3873
  /*
3870
3874
  * 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.
3875
+ * - `sender` - the survey object that fires the event.
3876
+ * - `options.name` - the question name.
3877
+ * - `options.content` - the file content.
3878
+ * - `options.fileValue` - single file question value.
3879
+ * - `options.callback` - a callback function to get the file downloading status and the downloaded file content.
3876
3880
  */
3877
3881
  onDownloadFile: EventBase<SurveyModel>;
3878
3882
  /*
3879
3883
  * 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.
3884
+ * - `sender` - the survey object that fires the event.
3885
+ * - `question` - the question instance.
3886
+ * - `options.name` - the question name.
3887
+ * - `options.value` - the question value.
3888
+ * - `options.fileName` - a removed file's name, set it to `null` to clear all files.
3889
+ * - `options.callback` - a callback function to get the operation status.
3886
3890
  */
3887
3891
  onClearFiles: EventBase<SurveyModel>;
3888
3892
  /*
3889
3893
  * 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
3894
  * 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.
3895
+ * - `sender` - the survey object that fires the event.
3896
+ * - `question` - the question where loaded choices are going to be assigned.
3897
+ * - `choices` - the loaded choices. You can change the loaded choices to before they are assigned to question.
3898
+ * - `serverResult` - a result that comes from the server as it is.
3895
3899
  */
3896
3900
  onLoadChoicesFromServer: EventBase<SurveyModel>;
3897
3901
  /*
3898
3902
  * The event is fired after survey is loaded from api.surveyjs.io service.
3899
3903
  * 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.
3904
+ * - `sender` - the survey object that fires the event.
3901
3905
  */
3902
3906
  onLoadedSurveyFromService: EventBase<SurveyModel>;
3903
3907
  /*
3904
3908
  * 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
3909
  * For example, you may use the text processing in loading choices from the web. If your `choicesByUrl.url` equals to "UrlToServiceToGetAllCities/{country}/{state}",
3906
3910
  * 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.
3911
+ * - `sender` - the survey object that fires the event.
3912
+ * - `options.name` - the name of the processing value, for example, "state" in our example.
3913
+ * - `options.value` - the value of the processing text.
3914
+ * - `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
3915
  */
3912
3916
  onProcessTextValue: EventBase<SurveyModel>;
3913
3917
  /*
3914
3918
  * 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.
3919
+ * - `sender` - the survey object that fires the event.
3920
+ * - `options.question` - a question for which you can change the CSS classes.
3921
+ * - `options.cssClasses` - an object with CSS classes. For example `{root: "table", button: "button"}`. You can change them to your own CSS classes.
3918
3922
  */
3919
3923
  onUpdateQuestionCssClasses: EventBase<SurveyModel>;
3920
3924
  /*
3921
3925
  * 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.
3926
+ * - `sender` - the survey object that fires the event.
3927
+ * - `options.panel` - a panel for which you can change the CSS classes.
3928
+ * - `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
3929
  */
3926
3930
  onUpdatePanelCssClasses: EventBase<SurveyModel>;
3927
3931
  /*
3928
3932
  * 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.
3933
+ * - `sender` - the survey object that fires the event.
3934
+ * - `options.page` - a page for which you can change the CSS classes.
3935
+ * - `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
3936
  */
3933
3937
  onUpdatePageCssClasses: EventBase<SurveyModel>;
3934
3938
  /*
3935
3939
  * 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.
3940
+ * - `sender` - the survey object that fires the event.
3941
+ * - `options.question` - a question where choice item is rendered.
3942
+ * - `options.item` - a choice item of ItemValue type. You can get value or text choice properties as options.item.value or options.choice.text
3943
+ * - `options.css` - a string with css classes divided by space. You can change it.
3940
3944
  */
3941
3945
  onUpdateChoiceItemCss: EventBase<SurveyModel>;
3942
3946
  /*
3943
3947
  * 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.
3948
+ * - `sender` - the survey object that fires the event.
3949
+ * - `options.htmlElement` - a root HTML element bound to the survey object.
3946
3950
  */
3947
3951
  onAfterRenderSurvey: EventBase<SurveyModel>;
3948
3952
  /*
3949
3953
  * 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.
3954
+ * - `sender` - the survey object that fires the event.
3955
+ * - `options.htmlElement` - an HTML element bound to the survey header object.
3952
3956
  */
3953
3957
  onAfterRenderHeader: EventBase<SurveyModel>;
3954
3958
  /*
3955
3959
  * 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.
3960
+ * - `sender` - the survey object that fires the event.
3961
+ * - `options.page` - a page object for which the event is fired. Typically the current/active page.
3962
+ * - `options.htmlElement` - an HTML element bound to the page object.
3959
3963
  */
3960
3964
  onAfterRenderPage: EventBase<SurveyModel>;
3961
3965
  /*
3962
3966
  * 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.
3967
+ * - `sender` - the survey object that fires the event.
3968
+ * - `options.question` - a question object for which the event is fired.
3969
+ * - `options.htmlElement` - an HTML element bound to the question object.
3966
3970
  */
3967
3971
  onAfterRenderQuestion: EventBase<SurveyModel>;
3968
3972
  /*
3969
3973
  * 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
3974
  * 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.
3975
+ * - `sender` - the survey object that fires the event.
3976
+ * - `options.question` - a question object for which the event is fired.
3977
+ * - `options.htmlElement` - an HTML element bound to the question object.
3974
3978
  */
3975
3979
  onAfterRenderQuestionInput: EventBase<SurveyModel>;
3976
3980
  /*
3977
3981
  * 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
3982
+ * - `sender` - the survey object that fires the event
3983
+ * - `options.panel` - a panel object for which the event is fired
3984
+ * - `options.htmlElement` - an HTML element bound to the panel object
3981
3985
  */
3982
3986
  onAfterRenderPanel: EventBase<SurveyModel>;
3983
3987
  /*
3984
3988
  * 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.
3989
+ * - `sender` - A [survey](https://surveyjs.io/Documentation/Library?id=surveymodel) object that fires the event.
3990
+ * - `options.question` - A [question](https://surveyjs.io/Documentation/Library?id=Question) whose child element gets focus.
3987
3991
  */
3988
3992
  onFocusInQuestion: EventBase<SurveyModel>;
3989
3993
  /*
3990
3994
  * 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.
3995
+ * - `sender` - A [survey](https://surveyjs.io/Documentation/Library?id=surveymodel) object that fires the event.
3996
+ * - `options.panel` - A [panel](https://surveyjs.io/Documentation/Library?id=PanelModelBase) whose child element gets focus.
3993
3997
  */
3994
3998
  onFocusInPanel: EventBase<SurveyModel>;
3995
3999
  /*
@@ -4005,123 +4009,123 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4005
4009
  onShowingChoiceItem: EventBase<SurveyModel>;
4006
4010
  /*
4007
4011
  * 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.
4012
+ * - `sender` - the survey object that fires the event
4013
+ * - `options.question` - a matrix question.
4014
+ * - `options.row` - a new added row.
4011
4015
  */
4012
4016
  onMatrixRowAdded: EventBase<SurveyModel>;
4013
4017
  /*
4014
4018
  * 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
4019
+ * - `sender` - the survey object that fires the event
4020
+ * - `options.question` - a matrix question.
4021
+ * - `options.canAddRow` - specifies whether a new row can be added
4018
4022
  */
4019
4023
  onMatrixBeforeRowAdded: EventBase<SurveyModel>;
4020
4024
  /*
4021
4025
  * 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.
4026
+ * - `sender` - the survey object that fires the event
4027
+ * - `options.question` - a matrix question.
4028
+ * - `options.rowIndex` - a row index.
4029
+ * - `options.row` - a row object.
4030
+ * - `options.allow` - a boolean property. Set it to `false` to disable the row removing.
4027
4031
  */
4028
4032
  onMatrixRowRemoving: EventBase<SurveyModel>;
4029
4033
  /*
4030
4034
  * 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
4035
+ * - `sender` - the survey object that fires the event
4036
+ * - `options.question` - a matrix question
4037
+ * - `options.rowIndex` - a removed row index
4038
+ * - `options.row` - a removed row object
4035
4039
  */
4036
4040
  onMatrixRowRemoved: EventBase<SurveyModel>;
4037
4041
  /*
4038
4042
  * 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.
4043
+ * - `sender` - the survey object that fires the event
4044
+ * - `options.question` - a matrix question.
4045
+ * - `options.rowIndex` - a row index.
4046
+ * - `options.row` - a row object.
4047
+ * - `options.allow` - a boolean property. Set it to `false` to disable the row removing.
4044
4048
  */
4045
4049
  onMatrixAllowRemoveRow: EventBase<SurveyModel>;
4046
4050
  /*
4047
4051
  * 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.
4052
+ * - `sender` - the survey object that fires the event.
4053
+ * - `options.question` - the matrix question.
4054
+ * - `options.cellType` - the cell question type. You can change it.
4055
+ * - `options.rowValue` - the value of the current row. To access a particular column's value within the current row, use: `options.rowValue["columnValue"]`.
4056
+ * - `options.column` - the matrix column object.
4057
+ * - `options.columnName` - the matrix column name.
4058
+ * - `options.row` - the matrix row object.
4055
4059
  */
4056
4060
  onMatrixCellCreating: EventBase<SurveyModel>;
4057
4061
  /*
4058
4062
  * 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.
4063
+ * - `sender` - the survey object that fires the event.
4064
+ * - `options.question` - the matrix question.
4065
+ * - `options.cell` - the matrix cell.
4066
+ * - `options.cellQuestion` - the question/editor in the cell. You may customize it, change it's properties, like choices or visible.
4067
+ * - `options.rowValue` - the value of the current row. To access a particular column's value within the current row, use: `options.rowValue["columnValue"]`.
4068
+ * - `options.column` - the matrix column object.
4069
+ * - `options.columnName` - the matrix column name.
4070
+ * - `options.row` - the matrix row object.
4067
4071
  */
4068
4072
  onMatrixCellCreated: EventBase<SurveyModel>;
4069
4073
  /*
4070
4074
  * 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.
4075
+ * - `sender` - the survey object that fires the event.
4076
+ * - `options.question` - the matrix question.
4077
+ * - `options.cell` - the matrix cell.
4078
+ * - `options.cellQuestion` - the question/editor in the cell.
4079
+ * - `options.htmlElement` - an HTML element bound to the `cellQuestion` object.
4080
+ * - `options.column` - the matrix column object.
4081
+ * - `options.row` - the matrix row object.
4078
4082
  */
4079
4083
  onMatrixAfterCellRender: EventBase<SurveyModel>;
4080
4084
  /*
4081
4085
  * 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.
4086
+ * - `sender` - the survey object that fires the event.
4087
+ * - `options.question` - the matrix question.
4088
+ * - `options.columnName` - the matrix column name.
4089
+ * - `options.value` - a new value.
4090
+ * - `options.row` - the matrix row object.
4091
+ * - `options.getCellQuestion(columnName)` - the function that returns the cell question by column name.
4088
4092
  */
4089
4093
  onMatrixCellValueChanged: EventBase<SurveyModel>;
4090
4094
  /*
4091
4095
  * 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.
4096
+ * - `sender` - the survey object that fires the event.
4097
+ * - `options.question` - the matrix question.
4098
+ * - `options.columnName` - the matrix column name.
4099
+ * - `options.value` - a new value.
4100
+ * - `options.oldValue` - the old value.
4101
+ * - `options.row` - the matrix row object.
4102
+ * - `options.getCellQuestion(columnName)` - the function that returns a cell question by column name.
4099
4103
  */
4100
4104
  onMatrixCellValueChanging: EventBase<SurveyModel>;
4101
4105
  /*
4102
4106
  * 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.
4107
+ * - `sender` - the survey object that fires the event.
4108
+ * - `options.error` - an error string. It is empty by default.
4109
+ * - `options.question` - the matrix question.
4110
+ * - `options.columnName` - the matrix column name.
4111
+ * - `options.value` - a cell value.
4112
+ * - `options.row` - the matrix row object.
4113
+ * - `options.getCellQuestion(columnName)` - the function that returns the cell question by column name.
4110
4114
  */
4111
4115
  onMatrixCellValidate: EventBase<SurveyModel>;
4112
4116
  /*
4113
4117
  * 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.
4118
+ * - `sender` - the survey object that fires the event.
4119
+ * - `options.question` - a panel question.
4120
+ * - `options.panel` - an added panel.
4117
4121
  */
4118
4122
  onDynamicPanelAdded: EventBase<SurveyModel>;
4119
4123
  /*
4120
4124
  * 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.
4125
+ * - `sender` - the survey object that fires the event.
4126
+ * - `options.question` - a panel question.
4127
+ * - `options.panelIndex` - a removed panel index.
4128
+ * - `options.panel` - a removed panel.
4125
4129
  */
4126
4130
  onDynamicPanelRemoved: EventBase<SurveyModel>;
4127
4131
  /*
@@ -4130,92 +4134,92 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4130
4134
  onTimer: EventBase<SurveyModel>;
4131
4135
  /*
4132
4136
  * 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.
4137
+ * - `sender` - the survey object that fires the event.
4138
+ * - `options.text` - the timer panel info text.
4135
4139
  */
4136
4140
  onTimerPanelInfoText: EventBase<SurveyModel>;
4137
4141
  /*
4138
4142
  * 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.
4143
+ * - `sender` - the survey object that fires the event.
4144
+ * - `options.question` - the panel question.
4145
+ * - `options.panel` - the dynamic panel item.
4146
+ * - `options.name` - the item name.
4147
+ * - `options.value` - a new value.
4148
+ * - `options.itemIndex` - the panel item index.
4149
+ * - `options.itemValue` - the panel item object.
4146
4150
  */
4147
4151
  onDynamicPanelItemValueChanged: EventBase<SurveyModel>;
4148
4152
  /*
4149
4153
  * 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.
4154
+ * - `sender` - the survey object that fires the event.
4155
+ * - `options.question` - a question on which you have to decide if the answer is correct or not.
4156
+ * - `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.
4157
+ * - `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
4158
  */
4155
4159
  onIsAnswerCorrect: EventBase<SurveyModel>;
4156
4160
  /*
4157
4161
  * 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.
4162
+ * - `sender` - the survey object that fires the event.
4163
+ * - `options.allow` - set it to `false` to disable dragging.
4164
+ * - `options.target` - a target element that is dragged.
4165
+ * - `options.source` - a source element. It can be `null`, if it is a new element, dragging from toolbox.
4166
+ * - `options.parent` - a page or panel where target element is dragging.
4167
+ * - `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.
4168
+ * - `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
4169
  */
4166
4170
  onDragDropAllow: EventBase<SurveyModel>;
4167
4171
  /*
4168
4172
  * 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.
4173
+ * - `sender` - the survey object that fires the event.
4174
+ * - `options.element` - an element that is going to be scrolled on top.
4175
+ * - `options.question` - a question that is going to be scrolled on top. It can be null if options.page is not null.
4176
+ * - `options.page` - a page that is going to be scrolled on top. It can be null if options.question is not null.
4177
+ * - `options.elementId` - the unique element DOM Id.
4178
+ * - `options.cancel` - set this property to true to cancel the default scrolling.
4175
4179
  */
4176
4180
  onScrollingElementToTop: EventBase<SurveyModel>;
4177
4181
  onLocaleChangedEvent: EventBase<SurveyModel>;
4178
4182
  /*
4179
4183
  * 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.
4184
+ * - `sender` - A [Survey](https://surveyjs.io/Documentation/Library?id=SurveyModel) object that fires the event.
4185
+ * - `options.question` - A [Question](https://surveyjs.io/Documentation/Library?id=Question) object for which the event is fired.
4186
+ * - `options.titleActions` - A list of actions ([IAction](https://surveyjs.io/Documentation/Library?id=IAction) objects) associated with the processed question.
4183
4187
  */
4184
4188
  onGetQuestionTitleActions: EventBase<SurveyModel>;
4185
4189
  /*
4186
4190
  * 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.
4191
+ * - `sender` - A survey object that fires the event.
4192
+ * - `options.panel` - A panel ([PanelModel](https://surveyjs.io/Documentation/Library?id=panelmodel) object) for which the event is fired.
4193
+ * - `options.titleActions` - A list of actions ([IAction](https://surveyjs.io/Documentation/Library?id=IAction) objects) associated with the processed panel.
4190
4194
  */
4191
4195
  onGetPanelTitleActions: EventBase<SurveyModel>;
4192
4196
  /*
4193
4197
  * 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.
4198
+ * - `sender` - A survey object that fires the event.
4199
+ * - `options.page` - A page ([PageModel](https://surveyjs.io/Documentation/Library?id=pagemodel) object) for which the event is fired.
4200
+ * - `options.titleActions` - A list of actions ([IAction](https://surveyjs.io/Documentation/Library?id=IAction) objects) associated with the processed page.
4197
4201
  */
4198
4202
  onGetPageTitleActions: EventBase<SurveyModel>;
4199
4203
  /*
4200
4204
  * 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.
4205
+ * - `sender` - A survey object that fires the event.
4206
+ * - `options.question` - A matrix question ([QuestionMatrixBaseModel](https://surveyjs.io/Documentation/Library?id=questionmatrixbasemodel) object) for which the event is fired.
4207
+ * - `options.row` - A matrix row for which the event is fired.
4208
+ * - `options.actions` - A list of actions ([IAction](https://surveyjs.io/Documentation/Library?id=IAction) objects) associated with the processed matrix question and row.
4205
4209
  */
4206
4210
  onGetMatrixRowActions: EventBase<SurveyModel>;
4207
4211
  /*
4208
4212
  * 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.
4213
+ * - `sender` - the survey object that fires the event.
4214
+ * - `options.element` - Specifies which survey element content was collapsed or expanded.
4211
4215
  */
4212
4216
  onElementContentVisibilityChanged: EventBase<SurveyModel>;
4213
4217
  /*
4214
4218
  * 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.
4219
+ * - `sender` - the survey object that fires the event.
4220
+ * - `options.question` - The expression question.
4221
+ * - `options.value` - The question value.
4222
+ * - `options.displayValue` - the display value that you can change before rendering.
4219
4223
  */
4220
4224
  onGetExpressionDisplayValue: EventBase<SurveyModel>;
4221
4225
  /*
@@ -6718,7 +6722,6 @@ export declare class SurveyQuestionPanelDynamicItem extends SurveyPanel {
6718
6722
  constructor(props: any);
6719
6723
  protected getSurvey(): SurveyModel;
6720
6724
  protected getCss(): any;
6721
- handleOnPanelRemoveClick(event: any): void;
6722
6725
  render(): JSX.Element;
6723
6726
  protected renderButton(): JSX.Element;
6724
6727
  }
@@ -6736,6 +6739,11 @@ export declare class SurveyQuestionPanelDynamicProgressText extends SurveyQuesti
6736
6739
  constructor(props: any);
6737
6740
  protected renderElement(): JSX.Element;
6738
6741
  }
6742
+ export declare class SurveyQuestionPanelDynamicRemoveButton extends SurveyQuestionPanelDynamicAction {
6743
+ constructor(props: any);
6744
+ protected handleClick: (event: any) => void;
6745
+ protected renderElement(): JSX.Element;
6746
+ }
6739
6747
  export declare class SurveyQuestionText extends SurveyQuestionUncontrolledElement<QuestionTextModel> {
6740
6748
  constructor(props: any);
6741
6749
  _isWaitingForEnter: boolean;
@@ -7354,6 +7362,7 @@ export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
7354
7362
  visibleRowsChangedCallback: any;
7355
7363
  protected createColumnValues(): any;
7356
7364
  getType(): string;
7365
+ endLoadingFromJson(): void;
7357
7366
  get isCompositeQuestion(): boolean;
7358
7367
  /*
7359
7368
  * Set this property to false, to hide table header. The default value is true.
@@ -7391,6 +7400,7 @@ export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
7391
7400
  protected filterItems(): boolean;
7392
7401
  protected onColumnsChanged(): void;
7393
7402
  protected onRowsChanged(): void;
7403
+ protected updateVisibilityBasedOnRows(): void;
7394
7404
  protected shouldRunColumnExpression(): boolean;
7395
7405
  protected hasRowsAsItems(): boolean;
7396
7406
  protected runItemsCondition(values: any, properties: any): boolean;
@@ -8512,6 +8522,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
8512
8522
  static set defaultCellType(val: string);
8513
8523
  static addDefaultColumns(matrix: QuestionMatrixDropdownModelBase): void;
8514
8524
  detailPanelValue: PanelModel;
8525
+ isUniqueCaseSensitiveValue: boolean;
8515
8526
  protected isRowChanging: boolean;
8516
8527
  columnsChangedCallback: any;
8517
8528
  onRenderedTableResetCallback: any;
@@ -8547,6 +8558,12 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
8547
8558
  */
8548
8559
  get isColumnLayoutHorizontal(): boolean;
8549
8560
  /*
8561
+ * 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.
8562
+ * It doesn't allow by default.
8563
+ */
8564
+ get isUniqueCaseSensitive(): boolean;
8565
+ set isUniqueCaseSensitive(val: boolean);
8566
+ /*
8550
8567
  * Set the value to "underRow" to show the detailPanel under the row.
8551
8568
  */
8552
8569
  get detailPanelMode(): string;
@@ -8796,7 +8813,6 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
8796
8813
  getConditionJson(operator?: string, path?: string): any;
8797
8814
  protected clearValueIfInvisibleCore(): void;
8798
8815
  protected getFirstInputElementId(): string;
8799
- protected onRowsChanged(): void;
8800
8816
  onMatrixRowChanged(row: MatrixRowModel): void;
8801
8817
  getCorrectedRowValue(value: any): any;
8802
8818
  protected getSearchableItemValueKeys(keys: any): void;
@@ -9103,6 +9119,11 @@ export declare class QuestionMatrixDropdownModel extends QuestionMatrixDropdownM
9103
9119
  get rowTitleWidth(): string;
9104
9120
  set rowTitleWidth(val: string);
9105
9121
  getRowTitleWidth(): string;
9122
+ /*
9123
+ * Set this property to true to hide the question if there is no visible rows in the matrix.
9124
+ */
9125
+ get hideIfRowsEmpty(): boolean;
9126
+ set hideIfRowsEmpty(val: boolean);
9106
9127
  protected getDisplayValueCore(keysAsText: boolean, value: any): any;
9107
9128
  protected getConditionObjectRowName(index: number): string;
9108
9129
  protected getConditionObjectRowText(index: number): string;
@@ -9298,6 +9319,8 @@ export declare class QuestionRadiogroupModel extends QuestionCheckboxBase {
9298
9319
  get canShowClearButton(): boolean;
9299
9320
  get clearButtonCaption(): string;
9300
9321
  supportGoNextPageAutomatic(): boolean;
9322
+ get showClearButtonInContent(): boolean;
9323
+ protected getDefaultTitleActions(): Array<Action>;
9301
9324
  }
9302
9325
  /*
9303
9326
  * A Model for a ranking question
@@ -10646,6 +10669,7 @@ export declare var defaultV2Css: {
10646
10669
  requiredText: string,
10647
10670
  header: string,
10648
10671
  collapsed: string,
10672
+ expanded: string,
10649
10673
  nested: string,
10650
10674
  invisible: string,
10651
10675
  navigationButton: string,
@@ -10733,6 +10757,7 @@ export declare var defaultV2Css: {
10733
10757
  formGroup: string,
10734
10758
  hasError: string,
10735
10759
  collapsed: string,
10760
+ expanded: string,
10736
10761
  nested: string,
10737
10762
  invisible: string,
10738
10763
  },
@@ -10880,7 +10905,6 @@ export declare var defaultV2Css: {
10880
10905
  itemControl: string,
10881
10906
  image: string,
10882
10907
  itemText: string,
10883
- clearButton: string,
10884
10908
  other: string,
10885
10909
  itemNoImage: string,
10886
10910
  itemNoImageSvgIcon: string,
@@ -11062,6 +11086,7 @@ export declare var defaultV2Css: {
11062
11086
  rootMobileMod: string,
11063
11087
  rootDragMod: string,
11064
11088
  rootDisabled: string,
11089
+ rootDesignMode: string,
11065
11090
  item: string,
11066
11091
  itemContent: string,
11067
11092
  itemIndex: string,