survey-react 1.9.45 → 1.9.46

package/survey.react.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definition for Survey JavaScript library for React v1.9.45
+* Type definition for Survey JavaScript library for React v1.9.46
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: MIT (http://www.opensource.org/licenses/mit-license.php)
 */
@@ -399,8 +399,9 @@ export interface ISurvey extends ITextProcessor, ISurveyErrorOwner {
   isValidateOnValueChanging: boolean;
   isValidateOnValueChanged: boolean;
   matrixCellValidate(question: IQuestion, options: any): SurveyError;
-  dynamicPanelAdded(question: IQuestion, panelIndex?: number, panel?: IPanel): any;
-  dynamicPanelRemoved(question: IQuestion, panelIndex: number, panel: IPanel): any;
+  dynamicPanelAdded(question: IQuestion, panelIndex?: number, panel?: IPanel): void;
+  dynamicPanelRemoved(question: IQuestion, panelIndex: number, panel: IPanel): void;
+  dynamicPanelRemoving(question: IQuestion, panelIndex: number, panel: IPanel): boolean;
   dynamicPanelItemValueChanged(question: IQuestion, options: any): any;
   dragAndDropAllow(options: any): boolean;
   scrollElementToTop(element: ISurveyElement, question: IQuestion, page: IPage, id: string): any;
@@ -609,7 +610,7 @@ export interface ICustomQuestionTypeConfiguration {
   */
   onCreated(question: Question): void;
   /*
-  * A function that is called when JSON definitions are loaded.
+  * A function that is called when JSON schemas are loaded.
   * 
   * Parameters:
   * 
@@ -672,7 +673,7 @@ export interface ICustomQuestionTypeConfiguration {
   */
   getDisplayValue?: any;
   /*
-  * 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).
+  * 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).
   */
   elementsJSON?: any;
   /*
@@ -680,7 +681,7 @@ export interface ICustomQuestionTypeConfiguration {
   */
   createElements?: any;
   /*
-  * A JSON definition for a built-in question type on which the custom question type is based.
+  * A JSON schema for a built-in question type on which the custom question type is based.
   * 
   * Refer to the [Create Specialized Question Types](https://surveyjs.io/Documentation/Survey-Creator?id=create-specialized-question-types) help topic for more information.
   */
@@ -792,28 +793,7 @@ export declare class Base {
   protected addEvent<T>(): EventBase<T>;
   protected onBaseCreating(): void;
   /*
-  * Returns the question type.
-  * Possible values:
-  * - [*"boolean"*](https://surveyjs.io/Documentation/Library?id=questionbooleanmodel)
-  * - [*"checkbox"*](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel)
-  * - [*"comment"*](https://surveyjs.io/Documentation/Library?id=questioncommentmodel)
-  * - [*"dropdown"*](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel)
-  * - [*"expression"*](https://surveyjs.io/Documentation/Library?id=questionexpressionmodel)
-  * - [*"file"*](https://surveyjs.io/Documentation/Library?id=questionfilemodel)
-  * - [*"html"*](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel)
-  * - [*"image"*](https://surveyjs.io/Documentation/Library?id=questionimagemodel)
-  * - [*"imagepicker"*](https://surveyjs.io/Documentation/Library?id=questionimagepickermodel)
-  * - [*"matrix"*](https://surveyjs.io/Documentation/Library?id=questionmatrixmodel)
-  * - [*"matrixdropdown"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdropdownmodel)
-  * - [*"matrixdynamic"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdynamicmodel)
-  * - [*"multipletext"*](https://surveyjs.io/Documentation/Library?id=questionmultipletextmodel)
-  * - [*"panel"*](https://surveyjs.io/Documentation/Library?id=panelmodel)
-  * - [*"paneldynamic"*](https://surveyjs.io/Documentation/Library?id=questionpaneldynamicmodel)
-  * - [*"radiogroup"*](https://surveyjs.io/Documentation/Library?id=questionradiogroupmodel)
-  * - [*"rating"*](https://surveyjs.io/Documentation/Library?id=questionratingmodel)
-  * - [*"ranking"*](https://surveyjs.io/Documentation/Library?id=questionrankingmodel)
-  * - [*"signaturepad"*](https://surveyjs.io/Documentation/Library?id=questionsignaturepadmodel)
-  * - [*"text"*](https://surveyjs.io/Documentation/Library?id=questiontextmodel)
+  * Returns the class type as it is used in the JSON schema.
   */
   getType(): string;
   /*
@@ -1038,6 +1018,7 @@ export declare class CustomPropertiesCollection {
   static parentClasses: any;
   static addProperty(className: string, property: any): void;
   static removeProperty(className: string, propertyName: string): void;
+  static removeAllProperties(className: string): void;
   static addClass(className: string, parentClassName: string): void;
   static getProperties(className: string): Array<any>;
   static createProperties(obj: any): void;
@@ -1219,8 +1200,10 @@ export declare class JsonMetadataClass {
   static requiredSymbol: string;
   static typeSymbol: string;
   properties: any;
+  isCustomValue: boolean;
   find(name: string): JsonObjectProperty;
-  createProperty(propInfo: any): JsonObjectProperty;
+  get isCustom(): boolean;
+  createProperty(propInfo: any, isCustom?: boolean): JsonObjectProperty;
 }
 export declare class JsonObject {
   static typePropertyName: string;
@@ -1355,6 +1338,7 @@ export declare class QuestionMatrixDropdownRenderedCell {
   question: Question;
   isRemoveRow: boolean;
   choiceIndex: number;
+  isOtherChoice: boolean;
   matrix: QuestionMatrixDropdownModelBase;
   requiredText: string;
   isEmpty: boolean;
@@ -1373,8 +1357,10 @@ export declare class QuestionMatrixDropdownRenderedCell {
   get item(): ItemValue;
   set item(val: ItemValue);
   get isChoice(): boolean;
+  get isItemChoice(): boolean;
   get choiceValue(): any;
   get isCheckbox(): boolean;
+  get isRadio(): boolean;
   get isFirstChoice(): boolean;
   get className(): string;
   get headers(): string;
@@ -1868,7 +1854,7 @@ export declare class ChoicesRestful extends Base {
   * url: "https://surveyjs.io/api/CountriesExample?region={region}"
   * ```
   * 
-  * [View Example](https://surveyjs.io/Examples/Library/?id=questiontype-dropdownrestfull)
+  * [View Example](https://surveyjs.io/Examples/Library/?id=questiontype-dropdownrestfull (linkStyle))
   */
   get url(): string;
   set url(val: string);
@@ -1891,7 +1877,7 @@ export declare class ChoicesRestful extends Base {
   /*
   * Specifies which property in the obtained data object contains choice values.
   * 
-  * [View Example](https://surveyjs.io/Examples/Library/?id=questiontype-dropdownrestfull)
+  * [View Example](https://surveyjs.io/Examples/Library/?id=questiontype-dropdownrestfull (linkStyle))
   */
   get valueName(): string;
   set valueName(val: string);
@@ -1994,6 +1980,7 @@ export declare class DragDropCore<T> extends Base {
 export declare class DropdownListModel extends Base {
   constructor(question: Question, onSelectionChanged?: (item: IAction, ...params: any) => void);
   _popupModel: any;
+  focusFirstInputSelector: string;
   protected listModel: ListModel;
   protected popupCssClasses: string;
   protected getAvailableItems(): Array<Action>;
@@ -2260,6 +2247,7 @@ export declare class List extends SurveyElementBase<IListProps, any> {
   renderElement(): JSX.Element;
   renderItems(): any;
   searchElementContent(): JSX.Element;
+  emptyContent(): JSX.Element;
 }
 export declare class ListItem extends SurveyElementBase<IListItemProps, any> {
   constructor(props: any);
@@ -2743,6 +2731,7 @@ export declare class PopupContainer extends SurveyElementBase<any, any> {
 export declare class PopupModel<T = any> extends Base {
   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);
   width: number;
+  focusFirstInputSelector: string;
   contentComponentName: string;
   contentComponentData: T;
   verticalPosition: any;
@@ -3285,7 +3274,8 @@ export declare class AdaptiveActionContainer<T extends Action = Action> extends
   minVisibleItemsCount: number;
   isResponsivenessDisabled: boolean;
   static ContainerID: number;
-  get invisibleItemsListModel(): ListModel;
+  get hiddenItemsListModel(): ListModel;
+  protected hiddenItemSelected(item: T): void;
   protected onSet(): void;
   protected onPush(item: T): void;
   protected getRenderedActions(): Array<T>;
@@ -3489,6 +3479,7 @@ export declare class ListModel extends ActionContainer {
   allowSelection: boolean;
   searchEnabled: boolean;
   needFilter: boolean;
+  isEmpty: boolean;
   isExpanded: boolean;
   selectedItem: IAction;
   filteredText: string;
@@ -3503,6 +3494,7 @@ export declare class ListModel extends ActionContainer {
   getItemClass: (itemValue: Action) => string;
   getItemIndent: (itemValue: any) => string;
   get filteredTextPlaceholder(): string;
+  get emptyMessage(): string;
   goToItems(event: any): void;
   onKeyDown(event: any): void;
   onPointerDown(event: any, item: any): void;
@@ -4396,6 +4388,15 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   */
   onDynamicPanelRemoved: EventBase<SurveyModel>;
   /*
+  * The event is fired before removing a panel from Panel Dynamic question. You can disable removing and optionally clear the data instead.
+  * - `sender` - the survey object that fires the event.
+  * - `options.question` - a panel question.
+  * - `options.panelIndex` - a removed panel index.
+  * - `options.panel` - a removed panel.
+  * - `options.allow` - a boolean property. Set it to `false` to disable the panel removing.
+  */
+  onDynamicPanelRemoving: EventBase<SurveyModel>;
+  /*
   * The event is fired every second if the method `startTimer` has been called.
   */
   onTimer: EventBase<SurveyModel>;
@@ -5366,6 +5367,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   matrixCellValidate(question: IQuestion, options: any): SurveyError;
   dynamicPanelAdded(question: IQuestion, panelIndex?: number, panel?: IPanel): void;
   dynamicPanelRemoved(question: IQuestion, panelIndex: number, panel: IPanel): void;
+  dynamicPanelRemoving(question: IQuestion, panelIndex: number, panel: IPanel): boolean;
   dynamicPanelItemValueChanged(question: IQuestion, options: any): void;
   dragAndDropAllow(options: any): boolean;
   elementContentVisibilityChanged(element: ISurveyElement): void;
@@ -5618,6 +5620,11 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   set widthMode(val: string);
   calculatedWidthMode: string;
   calculateWidthMode(): string;
+  /*
+  * 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.
+  */
+  get width(): string;
+  set width(val: string);
   get timerInfoText(): string;
   get timerModel(): SurveyTimerModel;
   /*
@@ -6127,28 +6134,7 @@ export declare class PanelModelBase extends SurveyElement implements IPanel, ICo
   removeElementCallback: (element: IElement) => void;
   onGetQuestionTitleLocation: any;
   /*
-  * Returns the question type.
-  * Possible values:
-  * - [*"boolean"*](https://surveyjs.io/Documentation/Library?id=questionbooleanmodel)
-  * - [*"checkbox"*](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel)
-  * - [*"comment"*](https://surveyjs.io/Documentation/Library?id=questioncommentmodel)
-  * - [*"dropdown"*](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel)
-  * - [*"expression"*](https://surveyjs.io/Documentation/Library?id=questionexpressionmodel)
-  * - [*"file"*](https://surveyjs.io/Documentation/Library?id=questionfilemodel)
-  * - [*"html"*](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel)
-  * - [*"image"*](https://surveyjs.io/Documentation/Library?id=questionimagemodel)
-  * - [*"imagepicker"*](https://surveyjs.io/Documentation/Library?id=questionimagepickermodel)
-  * - [*"matrix"*](https://surveyjs.io/Documentation/Library?id=questionmatrixmodel)
-  * - [*"matrixdropdown"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdropdownmodel)
-  * - [*"matrixdynamic"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdynamicmodel)
-  * - [*"multipletext"*](https://surveyjs.io/Documentation/Library?id=questionmultipletextmodel)
-  * - [*"panel"*](https://surveyjs.io/Documentation/Library?id=panelmodel)
-  * - [*"paneldynamic"*](https://surveyjs.io/Documentation/Library?id=questionpaneldynamicmodel)
-  * - [*"radiogroup"*](https://surveyjs.io/Documentation/Library?id=questionradiogroupmodel)
-  * - [*"rating"*](https://surveyjs.io/Documentation/Library?id=questionratingmodel)
-  * - [*"ranking"*](https://surveyjs.io/Documentation/Library?id=questionrankingmodel)
-  * - [*"signaturepad"*](https://surveyjs.io/Documentation/Library?id=questionsignaturepadmodel)
-  * - [*"text"*](https://surveyjs.io/Documentation/Library?id=questiontextmodel)
+  * Returns the class type as it is used in the JSON schema.
   */
   getType(): string;
   setSurveyImpl(value: ISurveyImpl, isLight?: boolean): void;
@@ -6510,7 +6496,28 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   */
   get isAllowTitleLeft(): boolean;
   /*
-  * Returns the type of the object as a string as it represents in the json.
+  * Returns the question type.
+  * Possible values:
+  * - [*"boolean"*](https://surveyjs.io/Documentation/Library?id=questionbooleanmodel)
+  * - [*"checkbox"*](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel)
+  * - [*"comment"*](https://surveyjs.io/Documentation/Library?id=questioncommentmodel)
+  * - [*"dropdown"*](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel)
+  * - [*"expression"*](https://surveyjs.io/Documentation/Library?id=questionexpressionmodel)
+  * - [*"file"*](https://surveyjs.io/Documentation/Library?id=questionfilemodel)
+  * - [*"html"*](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel)
+  * - [*"image"*](https://surveyjs.io/Documentation/Library?id=questionimagemodel)
+  * - [*"imagepicker"*](https://surveyjs.io/Documentation/Library?id=questionimagepickermodel)
+  * - [*"matrix"*](https://surveyjs.io/Documentation/Library?id=questionmatrixmodel)
+  * - [*"matrixdropdown"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdropdownmodel)
+  * - [*"matrixdynamic"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdynamicmodel)
+  * - [*"multipletext"*](https://surveyjs.io/Documentation/Library?id=questionmultipletextmodel)
+  * - [*"panel"*](https://surveyjs.io/Documentation/Library?id=panelmodel)
+  * - [*"paneldynamic"*](https://surveyjs.io/Documentation/Library?id=questionpaneldynamicmodel)
+  * - [*"radiogroup"*](https://surveyjs.io/Documentation/Library?id=questionradiogroupmodel)
+  * - [*"rating"*](https://surveyjs.io/Documentation/Library?id=questionratingmodel)
+  * - [*"ranking"*](https://surveyjs.io/Documentation/Library?id=questionrankingmodel)
+  * - [*"signaturepad"*](https://surveyjs.io/Documentation/Library?id=questionsignaturepadmodel)
+  * - [*"text"*](https://surveyjs.io/Documentation/Library?id=questiontextmodel)
   */
   getType(): string;
   get isQuestion(): boolean;
@@ -8281,7 +8288,10 @@ export declare class QuestionSelectBase extends Question {
   protected getHasOther(val: any): boolean;
   get validatedValue(): any;
   protected createRestful(): ChoicesRestful;
+  get autoOtherMode(): boolean;
+  set autoOtherMode(val: boolean);
   protected getQuestionComment(): string;
+  protected selectOtherValueFromComment(val: boolean): void;
   isSettingComment: boolean;
   protected setQuestionComment(newValue: string): void;
   clearValue(): void;
@@ -8873,7 +8883,28 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
   onRemoveColumn: (column: MatrixDropdownColumn) => void;
   protected createColumnValues(): any;
   /*
-  * Returns the type of the object as a string as it represents in the json.
+  * Returns the question type.
+  * Possible values:
+  * - [*"boolean"*](https://surveyjs.io/Documentation/Library?id=questionbooleanmodel)
+  * - [*"checkbox"*](https://surveyjs.io/Documentation/Library?id=questioncheckboxmodel)
+  * - [*"comment"*](https://surveyjs.io/Documentation/Library?id=questioncommentmodel)
+  * - [*"dropdown"*](https://surveyjs.io/Documentation/Library?id=questiondropdownmodel)
+  * - [*"expression"*](https://surveyjs.io/Documentation/Library?id=questionexpressionmodel)
+  * - [*"file"*](https://surveyjs.io/Documentation/Library?id=questionfilemodel)
+  * - [*"html"*](https://surveyjs.io/Documentation/Library?id=questionhtmlmodel)
+  * - [*"image"*](https://surveyjs.io/Documentation/Library?id=questionimagemodel)
+  * - [*"imagepicker"*](https://surveyjs.io/Documentation/Library?id=questionimagepickermodel)
+  * - [*"matrix"*](https://surveyjs.io/Documentation/Library?id=questionmatrixmodel)
+  * - [*"matrixdropdown"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdropdownmodel)
+  * - [*"matrixdynamic"*](https://surveyjs.io/Documentation/Library?id=questionmatrixdynamicmodel)
+  * - [*"multipletext"*](https://surveyjs.io/Documentation/Library?id=questionmultipletextmodel)
+  * - [*"panel"*](https://surveyjs.io/Documentation/Library?id=panelmodel)
+  * - [*"paneldynamic"*](https://surveyjs.io/Documentation/Library?id=questionpaneldynamicmodel)
+  * - [*"radiogroup"*](https://surveyjs.io/Documentation/Library?id=questionradiogroupmodel)
+  * - [*"rating"*](https://surveyjs.io/Documentation/Library?id=questionratingmodel)
+  * - [*"ranking"*](https://surveyjs.io/Documentation/Library?id=questionrankingmodel)
+  * - [*"signaturepad"*](https://surveyjs.io/Documentation/Library?id=questionsignaturepadmodel)
+  * - [*"text"*](https://surveyjs.io/Documentation/Library?id=questiontextmodel)
   */
   getType(): string;
   dispose(): void;
@@ -9362,6 +9393,7 @@ export declare class QuestionCheckboxModel extends QuestionCheckboxBase {
   protected convertValueToObject(val: any): any;
   protected renderedValueFromDataCore(val: any): any;
   protected rendredValueToDataCore(val: any): any;
+  protected selectOtherValueFromComment(val: boolean): void;
   get checkBoxSvgPath(): string;
 }
 /*
@@ -9750,6 +9782,7 @@ export declare function doKey2ClickUp(evt: any, options?: IAttachKey2clickOption
 export declare function doKey2ClickDown(evt: any, options?: IAttachKey2clickOptions): void;
 export declare function sanitizeEditableContent(element: any): void;
 export declare function getCurrecyCodes(): Array<any>;
+export declare function checkLibraryVersion(ver: string, libraryName: string): void;
 export declare function showModal(componentName: string, data: any, onApply: any, onCancel?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): void;
 export declare function showDialog(dialogOptions: any): void;
 export declare function attachKey2click(element: JSX.Element, viewModel?: any, options?: IAttachKey2clickOptions): JSX.Element;
@@ -9772,8 +9805,8 @@ export declare var settings: {
   */
   useLocalTimeZone: boolean,
   /*
-  * The prefix that uses to store the question comment, as {questionName} + {commentPrefix}.
-  * The default
+  * The prefix that uses to store the question comment, as "questionName + commentPrefix".
+  * The default value is "-Comment"
   */
   commentPrefix: string,
   /*