survey-react 1.9.35 → 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/defaultV2.css +131 -79
- package/defaultV2.min.css +2 -2
- package/modern.css +48 -35
- package/modern.min.css +2 -2
- package/package.json +1 -1
- package/survey.css +8 -2
- package/survey.min.css +2 -2
- package/survey.react.d.ts +356 -301
- package/survey.react.js +760 -479
- package/survey.react.min.js +3 -3
package/survey.react.d.ts
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
/*
|
2
|
-
* Type definition for Survey JavaScript library for React v1.9.
|
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;
|
@@ -223,6 +224,7 @@ export interface IConditionObject {
|
|
223
224
|
}
|
224
225
|
export interface IMatrixColumnOwner extends ILocalizableOwner {
|
225
226
|
getRequiredText(): string;
|
227
|
+
hasChoices(): boolean;
|
226
228
|
onColumnPropertyChanged(column: MatrixDropdownColumn, name: string, newValue: any): void;
|
227
229
|
onColumnItemValuePropertyChanged(column: MatrixDropdownColumn, propertyName: string, obj: ItemValue, name: string, newValue: any, oldValue: any): void;
|
228
230
|
onShowInMultipleColumnsChanged(column: MatrixDropdownColumn): void;
|
@@ -725,6 +727,7 @@ export declare class Base {
|
|
725
727
|
itemValuePropertyChanged(item: ItemValue, name: string, oldValue: any, newValue: any): void;
|
726
728
|
protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
|
727
729
|
protected propertyValueChanged(name: string, oldValue: any, newValue: any, arrayChanges?: ArrayChanges, target?: Base): void;
|
730
|
+
onBindingChanged(oldValue: any, newValue: any): void;
|
728
731
|
protected get isInternal(): boolean;
|
729
732
|
addExpressionProperty(name: string, onExecute: (obj: Base, res: any) => void, canRun?: (obj: Base) => boolean): void;
|
730
733
|
getDataFilteredValues(): any;
|
@@ -935,6 +938,8 @@ export declare class ElementFactory {
|
|
935
938
|
getAllTypes(): Array<any>;
|
936
939
|
createElement(elementType: string, name: string): IElement;
|
937
940
|
}
|
941
|
+
export declare class ElementHelper {
|
942
|
+
}
|
938
943
|
export declare class Event<T, Options> {
|
939
944
|
onCallbacksChanged: any;
|
940
945
|
protected callbacks: any;
|
@@ -1498,6 +1503,7 @@ export declare class Action extends Base implements IAction {
|
|
1498
1503
|
mode: any;
|
1499
1504
|
disableTabStop: boolean;
|
1500
1505
|
disableShrink: boolean;
|
1506
|
+
disableHide: boolean;
|
1501
1507
|
needSpace: boolean;
|
1502
1508
|
locTitle: any;
|
1503
1509
|
titleValue: string;
|
@@ -1522,6 +1528,7 @@ export declare class ActionContainer<T extends Action = Action> extends Base {
|
|
1522
1528
|
protected getRenderedActions(): Array<T>;
|
1523
1529
|
updateCallback: (isResetInitialized: boolean) => void;
|
1524
1530
|
containerCss: string;
|
1531
|
+
sizeMode: "default" | "small";
|
1525
1532
|
protected raiseUpdate(isResetInitialized: boolean): void;
|
1526
1533
|
protected onSet(): void;
|
1527
1534
|
protected onPush(item: T): void;
|
@@ -1702,6 +1709,7 @@ export declare class ConditionRunner extends ExpressionRunnerBase {
|
|
1702
1709
|
export declare class Const extends Operand {
|
1703
1710
|
constructor(value: any);
|
1704
1711
|
getType(): string;
|
1712
|
+
setValue(val: any): void;
|
1705
1713
|
toString(func?: (op: Operand) => string): string;
|
1706
1714
|
get correctValue(): any;
|
1707
1715
|
evaluate(): any;
|
@@ -3230,6 +3238,7 @@ export declare class ListModel extends ActionContainer {
|
|
3230
3238
|
getItemClass: (itemValue: Action) => string;
|
3231
3239
|
getItemIndent: (itemValue: any) => string;
|
3232
3240
|
get filteredTextPlaceholder(): string;
|
3241
|
+
goToItems(event: any): void;
|
3233
3242
|
onKeyDown(event: any): void;
|
3234
3243
|
onPointerDown(event: any, item: any): void;
|
3235
3244
|
refresh(): void;
|
@@ -3385,6 +3394,7 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
|
|
3385
3394
|
get titleActions(): any;
|
3386
3395
|
isTitleActionRequested: boolean;
|
3387
3396
|
getTitleActions(): Array<any>;
|
3397
|
+
protected getDefaultTitleActions(): Array<IAction>;
|
3388
3398
|
get hasTitleActions(): boolean;
|
3389
3399
|
get hasTitleEvents(): boolean;
|
3390
3400
|
get titleTabIndex(): number;
|
@@ -3491,7 +3501,6 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
|
|
3491
3501
|
protected setPage(parent: IPanel, newPage: IPage): void;
|
3492
3502
|
protected getSearchableLocKeys(keys: any): void;
|
3493
3503
|
protected get isDefaultV2Theme(): boolean;
|
3494
|
-
get showErrorsAboveQuestion(): boolean;
|
3495
3504
|
get isErrorsModeTooltip(): boolean;
|
3496
3505
|
protected getIsErrorsModeTooltip(): boolean;
|
3497
3506
|
get hasParent(): boolean;
|
@@ -3573,39 +3582,39 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
|
|
3573
3582
|
navigationBarValue: any;
|
3574
3583
|
/*
|
3575
3584
|
* The event is fired after a trigger has been executed
|
3576
|
-
* `sender` - the survey object that fires the event.
|
3577
|
-
* `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.
|
3578
3587
|
*/
|
3579
3588
|
onTriggerExecuted: EventBase<SurveyModel>;
|
3580
3589
|
/*
|
3581
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`
|
3582
|
-
* `sender` - the survey object that fires the event.
|
3583
|
-
* `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`.
|
3584
|
-
* `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.
|
3585
3594
|
*/
|
3586
3595
|
onCompleting: EventBase<SurveyModel>;
|
3587
3596
|
/*
|
3588
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.
|
3589
|
-
* `sender` - the survey object that fires the event.
|
3590
|
-
* `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.
|
3591
|
-
* `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.
|
3592
|
-
* `options.showDataSavingSuccess(text)` - call this method to show that the data was successfully saved on the server.
|
3593
|
-
* `options.showDataSavingClear` - call this method to hide the text about the saving progress.
|
3594
|
-
* `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.
|
3595
3604
|
*/
|
3596
3605
|
onComplete: EventBase<SurveyModel>;
|
3597
3606
|
/*
|
3598
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".
|
3599
3608
|
* You can prevent showing it by setting allowShowPreview to `false`.
|
3600
|
-
* `sender` - the survey object that fires the event.
|
3601
|
-
* `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`.
|
3602
3611
|
*/
|
3603
3612
|
onShowingPreview: EventBase<SurveyModel>;
|
3604
3613
|
/*
|
3605
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.
|
3606
3615
|
* Specify the `navigateToUrl` property to make survey navigate to another url.
|
3607
|
-
* `sender` - the survey object that fires the event.
|
3608
|
-
* `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.
|
3609
3618
|
*/
|
3610
3619
|
onNavigateToUrl: EventBase<SurveyModel>;
|
3611
3620
|
/*
|
@@ -3615,73 +3624,73 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
|
|
3615
3624
|
onStarted: EventBase<SurveyModel>;
|
3616
3625
|
/*
|
3617
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.
|
3618
|
-
* `sender` - the survey object that fires the event.
|
3627
|
+
* - `sender` - the survey object that fires the event.
|
3619
3628
|
*/
|
3620
3629
|
onPartialSend: EventBase<SurveyModel>;
|
3621
3630
|
/*
|
3622
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.
|
3623
|
-
* `sender` - the survey object that fires the event.
|
3624
|
-
* `option.oldCurrentPage` - the previous current/active page.
|
3625
|
-
* `option.newCurrentPage` - a new current/active page.
|
3626
|
-
* `option.allowChanging` - set it to `false` to disable the current page changing. It is `true` by default.
|
3627
|
-
* `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
|
3628
|
-
* `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
|
3629
3638
|
*/
|
3630
3639
|
onCurrentPageChanging: EventBase<SurveyModel>;
|
3631
3640
|
/*
|
3632
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.
|
3633
|
-
* `sender` - the survey object that fires the event.
|
3634
|
-
* `option.oldCurrentPage` - a previous current/active page.
|
3635
|
-
* `option.newCurrentPage` - a new current/active page.
|
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
|
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
|
3638
3647
|
*/
|
3639
3648
|
onCurrentPageChanged: EventBase<SurveyModel>;
|
3640
3649
|
/*
|
3641
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.
|
3642
|
-
* `sender` - the survey object that fires the event.
|
3643
|
-
* `options.name` - the value name that has being changed.
|
3644
|
-
* `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.
|
3645
|
-
* `options.oldValue` - an old, previous value.
|
3646
|
-
* `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.
|
3647
3656
|
*/
|
3648
3657
|
onValueChanging: EventBase<SurveyModel>;
|
3649
3658
|
/*
|
3650
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).
|
3651
3660
|
* Use the `onDynamicPanelItemValueChanged` and `onMatrixCellValueChanged` events to handle changes in a question in the Panel Dynamic and a cell question in matrices.
|
3652
|
-
* `sender` - the survey object that fires the event.
|
3653
|
-
* `options.name` - the value name that has been changed.
|
3654
|
-
* `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`.
|
3655
|
-
* `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.
|
3656
3665
|
*/
|
3657
3666
|
onValueChanged: EventBase<SurveyModel>;
|
3658
3667
|
/*
|
3659
3668
|
* The event is fired when setVariable function is called. It can be called on changing a calculated value.
|
3660
|
-
* `sender` - the survey object that fires the event.
|
3661
|
-
* `options.name` - the variable name that has been changed.
|
3662
|
-
* `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.
|
3663
3672
|
*/
|
3664
3673
|
onVariableChanged: EventBase<SurveyModel>;
|
3665
3674
|
/*
|
3666
3675
|
* The event is fired when a question visibility has been changed.
|
3667
|
-
* `sender` - the survey object that fires the event.
|
3668
|
-
* `options.question` - a question which visibility has been changed.
|
3669
|
-
* `options.name` - a question name.
|
3670
|
-
* `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.
|
3671
3680
|
*/
|
3672
3681
|
onVisibleChanged: EventBase<SurveyModel>;
|
3673
3682
|
/*
|
3674
3683
|
* The event is fired on changing a page visibility.
|
3675
|
-
* `sender` - the survey object that fires the event.
|
3676
|
-
* `options.page` - a page which visibility has been changed.
|
3677
|
-
* `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.
|
3678
3687
|
*/
|
3679
3688
|
onPageVisibleChanged: EventBase<SurveyModel>;
|
3680
3689
|
/*
|
3681
3690
|
* The event is fired on changing a panel visibility.
|
3682
|
-
* `sender` - the survey object that fires the event.
|
3683
|
-
* `options.panel` - a panel which visibility has been changed.
|
3684
|
-
* `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.
|
3685
3694
|
*/
|
3686
3695
|
onPanelVisibleChanged: EventBase<SurveyModel>;
|
3687
3696
|
/*
|
@@ -3690,88 +3699,88 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
|
|
3690
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.
|
3691
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.
|
3692
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.
|
3693
|
-
* `sender` - the survey object that fires the event.
|
3694
|
-
* `options.question` - a newly created question object.
|
3702
|
+
* - `sender` - the survey object that fires the event.
|
3703
|
+
* - `options.question` - a newly created question object.
|
3695
3704
|
*/
|
3696
3705
|
onQuestionCreated: EventBase<SurveyModel>;
|
3697
3706
|
/*
|
3698
3707
|
* The event is fired on adding a new question into survey.
|
3699
|
-
* `sender` - the survey object that fires the event.
|
3700
|
-
* `options.question` - a newly added question object.
|
3701
|
-
* `options.name` - a question name.
|
3702
|
-
* `options.index` - an index of the question in the container (page or panel).
|
3703
|
-
* `options.parentPanel` - a container where a new question is located. It can be a page or panel.
|
3704
|
-
* `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.
|
3705
3714
|
*/
|
3706
3715
|
onQuestionAdded: EventBase<SurveyModel>;
|
3707
3716
|
/*
|
3708
3717
|
* The event is fired on removing a question from survey.
|
3709
|
-
* `sender` - the survey object that fires the event.
|
3710
|
-
* `options.question` - a removed question object.
|
3711
|
-
* `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.
|
3712
3721
|
*/
|
3713
3722
|
onQuestionRemoved: EventBase<SurveyModel>;
|
3714
3723
|
/*
|
3715
3724
|
* The event is fired on adding a panel into survey.
|
3716
|
-
* `sender` - the survey object that fires the event.
|
3717
|
-
* `options.panel` - a newly added panel object.
|
3718
|
-
* `options.name` - a panel name.
|
3719
|
-
* `options.index` - an index of the panel in the container (a page or panel).
|
3720
|
-
* `options.parentPanel` - a container (a page or panel) where a new panel is located.
|
3721
|
-
* `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.
|
3722
3731
|
*/
|
3723
3732
|
onPanelAdded: EventBase<SurveyModel>;
|
3724
3733
|
/*
|
3725
3734
|
* The event is fired on removing a panel from survey.
|
3726
|
-
* `sender` - the survey object that fires the event.
|
3727
|
-
* `options.panel` - a removed panel object.
|
3728
|
-
* `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.
|
3729
3738
|
*/
|
3730
3739
|
onPanelRemoved: EventBase<SurveyModel>;
|
3731
3740
|
/*
|
3732
3741
|
* The event is fired on adding a page into survey.
|
3733
|
-
* `sender` - the survey object that fires the event.
|
3734
|
-
* `options.page` - a newly added `panel` object.
|
3742
|
+
* - `sender` - the survey object that fires the event.
|
3743
|
+
* - `options.page` - a newly added `panel` object.
|
3735
3744
|
*/
|
3736
3745
|
onPageAdded: EventBase<SurveyModel>;
|
3737
3746
|
/*
|
3738
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.
|
3739
|
-
* `sender` - the survey object that fires the event.
|
3740
|
-
* `options.question` - a validated question.
|
3741
|
-
* `options.name` - a question name.
|
3742
|
-
* `options.value` - the current question value (answer).
|
3743
|
-
* `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.
|
3744
3753
|
*/
|
3745
3754
|
onValidateQuestion: EventBase<SurveyModel>;
|
3746
3755
|
/*
|
3747
3756
|
* The event is fired before errors are assigned to a question. You may add/remove/modify errors for a question.
|
3748
|
-
* `sender` - the survey object that fires the event.
|
3749
|
-
* `options.question` - a validated question.
|
3750
|
-
* `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.
|
3751
3760
|
*/
|
3752
3761
|
onSettingQuestionErrors: EventBase<SurveyModel>;
|
3753
3762
|
/*
|
3754
3763
|
* Use this event to validate data on your server.
|
3755
|
-
* `sender` - the survey object that fires the event.
|
3756
|
-
* `options.data` - the values of all non-empty questions on the current page. You can get a question value as `options.data["myQuestionName"]`.
|
3757
|
-
* `options.errors` - set your errors to this object as: `options.errors["myQuestionName"] = "Error text";`. It will be shown as a question error.
|
3758
|
-
* `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.
|
3759
3768
|
*/
|
3760
3769
|
onServerValidateQuestions: any;
|
3761
3770
|
/*
|
3762
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.
|
3763
|
-
* `sender` - the survey object that fires the event.
|
3764
|
-
* `options.name` - a panel name.
|
3765
|
-
* `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.
|
3766
3775
|
*/
|
3767
3776
|
onValidatePanel: EventBase<SurveyModel>;
|
3768
3777
|
/*
|
3769
3778
|
* Use the event to change the default error text.
|
3770
|
-
* `sender` - the survey object that fires the event.
|
3771
|
-
* `options.text` - an error text.
|
3772
|
-
* `options.error` - an instance of the `SurveyError` object.
|
3773
|
-
* `options.obj` - an instance of Question, Panel or Survey object to where error is located.
|
3774
|
-
* `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:
|
3775
3784
|
* required, requireoneanswer, requirenumeric, exceedsize, webrequest, webrequestempty, otherempty,
|
3776
3785
|
* uploadingfile, requiredinallrowserror, minrowcounterror, keyduplicationerror, custom
|
3777
3786
|
*/
|
@@ -3785,206 +3794,206 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
|
|
3785
3794
|
onValidatedErrorsOnCurrentPage: EventBase<SurveyModel>;
|
3786
3795
|
/*
|
3787
3796
|
* Use this event to modify the HTML content before rendering, for example `completeHtml` or `loadingHtml`.
|
3788
|
-
* `options.html` - specifies the modified HTML content.
|
3797
|
+
* - `options.html` - specifies the modified HTML content.
|
3789
3798
|
*/
|
3790
3799
|
onProcessHtml: EventBase<SurveyModel>;
|
3791
3800
|
/*
|
3792
3801
|
* Use this event to change the question title in code. If you want to remove question numbering then set showQuestionNumbers to "off".
|
3793
|
-
* `sender` - the survey object that fires the event.
|
3794
|
-
* `options.title` - a calculated question title, based on question `title`, `name`.
|
3795
|
-
* `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.
|
3796
3805
|
*/
|
3797
3806
|
onGetQuestionTitle: EventBase<SurveyModel>;
|
3798
3807
|
/*
|
3799
3808
|
* Use this event to change the element title tag name that renders by default.
|
3800
|
-
* `sender` - the survey object that fires the event.
|
3801
|
-
* `options.element` - an element (question, panel, page and survey) that SurveyJS is going to render.
|
3802
|
-
* `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.
|
3803
3812
|
*/
|
3804
3813
|
onGetTitleTagName: EventBase<SurveyModel>;
|
3805
3814
|
/*
|
3806
3815
|
* Use this event to change the question no in code. If you want to remove question numbering then set showQuestionNumbers to "off".
|
3807
|
-
* `sender` - the survey object that fires the event.
|
3808
|
-
* `options.no` - a calculated question no, based on question `visibleIndex`, survey `.questionStartIndex` properties. You can change it.
|
3809
|
-
* `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.
|
3810
3819
|
*/
|
3811
3820
|
onGetQuestionNo: EventBase<SurveyModel>;
|
3812
3821
|
/*
|
3813
3822
|
* Use this event to change the progress text in code.
|
3814
|
-
* `sender` - the survey object that fires the event.
|
3815
|
-
* `options.text` - a progress text, that SurveyJS will render in progress bar.
|
3816
|
-
* `options.questionCount` - a number of questions that have input(s). We do not count html or expression questions
|
3817
|
-
* `options.answeredQuestionCount` - a number of questions that have input(s) and an user has answered.
|
3818
|
-
* `options.requiredQuestionCount` - a number of required questions that have input(s). We do not count html or expression questions
|
3819
|
-
* `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.
|
3820
3829
|
*/
|
3821
3830
|
onProgressText: EventBase<SurveyModel>;
|
3822
3831
|
/*
|
3823
3832
|
* Use this event to process the markdown text.
|
3824
|
-
* `sender` - the survey object that fires the event.
|
3825
|
-
* `options.element` - SurveyJS element (a question, panel, page, or survey) where the string is going to be rendered.
|
3826
|
-
* `options.name` - a property name is going to be rendered.
|
3827
|
-
* `options.text` - a text that is going to be rendered.
|
3828
|
-
* `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`.
|
3829
3838
|
*/
|
3830
3839
|
onTextMarkdown: EventBase<SurveyModel>;
|
3831
3840
|
/*
|
3832
3841
|
* Use this event to specity render component name used for text rendering.
|
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.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.
|
3837
3846
|
*/
|
3838
3847
|
onTextRenderAs: EventBase<SurveyModel>;
|
3839
3848
|
/*
|
3840
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.
|
3841
|
-
* `sender` - the survey object that fires the event.
|
3842
|
-
* `options.success` - it is `true` if the results has been sent to the service successfully.
|
3843
|
-
* `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.
|
3844
3853
|
*/
|
3845
3854
|
onSendResult: EventBase<SurveyModel>;
|
3846
3855
|
/*
|
3847
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.
|
3848
|
-
* `sender` - the survey object that fires the event.
|
3849
|
-
* `options.success` - it is `true` if the results were got from the service successfully.
|
3850
|
-
* `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.
|
3851
|
-
* `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.
|
3852
|
-
* `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.
|
3853
3862
|
*/
|
3854
3863
|
onGetResult: EventBase<SurveyModel>;
|
3855
3864
|
/*
|
3856
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.
|
3857
|
-
* `sender` - the survey object that fires the event.
|
3858
|
-
* `options.question` - the file question instance.
|
3859
|
-
* `options.name` - the question name.
|
3860
|
-
* `options.files` - the Javascript File objects array to upload.
|
3861
|
-
* `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.
|
3862
3871
|
*/
|
3863
3872
|
onUploadFiles: EventBase<SurveyModel>;
|
3864
3873
|
/*
|
3865
3874
|
* The event is fired on downloading a file in QuestionFile. Use this event to pass the file to a preview.
|
3866
|
-
* `sender` - the survey object that fires the event.
|
3867
|
-
* `options.name` - the question name.
|
3868
|
-
* `options.content` - the file content.
|
3869
|
-
* `options.fileValue` - single file question value.
|
3870
|
-
* `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.
|
3871
3880
|
*/
|
3872
3881
|
onDownloadFile: EventBase<SurveyModel>;
|
3873
3882
|
/*
|
3874
3883
|
* This event is fired on clearing the value in a QuestionFile. Use this event to remove files stored on your server.
|
3875
|
-
* `sender` - the survey object that fires the event.
|
3876
|
-
* `question` - the question instance.
|
3877
|
-
* `options.name` - the question name.
|
3878
|
-
* `options.value` - the question value.
|
3879
|
-
* `options.fileName` - a removed file's name, set it to `null` to clear all files.
|
3880
|
-
* `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.
|
3881
3890
|
*/
|
3882
3891
|
onClearFiles: EventBase<SurveyModel>;
|
3883
3892
|
/*
|
3884
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.
|
3885
3894
|
* You may change the choices, before they are assigned or disable/enabled make visible/invisible question, based on loaded results.
|
3886
|
-
* `sender` - the survey object that fires the event.
|
3887
|
-
* `question` - the question where loaded choices are going to be assigned.
|
3888
|
-
* `choices` - the loaded choices. You can change the loaded choices to before they are assigned to question.
|
3889
|
-
* `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.
|
3890
3899
|
*/
|
3891
3900
|
onLoadChoicesFromServer: EventBase<SurveyModel>;
|
3892
3901
|
/*
|
3893
3902
|
* The event is fired after survey is loaded from api.surveyjs.io service.
|
3894
3903
|
* You can use this event to perform manipulation with the survey model after it was loaded from the web service.
|
3895
|
-
* `sender` - the survey object that fires the event.
|
3904
|
+
* - `sender` - the survey object that fires the event.
|
3896
3905
|
*/
|
3897
3906
|
onLoadedSurveyFromService: EventBase<SurveyModel>;
|
3898
3907
|
/*
|
3899
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.
|
3900
3909
|
* For example, you may use the text processing in loading choices from the web. If your `choicesByUrl.url` equals to "UrlToServiceToGetAllCities/{country}/{state}",
|
3901
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.
|
3902
|
-
* `sender` - the survey object that fires the event.
|
3903
|
-
* `options.name` - the name of the processing value, for example, "state" in our example.
|
3904
|
-
* `options.value` - the value of the processing text.
|
3905
|
-
* `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.
|
3906
3915
|
*/
|
3907
3916
|
onProcessTextValue: EventBase<SurveyModel>;
|
3908
3917
|
/*
|
3909
3918
|
* The event is fired before rendering a question. Use it to override the default question CSS classes.
|
3910
|
-
* `sender` - the survey object that fires the event.
|
3911
|
-
* `options.question` - a question for which you can change the CSS classes.
|
3912
|
-
* `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.
|
3913
3922
|
*/
|
3914
3923
|
onUpdateQuestionCssClasses: EventBase<SurveyModel>;
|
3915
3924
|
/*
|
3916
3925
|
* The event is fired before rendering a panel. Use it to override the default panel CSS classes.
|
3917
|
-
* `sender` - the survey object that fires the event.
|
3918
|
-
* `options.panel` - a panel for which you can change the CSS classes.
|
3919
|
-
* `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.
|
3920
3929
|
*/
|
3921
3930
|
onUpdatePanelCssClasses: EventBase<SurveyModel>;
|
3922
3931
|
/*
|
3923
3932
|
* The event is fired before rendering a page. Use it to override the default page CSS classes.
|
3924
|
-
* `sender` - the survey object that fires the event.
|
3925
|
-
* `options.page` - a page for which you can change the CSS classes.
|
3926
|
-
* `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.
|
3927
3936
|
*/
|
3928
3937
|
onUpdatePageCssClasses: EventBase<SurveyModel>;
|
3929
3938
|
/*
|
3930
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.
|
3931
|
-
* `sender` - the survey object that fires the event.
|
3932
|
-
* `options.question` - a question where choice item is rendered.
|
3933
|
-
* `options.item` - a choice item of ItemValue type. You can get value or text choice properties as options.item.value or options.choice.text
|
3934
|
-
* `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.
|
3935
3944
|
*/
|
3936
3945
|
onUpdateChoiceItemCss: EventBase<SurveyModel>;
|
3937
3946
|
/*
|
3938
3947
|
* The event is fired right after survey is rendered in DOM.
|
3939
|
-
* `sender` - the survey object that fires the event.
|
3940
|
-
* `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.
|
3941
3950
|
*/
|
3942
3951
|
onAfterRenderSurvey: EventBase<SurveyModel>;
|
3943
3952
|
/*
|
3944
3953
|
* The event is fired right after a page is rendered in DOM. Use it to modify HTML elements.
|
3945
|
-
* `sender` - the survey object that fires the event.
|
3946
|
-
* `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.
|
3947
3956
|
*/
|
3948
3957
|
onAfterRenderHeader: EventBase<SurveyModel>;
|
3949
3958
|
/*
|
3950
3959
|
* The event is fired right after a page is rendered in DOM. Use it to modify HTML elements.
|
3951
|
-
* `sender` - the survey object that fires the event.
|
3952
|
-
* `options.page` - a page object for which the event is fired. Typically the current/active page.
|
3953
|
-
* `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.
|
3954
3963
|
*/
|
3955
3964
|
onAfterRenderPage: EventBase<SurveyModel>;
|
3956
3965
|
/*
|
3957
3966
|
* The event is fired right after a question is rendered in DOM. Use it to modify HTML elements.
|
3958
|
-
* `sender` - the survey object that fires the event.
|
3959
|
-
* `options.question` - a question object for which the event is fired.
|
3960
|
-
* `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.
|
3961
3970
|
*/
|
3962
3971
|
onAfterRenderQuestion: EventBase<SurveyModel>;
|
3963
3972
|
/*
|
3964
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.
|
3965
3974
|
* This event is not fired for matrices, panels, multiple text and image picker.
|
3966
|
-
* `sender` - the survey object that fires the event.
|
3967
|
-
* `options.question` - a question object for which the event is fired.
|
3968
|
-
* `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.
|
3969
3978
|
*/
|
3970
3979
|
onAfterRenderQuestionInput: EventBase<SurveyModel>;
|
3971
3980
|
/*
|
3972
3981
|
* The event is fired right after a panel is rendered in DOM. Use it to modify HTML elements.
|
3973
|
-
* `sender` - the survey object that fires the event
|
3974
|
-
* `options.panel` - a panel object for which the event is fired
|
3975
|
-
* `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
|
3976
3985
|
*/
|
3977
3986
|
onAfterRenderPanel: EventBase<SurveyModel>;
|
3978
3987
|
/*
|
3979
3988
|
* The event occurs when an element within a question gets focus.
|
3980
|
-
* `sender` - A [survey](https://surveyjs.io/Documentation/Library?id=surveymodel) object that fires the event.
|
3981
|
-
* `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.
|
3982
3991
|
*/
|
3983
3992
|
onFocusInQuestion: EventBase<SurveyModel>;
|
3984
3993
|
/*
|
3985
3994
|
* The event occurs when an element within a panel gets focus.
|
3986
|
-
* `sender` - A [survey](https://surveyjs.io/Documentation/Library?id=surveymodel) object that fires the event.
|
3987
|
-
* `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.
|
3988
3997
|
*/
|
3989
3998
|
onFocusInPanel: EventBase<SurveyModel>;
|
3990
3999
|
/*
|
@@ -4000,123 +4009,123 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
|
|
4000
4009
|
onShowingChoiceItem: EventBase<SurveyModel>;
|
4001
4010
|
/*
|
4002
4011
|
* The event is fired on adding a new row in Matrix Dynamic question.
|
4003
|
-
* `sender` - the survey object that fires the event
|
4004
|
-
* `options.question` - a matrix question.
|
4005
|
-
* `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.
|
4006
4015
|
*/
|
4007
4016
|
onMatrixRowAdded: EventBase<SurveyModel>;
|
4008
4017
|
/*
|
4009
4018
|
* The event is fired before adding a new row in Matrix Dynamic question.
|
4010
|
-
* `sender` - the survey object that fires the event
|
4011
|
-
* `options.question` - a matrix question.
|
4012
|
-
* `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
|
4013
4022
|
*/
|
4014
4023
|
onMatrixBeforeRowAdded: EventBase<SurveyModel>;
|
4015
4024
|
/*
|
4016
4025
|
* The event is fired before removing a row from Matrix Dynamic question. You can disable removing and clear the data instead.
|
4017
|
-
* `sender` - the survey object that fires the event
|
4018
|
-
* `options.question` - a matrix question.
|
4019
|
-
* `options.rowIndex` - a row index.
|
4020
|
-
* `options.row` - a row object.
|
4021
|
-
* `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.
|
4022
4031
|
*/
|
4023
4032
|
onMatrixRowRemoving: EventBase<SurveyModel>;
|
4024
4033
|
/*
|
4025
4034
|
* The event is fired on removing a row from Matrix Dynamic question.
|
4026
|
-
* `sender` - the survey object that fires the event
|
4027
|
-
* `options.question` - a matrix question
|
4028
|
-
* `options.rowIndex` - a removed row index
|
4029
|
-
* `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
|
4030
4039
|
*/
|
4031
4040
|
onMatrixRowRemoved: EventBase<SurveyModel>;
|
4032
4041
|
/*
|
4033
4042
|
* The event is fired before rendering "Remove" button for removing a row from Matrix Dynamic question.
|
4034
|
-
* `sender` - the survey object that fires the event
|
4035
|
-
* `options.question` - a matrix question.
|
4036
|
-
* `options.rowIndex` - a row index.
|
4037
|
-
* `options.row` - a row object.
|
4038
|
-
* `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.
|
4039
4048
|
*/
|
4040
4049
|
onMatrixAllowRemoveRow: EventBase<SurveyModel>;
|
4041
4050
|
/*
|
4042
4051
|
* The event is fired before creating cell question in the matrix. You can change the cell question type by setting different options.cellType.
|
4043
|
-
* `sender` - the survey object that fires the event.
|
4044
|
-
* `options.question` - the matrix question.
|
4045
|
-
* `options.cellType` - the cell question type. You can change it.
|
4046
|
-
* `options.rowValue` - the value of the current row. To access a particular column's value within the current row, use: `options.rowValue["columnValue"]`.
|
4047
|
-
* `options.column` - the matrix column object.
|
4048
|
-
* `options.columnName` - the matrix column name.
|
4049
|
-
* `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.
|
4050
4059
|
*/
|
4051
4060
|
onMatrixCellCreating: EventBase<SurveyModel>;
|
4052
4061
|
/*
|
4053
4062
|
* The event is fired for every cell created in Matrix Dynamic and Matrix Dropdown questions.
|
4054
|
-
* `sender` - the survey object that fires the event.
|
4055
|
-
* `options.question` - the matrix question.
|
4056
|
-
* `options.cell` - the matrix cell.
|
4057
|
-
* `options.cellQuestion` - the question/editor in the cell. You may customize it, change it's properties, like choices or visible.
|
4058
|
-
* `options.rowValue` - the value of the current row. To access a particular column's value within the current row, use: `options.rowValue["columnValue"]`.
|
4059
|
-
* `options.column` - the matrix column object.
|
4060
|
-
* `options.columnName` - the matrix column name.
|
4061
|
-
* `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.
|
4062
4071
|
*/
|
4063
4072
|
onMatrixCellCreated: EventBase<SurveyModel>;
|
4064
4073
|
/*
|
4065
4074
|
* The event is fired for every cell after is has been rendered in DOM.
|
4066
|
-
* `sender` - the survey object that fires the event.
|
4067
|
-
* `options.question` - the matrix question.
|
4068
|
-
* `options.cell` - the matrix cell.
|
4069
|
-
* `options.cellQuestion` - the question/editor in the cell.
|
4070
|
-
* `options.htmlElement` - an HTML element bound to the `cellQuestion` object.
|
4071
|
-
* `options.column` - the matrix column object.
|
4072
|
-
* `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.
|
4073
4082
|
*/
|
4074
4083
|
onMatrixAfterCellRender: EventBase<SurveyModel>;
|
4075
4084
|
/*
|
4076
4085
|
* The event is fired when cell value is changed in Matrix Dynamic and Matrix Dropdown questions.
|
4077
|
-
* `sender` - the survey object that fires the event.
|
4078
|
-
* `options.question` - the matrix question.
|
4079
|
-
* `options.columnName` - the matrix column name.
|
4080
|
-
* `options.value` - a new value.
|
4081
|
-
* `options.row` - the matrix row object.
|
4082
|
-
* `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.
|
4083
4092
|
*/
|
4084
4093
|
onMatrixCellValueChanged: EventBase<SurveyModel>;
|
4085
4094
|
/*
|
4086
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.
|
4087
|
-
* `sender` - the survey object that fires the event.
|
4088
|
-
* `options.question` - the matrix question.
|
4089
|
-
* `options.columnName` - the matrix column name.
|
4090
|
-
* `options.value` - a new value.
|
4091
|
-
* `options.oldValue` - the old value.
|
4092
|
-
* `options.row` - the matrix row object.
|
4093
|
-
* `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.
|
4094
4103
|
*/
|
4095
4104
|
onMatrixCellValueChanging: EventBase<SurveyModel>;
|
4096
4105
|
/*
|
4097
4106
|
* The event is fired when Matrix Dynamic and Matrix Dropdown questions validate the cell value.
|
4098
|
-
* `sender` - the survey object that fires the event.
|
4099
|
-
* `options.error` - an error string. It is empty by default.
|
4100
|
-
* `options.question` - the matrix question.
|
4101
|
-
* `options.columnName` - the matrix column name.
|
4102
|
-
* `options.value` - a cell value.
|
4103
|
-
* `options.row` - the matrix row object.
|
4104
|
-
* `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.
|
4105
4114
|
*/
|
4106
4115
|
onMatrixCellValidate: EventBase<SurveyModel>;
|
4107
4116
|
/*
|
4108
4117
|
* The event is fired on adding a new panel in Panel Dynamic question.
|
4109
|
-
* `sender` - the survey object that fires the event.
|
4110
|
-
* `options.question` - a panel question.
|
4111
|
-
* `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.
|
4112
4121
|
*/
|
4113
4122
|
onDynamicPanelAdded: EventBase<SurveyModel>;
|
4114
4123
|
/*
|
4115
4124
|
* The event is fired on removing a panel from Panel Dynamic question.
|
4116
|
-
* `sender` - the survey object that fires the event.
|
4117
|
-
* `options.question` - a panel question.
|
4118
|
-
* `options.panelIndex` - a removed panel index.
|
4119
|
-
* `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.
|
4120
4129
|
*/
|
4121
4130
|
onDynamicPanelRemoved: EventBase<SurveyModel>;
|
4122
4131
|
/*
|
@@ -4125,92 +4134,92 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
|
|
4125
4134
|
onTimer: EventBase<SurveyModel>;
|
4126
4135
|
/*
|
4127
4136
|
* The event is fired before displaying a new information in the Timer Panel. Use it to change the default text.
|
4128
|
-
* `sender` - the survey object that fires the event.
|
4129
|
-
* `options.text` - the timer panel info text.
|
4137
|
+
* - `sender` - the survey object that fires the event.
|
4138
|
+
* - `options.text` - the timer panel info text.
|
4130
4139
|
*/
|
4131
4140
|
onTimerPanelInfoText: EventBase<SurveyModel>;
|
4132
4141
|
/*
|
4133
4142
|
* The event is fired when item value is changed in Panel Dynamic question.
|
4134
|
-
* `sender` - the survey object that fires the event.
|
4135
|
-
* `options.question` - the panel question.
|
4136
|
-
* `options.panel` - the dynamic panel item.
|
4137
|
-
* `options.name` - the item name.
|
4138
|
-
* `options.value` - a new value.
|
4139
|
-
* `options.itemIndex` - the panel item index.
|
4140
|
-
* `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.
|
4141
4150
|
*/
|
4142
4151
|
onDynamicPanelItemValueChanged: EventBase<SurveyModel>;
|
4143
4152
|
/*
|
4144
4153
|
* Use this event to define, whether an answer to a question is correct or not.
|
4145
|
-
* `sender` - the survey object that fires the event.
|
4146
|
-
* `options.question` - a question on which you have to decide if the answer is correct or not.
|
4147
|
-
* `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.
|
4148
|
-
* `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.
|
4149
4158
|
*/
|
4150
4159
|
onIsAnswerCorrect: EventBase<SurveyModel>;
|
4151
4160
|
/*
|
4152
4161
|
* Use this event to control drag&drop operations during design mode.
|
4153
|
-
* `sender` - the survey object that fires the event.
|
4154
|
-
* `options.allow` - set it to `false` to disable dragging.
|
4155
|
-
* `options.target` - a target element that is dragged.
|
4156
|
-
* `options.source` - a source element. It can be `null`, if it is a new element, dragging from toolbox.
|
4157
|
-
* `options.parent` - a page or panel where target element is dragging.
|
4158
|
-
* `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.
|
4159
|
-
* `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.
|
4160
4169
|
*/
|
4161
4170
|
onDragDropAllow: EventBase<SurveyModel>;
|
4162
4171
|
/*
|
4163
4172
|
* Use this event to control scrolling element to top. You can cancel the default behavior by setting options.cancel property to true.
|
4164
|
-
* `sender` - the survey object that fires the event.
|
4165
|
-
* `options.element` - an element that is going to be scrolled on top.
|
4166
|
-
* `options.question` - a question that is going to be scrolled on top. It can be null if options.page is not null.
|
4167
|
-
* `options.page` - a page that is going to be scrolled on top. It can be null if options.question is not null.
|
4168
|
-
* `options.elementId` - the unique element DOM Id.
|
4169
|
-
* `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.
|
4170
4179
|
*/
|
4171
4180
|
onScrollingElementToTop: EventBase<SurveyModel>;
|
4172
4181
|
onLocaleChangedEvent: EventBase<SurveyModel>;
|
4173
4182
|
/*
|
4174
4183
|
* Use this event to create/customize actions to be displayed in a question's title.
|
4175
|
-
* `sender` - A [Survey](https://surveyjs.io/Documentation/Library?id=SurveyModel) object that fires the event.
|
4176
|
-
* `options.question` - A [Question](https://surveyjs.io/Documentation/Library?id=Question) object for which the event is fired.
|
4177
|
-
* `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.
|
4178
4187
|
*/
|
4179
4188
|
onGetQuestionTitleActions: EventBase<SurveyModel>;
|
4180
4189
|
/*
|
4181
4190
|
* Use this event to create/customize actions to be displayed in a panel's title.
|
4182
|
-
* `sender` - A survey object that fires the event.
|
4183
|
-
* `options.panel` - A panel ([PanelModel](https://surveyjs.io/Documentation/Library?id=panelmodel) object) for which the event is fired.
|
4184
|
-
* `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.
|
4185
4194
|
*/
|
4186
4195
|
onGetPanelTitleActions: EventBase<SurveyModel>;
|
4187
4196
|
/*
|
4188
4197
|
* Use this event to create/customize actions to be displayed in a page's title.
|
4189
|
-
* `sender` - A survey object that fires the event.
|
4190
|
-
* `options.page` - A page ([PageModel](https://surveyjs.io/Documentation/Library?id=pagemodel) object) for which the event is fired.
|
4191
|
-
* `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.
|
4192
4201
|
*/
|
4193
4202
|
onGetPageTitleActions: EventBase<SurveyModel>;
|
4194
4203
|
/*
|
4195
4204
|
* Use this event to create/customize actions to be displayed in a matrix question's row.
|
4196
|
-
* `sender` - A survey object that fires the event.
|
4197
|
-
* `options.question` - A matrix question ([QuestionMatrixBaseModel](https://surveyjs.io/Documentation/Library?id=questionmatrixbasemodel) object) for which the event is fired.
|
4198
|
-
* `options.row` - A matrix row for which the event is fired.
|
4199
|
-
* `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.
|
4200
4209
|
*/
|
4201
4210
|
onGetMatrixRowActions: EventBase<SurveyModel>;
|
4202
4211
|
/*
|
4203
4212
|
* The event is fired after the survey element content was collapsed or expanded.
|
4204
|
-
* `sender` - the survey object that fires the event.
|
4205
|
-
* `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.
|
4206
4215
|
*/
|
4207
4216
|
onElementContentVisibilityChanged: EventBase<SurveyModel>;
|
4208
4217
|
/*
|
4209
4218
|
* The event is fired before expression question convert it's value into display value for rendering.
|
4210
|
-
* `sender` - the survey object that fires the event.
|
4211
|
-
* `options.question` - The expression question.
|
4212
|
-
* `options.value` - The question value.
|
4213
|
-
* `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.
|
4214
4223
|
*/
|
4215
4224
|
onGetExpressionDisplayValue: EventBase<SurveyModel>;
|
4216
4225
|
/*
|
@@ -6337,6 +6346,8 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6337
6346
|
showErrorOnCore(location: string): boolean;
|
6338
6347
|
get showErrorOnTop(): boolean;
|
6339
6348
|
get showErrorOnBottom(): boolean;
|
6349
|
+
get showErrorsAboveQuestion(): boolean;
|
6350
|
+
get showErrorsBelowQuestion(): boolean;
|
6340
6351
|
get cssError(): string;
|
6341
6352
|
protected setCssError(val: string): void;
|
6342
6353
|
protected getCssError(cssClasses: any): string;
|
@@ -6711,7 +6722,6 @@ export declare class SurveyQuestionPanelDynamicItem extends SurveyPanel {
|
|
6711
6722
|
constructor(props: any);
|
6712
6723
|
protected getSurvey(): SurveyModel;
|
6713
6724
|
protected getCss(): any;
|
6714
|
-
handleOnPanelRemoveClick(event: any): void;
|
6715
6725
|
render(): JSX.Element;
|
6716
6726
|
protected renderButton(): JSX.Element;
|
6717
6727
|
}
|
@@ -6729,6 +6739,11 @@ export declare class SurveyQuestionPanelDynamicProgressText extends SurveyQuesti
|
|
6729
6739
|
constructor(props: any);
|
6730
6740
|
protected renderElement(): JSX.Element;
|
6731
6741
|
}
|
6742
|
+
export declare class SurveyQuestionPanelDynamicRemoveButton extends SurveyQuestionPanelDynamicAction {
|
6743
|
+
constructor(props: any);
|
6744
|
+
protected handleClick: (event: any) => void;
|
6745
|
+
protected renderElement(): JSX.Element;
|
6746
|
+
}
|
6732
6747
|
export declare class SurveyQuestionText extends SurveyQuestionUncontrolledElement<QuestionTextModel> {
|
6733
6748
|
constructor(props: any);
|
6734
6749
|
_isWaitingForEnter: boolean;
|
@@ -7347,6 +7362,7 @@ export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
|
|
7347
7362
|
visibleRowsChangedCallback: any;
|
7348
7363
|
protected createColumnValues(): any;
|
7349
7364
|
getType(): string;
|
7365
|
+
endLoadingFromJson(): void;
|
7350
7366
|
get isCompositeQuestion(): boolean;
|
7351
7367
|
/*
|
7352
7368
|
* Set this property to false, to hide table header. The default value is true.
|
@@ -7384,6 +7400,7 @@ export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
|
|
7384
7400
|
protected filterItems(): boolean;
|
7385
7401
|
protected onColumnsChanged(): void;
|
7386
7402
|
protected onRowsChanged(): void;
|
7403
|
+
protected updateVisibilityBasedOnRows(): void;
|
7387
7404
|
protected shouldRunColumnExpression(): boolean;
|
7388
7405
|
protected hasRowsAsItems(): boolean;
|
7389
7406
|
protected runItemsCondition(values: any, properties: any): boolean;
|
@@ -7391,6 +7408,15 @@ export declare class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
|
|
7391
7408
|
clearIncorrectValues(): void;
|
7392
7409
|
protected clearInvisibleValuesInRows(): void;
|
7393
7410
|
needResponsiveWidth(): boolean;
|
7411
|
+
getTableCss(): string;
|
7412
|
+
/*
|
7413
|
+
* Aligns matrix cell content in the vertical direction.
|
7414
|
+
*/
|
7415
|
+
verticalAlign: "top" | "middle";
|
7416
|
+
/*
|
7417
|
+
* Specifies whether to apply shading to alternate matrix rows.
|
7418
|
+
*/
|
7419
|
+
alternateRows: boolean;
|
7394
7420
|
}
|
7395
7421
|
/*
|
7396
7422
|
* A Model for a multiple text question.
|
@@ -8496,6 +8522,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
|
|
8496
8522
|
static set defaultCellType(val: string);
|
8497
8523
|
static addDefaultColumns(matrix: QuestionMatrixDropdownModelBase): void;
|
8498
8524
|
detailPanelValue: PanelModel;
|
8525
|
+
isUniqueCaseSensitiveValue: boolean;
|
8499
8526
|
protected isRowChanging: boolean;
|
8500
8527
|
columnsChangedCallback: any;
|
8501
8528
|
onRenderedTableResetCallback: any;
|
@@ -8531,6 +8558,12 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
|
|
8531
8558
|
*/
|
8532
8559
|
get isColumnLayoutHorizontal(): boolean;
|
8533
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
|
+
/*
|
8534
8567
|
* Set the value to "underRow" to show the detailPanel under the row.
|
8535
8568
|
*/
|
8536
8569
|
get detailPanelMode(): string;
|
@@ -8588,6 +8621,7 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
|
|
8588
8621
|
get allowAdaptiveActions(): boolean;
|
8589
8622
|
set allowAdaptiveActions(val: boolean);
|
8590
8623
|
getRequiredText(): string;
|
8624
|
+
hasChoices(): boolean;
|
8591
8625
|
onColumnPropertyChanged(column: MatrixDropdownColumn, name: string, newValue: any): void;
|
8592
8626
|
onColumnItemValuePropertyChanged(column: MatrixDropdownColumn, propertyName: string, obj: ItemValue, name: string, newValue: any, oldValue: any): void;
|
8593
8627
|
onShowInMultipleColumnsChanged(column: MatrixDropdownColumn): void;
|
@@ -8779,7 +8813,6 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
|
|
8779
8813
|
getConditionJson(operator?: string, path?: string): any;
|
8780
8814
|
protected clearValueIfInvisibleCore(): void;
|
8781
8815
|
protected getFirstInputElementId(): string;
|
8782
|
-
protected onRowsChanged(): void;
|
8783
8816
|
onMatrixRowChanged(row: MatrixRowModel): void;
|
8784
8817
|
getCorrectedRowValue(value: any): any;
|
8785
8818
|
protected getSearchableItemValueKeys(keys: any): void;
|
@@ -9086,6 +9119,11 @@ export declare class QuestionMatrixDropdownModel extends QuestionMatrixDropdownM
|
|
9086
9119
|
get rowTitleWidth(): string;
|
9087
9120
|
set rowTitleWidth(val: string);
|
9088
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);
|
9089
9127
|
protected getDisplayValueCore(keysAsText: boolean, value: any): any;
|
9090
9128
|
protected getConditionObjectRowName(index: number): string;
|
9091
9129
|
protected getConditionObjectRowText(index: number): string;
|
@@ -9281,6 +9319,8 @@ export declare class QuestionRadiogroupModel extends QuestionCheckboxBase {
|
|
9281
9319
|
get canShowClearButton(): boolean;
|
9282
9320
|
get clearButtonCaption(): string;
|
9283
9321
|
supportGoNextPageAutomatic(): boolean;
|
9322
|
+
get showClearButtonInContent(): boolean;
|
9323
|
+
protected getDefaultTitleActions(): Array<Action>;
|
9284
9324
|
}
|
9285
9325
|
/*
|
9286
9326
|
* A Model for a ranking question
|
@@ -9557,6 +9597,8 @@ export declare var registerFunction: (name: string, func: any) => any;
|
|
9557
9597
|
export declare var parse: any;
|
9558
9598
|
export declare var defaultActionBarCss: {
|
9559
9599
|
root: string,
|
9600
|
+
defaultSizeMode: string,
|
9601
|
+
smallSizeMode: string,
|
9560
9602
|
item: string,
|
9561
9603
|
itemActive: string,
|
9562
9604
|
itemPressed: string,
|
@@ -10627,6 +10669,7 @@ export declare var defaultV2Css: {
|
|
10627
10669
|
requiredText: string,
|
10628
10670
|
header: string,
|
10629
10671
|
collapsed: string,
|
10672
|
+
expanded: string,
|
10630
10673
|
nested: string,
|
10631
10674
|
invisible: string,
|
10632
10675
|
navigationButton: string,
|
@@ -10714,6 +10757,7 @@ export declare var defaultV2Css: {
|
|
10714
10757
|
formGroup: string,
|
10715
10758
|
hasError: string,
|
10716
10759
|
collapsed: string,
|
10760
|
+
expanded: string,
|
10717
10761
|
nested: string,
|
10718
10762
|
invisible: string,
|
10719
10763
|
},
|
@@ -10734,7 +10778,9 @@ export declare var defaultV2Css: {
|
|
10734
10778
|
icon: string,
|
10735
10779
|
item: string,
|
10736
10780
|
tooltip: string,
|
10781
|
+
outsideQuestion: string,
|
10737
10782
|
aboveQuestion: string,
|
10783
|
+
belowQuestion: string,
|
10738
10784
|
locationTop: string,
|
10739
10785
|
locationBottom: string,
|
10740
10786
|
},
|
@@ -10859,7 +10905,6 @@ export declare var defaultV2Css: {
|
|
10859
10905
|
itemControl: string,
|
10860
10906
|
image: string,
|
10861
10907
|
itemText: string,
|
10862
|
-
clearButton: string,
|
10863
10908
|
other: string,
|
10864
10909
|
itemNoImage: string,
|
10865
10910
|
itemNoImageSvgIcon: string,
|
@@ -10870,8 +10915,12 @@ export declare var defaultV2Css: {
|
|
10870
10915
|
mainRoot: string,
|
10871
10916
|
tableWrapper: string,
|
10872
10917
|
root: string,
|
10918
|
+
rootVerticalAlignTop: string,
|
10919
|
+
rootVerticalAlignMiddle: string,
|
10920
|
+
rootAlternateRows: string,
|
10873
10921
|
rowError: string,
|
10874
10922
|
cell: string,
|
10923
|
+
row: string,
|
10875
10924
|
headerCell: string,
|
10876
10925
|
rowTextCell: string,
|
10877
10926
|
label: string,
|
@@ -10891,7 +10940,11 @@ export declare var defaultV2Css: {
|
|
10891
10940
|
mainRoot: string,
|
10892
10941
|
rootScroll: string,
|
10893
10942
|
root: string,
|
10943
|
+
rootVerticalAlignTop: string,
|
10944
|
+
rootVerticalAlignMiddle: string,
|
10945
|
+
rootAlternateRows: string,
|
10894
10946
|
cell: string,
|
10947
|
+
row: string,
|
10895
10948
|
headerCell: string,
|
10896
10949
|
rowTextCell: string,
|
10897
10950
|
cellRequiredText: string,
|
@@ -10912,6 +10965,7 @@ export declare var defaultV2Css: {
|
|
10912
10965
|
empty: string,
|
10913
10966
|
root: string,
|
10914
10967
|
cell: string,
|
10968
|
+
row: string,
|
10915
10969
|
headerCell: string,
|
10916
10970
|
rowTextCell: string,
|
10917
10971
|
cellRequiredText: string,
|
@@ -11032,6 +11086,7 @@ export declare var defaultV2Css: {
|
|
11032
11086
|
rootMobileMod: string,
|
11033
11087
|
rootDragMod: string,
|
11034
11088
|
rootDisabled: string,
|
11089
|
+
rootDesignMode: string,
|
11035
11090
|
item: string,
|
11036
11091
|
itemContent: string,
|
11037
11092
|
itemIndex: string,
|