survey-core 1.9.18 → 1.9.21

package/survey.core.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definition for Survey JavaScript library. Platform independent (core) v1.9.18
+* Type definition for Survey JavaScript library. Platform independent (core) v1.9.21
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: MIT (http://www.opensource.org/licenses/mit-license.php)
 */
@@ -82,6 +82,40 @@ export interface IParseOptions {
   tracer?: any;
 }
 /*
+* Base interface for expression execution
+*/
+export interface IExpresionExecutor {
+  /*
+  * This call back runs on executing expression if there is at least one async function
+  */
+  onComplete: any;
+  /*
+  * The expression as string, property with get/set
+  */
+  expression: string;
+  /*
+  * Returns true if the expression is valid and can be executed
+  */
+  canRun(): boolean;
+  /*
+  * Run the expression. Returns the result of execution.
+  * The result can be undefined if there is an asyn function. In this case result will be returned onComplete callback.
+  */
+  run(values: any, properties: any): any;
+  /*
+  * Returns the list of variables that used in the expression. They defined as: {variableName} in default parser.
+  */
+  getVariables(): Array<any>;
+  /*
+  * Returns true if there is a function in the expression
+  */
+  hasFunction(): boolean;
+  /*
+  * Returns true if there is an async function in the expression
+  */
+  isAsync: boolean;
+}
+/*
 * Defines an individual action. Action items can be displayed in certain survey elements - in Toolbar (or action bar), in titles (of pages, panels, questions), in matrix rows (as 'expand details' or 'remove row' buttons), and etc.
 */
 export interface IAction {
@@ -174,6 +208,7 @@ export interface IAction {
   */
   mode?: "popup" | "large" | "small";
   visibleIndex?: number;
+  needSpace?: boolean;
 }
 export interface IDimensions {
   scroll: number;
@@ -509,6 +544,12 @@ export interface IQuestionPanelDynamicData {
   getSurvey(): ISurvey;
   getRootData(): ISurveyData;
 }
+export declare class ActionDropdownViewModel {
+  constructor(item: Action);
+  popupModel: any;
+  funcKey: string;
+  dispose(): void;
+}
 export declare class ArrayChanges {
   constructor(index: number, deleteCount: number, itemsToAdd: any, deletedItems: any);
   index: number;
@@ -850,13 +891,7 @@ export declare class Event<T, Options> {
 }
 export declare class ExpressionRunnerBase {
   constructor(expression: string);
-  expressionValue: string;
-  operand: Operand;
-  processValue: ProcessValue;
-  parser: ConditionsParser;
-  isAsyncValue: boolean;
-  hasFunctionValue: boolean;
-  asyncFuncList: any;
+  expressionExecutor: IExpresionExecutor;
   get expression(): string;
   set expression(val: string);
   getVariables(): Array<any>;
@@ -972,6 +1007,7 @@ export declare class MatrixCells {
   cellsOwner: IMatrixCellsOwner;
   values: any;
   get isEmpty(): boolean;
+  onValuesChanged: any;
   setCellText(row: any, column: any, val: string): void;
   setDefaultCellText(column: any, val: string): void;
   getCellLocText(row: any, column: any): LocalizableString;
@@ -1185,6 +1221,7 @@ export declare class SvgIconRegistry {
   registerIconFromSymbol(iconId: string, iconSymbolSvg: string): void;
   registerIconFromSvgViaElement(iconId: string, iconSvg: string, iconPrefix?: string): void;
   registerIconFromSvg(iconId: string, iconSvg: string, iconPrefix?: string): boolean;
+  registerIconsFromFolder(r: any): void;
   iconsRenderedHtml(): any;
   renderIcons(): void;
 }
@@ -1281,6 +1318,7 @@ export declare class Action extends Base implements IAction {
   mode: "popup" | "large" | "small";
   disableTabStop: boolean;
   disableShrink: boolean;
+  needSpace: boolean;
   cssClassesValue: any;
   get cssClasses(): any;
   get disabled(): boolean;
@@ -1550,6 +1588,24 @@ export declare class ExceedSizeError extends SurveyError {
   getErrorType(): string;
   getDefaultText(): string;
 }
+export declare class ExpressionExecutor implements IExpresionExecutor {
+  static createExpressionExecutor: any;
+  onComplete: any;
+  expressionValue: string;
+  operand: Operand;
+  processValue: ProcessValue;
+  parser: ConditionsParser;
+  isAsyncValue: boolean;
+  hasFunctionValue: boolean;
+  asyncFuncList: any;
+  get expression(): string;
+  set expression(val: string);
+  getVariables(): Array<any>;
+  hasFunction(): boolean;
+  get isAsync(): boolean;
+  canRun(): boolean;
+  run(values: any, properties?: any): any;
+}
 /*
 * Base class for HtmlConditionItem and UrlConditionItem classes.
 */
@@ -2536,7 +2592,7 @@ export declare class UploadingFileError extends SurveyError {
   protected getDefaultText(): string;
 }
 export declare class VerticalResponsivityManager extends ResponsivityManager {
-  constructor(container: any, model: any, itemsSelector: string, dotsItemSize?: number);
+  constructor(container: any, model: any, itemsSelector: string, dotsItemSize?: number, minDimension?: number);
   protected getDimensions(): IDimensions;
   protected getAvailableSpace(): number;
   protected calcItemSize(item: any): number;
@@ -3984,6 +4040,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   get isLogoAfter(): boolean;
   get logoClassNames(): string;
   get renderedHasTitle(): boolean;
+  get renderedHasDescription(): boolean;
   get hasTitle(): boolean;
   get renderedHasLogo(): boolean;
   get renderedHasHeader(): boolean;
@@ -4523,12 +4580,15 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   isCalculatingProgressText: boolean;
   updateProgressText(onValueChanged?: boolean): void;
   getProgressText(): string;
+  getRootCss(): string;
+  resizeObserver: any;
   afterRenderSurvey(htmlElement: any): void;
   updateQuestionCssClasses(question: IQuestion, cssClasses: any): void;
   updatePanelCssClasses(panel: IPanel, cssClasses: any): void;
   updatePageCssClasses(page: IPage, cssClasses: any): void;
   updateChoiceItemCss(question: IQuestion, options: any): void;
   isFirstPageRendering: boolean;
+  isCurrentPageRendering: boolean;
   afterRenderPage(htmlElement: any): void;
   afterRenderHeader(htmlElement: any): void;
   afterRenderQuestion(question: IQuestion, htmlElement: any): void;
@@ -4742,17 +4802,25 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   processTextEx(text: string, returnDisplayValue: boolean, doEncoding: boolean): any;
   getSurveyMarkdownHtml(element: Base, text: string, name: string): string;
   /*
-  * Returns an amount of corrected quiz answers.
+  * Deprecated. Use the getCorrectAnswerCount method instead.
   */
   getCorrectedAnswerCount(): number;
   /*
+  * Returns an amount of corrected quiz answers.
+  */
+  getCorrectAnswerCount(): number;
+  /*
   * Returns quiz question number. It may be different from `getQuizQuestions.length` because some widgets like matrix may have several questions.
   */
   getQuizQuestionCount(): number;
   /*
-  * Returns an amount of incorrect quiz answers.
+  * Deprecated. Use the getInCorrectAnswerCount method instead.
   */
   getInCorrectedAnswerCount(): number;
+  /*
+  * Returns an amount of incorrect quiz answers.
+  */
+  getInCorrectAnswerCount(): number;
   getCorrectedAnswers(): number;
   getInCorrectedAnswers(): number;
   /*
@@ -4834,6 +4902,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   */
   focusQuestion(name: string): boolean;
   getElementWrapperComponentName(element: any, reason?: string): string;
+  getQuestionContentWrapperComponentName(element: any): string;
   getRowWrapperComponentName(row: QuestionRowModel): string;
   getElementWrapperComponentData(element: any, reason?: string): any;
   getRowWrapperComponentData(row: QuestionRowModel): any;
@@ -4914,7 +4983,7 @@ export declare class Variable extends Const {
 export declare class DragDropRankingChoices extends DragDropChoices {
   constructor(surveyValue?: ISurvey, creator?: any);
   protected get draggedElementType(): string;
-  protected createDraggedElementShortcut(text: string, draggedElementNode: any): any;
+  protected createDraggedElementShortcut(text: string, draggedElementNode: any, event: any): any;
   protected getDropTargetByDataAttributeValue(dataAttributeValue: string): ItemValue;
   isDragOverRootNode: boolean;
   protected findDropTargetNodeByDragOverNode(dragOverNode: any): any;
@@ -5719,6 +5788,7 @@ export declare class Question extends SurveyElement implements IQuestion, ICondi
   protected supportResponsiveness(): boolean;
   resizeObserver: any;
   protected getCompactRenderAs(): string;
+  protected getDesktopRenderAs(): string;
   protected processResponsiveness(requiredWidth: number, availableWidth: number): void;
   dispose(): void;
 }
@@ -5815,6 +5885,7 @@ export declare class PageModel extends PanelModelBase implements IPage {
   get navigationDescription(): string;
   set navigationDescription(val: string);
   get locNavigationDescription(): LocalizableString;
+  navigationLocStrChanged(): void;
   get passed(): boolean;
   set passed(val: boolean);
   delete(): void;
@@ -6735,6 +6806,7 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
   getPlainData(options?: any): any;
   updateElementCss(reNew?: boolean): void;
   get progressText(): string;
+  get progress(): string;
   getRootCss(): string;
   getPanelWrapperCss(): string;
   getPanelRemoveButtonCss(): string;
@@ -6748,6 +6820,11 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
   set noEntriesText(val: string);
   get locNoEntriesText(): LocalizableString;
   getShowNoEntriesPlaceholder(): boolean;
+  needResponsiveWidth(): boolean;
+  footerToolbarValue: any;
+  get footerToolbar(): any;
+  legacyNavigation: boolean;
+  updateFooterActionsCallback: any;
 }
 /*
 * A Model for a rating question.
@@ -6811,11 +6888,13 @@ export declare class QuestionRatingModel extends Question {
   * are displayed as plain non-clickable texts.
   */
   displayRateDescriptionsAsExtremeItems: boolean;
+  useDropdown: "auto" | "always" | "never";
   protected valueToData(val: any): any;
   /*
   * Click value again to clear.
   */
   setValueFromClick(value: any): void;
+  get ratingRootCss(): string;
   getItemClass(item: ItemValue): string;
   getControlClass(): string;
   get optionsCaption(): string;
@@ -6826,8 +6905,10 @@ export declare class QuestionRatingModel extends Question {
   set renderedValue(val: boolean);
   get visibleChoices(): any;
   get readOnlyText(): any;
+  needResponsiveWidth(): boolean;
   protected supportResponsiveness(): boolean;
   protected getCompactRenderAs(): string;
+  protected getDesktopRenderAs(): string;
 }
 /*
 * It is a base class for checkbox, dropdown and radiogroup questions.
@@ -6977,6 +7058,10 @@ export declare class QuestionSelectBase extends Question {
   set otherText(val: string);
   get locOtherText(): LocalizableString;
   /*
+  * Use this property to show "Select All", "None" and "Other" choices in multi columns .
+  */
+  separateSpecialChoices: boolean;
+  /*
   * Use this property to set the place holder text for other or comment field  .
   */
   get otherPlaceHolder(): string;
@@ -7056,6 +7141,10 @@ export declare class QuestionSelectBase extends Question {
   protected getItemClassCore(item: any, options: any): string;
   getLabelClass(item: ItemValue): string;
   getControlLabelClass(item: ItemValue): string;
+  get headItems(): any;
+  get footItems(): any;
+  get hasHeadItems(): boolean;
+  get hasFootItems(): boolean;
   get columns(): any;
   get hasColumns(): boolean;
   choicesLoaded(): void;
@@ -7069,6 +7158,10 @@ export declare class QuestionSelectBase extends Question {
   getItemId(item: ItemValue): string;
   get questionName(): string;
   getItemEnabled(item: ItemValue): any;
+  rootElement: any;
+  afterRender(el: any): void;
+  prevIsOtherSelected: boolean;
+  protected onValueChanged(): void;
 }
 /*
 * A Model for signature pad question.
@@ -7402,6 +7495,7 @@ export declare class QuestionImageModel extends QuestionNonValue {
   * The rendered mode.
   */
   get renderedMode(): string;
+  getImageCss(): string;
   protected calculateRenderedMode(): void;
 }
 /*
@@ -7674,6 +7768,7 @@ export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixR
   get cells(): MatrixCells;
   set cells(val: MatrixCells);
   get hasCellText(): boolean;
+  protected updateHasCellText(): void;
   setCellText(row: any, column: any, val: string): void;
   getCellText(row: any, column: any): string;
   setDefaultCellText(column: any, val: string): void;
@@ -8645,6 +8740,8 @@ export declare var defaultStandardCss: {
     buttonRemove: string,
     buttonRemoveRight: string,
     buttonPrev: string,
+    buttonPrevDisabled: string,
+    buttonNextDisabled: string,
     buttonNext: string,
     progressContainer: string,
     progress: string,
@@ -8752,6 +8849,7 @@ export declare var surveyTimerFunctions: {
   setTimeout: any,
   clearTimeout: any,
 };
+export declare var keyFocusedClassName: any;
 export declare var matrixDropdownColumnTypes: {
   dropdown: {
     onCellQuestionUpdate: any,
@@ -8996,6 +9094,8 @@ export declare var defaultBootstrapCss: {
     buttonRemoveRight: string,
     buttonPrev: string,
     buttonNext: string,
+    buttonPrevDisabled: string,
+    buttonNextDisabled: string,
     progressContainer: string,
     progress: string,
     progressBar: string,
@@ -9319,6 +9419,8 @@ export declare var defaultBootstrapMaterialCss: {
     buttonRemoveRight: string,
     buttonPrev: string,
     buttonNext: string,
+    buttonPrevDisabled: string,
+    buttonNextDisabled: string,
     progressContainer: string,
     progress: string,
     progressBar: string,
@@ -9424,6 +9526,7 @@ export declare var defaultBootstrapMaterialCss: {
 };
 export declare var defaultV2Css: {
   root: string,
+  rootMobile: string,
   container: string,
   header: string,
   body: string,
@@ -9436,6 +9539,7 @@ export declare var defaultV2Css: {
   headerText: string,
   navigationButton: string,
   completedPage: string,
+  timerRoot: string,
   navigation: {
     complete: string,
     prev: string,
@@ -9473,9 +9577,9 @@ export declare var defaultV2Css: {
     button: string,
     buttonRemove: string,
     buttonAdd: string,
-    progressTop: string,
-    progressBottom: string,
     buttonPrev: string,
+    buttonPrevDisabled: string,
+    buttonNextDisabled: string,
     buttonNext: string,
     progressContainer: string,
     progress: string,
@@ -9554,6 +9658,7 @@ export declare var defaultV2Css: {
     mainRoot: string,
     root: string,
     image: string,
+    adaptive: string,
     withFrame: string,
   },
   html: {
@@ -9758,6 +9863,7 @@ export declare var defaultV2Css: {
   rating: {
     rootDropdown: string,
     root: string,
+    rootWrappable: string,
     item: string,
     itemOnError: string,
     itemHover: string,
@@ -9793,6 +9899,7 @@ export declare var defaultV2Css: {
     noFileChosen: string,
     chooseFile: string,
     chooseFileAsText: string,
+    chooseFileAsTextDisabled: string,
     chooseFileAsIcon: string,
     chooseFileIconId: string,
     disabled: string,
@@ -9865,10 +9972,15 @@ export declare var defaultV2Css: {
     itemPressed: string,
     itemAsIcon: string,
     itemIcon: string,
+    itemTitle: string,
+  },
+  variables: {
+    mobileWidth: string,
   },
 };
 export declare var modernCss: {
   root: string,
+  timerRoot: string,
   container: string,
   header: string,
   headerClose: string,
@@ -9917,6 +10029,8 @@ export declare var modernCss: {
     progressBottom: string,
     buttonPrev: string,
     buttonNext: string,
+    buttonPrevDisabled: string,
+    buttonNextDisabled: string,
     progressContainer: string,
     progress: string,
     progressBar: string,
@@ -10234,4 +10348,5 @@ export declare var modernCss: {
   },
 };
 export declare var SvgRegistry: SvgIconRegistry;
-export declare var SvgBundleViewModel: any;
+export declare var SvgBundleViewModel: any;
+export declare var path: any;