survey-react 1.9.49 → 1.9.51
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 +75 -28
- package/defaultV2.min.css +2 -2
- package/modern.css +38 -10
- package/modern.min.css +2 -2
- package/package.json +1 -1
- package/survey.css +9 -2
- package/survey.min.css +2 -2
- package/survey.react.d.ts +206 -152
- package/survey.react.js +1156 -772
- 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.51
|
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
|
*/
|
@@ -155,10 +155,12 @@ export interface IAction {
|
|
155
155
|
*/
|
156
156
|
title?: string;
|
157
157
|
locTitle?: any;
|
158
|
+
locTitleName?: string;
|
158
159
|
/*
|
159
160
|
* The action item's tooltip.
|
160
161
|
*/
|
161
162
|
tooltip?: string;
|
163
|
+
locTooltipName?: string;
|
162
164
|
/*
|
163
165
|
* Specifies whether users can interact with the action item.
|
164
166
|
*/
|
@@ -817,7 +819,7 @@ export declare class Base {
|
|
817
819
|
/*
|
818
820
|
* Returns `true` if the object is included in a survey.
|
819
821
|
*
|
820
|
-
* This
|
822
|
+
* This property may return `false`, for example, when you [create a survey model dynamically](https://surveyjs.io/form-library/documentation/design-survey-create-a-simple-survey#create-or-change-a-survey-model-dynamically).
|
821
823
|
*/
|
822
824
|
get inSurvey(): boolean;
|
823
825
|
get bindings(): Bindings;
|
@@ -870,11 +872,6 @@ export declare class Base {
|
|
870
872
|
get isEditingSurveyElement(): boolean;
|
871
873
|
iteratePropertiesHash(func: (hash: any, key: any) => void): void;
|
872
874
|
/*
|
873
|
-
* set property value and before check if new property value is correct by calling JsonProperty onSettingValue function
|
874
|
-
* If onSettingValue is not set in declaration, then this function works as `setPropertyValue`.
|
875
|
-
*/
|
876
|
-
checkAndSetPropertyValue(name: string, val: any): void;
|
877
|
-
/*
|
878
875
|
* Assigns a new value to a specified property.
|
879
876
|
*/
|
880
877
|
setPropertyValue(name: string, val: any): void;
|
@@ -1128,6 +1125,12 @@ export declare class ExpressionRunnerBase {
|
|
1128
1125
|
protected runCore(values: any, properties?: any): any;
|
1129
1126
|
protected doOnComplete(res: any): void;
|
1130
1127
|
}
|
1128
|
+
export declare class FileLoader {
|
1129
|
+
constructor(fileQuestion: QuestionFileModel, callback: (status: string, files: any) => void);
|
1130
|
+
loaded: any;
|
1131
|
+
load(files: any): void;
|
1132
|
+
dispose(): void;
|
1133
|
+
}
|
1131
1134
|
export declare class FunctionFactory {
|
1132
1135
|
static Instance: FunctionFactory;
|
1133
1136
|
functionHash: any;
|
@@ -1420,11 +1423,13 @@ export declare class ResponsivityManager {
|
|
1420
1423
|
separatorSize: number;
|
1421
1424
|
separatorAddConst: number;
|
1422
1425
|
paddingSizeConst: number;
|
1426
|
+
dotsSizeConst: number;
|
1423
1427
|
protected recalcMinDimensionConst: boolean;
|
1424
1428
|
getComputedStyle: (elt: JSX.Element) => any;
|
1425
1429
|
protected getDimensions(element: any): IDimensions;
|
1426
1430
|
protected getAvailableSpace(): number;
|
1427
1431
|
protected calcItemSize(item: any): number;
|
1432
|
+
protected calcActionDimensions(currentAction: Action, item: any): void;
|
1428
1433
|
dispose(): void;
|
1429
1434
|
}
|
1430
1435
|
export declare class Skeleton extends React.Component<any, any> {
|
@@ -1663,6 +1668,7 @@ export declare class Action extends Base implements IAction, ILocalizableOwner {
|
|
1663
1668
|
iconSize: number;
|
1664
1669
|
visible: boolean;
|
1665
1670
|
tooltip: string;
|
1671
|
+
locTooltipName: string;
|
1666
1672
|
enabled: boolean;
|
1667
1673
|
showTitle: boolean;
|
1668
1674
|
action: (context?: any) => void;
|
@@ -1685,6 +1691,9 @@ export declare class Action extends Base implements IAction, ILocalizableOwner {
|
|
1685
1691
|
title: string;
|
1686
1692
|
get locTitle(): any;
|
1687
1693
|
set locTitle(val: any);
|
1694
|
+
get locTitleName(): string;
|
1695
|
+
set locTitleName(val: string);
|
1696
|
+
locStrsChanged(): void;
|
1688
1697
|
locTitleChanged: any;
|
1689
1698
|
cssClassesValue: any;
|
1690
1699
|
get cssClasses(): any;
|
@@ -1718,6 +1727,7 @@ export declare class ActionContainer<T extends Action = Action> extends Base imp
|
|
1718
1727
|
sizeMode: "default" | "small";
|
1719
1728
|
locOwner: ILocalizableOwner;
|
1720
1729
|
isEmpty: boolean;
|
1730
|
+
locStrsChanged(): void;
|
1721
1731
|
protected raiseUpdate(isResetInitialized: boolean): void;
|
1722
1732
|
protected onSet(): void;
|
1723
1733
|
protected onPush(item: T): void;
|
@@ -2009,14 +2019,17 @@ export declare class DropdownListModel extends Base {
|
|
2009
2019
|
protected getAvailableItems(): Array<Action>;
|
2010
2020
|
protected createListModel(): ListModel;
|
2011
2021
|
protected resetFilterString(): void;
|
2022
|
+
protected onSetFilterString(): void;
|
2023
|
+
setInputHasValue(newValue: boolean): void;
|
2012
2024
|
searchEnabled: boolean;
|
2013
2025
|
filterString: string;
|
2014
2026
|
get popupModel(): any;
|
2027
|
+
get inputReadOnly(): boolean;
|
2015
2028
|
setSearchEnabled(newValue: boolean): void;
|
2016
2029
|
updateItems(): void;
|
2017
2030
|
onClick(event: any): void;
|
2018
2031
|
onClear(event: any): void;
|
2019
|
-
|
2032
|
+
keyHandler(event: any): void;
|
2020
2033
|
onBlur(event: any): void;
|
2021
2034
|
scrollToFocusedItem(): void;
|
2022
2035
|
}
|
@@ -2706,6 +2719,7 @@ export declare class Popup extends SurveyElementBase<IPopupProps, any> {
|
|
2706
2719
|
export declare class PopupBaseViewModel extends Base {
|
2707
2720
|
constructor(model: any, targetElement?: any);
|
2708
2721
|
targetElement: any;
|
2722
|
+
isAutoScroll: boolean;
|
2709
2723
|
prevActiveElement: any;
|
2710
2724
|
scrollEventCallBack: any;
|
2711
2725
|
top: string;
|
@@ -3248,7 +3262,7 @@ export declare class TagboxFilterString extends SurveyElementBase<ITagboxFilterP
|
|
3248
3262
|
componentDidMount(): void;
|
3249
3263
|
updateDomElement(): void;
|
3250
3264
|
onChange(e: any): void;
|
3251
|
-
|
3265
|
+
keyhandler(e: any): void;
|
3252
3266
|
onBlur(e: any): void;
|
3253
3267
|
getStateElement(): any;
|
3254
3268
|
render(): JSX.Element;
|
@@ -3306,6 +3320,7 @@ export declare class VerticalResponsivityManager extends ResponsivityManager {
|
|
3306
3320
|
protected getDimensions(): IDimensions;
|
3307
3321
|
protected getAvailableSpace(): number;
|
3308
3322
|
protected calcItemSize(item: any): number;
|
3323
|
+
protected calcActionDimensions(currentAction: Action, item: any): void;
|
3309
3324
|
}
|
3310
3325
|
export declare class WebRequestEmptyError extends SurveyError {
|
3311
3326
|
constructor(text: string, errorOwner?: ISurveyErrorOwner);
|
@@ -3447,8 +3462,10 @@ export declare class DragDropSurveyElements extends DragDropCore<any> {
|
|
3447
3462
|
export declare class DropdownMultiSelectListModel extends DropdownListModel {
|
3448
3463
|
constructor(question: Question, onSelectionChanged?: (item: IAction, ...params: any) => void);
|
3449
3464
|
filterStringPlaceholder: string;
|
3465
|
+
closeOnSelect: boolean;
|
3450
3466
|
protected override: any;
|
3451
3467
|
createListModel(): MultiSelectListModel;
|
3468
|
+
protected onSetFilterString(): void;
|
3452
3469
|
selectAllItems(): void;
|
3453
3470
|
selectNoneItem(): void;
|
3454
3471
|
selectItem(id: string): void;
|
@@ -3456,7 +3473,7 @@ export declare class DropdownMultiSelectListModel extends DropdownListModel {
|
|
3456
3473
|
onClear(event: any): void;
|
3457
3474
|
setHideSelectedItems(newValue: boolean): void;
|
3458
3475
|
removeLastSelectedItem(): void;
|
3459
|
-
|
3476
|
+
inputKeyHandler(event: any): void;
|
3460
3477
|
}
|
3461
3478
|
/*
|
3462
3479
|
* Validate e-mail address in the text input
|
@@ -3535,7 +3552,6 @@ export declare class ListModel extends ActionContainer {
|
|
3535
3552
|
allowSelection: boolean;
|
3536
3553
|
searchEnabled: boolean;
|
3537
3554
|
showFilter: boolean;
|
3538
|
-
isEmpty: boolean;
|
3539
3555
|
isExpanded: boolean;
|
3540
3556
|
selectedItem: IAction;
|
3541
3557
|
focusedItem: Action;
|
@@ -3704,8 +3720,9 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
|
|
3704
3720
|
*
|
3705
3721
|
* Possible values:
|
3706
3722
|
*
|
3707
|
-
* - `"
|
3708
|
-
* - `"expanded"` - The survey element is displayed in full.
|
3723
|
+
* - `"default"` (default) - The survey element is displayed in full and cannot be collapsed in the UI.
|
3724
|
+
* - `"expanded"` - The survey element is displayed in full and can be collapsed in the UI.
|
3725
|
+
* - `"collapsed"` - The survey element displays only `title` and `description` and can be expanded in the UI.
|
3709
3726
|
*/
|
3710
3727
|
get state(): string;
|
3711
3728
|
set state(val: string);
|
@@ -3764,11 +3781,15 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
|
|
3764
3781
|
get areInvisibleElementsShowing(): boolean;
|
3765
3782
|
get isVisible(): boolean;
|
3766
3783
|
/*
|
3767
|
-
* Returns `true` if the survey element or its parent element is read-only.
|
3784
|
+
* Returns `true` if the survey element or its parent element is read-only.
|
3785
|
+
*
|
3786
|
+
* If you want to switch a survey element to the read-only state based on a condition, specify the [`enableIf`](https://surveyjs.io/form-library/documentation/question#enableIf) property. Refer to the following help topic for information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
|
3768
3787
|
*/
|
3769
3788
|
get isReadOnly(): boolean;
|
3770
3789
|
/*
|
3771
|
-
* Makes the survey element read-only.
|
3790
|
+
* Makes the survey element read-only.
|
3791
|
+
*
|
3792
|
+
* If you want to switch a survey element to the read-only state based on a condition, specify the [`enableIf`](https://surveyjs.io/form-library/documentation/question#enableIf) property. Refer to the following help topic for information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
|
3772
3793
|
*/
|
3773
3794
|
get readOnly(): boolean;
|
3774
3795
|
set readOnly(val: boolean);
|
@@ -3805,7 +3826,7 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
|
|
3805
3826
|
set errors(val: any);
|
3806
3827
|
hasVisibleErrors: boolean;
|
3807
3828
|
/*
|
3808
|
-
* Returns `true` if the survey element or its child elements have
|
3829
|
+
* Returns `true` if the survey element or its child elements have validation errors.
|
3809
3830
|
*
|
3810
3831
|
* This property contains the result of the most recent validation. This result may be outdated. Call the `hasErrors` method to get an up-to-date value.
|
3811
3832
|
*/
|
@@ -3835,7 +3856,14 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
|
|
3835
3856
|
delete(): void;
|
3836
3857
|
locOwner: ILocalizableOwner;
|
3837
3858
|
/*
|
3838
|
-
* Returns the survey's [locale](https://surveyjs.io/form-library/documentation/surveymodel#locale).
|
3859
|
+
* Returns the survey's [locale](https://surveyjs.io/form-library/documentation/surveymodel#locale).
|
3860
|
+
*
|
3861
|
+
* If a default locale is used, this method returns an empty string. To get the applied locale in this case, use the following code:
|
3862
|
+
*
|
3863
|
+
* ```js
|
3864
|
+
* import { surveyLocalization } from 'survey-core';
|
3865
|
+
* const defaultLocale = surveyLocalization.defaultLocale;
|
3866
|
+
* ```
|
3839
3867
|
*/
|
3840
3868
|
getLocale(): string;
|
3841
3869
|
getMarkdownHtml(text: string, name: string): string;
|
@@ -3919,7 +3947,7 @@ export declare class SurveyElementErrors extends ReactSurveyElement {
|
|
3919
3947
|
protected renderElement(): JSX.Element;
|
3920
3948
|
}
|
3921
3949
|
/*
|
3922
|
-
* The `
|
3950
|
+
* The `SurveyModel` object contains properties and methods that allow you to control the survey and access its elements.
|
3923
3951
|
*/
|
3924
3952
|
export declare class SurveyModel extends SurveyElementCore implements ISurvey, ISurveyData, ISurveyImpl, ISurveyTriggerOwner, ISurveyErrorOwner, ISurveyTimerText {
|
3925
3953
|
constructor(jsonObj?: any, renderedElement?: any);
|
@@ -3956,12 +3984,15 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
|
|
3956
3984
|
onCompleting: EventBase<SurveyModel>;
|
3957
3985
|
/*
|
3958
3986
|
* The event is fired after a user clicks the 'Complete' button and finishes a survey. Use this event to send the survey data to your web server.
|
3987
|
+
*
|
3959
3988
|
* - `sender` - the survey object that fires the event.
|
3960
3989
|
* - `options.showDataSaving(text)` - call this method to show that the survey is saving survey data on your server. The `text` is an optional parameter to show a custom message instead of default.
|
3961
3990
|
* - `options.showDataSavingError(text)` - call this method to show that an error occurred while saving the data on your server. If you want to show a custom error, use an optional `text` parameter.
|
3962
3991
|
* - `options.showDataSavingSuccess(text)` - call this method to show that the data was successfully saved on the server.
|
3963
3992
|
* - `options.showDataSavingClear` - call this method to hide the text about the saving progress.
|
3964
3993
|
* - `options.isCompleteOnTrigger` - returns true if the survey is completed on "complete" trigger.
|
3994
|
+
*
|
3995
|
+
* > NOTE: Do not disable the [`showCompletedPage`](https://surveyjs.io/form-library/documentation/surveymodel#showCompletedPage) property if you call one of the `options.showDataSaving...` methods described above. This is required because the UI that indicates data saving progress is integrated into the Complete page. If you hide the Complete page, the UI also becomes invisible.
|
3965
3996
|
*/
|
3966
3997
|
onComplete: EventBase<SurveyModel>;
|
3967
3998
|
/*
|
@@ -4992,9 +5023,6 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
|
|
4992
5023
|
get questionTitlePattern(): string;
|
4993
5024
|
set questionTitlePattern(val: string);
|
4994
5025
|
getQuestionTitlePatternOptions(): Array<any>;
|
4995
|
-
/*
|
4996
|
-
* Gets or sets a question title template. Obsolete, please use questionTitlePattern
|
4997
|
-
*/
|
4998
5026
|
get questionTitleTemplate(): string;
|
4999
5027
|
set questionTitleTemplate(val: string);
|
5000
5028
|
get locQuestionTitleTemplate(): LocalizableString;
|
@@ -5048,15 +5076,11 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
|
|
5048
5076
|
*/
|
5049
5077
|
get processedTitle(): string;
|
5050
5078
|
/*
|
5051
|
-
* Gets or sets
|
5052
|
-
*
|
5053
|
-
* The following options are available:
|
5079
|
+
* Gets or sets question title location relative to the input field: `"top"`, `"bottom"`, or `"left"`.
|
5054
5080
|
*
|
5055
|
-
*
|
5056
|
-
* - `left` - show a question title to left
|
5057
|
-
* - `top` - show a question title to top.
|
5081
|
+
* > NOTE: Certain question types (Matrix, Multiple Text) do not support the `"left"` value. For them, the `"top"` value is used.
|
5058
5082
|
*
|
5059
|
-
*
|
5083
|
+
* You can override this setting if you specify the `questionTitleLocation` property for an [individual page](https://surveyjs.io/form-library/documentation/pagemodel#questionTitleLocation) or [panel](https://surveyjs.io/form-library/documentation/panelmodel#questionTitleLocation) or set the `titleLocation` property for a [specific question](https://surveyjs.io/form-library/documentation/question#titleLocation).
|
5060
5084
|
*/
|
5061
5085
|
get questionTitleLocation(): string;
|
5062
5086
|
set questionTitleLocation(val: string);
|
@@ -5109,11 +5133,11 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
|
|
5109
5133
|
get isEditingSurveyElement(): boolean;
|
5110
5134
|
getAllValues(): any;
|
5111
5135
|
/*
|
5112
|
-
* Returns survey
|
5136
|
+
* Returns survey results as an array of objects in which the question name, title, value, and other parameters are stored as individual properties.
|
5113
5137
|
*
|
5114
|
-
*
|
5138
|
+
* If a question can have more than one value (Matrix, Multiple Text), its object enables the `isNode` flag and stores information about these values in the `data` property. Refer to the following help topic for more information: [Access Full Survey Results](https://surveyjs.io/form-library/documentation/handle-survey-results-access#access-full-survey-results).
|
5115
5139
|
*
|
5116
|
-
*
|
5140
|
+
* If you want to skip empty answers, pass an object with the `includeEmpty` property set to `false`.
|
5117
5141
|
*/
|
5118
5142
|
getPlainData(options?: any): any;
|
5119
5143
|
getFilteredValues(): any;
|
@@ -5733,6 +5757,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
|
|
5733
5757
|
*/
|
5734
5758
|
get width(): string;
|
5735
5759
|
set width(val: string);
|
5760
|
+
get renderedWidth(): string;
|
5736
5761
|
get timerInfoText(): string;
|
5737
5762
|
get timerModel(): SurveyTimerModel;
|
5738
5763
|
/*
|
@@ -6188,7 +6213,8 @@ export declare class UrlConditionItem extends ExpressionItem {
|
|
6188
6213
|
}
|
6189
6214
|
export declare class Variable extends Const {
|
6190
6215
|
constructor(variableName: string);
|
6191
|
-
static DisableConversionChar: string;
|
6216
|
+
static get DisableConversionChar(): string;
|
6217
|
+
static set DisableConversionChar(val: string);
|
6192
6218
|
valueInfo: any;
|
6193
6219
|
useValueAsItIs: boolean;
|
6194
6220
|
getType(): string;
|
@@ -6517,10 +6543,13 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6517
6543
|
protected isReadyValue: boolean;
|
6518
6544
|
commentElement: any;
|
6519
6545
|
/*
|
6520
|
-
*
|
6521
|
-
*
|
6522
|
-
*
|
6523
|
-
*
|
6546
|
+
* An event that is raised when the question's ready state has changed (expressions are evaluated, choices are loaded from a web resource specified by the `choicesByUrl` property, etc.).
|
6547
|
+
*
|
6548
|
+
* Parameters:
|
6549
|
+
*
|
6550
|
+
* - `sender` - A survey that contains the question whose ready state has changed.
|
6551
|
+
* - `options.isReady` - A Boolean value that indicates whether the question is ready.
|
6552
|
+
* - `options.oldIsReady` - A Boolean value that indicates the previous ready state.
|
6524
6553
|
*/
|
6525
6554
|
onReadyChanged: EventBase<Question>;
|
6526
6555
|
isReadOnlyRenderDiv(): boolean;
|
@@ -6529,29 +6558,21 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6529
6558
|
getSurvey(live?: boolean): ISurvey;
|
6530
6559
|
getValueName(): string;
|
6531
6560
|
/*
|
6532
|
-
*
|
6533
|
-
*
|
6534
|
-
*
|
6535
|
-
* In this case if you set the question.name property to 'x.y' then the valueName becomes 'x y'.
|
6536
|
-
* Please note, this property is hidden for questions without input, for example html question.
|
6561
|
+
* Specifies an object property that should store the question value.
|
6562
|
+
*
|
6563
|
+
* Refer to the [Merge Question Values](https://surveyjs.io/form-library/documentation/design-survey-merge-question-values) help topic for more information.
|
6537
6564
|
*/
|
6538
6565
|
get valueName(): string;
|
6539
6566
|
set valueName(val: string);
|
6540
6567
|
protected onValueNameChanged(oldValue: string): void;
|
6541
6568
|
protected onNameChanged(oldValue: string): void;
|
6542
6569
|
get isReady(): boolean;
|
6543
|
-
/*
|
6544
|
-
* A11Y properties
|
6545
|
-
*/
|
6546
6570
|
get ariaRequired(): "true" | "false";
|
6547
6571
|
get ariaInvalid(): "true" | "false";
|
6548
6572
|
get ariaDescribedBy(): string;
|
6549
|
-
/*
|
6550
|
-
* Get is question ready to use
|
6551
|
-
*/
|
6552
6573
|
choicesLoaded(): void;
|
6553
6574
|
/*
|
6554
|
-
*
|
6575
|
+
* Returns a page to which the question belongs and allows you to move this question to a different page.
|
6555
6576
|
*/
|
6556
6577
|
get page(): IPage;
|
6557
6578
|
set page(val: IPage);
|
@@ -6561,25 +6582,36 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6561
6582
|
getLayoutType(): string;
|
6562
6583
|
isLayoutTypeSupported(layoutType: string): boolean;
|
6563
6584
|
/*
|
6564
|
-
*
|
6585
|
+
* Gets or sets question visibility.
|
6586
|
+
*
|
6587
|
+
* If you want to display or hide a question based on a condition, specify the [`visibleIf`](https://surveyjs.io/form-library/documentation/question#visibleIf) property. Refer to the following help topic for information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
|
6565
6588
|
*/
|
6566
6589
|
get visible(): boolean;
|
6567
6590
|
set visible(val: boolean);
|
6568
6591
|
protected onVisibleChanged(): void;
|
6569
6592
|
/*
|
6570
|
-
*
|
6571
|
-
*
|
6593
|
+
* Specifies whether to use display names for question values interpolated in the title. To interpolate question values, use curly brackets (`{}`).
|
6594
|
+
*
|
6595
|
+
* This property is useful when interpolated question values have both the `value` and `text` properties.
|
6596
|
+
*
|
6597
|
+
* Default value: `true`
|
6572
6598
|
*/
|
6573
6599
|
get useDisplayValuesInTitle(): boolean;
|
6574
6600
|
set useDisplayValuesInTitle(val: boolean);
|
6575
6601
|
protected getUseDisplayValuesInTitle(): boolean;
|
6576
6602
|
/*
|
6577
|
-
*
|
6603
|
+
* A Boolean expression. If it evaluates to `false`, this question becomes hidden.
|
6604
|
+
*
|
6605
|
+
* A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
|
6606
|
+
*
|
6607
|
+
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility)
|
6578
6608
|
*/
|
6579
6609
|
get visibleIf(): string;
|
6580
6610
|
set visibleIf(val: string);
|
6581
6611
|
/*
|
6582
|
-
* Returns true if the question is visible or survey is in design mode
|
6612
|
+
* Returns `true` if the question is visible or the survey is currently in design mode.
|
6613
|
+
*
|
6614
|
+
* If you want to display or hide a question based on a condition, specify the [`visibleIf`](https://surveyjs.io/form-library/documentation/question#visibleIf) property. Refer to the following help topic for information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
|
6583
6615
|
*/
|
6584
6616
|
get isVisible(): boolean;
|
6585
6617
|
/*
|
@@ -6588,12 +6620,14 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6588
6620
|
*/
|
6589
6621
|
get visibleIndex(): number;
|
6590
6622
|
/*
|
6591
|
-
*
|
6623
|
+
* Hides the question number from the title and excludes the question from numbering.
|
6624
|
+
*
|
6625
|
+
* If you want to disable question numbering in the entire survey, set SurveyModel's `showQuestionNumbers` property to `false`.
|
6592
6626
|
*/
|
6593
6627
|
get hideNumber(): boolean;
|
6594
6628
|
set hideNumber(val: boolean);
|
6595
6629
|
/*
|
6596
|
-
* Returns true if the question
|
6630
|
+
* Returns `true` if the question can display its title to the left of the input field.
|
6597
6631
|
*/
|
6598
6632
|
get isAllowTitleLeft(): boolean;
|
6599
6633
|
/*
|
@@ -6622,40 +6656,48 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6622
6656
|
*/
|
6623
6657
|
getType(): string;
|
6624
6658
|
get isQuestion(): boolean;
|
6625
|
-
/*
|
6626
|
-
* Move question to a new container Page/Panel. Add as a last element if insertBefore parameter is not used or inserted into the given index,
|
6627
|
-
* if insert parameter is number, or before the given element, if the insertBefore parameter is a question or panel
|
6628
|
-
*/
|
6629
6659
|
moveTo(container: IPanel, insertBefore?: any): boolean;
|
6630
6660
|
getProgressInfo(): IProgressInfo;
|
6631
6661
|
setSurveyImpl(value: ISurveyImpl, isLight?: boolean): void;
|
6632
6662
|
/*
|
6633
|
-
*
|
6663
|
+
* Returns a survey element (panel or page) that contains the question and allows you to move this question to a different survey element.
|
6634
6664
|
*/
|
6635
6665
|
get parent(): IPanel;
|
6636
6666
|
set parent(val: IPanel);
|
6637
6667
|
parentQuestionValue: Question;
|
6638
6668
|
/*
|
6639
|
-
* A
|
6640
|
-
*
|
6669
|
+
* A Dynamic Panel, Dynamic Matrix, or Dropdown Matrix that includes the current question.
|
6670
|
+
*
|
6671
|
+
* This property is `null` for standalone questions.
|
6641
6672
|
*/
|
6642
6673
|
get parentQuestion(): Question;
|
6643
6674
|
setParentQuestion(val: Question): void;
|
6644
6675
|
protected onParentQuestionChanged(): void;
|
6645
6676
|
protected onParentChanged(): void;
|
6646
6677
|
/*
|
6647
|
-
* Returns false if the question
|
6678
|
+
* Returns `false` if the `titleLocation` property is set to `"hidden"` or if the question cannot have a title (for example, an [HTML](https://surveyjs.io/form-library/documentation/questionhtmlmodel) question).
|
6679
|
+
*
|
6680
|
+
* If the `title` property is `undefined` or set to an empty string, the `hasTitle` property returns `true`, because the question uses its `name` as a title in this case.
|
6648
6681
|
*/
|
6649
6682
|
get hasTitle(): boolean;
|
6650
6683
|
/*
|
6651
|
-
*
|
6652
|
-
*
|
6684
|
+
* Sets question title location relative to the input field. Overrides the `questionTitleLocation` property specified for the question's container (survey, page, or panel).
|
6685
|
+
*
|
6686
|
+
* Possible values:
|
6687
|
+
*
|
6688
|
+
* - `"default"` - Inherits the setting from the `questionTitleLocation` property specified for the question's container.
|
6689
|
+
* - `"top"` - Displays the title above the input field.
|
6690
|
+
* - `"bottom"` - Displays the title below the input field.
|
6691
|
+
* - `"left"` - Displays the title to the left of the input field.
|
6692
|
+
* - `"hidden"` - Hides the question title.
|
6693
|
+
*
|
6694
|
+
* > NOTE: Certain question types (Matrix, Multiple Text) do not support the `"left"` value. For them, the `"top"` value is used.
|
6653
6695
|
*/
|
6654
6696
|
get titleLocation(): string;
|
6655
6697
|
set titleLocation(val: string);
|
6656
6698
|
getTitleOwner(): ITitleOwner;
|
6657
6699
|
/*
|
6658
|
-
*
|
6700
|
+
* Returns title location calculated based on the question's `titleLocation` property and the `questionTitleLocation` property of the question's containers (survey, page, or panel).
|
6659
6701
|
*/
|
6660
6702
|
getTitleLocation(): string;
|
6661
6703
|
protected getTitleLocationCore(): string;
|
@@ -6665,19 +6707,24 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6665
6707
|
get hasTitleOnLeftTop(): boolean;
|
6666
6708
|
get errorLocation(): string;
|
6667
6709
|
/*
|
6668
|
-
* Returns false if the question
|
6710
|
+
* Returns `false` if the question has no input fields ([HTML](https://surveyjs.io/form-library/documentation/questionhtmlmodel), [Image](https://surveyjs.io/form-library/documentation/questionimagemodel), and similar question types).
|
6669
6711
|
*/
|
6670
6712
|
get hasInput(): boolean;
|
6671
6713
|
/*
|
6672
|
-
* Returns false if the question
|
6714
|
+
* Returns `false` if the question has no input fields ([HTML](https://surveyjs.io/form-library/documentation/questionhtmlmodel), [Image](https://surveyjs.io/form-library/documentation/questionimagemodel)) or has multiple input fields ([Matrix](https://surveyjs.io/form-library/documentation/questionmatrixmodel), [Multiple Text](https://surveyjs.io/form-library/documentation/questionmultipletextmodel)).
|
6673
6715
|
*/
|
6674
6716
|
get hasSingleInput(): boolean;
|
6675
6717
|
get inputId(): string;
|
6676
6718
|
protected getDefaultTitleValue(): string;
|
6677
6719
|
protected getDefaultTitleTagName(): string;
|
6678
6720
|
/*
|
6679
|
-
*
|
6680
|
-
*
|
6721
|
+
* Specifies where to display a question description.
|
6722
|
+
*
|
6723
|
+
* Possible values:
|
6724
|
+
*
|
6725
|
+
* - `"default"` (default) - Inherits the setting from the Survey's [`questionDescriptionLocation`](https://surveyjs.io/form-library/documentation/surveymodel#questionDescriptionLocation) property.
|
6726
|
+
* - `"underTitle"` - Displays the description under the question title.
|
6727
|
+
* - `"underInput"` - Displays the description under the interactive area.
|
6681
6728
|
*/
|
6682
6729
|
get descriptionLocation(): string;
|
6683
6730
|
set descriptionLocation(val: string);
|
@@ -6686,33 +6733,28 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6686
6733
|
protected needClickTitleFunction(): boolean;
|
6687
6734
|
protected processTitleClick(): boolean;
|
6688
6735
|
/*
|
6689
|
-
*
|
6690
|
-
* Please note, this property is hidden for question without input, for example html question.
|
6736
|
+
* Specifies a custom error message for a required form field.
|
6691
6737
|
*/
|
6692
6738
|
get requiredErrorText(): string;
|
6693
6739
|
set requiredErrorText(val: string);
|
6694
6740
|
get locRequiredErrorText(): LocalizableString;
|
6695
6741
|
/*
|
6696
|
-
*
|
6742
|
+
* Specifies a caption displayed above the comment area. Applies when the `hasComment` property is `true`.
|
6697
6743
|
*/
|
6698
6744
|
get commentText(): string;
|
6699
6745
|
set commentText(val: string);
|
6700
6746
|
get locCommentText(): LocalizableString;
|
6701
6747
|
/*
|
6702
|
-
*
|
6748
|
+
* A placeholder for the comment area. Applies when the `hasComment` property is `true`.
|
6703
6749
|
*/
|
6750
|
+
get commentPlaceholder(): string;
|
6751
|
+
set commentPlaceholder(val: string);
|
6752
|
+
get locCommentPlaceholder(): LocalizableString;
|
6704
6753
|
get commentPlaceHolder(): string;
|
6705
6754
|
set commentPlaceHolder(val: string);
|
6706
|
-
get
|
6707
|
-
get commentOrOtherPlaceHolder(): string;
|
6708
|
-
/*
|
6709
|
-
* Returns a copy of question errors survey. For some questions like matrix and panel dynamic it includes the errors of nested questions.
|
6710
|
-
*/
|
6755
|
+
get commentOrOtherPlaceholder(): string;
|
6711
6756
|
getAllErrors(): Array<SurveyError>;
|
6712
6757
|
getErrorByType(errorType: string): SurveyError;
|
6713
|
-
/*
|
6714
|
-
* The link to the custom widget.
|
6715
|
-
*/
|
6716
6758
|
get customWidget(): QuestionCustomWidget;
|
6717
6759
|
updateCustomWidget(): void;
|
6718
6760
|
localeChanged(): void;
|
@@ -6723,20 +6765,14 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6723
6765
|
afterRenderQuestionElement(el: any): void;
|
6724
6766
|
afterRender(el: any): void;
|
6725
6767
|
beforeDestroyQuestionElement(el: any): void;
|
6726
|
-
/*
|
6727
|
-
* Returns the rendred question title.
|
6728
|
-
*/
|
6729
6768
|
get processedTitle(): string;
|
6730
|
-
/*
|
6731
|
-
* Returns the title after processing the question template.
|
6732
|
-
*/
|
6733
6769
|
get fullTitle(): string;
|
6734
6770
|
protected get titlePattern(): string;
|
6735
6771
|
get isRequireTextOnStart(): boolean;
|
6736
6772
|
get isRequireTextBeforeTitle(): boolean;
|
6737
6773
|
get isRequireTextAfterTitle(): boolean;
|
6738
6774
|
/*
|
6739
|
-
*
|
6775
|
+
* Disable this property if you want to render the current question on the same line or row with the previous question or panel.
|
6740
6776
|
*/
|
6741
6777
|
get startWithNewLine(): boolean;
|
6742
6778
|
set startWithNewLine(val: boolean);
|
@@ -6773,7 +6809,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6773
6809
|
protected getCssType(): string;
|
6774
6810
|
get renderCssRoot(): string;
|
6775
6811
|
/*
|
6776
|
-
*
|
6812
|
+
* Moves focus to the input field of this question.
|
6777
6813
|
*/
|
6778
6814
|
focus(onError?: boolean): void;
|
6779
6815
|
focusIn: any;
|
@@ -6787,33 +6823,33 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6787
6823
|
supportComment(): boolean;
|
6788
6824
|
supportOther(): boolean;
|
6789
6825
|
/*
|
6790
|
-
*
|
6791
|
-
* Please note, this property is hidden for question without input, for example html question.
|
6826
|
+
* Makes the question required. If a respondent skips a required question, the survey displays a validation error.
|
6792
6827
|
*/
|
6793
6828
|
get isRequired(): boolean;
|
6794
6829
|
set isRequired(val: boolean);
|
6795
6830
|
/*
|
6796
|
-
*
|
6797
|
-
*
|
6798
|
-
*
|
6799
|
-
*
|
6831
|
+
* A Boolean expression. If it evaluates to `true`, this question becomes required.
|
6832
|
+
*
|
6833
|
+
* A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
|
6834
|
+
*
|
6835
|
+
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility)
|
6800
6836
|
*/
|
6801
6837
|
get requiredIf(): string;
|
6802
6838
|
set requiredIf(val: string);
|
6803
6839
|
/*
|
6804
|
-
*
|
6840
|
+
* Specifies whether to display a comment area. Incompatible with the `hasOther` property.
|
6805
6841
|
*/
|
6806
6842
|
get hasComment(): boolean;
|
6807
6843
|
set hasComment(val: boolean);
|
6808
6844
|
/*
|
6809
|
-
*
|
6845
|
+
* A value to assign to the `id` attribute of the rendered HTML element. A default `id` is generated automatically.
|
6810
6846
|
*/
|
6811
6847
|
get id(): string;
|
6812
6848
|
set id(val: string);
|
6813
6849
|
get ariaTitleId(): string;
|
6814
6850
|
get ariaRole(): string;
|
6815
6851
|
/*
|
6816
|
-
* Specifies whether to display the "Other" choice item.
|
6852
|
+
* Specifies whether to display the "Other" choice item. Incompatible with the `hasComment` property.
|
6817
6853
|
*/
|
6818
6854
|
get hasOther(): boolean;
|
6819
6855
|
set hasOther(val: boolean);
|
@@ -6825,19 +6861,20 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6825
6861
|
get renderedInputDisabled(): string;
|
6826
6862
|
protected onReadOnlyChanged(): void;
|
6827
6863
|
/*
|
6828
|
-
*
|
6829
|
-
*
|
6864
|
+
* A Boolean expression. If it evaluates to `false`, this question becomes read-only.
|
6865
|
+
*
|
6866
|
+
* A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
|
6867
|
+
*
|
6868
|
+
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility)
|
6830
6869
|
*/
|
6831
6870
|
get enableIf(): string;
|
6832
6871
|
set enableIf(val: string);
|
6833
6872
|
surveyChoiceItemVisibilityChange(): void;
|
6834
|
-
/*
|
6835
|
-
* Run visibleIf and enableIf expressions. If visibleIf or/and enabledIf are not empty, then the results of performing the expression (true or false) set to the visible/readOnly properties.
|
6836
|
-
*/
|
6837
6873
|
runCondition(values: any, properties: any): void;
|
6838
6874
|
/*
|
6839
|
-
*
|
6840
|
-
*
|
6875
|
+
* A question number or letter (depends on SurveyModel's `questionStartIndex` property).
|
6876
|
+
*
|
6877
|
+
* For invisible questions, this property returns an empty string.
|
6841
6878
|
*/
|
6842
6879
|
get no(): string;
|
6843
6880
|
protected getStartIndex(): string;
|
@@ -6847,13 +6884,13 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6847
6884
|
protected initCommentFromSurvey(): void;
|
6848
6885
|
protected runExpression(expression: string): any;
|
6849
6886
|
/*
|
6850
|
-
*
|
6887
|
+
* Gets or sets the question value.
|
6851
6888
|
*/
|
6852
6889
|
get value(): any;
|
6853
6890
|
set value(val: any);
|
6854
6891
|
get valueForSurvey(): any;
|
6855
6892
|
/*
|
6856
|
-
*
|
6893
|
+
* Sets the question's `value` and `comment` properties to `undefined`.
|
6857
6894
|
*/
|
6858
6895
|
clearValue(): void;
|
6859
6896
|
unbindValue(): void;
|
@@ -6861,32 +6898,32 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6861
6898
|
protected getUnbindValue(value: any): any;
|
6862
6899
|
protected isValueSurveyElement(val: any): boolean;
|
6863
6900
|
/*
|
6864
|
-
*
|
6901
|
+
* Returns `true` if a parent element (page or panel) is visible.
|
6865
6902
|
*/
|
6866
6903
|
get isParentVisible(): boolean;
|
6867
6904
|
clearValueIfInvisible(reason?: string): void;
|
6868
6905
|
protected clearValueIfInvisibleCore(): void;
|
6869
6906
|
/*
|
6870
|
-
*
|
6907
|
+
* Specifies when to clear the question value if the question becomes invisible.
|
6871
6908
|
*
|
6872
|
-
*
|
6909
|
+
* Possible values:
|
6873
6910
|
*
|
6874
|
-
* - `default` (default) -
|
6875
|
-
* - `
|
6876
|
-
* - `
|
6877
|
-
* - `
|
6911
|
+
* - `"default"` (default) - Inherits the setting from the Survey's [`clearInvisibleValues`](https://surveyjs.io/form-library/documentation/surveymodel#clearInvisibleValues) property.
|
6912
|
+
* - `"onHidden"` - Clears the value when the question becomes invisible. If a question is invisible on startup and has an initial value, this value will be cleared when the survey is complete.
|
6913
|
+
* - `"onComplete"` - Clears the value when the survey is complete.
|
6914
|
+
* - `"none"` - Never clears the value of an invisible question.
|
6878
6915
|
*/
|
6879
6916
|
get clearIfInvisible(): string;
|
6880
6917
|
set clearIfInvisible(val: string);
|
6881
6918
|
get displayValue(): any;
|
6882
6919
|
/*
|
6883
|
-
*
|
6920
|
+
* Returns a display text that corresponds to the question value. For example, if you call this method for a Dropdown question, it returns an item text instead of an item value.
|
6884
6921
|
*/
|
6885
6922
|
getDisplayValue(keysAsText: boolean, value?: any): any;
|
6886
6923
|
protected getDisplayValueCore(keyAsText: boolean, value: any): any;
|
6887
6924
|
protected getDisplayValueEmpty(): string;
|
6888
6925
|
/*
|
6889
|
-
* A default value for the question. Ignored for question types that cannot have a [value](https://surveyjs.io/
|
6926
|
+
* A default value for the question. Ignored for question types that cannot have a [value](https://surveyjs.io/form-library/documentation/question#value) (for example, HTML).
|
6890
6927
|
*
|
6891
6928
|
* The default value is used as a question value in the following cases:
|
6892
6929
|
*
|
@@ -6897,9 +6934,9 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6897
6934
|
get defaultValue(): any;
|
6898
6935
|
set defaultValue(val: any);
|
6899
6936
|
/*
|
6900
|
-
* An expression used to calculate the [defaultValue](https://surveyjs.io/
|
6937
|
+
* An expression used to calculate the [defaultValue](https://surveyjs.io/form-library/documentation/question#defaultValue).
|
6901
6938
|
*
|
6902
|
-
* This expression applies until the question [value](https://surveyjs.io/
|
6939
|
+
* This expression applies until the question [value](https://surveyjs.io/form-library/documentation/question#value) is specified by an end user or programmatically.
|
6903
6940
|
*
|
6904
6941
|
* An expression can reference other questions as follows:
|
6905
6942
|
*
|
@@ -6907,26 +6944,27 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6907
6944
|
* - `{panel.other_question_name}` (to access questions inside the same dynamic panel)
|
6908
6945
|
* - `{row.other_question_name}` (to access questions inside the same dynamic matrix or multi-column dropdown)
|
6909
6946
|
*
|
6910
|
-
* An expression can also include built-in and custom functions for advanced calculations. For example, if the `defaultValue` should be today's date, set the `defaultValueExpression` to `"today()"`, and the corresponding built-in function will be executed each time the survey is loaded. Refer to the following help topic for more information: [
|
6947
|
+
* An expression can also include built-in and custom functions for advanced calculations. For example, if the `defaultValue` should be today's date, set the `defaultValueExpression` to `"today()"`, and the corresponding built-in function will be executed each time the survey is loaded. Refer to the following help topic for more information: [Built-In Functions](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#built-in-functions).
|
6911
6948
|
*/
|
6912
6949
|
get defaultValueExpression(): any;
|
6913
6950
|
set defaultValueExpression(val: any);
|
6914
6951
|
get resizeStyle(): "none" | "both";
|
6915
6952
|
/*
|
6916
|
-
* Returns question
|
6917
|
-
*
|
6918
|
-
*
|
6953
|
+
* Returns the question value as an object in which the question name, title, value, and other parameters are stored as individual properties.
|
6954
|
+
*
|
6955
|
+
* If the question can have more than one value (Matrix, Multiple Text), the object enables the `isNode` flag and stores information about these values in the `data` property. Refer to the following help topic for more information: [Access Full Survey Results](https://surveyjs.io/form-library/documentation/handle-survey-results-access#access-full-survey-results).
|
6956
|
+
*
|
6957
|
+
* Pass an object with the `includeEmpty` property set to `false` if you want to skip empty answers.
|
6919
6958
|
*/
|
6920
6959
|
getPlainData(options?: any): any;
|
6921
6960
|
/*
|
6922
|
-
*
|
6923
|
-
* Please note, this property is hidden for question without input, for example html question.
|
6961
|
+
* A correct answer to this question. Specify this property if you want to [create a quiz](https://surveyjs.io/form-library/documentation/design-survey-create-a-quiz).
|
6924
6962
|
*/
|
6925
6963
|
get correctAnswer(): any;
|
6926
6964
|
set correctAnswer(val: any);
|
6927
6965
|
protected convertDefaultValue(val: any): any;
|
6928
6966
|
/*
|
6929
|
-
*
|
6967
|
+
* The number of quiz questions. A question counts if it is visible, has an input field, and specifies `correctAnswer`.
|
6930
6968
|
*/
|
6931
6969
|
get quizQuestionCount(): number;
|
6932
6970
|
get correctAnswerCount(): number;
|
@@ -6943,14 +6981,14 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6943
6981
|
protected isValueExpression(val: any): boolean;
|
6944
6982
|
protected setValueAndRunExpression(runner: ExpressionRunner, defaultValue: any, setFunc: (val: any) => void, values?: any, properties?: any): void;
|
6945
6983
|
/*
|
6946
|
-
*
|
6984
|
+
* A comment to the selected question value. Enable the `hasComment` property to allow users to leave comments.
|
6947
6985
|
*/
|
6948
6986
|
get comment(): string;
|
6949
6987
|
set comment(val: string);
|
6950
6988
|
protected getQuestionComment(): string;
|
6951
6989
|
protected setQuestionComment(newValue: string): void;
|
6952
6990
|
/*
|
6953
|
-
* Returns true if the question value is empty
|
6991
|
+
* Returns `true` if the question value is an empty string, array, or object or if it equals `undefined` or `null`.
|
6954
6992
|
*/
|
6955
6993
|
isEmpty(): boolean;
|
6956
6994
|
get isAnswered(): boolean;
|
@@ -6958,8 +6996,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6958
6996
|
protected updateIsAnswered(): void;
|
6959
6997
|
protected getIsAnswered(): boolean;
|
6960
6998
|
/*
|
6961
|
-
*
|
6962
|
-
* Please note, this property is hidden for question without input, for example html question.
|
6999
|
+
* Question validators.
|
6963
7000
|
*/
|
6964
7001
|
get validators(): any;
|
6965
7002
|
set validators(val: any);
|
@@ -6971,21 +7008,12 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
6971
7008
|
* Returns true if there is a validation error(s) in the question.
|
6972
7009
|
*/
|
6973
7010
|
hasErrors(fireCallback?: boolean, rec?: any): boolean;
|
6974
|
-
/*
|
6975
|
-
* Returns the validation errors count.
|
6976
|
-
*/
|
6977
7011
|
get currentErrorCount(): number;
|
6978
7012
|
/*
|
6979
|
-
* Returns
|
7013
|
+
* Returns a character or text string that indicates a required question.
|
6980
7014
|
*/
|
6981
7015
|
get requiredText(): string;
|
6982
|
-
/*
|
6983
|
-
* Add error into the question error list.
|
6984
|
-
*/
|
6985
7016
|
addError(error: string | SurveyError): void;
|
6986
|
-
/*
|
6987
|
-
* Remove a particular error from the question error list.
|
6988
|
-
*/
|
6989
7017
|
removeError(error: SurveyError): void;
|
6990
7018
|
protected canCollectErrors(): boolean;
|
6991
7019
|
protected canRunValidators(isOnValueChanged: boolean): boolean;
|
@@ -7022,13 +7050,16 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
|
|
7022
7050
|
supportGoNextPageAutomatic(): boolean;
|
7023
7051
|
supportGoNextPageError(): boolean;
|
7024
7052
|
/*
|
7025
|
-
*
|
7026
|
-
*
|
7053
|
+
* Removes values that cannot be assigned to this question, for example, choices unlisted in the `choices` array.
|
7054
|
+
*
|
7055
|
+
* Call this method after you assign new question values in code to ensure that they are acceptable.
|
7056
|
+
*
|
7057
|
+
* > NOTE: This method does not remove values that do not pass validation. Call the `hasErrors()` method to validate newly assigned values.
|
7027
7058
|
*/
|
7028
7059
|
clearIncorrectValues(): void;
|
7029
7060
|
clearOnDeletingContainer(): void;
|
7030
7061
|
/*
|
7031
|
-
*
|
7062
|
+
* Empties the `errors` array.
|
7032
7063
|
*/
|
7033
7064
|
clearErrors(): void;
|
7034
7065
|
clearUnusedValues(): void;
|
@@ -7112,7 +7143,7 @@ export declare class SurveyQuestionDropdownBase<T> extends SurveyQuestionUncontr
|
|
7112
7143
|
inputElement: any;
|
7113
7144
|
click: (event: any) => void;
|
7114
7145
|
clear: (event: any) => void;
|
7115
|
-
|
7146
|
+
keyhandler: (event: any) => void;
|
7116
7147
|
blur: (event: any) => void;
|
7117
7148
|
protected setValueCore(newValue: any): void;
|
7118
7149
|
protected getValueCore(): any;
|
@@ -7351,10 +7382,6 @@ export declare class PanelModel extends PanelModelBase implements IElement {
|
|
7351
7382
|
get page(): IPage;
|
7352
7383
|
set page(val: IPage);
|
7353
7384
|
delete(): void;
|
7354
|
-
/*
|
7355
|
-
* Move panel to a new container Page/Panel. Add as a last element if insertBefore parameter is not used or inserted into the given index,
|
7356
|
-
* if insert parameter is number, or before the given element, if the insertBefore parameter is a question or panel
|
7357
|
-
*/
|
7358
7385
|
moveTo(container: IPanel, insertBefore?: any): boolean;
|
7359
7386
|
/*
|
7360
7387
|
* Returns the visible index of the panel in the survey. Commonly it is -1 and it doesn't show.
|
@@ -7764,6 +7791,7 @@ export declare class QuestionFileModel extends Question {
|
|
7764
7791
|
*/
|
7765
7792
|
loadFiles(files: any): void;
|
7766
7793
|
canPreviewImage(fileItem: any): boolean;
|
7794
|
+
protected loadPreview(newValue: any): void;
|
7767
7795
|
protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
|
7768
7796
|
protected onCheckForErrors(errors: any, isOnValueChanged: boolean): void;
|
7769
7797
|
protected stateChanged(state: string): void;
|
@@ -8297,7 +8325,16 @@ export declare class QuestionRatingModel extends Question {
|
|
8297
8325
|
* When the `displayRateDescriptionsAsExtremeItems` property is disabled, the texts defined through the [minRateDescription](https://surveyjs.io/Documentation/Library?id=questionratingmodel#minRateDescription) and [maxRateDescription](https://surveyjs.io/Documentation/Library?id=questionratingmodel#maxRateDescription) properties are displayed as plain non-clickable texts.
|
8298
8326
|
*/
|
8299
8327
|
displayRateDescriptionsAsExtremeItems: boolean;
|
8300
|
-
|
8328
|
+
/*
|
8329
|
+
* Specifies how a Rating question displays rate values.
|
8330
|
+
*
|
8331
|
+
* Possible values:
|
8332
|
+
*
|
8333
|
+
* - `"buttons"` - Displays rate values as buttons in a row.
|
8334
|
+
* - `"dropdown"` - Displays rate values as items in a drop-down list.
|
8335
|
+
* - `"auto"` (default) - Selects between the `"buttons"` and `"dropdown"` modes based on the available width. When the width is insufficient to display buttons, the question displays a dropdown.
|
8336
|
+
*/
|
8337
|
+
displayMode: "dropdown" | "auto" | "buttons";
|
8301
8338
|
protected valueToData(val: any): any;
|
8302
8339
|
/*
|
8303
8340
|
* Click value again to clear.
|
@@ -8476,9 +8513,11 @@ export declare class QuestionSelectBase extends Question {
|
|
8476
8513
|
/*
|
8477
8514
|
* Use this property to set the place holder text for other or comment field .
|
8478
8515
|
*/
|
8516
|
+
get otherPlaceholder(): string;
|
8517
|
+
set otherPlaceholder(val: string);
|
8518
|
+
get locOtherPlaceholder(): LocalizableString;
|
8479
8519
|
get otherPlaceHolder(): string;
|
8480
8520
|
set otherPlaceHolder(val: string);
|
8481
|
-
get locOtherPlaceHolder(): LocalizableString;
|
8482
8521
|
/*
|
8483
8522
|
* The text that shows when the other item is choosed by the other input is empty.
|
8484
8523
|
*/
|
@@ -8511,6 +8550,7 @@ export declare class QuestionSelectBase extends Question {
|
|
8511
8550
|
protected getDisplayValueCore(keysAsText: boolean, value: any): any;
|
8512
8551
|
protected getDisplayValueEmpty(): string;
|
8513
8552
|
protected getChoicesDisplayValue(items: any, val: any): any;
|
8553
|
+
protected getDisplayArrayValue(keysAsText: boolean, value: any, onGetValueCallback?: (index: number) => any): string;
|
8514
8554
|
protected get activeChoices(): any;
|
8515
8555
|
protected getChoicesFromQuestion(question: QuestionSelectBase): Array<ItemValue>;
|
8516
8556
|
protected get hasActiveChoices(): boolean;
|
@@ -8546,6 +8586,7 @@ export declare class QuestionSelectBase extends Question {
|
|
8546
8586
|
* Returns true if item is selected
|
8547
8587
|
*/
|
8548
8588
|
isItemSelected(item: ItemValue): boolean;
|
8589
|
+
protected isItemSelectedCore(item: ItemValue): boolean;
|
8549
8590
|
protected clearIncorrectValuesCore(): void;
|
8550
8591
|
protected canClearValueAnUnknow(val: any): boolean;
|
8551
8592
|
protected clearDisabledValuesCore(): void;
|
@@ -8846,6 +8887,8 @@ export declare class QuestionCustomModel extends QuestionCustomModelBase {
|
|
8846
8887
|
export declare class QuestionDropdownModel extends QuestionSelectBase {
|
8847
8888
|
constructor(name: string);
|
8848
8889
|
dropdownListModel: DropdownListModel;
|
8890
|
+
updateReadOnlyText(): void;
|
8891
|
+
locStrsChanged(): void;
|
8849
8892
|
get showOptionsCaption(): boolean;
|
8850
8893
|
set showOptionsCaption(val: boolean);
|
8851
8894
|
get optionsCaption(): string;
|
@@ -8900,8 +8943,10 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
|
|
8900
8943
|
get cleanButtonCaption(): string;
|
8901
8944
|
set cleanButtonCaption(val: string);
|
8902
8945
|
get locCleanButtonCaption(): LocalizableString;
|
8946
|
+
inputHasValue: boolean;
|
8947
|
+
readOnlyText: string;
|
8903
8948
|
getControlClass(): string;
|
8904
|
-
get
|
8949
|
+
get selectedItemLocText(): LocalizableString;
|
8905
8950
|
get popupModel(): any;
|
8906
8951
|
onOpened: EventBase<QuestionDropdownModel>;
|
8907
8952
|
onOpenedCallBack(): void;
|
@@ -9468,7 +9513,7 @@ export declare class QuestionCheckboxModel extends QuestionCheckboxBase {
|
|
9468
9513
|
/*
|
9469
9514
|
* Returns true if item is checked
|
9470
9515
|
*/
|
9471
|
-
|
9516
|
+
isItemSelectedCore(item: ItemValue): boolean;
|
9472
9517
|
/*
|
9473
9518
|
* Set this property different to 0 to limit the number of selected choices in the checkbox.
|
9474
9519
|
*/
|
@@ -9537,6 +9582,7 @@ export declare class QuestionImagePickerModel extends QuestionCheckboxBase {
|
|
9537
9582
|
*/
|
9538
9583
|
isItemSelected(item: ItemValue): boolean;
|
9539
9584
|
clearIncorrectValues(): void;
|
9585
|
+
protected getDisplayValueCore(keysAsText: boolean, value: any): any;
|
9540
9586
|
/*
|
9541
9587
|
* Show label under the image.
|
9542
9588
|
*/
|
@@ -9934,6 +9980,7 @@ export declare var settings: {
|
|
9934
9980
|
trimStrings: boolean,
|
9935
9981
|
caseSensitive: boolean,
|
9936
9982
|
},
|
9983
|
+
expressionDisableConversionChar: string,
|
9937
9984
|
/*
|
9938
9985
|
* Set this value to false, if you want to have UTC fuctions, for example setUTCHours inside our functions, like today.
|
9939
9986
|
* By default it uses setHours function, with local date
|
@@ -10031,6 +10078,10 @@ export declare var settings: {
|
|
10031
10078
|
*/
|
10032
10079
|
executeCompleteTriggerOnValueChanged: boolean,
|
10033
10080
|
/*
|
10081
|
+
* Set this property to false to stop showing "Compete" button when the complete trigger is going to be executed.
|
10082
|
+
*/
|
10083
|
+
changeNavigationButtonsOnCompleteTrigger: boolean,
|
10084
|
+
/*
|
10034
10085
|
* Set this property to false to execute the skip trigger on next page instead of on value change.
|
10035
10086
|
*/
|
10036
10087
|
executeSkipTriggerOnValueChanged: boolean,
|
@@ -10167,6 +10218,8 @@ export declare var defaultListCss: {
|
|
10167
10218
|
itemDisabled: string,
|
10168
10219
|
itemFocused: string,
|
10169
10220
|
itemIcon: string,
|
10221
|
+
itemSeparator: string,
|
10222
|
+
itemBody: string,
|
10170
10223
|
itemsContainer: string,
|
10171
10224
|
filter: string,
|
10172
10225
|
filterIcon: string,
|
@@ -11748,6 +11801,7 @@ export declare var defaultV2Css: {
|
|
11748
11801
|
list: {
|
11749
11802
|
root: string,
|
11750
11803
|
item: string,
|
11804
|
+
itemBody: string,
|
11751
11805
|
itemSelected: string,
|
11752
11806
|
},
|
11753
11807
|
actionBar: {
|