survey-react 1.9.43 → 1.9.46

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/survey.react.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  /*
2
- * Type definition for Survey JavaScript library for React v1.9.43
2
+ * Type definition for Survey JavaScript library for React v1.9.46
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
  */
@@ -92,6 +92,47 @@ export interface IExpresionExecutor {
92
92
  */
93
93
  onComplete: (res: any) => void;
94
94
  }
95
+ export interface IListModel {
96
+ items: any;
97
+ onSelectionChanged: (item: Action, ...params: any) => void;
98
+ allowSelection?: boolean;
99
+ selectedItem?: IAction;
100
+ onFilteredTextChangedCallback?: (text: string) => void;
101
+ }
102
+ export interface IPosition {
103
+ left?: string | number;
104
+ top?: string | number;
105
+ }
106
+ export interface INumberPosition extends IPosition {
107
+ left?: number;
108
+ top?: number;
109
+ }
110
+ export interface ISize {
111
+ width: number;
112
+ height: number;
113
+ }
114
+ export interface IPopupOptionsBase {
115
+ onHide?: any;
116
+ onShow?: any;
117
+ onApply?: any;
118
+ onCancel?: any;
119
+ cssClass?: string;
120
+ title?: string;
121
+ verticalPosition?: any;
122
+ horizontalPosition?: any;
123
+ showPointer?: boolean;
124
+ isModal?: boolean;
125
+ displayMode?: "popup" | "overlay";
126
+ }
127
+ export interface IDialogOptions extends IPopupOptionsBase {
128
+ componentName: string;
129
+ data: any;
130
+ onApply: any;
131
+ }
132
+ export interface IPopupModel<T = any> extends IDialogOptions {
133
+ contentComponentName: string;
134
+ contentComponentData: T;
135
+ }
95
136
  /*
96
137
  * An action item.
97
138
  * Action items are used in the Toolbar, matrix rows, titles of pages, panels, questions, and other survey elements.
@@ -189,6 +230,8 @@ export interface IAction {
189
230
  visibleIndex?: number;
190
231
  needSpace?: boolean;
191
232
  }
233
+ export interface IActionDropdownPopupOptions extends IListModel, IPopupOptionsBase {
234
+ }
192
235
  export interface IAttachKey2clickOptions {
193
236
  processEsc?: boolean;
194
237
  disableTabStop?: boolean;
@@ -197,29 +240,6 @@ export interface IDimensions {
197
240
  scroll: number;
198
241
  offset: number;
199
242
  }
200
- export interface IPosition {
201
- left?: string | number;
202
- top?: string | number;
203
- }
204
- export interface INumberPosition extends IPosition {
205
- left?: number;
206
- top?: number;
207
- }
208
- export interface ISize {
209
- width: number;
210
- height: number;
211
- }
212
- export interface IDialogOptions {
213
- componentName: string;
214
- data: any;
215
- onApply: any;
216
- onCancel?: any;
217
- onHide?: any;
218
- onShow?: any;
219
- cssClass?: string;
220
- title?: string;
221
- displayMode?: "popup" | "overlay";
222
- }
223
243
  export interface ISurveyTriggerOwner {
224
244
  getObjects(pages: any, questions: any): Array<any>;
225
245
  setCompleted(): void;
@@ -379,8 +399,9 @@ export interface ISurvey extends ITextProcessor, ISurveyErrorOwner {
379
399
  isValidateOnValueChanging: boolean;
380
400
  isValidateOnValueChanged: boolean;
381
401
  matrixCellValidate(question: IQuestion, options: any): SurveyError;
382
- dynamicPanelAdded(question: IQuestion, panelIndex?: number, panel?: IPanel): any;
383
- dynamicPanelRemoved(question: IQuestion, panelIndex: number, panel: IPanel): any;
402
+ dynamicPanelAdded(question: IQuestion, panelIndex?: number, panel?: IPanel): void;
403
+ dynamicPanelRemoved(question: IQuestion, panelIndex: number, panel: IPanel): void;
404
+ dynamicPanelRemoving(question: IQuestion, panelIndex: number, panel: IPanel): boolean;
384
405
  dynamicPanelItemValueChanged(question: IQuestion, options: any): any;
385
406
  dragAndDropAllow(options: any): boolean;
386
407
  scrollElementToTop(element: ISurveyElement, question: IQuestion, page: IPage, id: string): any;
@@ -589,7 +610,7 @@ export interface ICustomQuestionTypeConfiguration {
589
610
  */
590
611
  onCreated(question: Question): void;
591
612
  /*
592
- * A function that is called when JSON definitions are loaded.
613
+ * A function that is called when JSON schemas are loaded.
593
614
  *
594
615
  * Parameters:
595
616
  *
@@ -652,7 +673,7 @@ export interface ICustomQuestionTypeConfiguration {
652
673
  */
653
674
  getDisplayValue?: any;
654
675
  /*
655
- * JSON definitions of nested questions. Specify this property to create a [composite question type](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types).
676
+ * JSON schemas of nested questions. Specify this property to create a [composite question type](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types).
656
677
  */
657
678
  elementsJSON?: any;
658
679
  /*
@@ -660,7 +681,7 @@ export interface ICustomQuestionTypeConfiguration {
660
681
  */
661
682
  createElements?: any;
662
683
  /*
663
- * A JSON definition for a built-in question type on which the custom question type is based.
684
+ * A JSON schema for a built-in question type on which the custom question type is based.
664
685
  *
665
686
  * Refer to the [Create Specialized Question Types](https://surveyjs.io/Documentation/Survey-Creator?id=create-specialized-question-types) help topic for more information.
666
687
  */
@@ -772,28 +793,7 @@ export declare class Base {
772
793
  protected addEvent<T>(): EventBase<T>;
773
794
  protected onBaseCreating(): void;
774
795
  /*
775
- * Returns the question type.
776
- * Possible values:
777
- * - [*"boolean"*](https://surveyjs.io/Documentation/Library?id=questionbooleanmodel)
778
- * - [*"checkbox"*](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel)
779
- * - [*"comment"*](https://surveyjs.io/Documentation/Library?id=questioncommentmodel)
780
- * - [*"dropdown"*](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel)
781
- * - [*"expression"*](https://surveyjs.io/Documentation/Library?id=questionexpressionmodel)
782
- * - [*"file"*](https://surveyjs.io/Documentation/Library?id=questionfilemodel)
783
- * - [*"html"*](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel)
784
- * - [*"image"*](https://surveyjs.io/Documentation/Library?id=questionimagemodel)
785
- * - [*"imagepicker"*](https://surveyjs.io/Documentation/Library?id=questionimagepickermodel)
786
- * - [*"matrix"*](https://surveyjs.io/Documentation/Library?id=questionmatrixmodel)
787
- * - [*"matrixdropdown"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdropdownmodel)
788
- * - [*"matrixdynamic"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdynamicmodel)
789
- * - [*"multipletext"*](https://surveyjs.io/Documentation/Library?id=questionmultipletextmodel)
790
- * - [*"panel"*](https://surveyjs.io/Documentation/Library?id=panelmodel)
791
- * - [*"paneldynamic"*](https://surveyjs.io/Documentation/Library?id=questionpaneldynamicmodel)
792
- * - [*"radiogroup"*](https://surveyjs.io/Documentation/Library?id=questionradiogroupmodel)
793
- * - [*"rating"*](https://surveyjs.io/Documentation/Library?id=questionratingmodel)
794
- * - [*"ranking"*](https://surveyjs.io/Documentation/Library?id=questionrankingmodel)
795
- * - [*"signaturepad"*](https://surveyjs.io/Documentation/Library?id=questionsignaturepadmodel)
796
- * - [*"text"*](https://surveyjs.io/Documentation/Library?id=questiontextmodel)
796
+ * Returns the class type as it is used in the JSON schema.
797
797
  */
798
798
  getType(): string;
799
799
  /*
@@ -1018,6 +1018,7 @@ export declare class CustomPropertiesCollection {
1018
1018
  static parentClasses: any;
1019
1019
  static addProperty(className: string, property: any): void;
1020
1020
  static removeProperty(className: string, propertyName: string): void;
1021
+ static removeAllProperties(className: string): void;
1021
1022
  static addClass(className: string, parentClassName: string): void;
1022
1023
  static getProperties(className: string): Array<any>;
1023
1024
  static createProperties(obj: any): void;
@@ -1199,8 +1200,10 @@ export declare class JsonMetadataClass {
1199
1200
  static requiredSymbol: string;
1200
1201
  static typeSymbol: string;
1201
1202
  properties: any;
1203
+ isCustomValue: boolean;
1202
1204
  find(name: string): JsonObjectProperty;
1203
- createProperty(propInfo: any): JsonObjectProperty;
1205
+ get isCustom(): boolean;
1206
+ createProperty(propInfo: any, isCustom?: boolean): JsonObjectProperty;
1204
1207
  }
1205
1208
  export declare class JsonObject {
1206
1209
  static typePropertyName: string;
@@ -1335,6 +1338,7 @@ export declare class QuestionMatrixDropdownRenderedCell {
1335
1338
  question: Question;
1336
1339
  isRemoveRow: boolean;
1337
1340
  choiceIndex: number;
1341
+ isOtherChoice: boolean;
1338
1342
  matrix: QuestionMatrixDropdownModelBase;
1339
1343
  requiredText: string;
1340
1344
  isEmpty: boolean;
@@ -1353,8 +1357,10 @@ export declare class QuestionMatrixDropdownRenderedCell {
1353
1357
  get item(): ItemValue;
1354
1358
  set item(val: ItemValue);
1355
1359
  get isChoice(): boolean;
1360
+ get isItemChoice(): boolean;
1356
1361
  get choiceValue(): any;
1357
1362
  get isCheckbox(): boolean;
1363
+ get isRadio(): boolean;
1358
1364
  get isFirstChoice(): boolean;
1359
1365
  get className(): string;
1360
1366
  get headers(): string;
@@ -1676,14 +1682,21 @@ export declare class Action extends Base implements IAction {
1676
1682
  minDimension: number;
1677
1683
  maxDimension: number;
1678
1684
  }
1679
- export declare class ActionContainer<T extends Action = Action> extends Base {
1685
+ export declare class ActionContainer<T extends Action = Action> extends Base implements ILocalizableOwner {
1680
1686
  constructor();
1687
+ getMarkdownHtml(text: string, name: string): string;
1688
+ getRenderer(name: string): string;
1689
+ getRendererContext(locStr: LocalizableString): any;
1690
+ getProcessedText(text: string): string;
1691
+ getLocale(): string;
1681
1692
  actions: any;
1682
1693
  cssClassesValue: any;
1683
1694
  protected getRenderedActions(): Array<T>;
1684
1695
  updateCallback: (isResetInitialized: boolean) => void;
1685
1696
  containerCss: string;
1686
1697
  sizeMode: "default" | "small";
1698
+ locOwner: ILocalizableOwner;
1699
+ isEmpty: boolean;
1687
1700
  protected raiseUpdate(isResetInitialized: boolean): void;
1688
1701
  protected onSet(): void;
1689
1702
  protected onPush(item: T): void;
@@ -1778,8 +1791,22 @@ export declare class CalculatedValue extends Base {
1778
1791
  protected setValue(val: any): void;
1779
1792
  }
1780
1793
  /*
1781
- * A definition for filling choices for checkbox, dropdown and radiogroup questions from resfull services.
1782
- * The run method call a restful service and results can be get on getResultCallback.
1794
+ * Configures access to a RESTful service that returns choices for [Checkbox](https://surveyjs.io/Examples/Library?id=questiontype-checkbox), [Dropdown](https://surveyjs.io/Examples/Library?id=questiontype-dropdown), [Radiogroup](https://surveyjs.io/Examples/Library?id=questiontype-radiogroup), and other multiple-choice question types.
1795
+ *
1796
+ * Use the following properties to configure this object:
1797
+ *
1798
+ * ```js
1799
+ * {
1800
+ * url: "http://...", // A RESTful service's URL.
1801
+ * valueName: "value", // Specifies which field contains choice values.
1802
+ * titleName: "title", // Specifies which field contains display texts for choice values.
1803
+ * imageLinkName: "imageUrl", // Specifies which field contains image URLs. Used in Image Picker questions.
1804
+ * // Path to the array of choices. Specify `path` only if the array of choices is nested within the object returned by the service.
1805
+ * path: "myNestedArray"
1806
+ * }
1807
+ * ```
1808
+ *
1809
+ * Typically, you should assign this object to a question's [`choicesByUrl`](https://surveyjs.io/Documentation/Library?id=QuestionSelectBase#choicesByUrl) property.
1783
1810
  */
1784
1811
  export declare class ChoicesRestful extends Base {
1785
1812
  constructor();
@@ -1819,29 +1846,49 @@ export declare class ChoicesRestful extends Base {
1819
1846
  setData(json: any): void;
1820
1847
  getData(): any;
1821
1848
  /*
1822
- * Gets or sets a link to a web service. You can use text preprocessing here.
1823
- * For example, the following url: _https://surveyjs.io/api/CountriesExample?region={region}_ is changed based on the _region_ question's value.
1824
- * SurveyJS automatically gets data from the web service when the value of the _region_ question changes.
1849
+ * A RESTful service's URL.
1850
+ *
1851
+ * This property supports [dynamic URLs](https://surveyjs.io/Documentation/Library?id=design-survey-conditional-logic#dynamic-texts). For example, the URL below depends on the `region` question's value. When the value changes, the survey automatically loads a new dataset that corresponds to the selected region.
1852
+ *
1853
+ * ```js
1854
+ * url: "https://surveyjs.io/api/CountriesExample?region={region}"
1855
+ * ```
1856
+ *
1857
+ * [View Example](https://surveyjs.io/Examples/Library/?id=questiontype-dropdownrestfull (linkStyle))
1825
1858
  */
1826
1859
  get url(): string;
1827
1860
  set url(val: string);
1828
1861
  /*
1829
- * Use this property, if a web service returns a lot of information and you need only a part of it.
1830
- * For example, a web service returns a list of countries and a list of capitals.
1831
- * If you need a list of countries, set a correct path from which SurveyJS obtains the data, like: _DataList1\DataList2_
1862
+ * Path to the array of choices.
1863
+ *
1864
+ * Specify this property only if the array of choices is nested within the object returned by the service. For example, the service returns the following object:
1865
+ *
1866
+ * ```js
1867
+ * {
1868
+ * countries: [ ... ],
1869
+ * capitals: [ ... ]
1870
+ * }
1871
+ * ```
1872
+ *
1873
+ * To populate choices with values from the `countries` array, set the `path` property to `"countries"`. To use the `capitals` array, set this property to `"capitals"`.
1832
1874
  */
1833
1875
  get path(): string;
1834
1876
  set path(val: string);
1835
1877
  /*
1836
- * Gets or sets the name of a property (in the obtained data object) to which SurveyJS binds to provide values for choice items.
1878
+ * Specifies which property in the obtained data object contains choice values.
1879
+ *
1880
+ * [View Example](https://surveyjs.io/Examples/Library/?id=questiontype-dropdownrestfull (linkStyle))
1837
1881
  */
1838
1882
  get valueName(): string;
1839
1883
  set valueName(val: string);
1840
1884
  /*
1841
- * Gets or sets the name of a property (in the obtained data object) to which SurveyJS binds to provide display texts for choice items.
1885
+ * Specifies which property in the obtained data object contains display texts for choices.
1842
1886
  */
1843
1887
  get titleName(): string;
1844
1888
  set titleName(val: string);
1889
+ /*
1890
+ * Specifies which property in the obtained data object contains image URLs. Used only in [Image Picker](https://surveyjs.io/Examples/Library?id=questiontype-imagepicker) questions.
1891
+ */
1845
1892
  get imageLinkName(): string;
1846
1893
  set imageLinkName(val: string);
1847
1894
  get allowEmptyResponse(): boolean;
@@ -1933,7 +1980,9 @@ export declare class DragDropCore<T> extends Base {
1933
1980
  export declare class DropdownListModel extends Base {
1934
1981
  constructor(question: Question, onSelectionChanged?: (item: IAction, ...params: any) => void);
1935
1982
  _popupModel: any;
1983
+ focusFirstInputSelector: string;
1936
1984
  protected listModel: ListModel;
1985
+ protected popupCssClasses: string;
1937
1986
  protected getAvailableItems(): Array<Action>;
1938
1987
  protected createListModel(): ListModel;
1939
1988
  get popupModel(): any;
@@ -2198,6 +2247,7 @@ export declare class List extends SurveyElementBase<IListProps, any> {
2198
2247
  renderElement(): JSX.Element;
2199
2248
  renderItems(): any;
2200
2249
  searchElementContent(): JSX.Element;
2250
+ emptyContent(): JSX.Element;
2201
2251
  }
2202
2252
  export declare class ListItem extends SurveyElementBase<IListItemProps, any> {
2203
2253
  constructor(props: any);
@@ -2552,6 +2602,9 @@ export declare class MultipleTextItemModel extends Base implements IValidatorOwn
2552
2602
  /*
2553
2603
  * The input place holder.
2554
2604
  */
2605
+ get placeholder(): string;
2606
+ set placeholder(val: string);
2607
+ get locPlaceholder(): LocalizableString;
2555
2608
  get placeHolder(): string;
2556
2609
  set placeHolder(val: string);
2557
2610
  get locPlaceHolder(): LocalizableString;
@@ -2678,6 +2731,7 @@ export declare class PopupContainer extends SurveyElementBase<any, any> {
2678
2731
  export declare class PopupModel<T = any> extends Base {
2679
2732
  constructor(contentComponentName: string, contentComponentData: T, verticalPosition?: any, horizontalPosition?: any, showPointer?: boolean, isModal?: boolean, onCancel?: any, onApply?: any, onHide?: any, onShow?: any, cssClass?: string, title?: string);
2680
2733
  width: number;
2734
+ focusFirstInputSelector: string;
2681
2735
  contentComponentName: string;
2682
2736
  contentComponentData: T;
2683
2737
  verticalPosition: any;
@@ -3216,12 +3270,12 @@ export declare class WebRequestError extends SurveyError {
3216
3270
  export declare class AdaptiveActionContainer<T extends Action = Action> extends ActionContainer<T> {
3217
3271
  constructor();
3218
3272
  protected dotsItem: Action;
3219
- protected dotsItemPopupModel: any;
3220
3273
  responsivityManager: ResponsivityManager;
3221
3274
  minVisibleItemsCount: number;
3222
3275
  isResponsivenessDisabled: boolean;
3223
- protected invisibleItemsListModel: ListModel;
3224
3276
  static ContainerID: number;
3277
+ get hiddenItemsListModel(): ListModel;
3278
+ protected hiddenItemSelected(item: T): void;
3225
3279
  protected onSet(): void;
3226
3280
  protected onPush(item: T): void;
3227
3281
  protected getRenderedActions(): Array<T>;
@@ -3346,6 +3400,7 @@ export declare class DropdownMultiSelectListModel extends DropdownListModel {
3346
3400
  selectItem(id: string): void;
3347
3401
  deselectItem(id: string): void;
3348
3402
  onClear(event: any): void;
3403
+ setHideSelectedItems(newValue: boolean): void;
3349
3404
  }
3350
3405
  /*
3351
3406
  * Validate e-mail address in the text input
@@ -3424,6 +3479,7 @@ export declare class ListModel extends ActionContainer {
3424
3479
  allowSelection: boolean;
3425
3480
  searchEnabled: boolean;
3426
3481
  needFilter: boolean;
3482
+ isEmpty: boolean;
3427
3483
  isExpanded: boolean;
3428
3484
  selectedItem: IAction;
3429
3485
  filteredText: string;
@@ -3431,12 +3487,14 @@ export declare class ListModel extends ActionContainer {
3431
3487
  static MINELEMENTCOUNT: number;
3432
3488
  isItemVisible(item: Action): boolean;
3433
3489
  protected onSet(): void;
3490
+ protected updateItemActiveState(): void;
3434
3491
  onItemClick: (itemValue: Action) => void;
3435
3492
  isItemDisabled: (itemValue: Action) => boolean;
3436
3493
  isItemSelected: (itemValue: Action) => boolean;
3437
3494
  getItemClass: (itemValue: Action) => string;
3438
3495
  getItemIndent: (itemValue: any) => string;
3439
3496
  get filteredTextPlaceholder(): string;
3497
+ get emptyMessage(): string;
3440
3498
  goToItems(event: any): void;
3441
3499
  onKeyDown(event: any): void;
3442
3500
  onPointerDown(event: any, item: any): void;
@@ -4330,6 +4388,15 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
4330
4388
  */
4331
4389
  onDynamicPanelRemoved: EventBase<SurveyModel>;
4332
4390
  /*
4391
+ * The event is fired before removing a panel from Panel Dynamic question. You can disable removing and optionally clear the data instead.
4392
+ * - `sender` - the survey object that fires the event.
4393
+ * - `options.question` - a panel question.
4394
+ * - `options.panelIndex` - a removed panel index.
4395
+ * - `options.panel` - a removed panel.
4396
+ * - `options.allow` - a boolean property. Set it to `false` to disable the panel removing.
4397
+ */
4398
+ onDynamicPanelRemoving: EventBase<SurveyModel>;
4399
+ /*
4333
4400
  * The event is fired every second if the method `startTimer` has been called.
4334
4401
  */
4335
4402
  onTimer: EventBase<SurveyModel>;
@@ -5300,6 +5367,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5300
5367
  matrixCellValidate(question: IQuestion, options: any): SurveyError;
5301
5368
  dynamicPanelAdded(question: IQuestion, panelIndex?: number, panel?: IPanel): void;
5302
5369
  dynamicPanelRemoved(question: IQuestion, panelIndex: number, panel: IPanel): void;
5370
+ dynamicPanelRemoving(question: IQuestion, panelIndex: number, panel: IPanel): boolean;
5303
5371
  dynamicPanelItemValueChanged(question: IQuestion, options: any): void;
5304
5372
  dragAndDropAllow(options: any): boolean;
5305
5373
  elementContentVisibilityChanged(element: ISurveyElement): void;
@@ -5552,6 +5620,11 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
5552
5620
  set widthMode(val: string);
5553
5621
  calculatedWidthMode: string;
5554
5622
  calculateWidthMode(): string;
5623
+ /*
5624
+ * Gets or sets the width of the survey root element. It is empty by default. Use it to limit survey width to a particular value.
5625
+ */
5626
+ get width(): string;
5627
+ set width(val: string);
5555
5628
  get timerInfoText(): string;
5556
5629
  get timerModel(): SurveyTimerModel;
5557
5630
  /*
@@ -6042,6 +6115,7 @@ export declare class DragDropRankingChoices extends DragDropChoices {
6042
6115
  export declare class MultiSelectListModel extends ListModel {
6043
6116
  constructor(items: any, onSelectionChanged: (item: Action, status: string) => void, allowSelection: boolean, selectedItems?: any, onFilteredTextChangedCallback?: (text: string) => void);
6044
6117
  selectedItems: any;
6118
+ hideSelectedItems: boolean;
6045
6119
  onItemClick: (item: Action) => void;
6046
6120
  isItemDisabled: (itemValue: Action) => boolean;
6047
6121
  isItemSelected: (itemValue: Action) => boolean;
@@ -6060,28 +6134,7 @@ export declare class PanelModelBase extends SurveyElement implements IPanel, ICo
6060
6134
  removeElementCallback: (element: IElement) => void;
6061
6135
  onGetQuestionTitleLocation: any;
6062
6136
  /*
6063
- * Returns the question type.
6064
- * Possible values:
6065
- * - [*"boolean"*](https://surveyjs.io/Documentation/Library?id=questionbooleanmodel)
6066
- * - [*"checkbox"*](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel)
6067
- * - [*"comment"*](https://surveyjs.io/Documentation/Library?id=questioncommentmodel)
6068
- * - [*"dropdown"*](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel)
6069
- * - [*"expression"*](https://surveyjs.io/Documentation/Library?id=questionexpressionmodel)
6070
- * - [*"file"*](https://surveyjs.io/Documentation/Library?id=questionfilemodel)
6071
- * - [*"html"*](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel)
6072
- * - [*"image"*](https://surveyjs.io/Documentation/Library?id=questionimagemodel)
6073
- * - [*"imagepicker"*](https://surveyjs.io/Documentation/Library?id=questionimagepickermodel)
6074
- * - [*"matrix"*](https://surveyjs.io/Documentation/Library?id=questionmatrixmodel)
6075
- * - [*"matrixdropdown"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdropdownmodel)
6076
- * - [*"matrixdynamic"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdynamicmodel)
6077
- * - [*"multipletext"*](https://surveyjs.io/Documentation/Library?id=questionmultipletextmodel)
6078
- * - [*"panel"*](https://surveyjs.io/Documentation/Library?id=panelmodel)
6079
- * - [*"paneldynamic"*](https://surveyjs.io/Documentation/Library?id=questionpaneldynamicmodel)
6080
- * - [*"radiogroup"*](https://surveyjs.io/Documentation/Library?id=questionradiogroupmodel)
6081
- * - [*"rating"*](https://surveyjs.io/Documentation/Library?id=questionratingmodel)
6082
- * - [*"ranking"*](https://surveyjs.io/Documentation/Library?id=questionrankingmodel)
6083
- * - [*"signaturepad"*](https://surveyjs.io/Documentation/Library?id=questionsignaturepadmodel)
6084
- * - [*"text"*](https://surveyjs.io/Documentation/Library?id=questiontextmodel)
6137
+ * Returns the class type as it is used in the JSON schema.
6085
6138
  */
6086
6139
  getType(): string;
6087
6140
  setSurveyImpl(value: ISurveyImpl, isLight?: boolean): void;
@@ -6443,7 +6496,28 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6443
6496
  */
6444
6497
  get isAllowTitleLeft(): boolean;
6445
6498
  /*
6446
- * Returns the type of the object as a string as it represents in the json.
6499
+ * Returns the question type.
6500
+ * Possible values:
6501
+ * - [*"boolean"*](https://surveyjs.io/Documentation/Library?id=questionbooleanmodel)
6502
+ * - [*"checkbox"*](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel)
6503
+ * - [*"comment"*](https://surveyjs.io/Documentation/Library?id=questioncommentmodel)
6504
+ * - [*"dropdown"*](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel)
6505
+ * - [*"expression"*](https://surveyjs.io/Documentation/Library?id=questionexpressionmodel)
6506
+ * - [*"file"*](https://surveyjs.io/Documentation/Library?id=questionfilemodel)
6507
+ * - [*"html"*](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel)
6508
+ * - [*"image"*](https://surveyjs.io/Documentation/Library?id=questionimagemodel)
6509
+ * - [*"imagepicker"*](https://surveyjs.io/Documentation/Library?id=questionimagepickermodel)
6510
+ * - [*"matrix"*](https://surveyjs.io/Documentation/Library?id=questionmatrixmodel)
6511
+ * - [*"matrixdropdown"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdropdownmodel)
6512
+ * - [*"matrixdynamic"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdynamicmodel)
6513
+ * - [*"multipletext"*](https://surveyjs.io/Documentation/Library?id=questionmultipletextmodel)
6514
+ * - [*"panel"*](https://surveyjs.io/Documentation/Library?id=panelmodel)
6515
+ * - [*"paneldynamic"*](https://surveyjs.io/Documentation/Library?id=questionpaneldynamicmodel)
6516
+ * - [*"radiogroup"*](https://surveyjs.io/Documentation/Library?id=questionradiogroupmodel)
6517
+ * - [*"rating"*](https://surveyjs.io/Documentation/Library?id=questionratingmodel)
6518
+ * - [*"ranking"*](https://surveyjs.io/Documentation/Library?id=questionrankingmodel)
6519
+ * - [*"signaturepad"*](https://surveyjs.io/Documentation/Library?id=questionsignaturepadmodel)
6520
+ * - [*"text"*](https://surveyjs.io/Documentation/Library?id=questiontextmodel)
6447
6521
  */
6448
6522
  getType(): string;
6449
6523
  get isQuestion(): boolean;
@@ -6637,6 +6711,9 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
6637
6711
  set id(val: string);
6638
6712
  get ariaTitleId(): string;
6639
6713
  get ariaRole(): string;
6714
+ /*
6715
+ * Specifies whether to display the "Other" choice item.
6716
+ */
6640
6717
  get hasOther(): boolean;
6641
6718
  set hasOther(val: boolean);
6642
6719
  protected hasOtherChanged(): void;
@@ -8211,7 +8288,10 @@ export declare class QuestionSelectBase extends Question {
8211
8288
  protected getHasOther(val: any): boolean;
8212
8289
  get validatedValue(): any;
8213
8290
  protected createRestful(): ChoicesRestful;
8291
+ get autoOtherMode(): boolean;
8292
+ set autoOtherMode(val: boolean);
8214
8293
  protected getQuestionComment(): string;
8294
+ protected selectOtherValueFromComment(val: boolean): void;
8215
8295
  isSettingComment: boolean;
8216
8296
  protected setQuestionComment(newValue: string): void;
8217
8297
  clearValue(): void;
@@ -8464,6 +8544,9 @@ export declare class QuestionTextBase extends Question {
8464
8544
  /*
8465
8545
  * Use this property to set the input place holder.
8466
8546
  */
8547
+ get placeholder(): string;
8548
+ set placeholder(val: string);
8549
+ get locPlaceholder(): LocalizableString;
8467
8550
  get placeHolder(): string;
8468
8551
  set placeHolder(val: string);
8469
8552
  get locPlaceHolder(): LocalizableString;
@@ -8482,12 +8565,12 @@ export declare class QuestionTextBase extends Question {
8482
8565
  get textUpdateMode(): string;
8483
8566
  set textUpdateMode(val: string);
8484
8567
  get isSurveyInputTextUpdate(): boolean;
8485
- get renderedPlaceHolder(): string;
8486
- protected setRenderedPlaceHolder(val: string): void;
8568
+ get renderedPlaceholder(): string;
8569
+ protected setRenderedPlaceholder(val: string): void;
8487
8570
  protected onReadOnlyChanged(): void;
8488
8571
  onSurveyLoad(): void;
8489
8572
  localeChanged(): void;
8490
- protected calcRenderedPlaceHolder(): void;
8573
+ protected calcRenderedPlaceholder(): void;
8491
8574
  protected hasPlaceHolder(): boolean;
8492
8575
  getControlClass(): string;
8493
8576
  get ariaRole(): string;
@@ -8800,7 +8883,28 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
8800
8883
  onRemoveColumn: (column: MatrixDropdownColumn) => void;
8801
8884
  protected createColumnValues(): any;
8802
8885
  /*
8803
- * Returns the type of the object as a string as it represents in the json.
8886
+ * Returns the question type.
8887
+ * Possible values:
8888
+ * - [*"boolean"*](https://surveyjs.io/Documentation/Library?id=questionbooleanmodel)
8889
+ * - [*"checkbox"*](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel)
8890
+ * - [*"comment"*](https://surveyjs.io/Documentation/Library?id=questioncommentmodel)
8891
+ * - [*"dropdown"*](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel)
8892
+ * - [*"expression"*](https://surveyjs.io/Documentation/Library?id=questionexpressionmodel)
8893
+ * - [*"file"*](https://surveyjs.io/Documentation/Library?id=questionfilemodel)
8894
+ * - [*"html"*](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel)
8895
+ * - [*"image"*](https://surveyjs.io/Documentation/Library?id=questionimagemodel)
8896
+ * - [*"imagepicker"*](https://surveyjs.io/Documentation/Library?id=questionimagepickermodel)
8897
+ * - [*"matrix"*](https://surveyjs.io/Documentation/Library?id=questionmatrixmodel)
8898
+ * - [*"matrixdropdown"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdropdownmodel)
8899
+ * - [*"matrixdynamic"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdynamicmodel)
8900
+ * - [*"multipletext"*](https://surveyjs.io/Documentation/Library?id=questionmultipletextmodel)
8901
+ * - [*"panel"*](https://surveyjs.io/Documentation/Library?id=panelmodel)
8902
+ * - [*"paneldynamic"*](https://surveyjs.io/Documentation/Library?id=questionpaneldynamicmodel)
8903
+ * - [*"radiogroup"*](https://surveyjs.io/Documentation/Library?id=questionradiogroupmodel)
8904
+ * - [*"rating"*](https://surveyjs.io/Documentation/Library?id=questionratingmodel)
8905
+ * - [*"ranking"*](https://surveyjs.io/Documentation/Library?id=questionrankingmodel)
8906
+ * - [*"signaturepad"*](https://surveyjs.io/Documentation/Library?id=questionsignaturepadmodel)
8907
+ * - [*"text"*](https://surveyjs.io/Documentation/Library?id=questiontextmodel)
8804
8908
  */
8805
8909
  getType(): string;
8806
8910
  dispose(): void;
@@ -9289,6 +9393,7 @@ export declare class QuestionCheckboxModel extends QuestionCheckboxBase {
9289
9393
  protected convertValueToObject(val: any): any;
9290
9394
  protected renderedValueFromDataCore(val: any): any;
9291
9395
  protected rendredValueToDataCore(val: any): any;
9396
+ protected selectOtherValueFromComment(val: boolean): void;
9292
9397
  get checkBoxSvgPath(): string;
9293
9398
  }
9294
9399
  /*
@@ -9622,6 +9727,7 @@ export declare class QuestionRankingModel extends QuestionCheckboxModel {
9622
9727
  handleArrowDown: (index: number, choice: ItemValue) => void;
9623
9728
  focusItem: (index: number) => void;
9624
9729
  setValue: any;
9730
+ protected getChoicesFromQuestion(question: QuestionSelectBase): Array<ItemValue>;
9625
9731
  setValueFromUI: any;
9626
9732
  syncNumbers: any;
9627
9733
  setGhostText: (text: string) => void;
@@ -9649,6 +9755,7 @@ export declare class QuestionTagboxModel extends QuestionCheckboxModel {
9649
9755
  * Specifies whether to display a search bar in the drop-down menu.
9650
9756
  */
9651
9757
  searchEnabled: boolean;
9758
+ hideSelectedItems: boolean;
9652
9759
  /*
9653
9760
  * A text displayed in the input field when it doesn't have a value.
9654
9761
  */
@@ -9664,15 +9771,18 @@ export declare class QuestionTagboxModel extends QuestionCheckboxModel {
9664
9771
  }
9665
9772
  export declare function property(options?: any): (target: any, key: string) => void;
9666
9773
  export declare function propertyArray(options?: IArrayPropertyDecoratorOptions): (target: any, key: string) => void;
9774
+ export declare function createDialogOptions(componentName: string, data: any, onApply: any, onCancel?: any, onHide?: any, onShow?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): IDialogOptions;
9775
+ export declare function createPopupModalViewModel(options: IDialogOptions): PopupBaseViewModel;
9776
+ export declare function createDropdownActionModel(actionOptions: IAction, dropdownOptions: IActionDropdownPopupOptions, locOwner?: any): Action;
9777
+ export declare function createDropdownActionModelAdvanced(actionOptions: IAction, listOptions: IListModel, popupOptions?: IPopupOptionsBase, locOwner?: any): Action;
9667
9778
  export declare function unwrap<T>(value: any): T;
9668
9779
  export declare function getSize(value: any): any;
9669
9780
  export declare function doKey2ClickBlur(evt: any): void;
9670
9781
  export declare function doKey2ClickUp(evt: any, options?: IAttachKey2clickOptions): void;
9671
9782
  export declare function doKey2ClickDown(evt: any, options?: IAttachKey2clickOptions): void;
9672
9783
  export declare function sanitizeEditableContent(element: any): void;
9673
- export declare function createDialogOptions(componentName: string, data: any, onApply: any, onCancel?: any, onHide?: any, onShow?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): IDialogOptions;
9674
- export declare function createPopupModalViewModel(options: IDialogOptions): PopupBaseViewModel;
9675
9784
  export declare function getCurrecyCodes(): Array<any>;
9785
+ export declare function checkLibraryVersion(ver: string, libraryName: string): void;
9676
9786
  export declare function showModal(componentName: string, data: any, onApply: any, onCancel?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): void;
9677
9787
  export declare function showDialog(dialogOptions: any): void;
9678
9788
  export declare function attachKey2click(element: JSX.Element, viewModel?: any, options?: IAttachKey2clickOptions): JSX.Element;
@@ -9695,8 +9805,8 @@ export declare var settings: {
9695
9805
  */
9696
9806
  useLocalTimeZone: boolean,
9697
9807
  /*
9698
- * The prefix that uses to store the question comment, as {questionName} + {commentPrefix}.
9699
- * The default
9808
+ * The prefix that uses to store the question comment, as "questionName + commentPrefix".
9809
+ * The default value is "-Comment"
9700
9810
  */
9701
9811
  commentPrefix: string,
9702
9812
  /*
@@ -9892,6 +10002,7 @@ export declare var surveyLocalization: {
9892
10002
  getCurrentStrings: (locale?: string) => any,
9893
10003
  getString: (strName: string, locale?: string) => any,
9894
10004
  getLocales: (removeDefaultLoc?: boolean) => any,
10005
+ onGetExternalString: (name: string, locale: string) => string,
9895
10006
  };
9896
10007
  export declare var surveyStrings: any;
9897
10008
  /*
@@ -9912,8 +10023,8 @@ export declare var defaultActionBarCss: {
9912
10023
  itemTitle: string,
9913
10024
  itemTitleWithIcon: string,
9914
10025
  };
9915
- export declare var keyFocusedClassName: any;
9916
10026
  export declare var FOCUS_INPUT_SELECTOR: any;
10027
+ export declare var keyFocusedClassName: any;
9917
10028
  export declare var surveyCss: {
9918
10029
  currentType: string,
9919
10030
  getCss: any,
@@ -10296,6 +10407,8 @@ export declare var IsTouch: boolean;
10296
10407
  export declare var minMaxTypes: any;
10297
10408
  export declare var youtubeTags: any;
10298
10409
  export declare var videoSuffics: any;
10410
+ export declare var youtubeUrl: any;
10411
+ export declare var youtubeEmbed: any;
10299
10412
  export declare var defaultWidth: number;
10300
10413
  export declare var defaultHeight: number;
10301
10414
  export declare var Version: string;