survey-core 1.9.124 → 1.9.126

package/typings/question_matrixdropdowncolumn.d.ts

@@ -18,6 +18,11 @@ export interface IMatrixColumnOwner extends ILocalizableOwner {
     getCellAriaLabel(rowTitle: string, columnTitle: string): string;
 }
 export declare var matrixDropdownColumnTypes: any;
+/**
+ * An auxiliary class that describes a column in a [Multi-Select Matrix](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-with-dropdown-list) or [Dynamic Matrix](https://surveyjs.io/form-library/documentation/api-reference/dynamic-matrix-table-question-model).
+ *
+ * You can get an object of this class from the [`columns`](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-with-dropdown-list#columns) array or by calling the [`getColumnByName()`](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-with-dropdown-list#getColumnByName) method on a matrix instance.
+ */
 export declare class MatrixDropdownColumn extends Base implements ILocalizableOwner, IWrapperObject {
     static getColumnTypes(): Array<string>;
     private templateQuestionValue;
@@ -39,12 +44,39 @@ export declare class MatrixDropdownColumn extends Base implements ILocalizableOw
     get index(): number;
     setIndex(val: number): void;
     getType(): string;
+    /**
+     * Specifies the type of column cells.
+     *
+     * Possible values:
+     *
+     * - [`"dropdown"`](https://surveyjs.io/form-library/documentation/api-reference/dropdown-menu-model)
+     * - [`"checkbox"`](https://surveyjs.io/form-library/documentation/api-reference/checkbox-question-model)
+     * - [`"radiogroup"`](https://surveyjs.io/form-library/documentation/api-reference/radio-button-question-model)
+     * - [`"tagbox"`](https://surveyjs.io/form-library/documentation/api-reference/dropdown-tag-box-model)
+     * - [`"text"`](https://surveyjs.io/form-library/documentation/api-reference/text-entry-question-model)
+     * - [`"comment"`](https://surveyjs.io/form-library/documentation/api-reference/comment-field-model)
+     * - [`"boolean"`](https://surveyjs.io/form-library/documentation/api-reference/boolean-question-model)
+     * - [`"expression"`](https://surveyjs.io/form-library/documentation/api-reference/expression-model)
+     * - [`"rating"`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model)
+     * - `"default"` (default) - Inherits the input type from the [`cellType`](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-with-dropdown-list#cellType) property specified for the parent matrix.
+     *
+     * The input types are based upon standalone question types. Depending on the selected input type, the matrix column can have additional configuration properties inherited from the corresponding question type. For instance, Dropdown, Checkboxes, Radio Button Group, and Tag Box columns can specify the [`choices`](https://surveyjs.io/form-library/documentation/api-reference/radio-button-question-model#choices) array, similar to the question types upon which they are based. Refer to the API Reference of these question types for a full list of available properties.
+     *
+     * [View Demo](https://surveyjs.io/form-library/examples/aggregate-data-within-form/ (linkStyle))
+     */
     get cellType(): string;
     set cellType(val: string);
     get templateQuestion(): Question;
     get value(): string;
     get isVisible(): boolean;
     get isColumnVisible(): boolean;
+    /**
+     * Gets or sets column visibility.
+     *
+     * If you want to display or hide a column based on a condition, specify the [`visibleIf`](#visibleIf) property.
+     * @see isRequired
+     * @see readOnly
+     */
     get visible(): boolean;
     set visible(val: boolean);
     get hasVisibleCell(): boolean;
@@ -53,52 +85,167 @@ export declare class MatrixDropdownColumn extends Base implements ILocalizableOw
     get getVisibleChoicesInCell(): Array<any>;
     setVisibleChoicesInCell(val: Array<any>): void;
     get isFilteredMultipleColumns(): boolean;
+    /**
+     * A column ID that is not visible to respondents.
+     *
+     * > Column IDs must be unique.
+     * @see title
+     */
     get name(): string;
     set name(val: string);
+    /**
+     * A user-friendly column caption to display. If `title` is undefined, [`name`](#name) is displayed instead.
+     */
     get title(): string;
     set title(val: string);
     get locTitle(): LocalizableString;
     get fullTitle(): string;
+    /**
+     * Marks the column as required. If a respondent skips any cell in a required column, the matrix displays a validation error.
+     *
+     * If you want to mark the column as required based on a condition, specify the [`requiredIf`](#requiredIf) property.
+     * @see requiredErrorText
+     * @see visible
+     * @see readOnly
+     */
     get isRequired(): boolean;
     set isRequired(val: boolean);
     get isRenderedRequired(): boolean;
     set isRenderedRequired(val: boolean);
     updateIsRenderedRequired(val: boolean): void;
     get requiredText(): string;
+    /**
+     * Specifies a custom error message for a required column.
+     * @see isRequired
+     */
     get requiredErrorText(): string;
     set requiredErrorText(val: string);
     get locRequiredErrorText(): LocalizableString;
+    /**
+     * Makes the column read-only.
+     *
+     * If you want to switch the column to the read-only state based on a condition, specify the [`enableIf`](#enableIf) property.
+     * @see visible
+     * @see isRequired
+     */
     get readOnly(): boolean;
     set readOnly(val: boolean);
     get hasOther(): boolean;
     set hasOther(val: boolean);
+    /**
+     * A Boolean expression. If it evaluates to `false`, this column becomes hidden.
+     *
+     * Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
+     * @see visible
+     */
     get visibleIf(): string;
     set visibleIf(val: string);
+    /**
+     * A Boolean expression. If it evaluates to `false`, this column becomes read-only.
+     *
+     * Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
+     * @see readOnly
+     */
     get enableIf(): string;
     set enableIf(val: string);
+    /**
+     * A Boolean expression. If it evaluates to `true`, this column becomes required.
+     *
+     * Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
+     * @see isRequired
+     */
     get requiredIf(): string;
     set requiredIf(val: string);
+    /**
+     * A Boolean expression. If it evaluates to `true`, all cells in this column are set to a value calculated using the [`defaultValueExpression`](#defaultValueExpression).
+     *
+     * [Expressions](https://surveyjs.io/form-library/documentation/design-survey/conditional-logic#expressions (linkStyle))
+     * @see setValueIf
+     */
     get resetValueIf(): string;
     set resetValueIf(val: string);
+    /**
+     * An expression used to calculate the column's default value. This expression applies to all cells of this column until the cell value is specified by an end user or programmatically.
+     *
+     * [Expressions](https://surveyjs.io/form-library/documentation/design-survey/conditional-logic#expressions (linkStyle))
+     * @see setValueExpression
+     */
     get defaultValueExpression(): string;
     set defaultValueExpression(val: string);
+    /**
+     * A Boolean expression. If it evaluates to `true`, all cells in this column are set to a value calculated using the [`setValueExpression`](#setValueExpression).
+     *
+     * [Expressions](https://surveyjs.io/form-library/documentation/design-survey/conditional-logic#expressions (linkStyle))
+     * @see resetValueIf
+     */
     get setValueIf(): string;
     set setValueIf(val: string);
+    /**
+     * An expression used to calculate a value for all column cells.
+     *
+     * You can use `setValueExpression` as a standalone property or in conjunction with the [`setValueIf`](#setValueIf) expression, in which case the calculated cell value applies only when `setValueIf` evaluates to `true`.
+     *
+     * [Expressions](https://surveyjs.io/form-library/documentation/design-survey/conditional-logic#expressions (linkStyle))
+     * @see defaultValueExpression
+     * @see resetValueIf
+     */
     get setValueExpession(): string;
     set setValueExpession(val: string);
+    /**
+     * Specifies whether a respondent is required to provide a unique response for each question within this column.
+     *
+     * Default value: `false`
+     */
     get isUnique(): boolean;
     set isUnique(val: boolean);
+    /**
+     * Specifies whether to create an individual column for each choice option. Applies only to columns of `"checkbox"` or `"radiogroup"` [`cellType`](#cellType).
+     */
     get showInMultipleColumns(): boolean;
     set showInMultipleColumns(val: boolean);
     get isSupportMultipleColumns(): boolean;
     get isShowInMultipleColumns(): boolean;
+    /**
+     * Column validators.
+     *
+     * [Data Validation](https://surveyjs.io/form-library/documentation/data-validation (linkStyle))
+     * @see isRequired
+     */
     get validators(): Array<SurveyValidator>;
     set validators(val: Array<SurveyValidator>);
+    /**
+     * An aggregation method used to calculate the column total.
+     *
+     * Possible values:
+     *
+     * - `"none"` (default) - Disables total calculations.
+     * - `"sum"`
+     * - `"count"`
+     * - `"min"`
+     * - `"max"`
+     * - `"avg"`
+     *
+     * [View Demo](https://surveyjs.io/form-library/examples/aggregate-data-within-form/ (linkStyle))
+     * @see totalFormat
+     * @see totalDisplayStyle
+     */
     get totalType(): string;
     set totalType(val: string);
+    /**
+     * An expression used to calculate total values. Overrides the [`totalType`](#totalType) property.
+     *
+     * [Expressions](https://surveyjs.io/form-library/documentation/design-survey/conditional-logic#expressions (linkStyle))
+     */
     get totalExpression(): string;
     set totalExpression(val: string);
     get hasTotal(): boolean;
+    /**
+     * A string pattern used to display column totals. To reference a total value within this pattern, use the `{0}` placeholder.
+     *
+     * [View Demo](https://surveyjs.io/form-library/examples/aggregate-data-within-form/ (linkStyle))
+     * @see totalType
+     * @see totalDisplayStyle
+     */
     get totalFormat(): string;
     set totalFormat(val: string);
     get locTotalFormat(): LocalizableString;
@@ -111,14 +258,46 @@ export declare class MatrixDropdownColumn extends Base implements ILocalizableOw
     set totalMaximumFractionDigits(val: number);
     get totalMinimumFractionDigits(): number;
     set totalMinimumFractionDigits(val: number);
+    /**
+     * A format for calculated total values.
+     *
+     * Possible values:
+     *
+     * - `"none"` (default)
+     * - `"decimal"`
+     * - `"currency"`
+     * - `"percent"`
+     *
+     * [View Demo](https://surveyjs.io/form-library/examples/aggregate-data-within-form/ (linkStyle))
+     * @see totalType
+     * @see totalFormat
+     * @see totalCurrency
+     */
     get totalDisplayStyle(): string;
     set totalDisplayStyle(val: string);
+    /**
+     * Specifies a currency used to display calculated total values. Applies only if [`totalDisplayStyle`](#totalDisplayStyle) is set to `"currency"`.
+     * @see totalType
+     */
     get totalCurrency(): string;
     set totalCurrency(val: string);
+    /**
+     * Gets or sets minimum column width in CSS values. By default, the matrix calculates column widths to optimally fit the content of all columns.
+     * @see width
+     */
     get minWidth(): string;
     set minWidth(val: string);
+    /**
+     * Gets or sets column width in CSS values. By default, the matrix calculates column widths to optimally fit the content of all columns.
+     * @see minWidth
+    */
     get width(): string;
     set width(val: string);
+    /**
+     * Gets or sets the number of columns used to arrange choice options. Applies only to columns of `"checkbox"` or `"radiogroup"` [`cellType`](#cellType).
+     *
+     * Default value: -1 (inherits the actual value from the parent matrix's [`columnColCount`](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-with-dropdown-list#columnColCount) property)
+     */
     get colCount(): number;
     set colCount(val: number);
     getLocale(): string;

package/typings/question_paneldynamic.d.ts

@@ -164,6 +164,8 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
      * @see templateVisibleIf
      */
     get visiblePanels(): Array<PanelModel>;
+    protected get panelsCore(): Array<PanelModel>;
+    protected get visiblePanelsCore(): Array<PanelModel>;
     private onPanelAdded;
     private onPanelRemoved;
     private onPanelRemovedCore;
@@ -549,6 +551,11 @@ export declare class QuestionPanelDynamicModel extends Question implements IQues
     protected onReadOnlyChanged(): void;
     private updateNoEntriesTextDefaultLoc;
     onSurveyLoad(): void;
+    private hasPanelBuildFirstTime;
+    private isBuildingPanelsFirstTime;
+    private buildPanelsFirstTime;
+    private get wasNotRenderedInSurvey();
+    private get canBuildPanels();
     onFirstRendering(): void;
     localeChanged(): void;
     runCondition(values: HashTable<any>, properties: HashTable<any>): void;

package/typings/question_ranking.d.ts

@@ -13,6 +13,7 @@ export declare class QuestionRankingModel extends QuestionCheckboxModel {
     protected getDefaultItemComponent(): string;
     getType(): string;
     getItemTabIndex(item: ItemValue): number;
+    protected supportContainerQueries(): boolean;
     get rootClass(): string;
     protected getItemClassCore(item: ItemValue, options: any): string;
     getContainerClasses(containerType?: string): string;

package/typings/settings.d.ts

@@ -142,12 +142,12 @@ export declare var settings: {
      * import { ItemValue, settings } from "survey-core";
      *
      * // `itemValueSerializeAsObject` example
-     * settings.localization.itemValueSerializeAsObject = true;
+     * settings.serialization.itemValueSerializeAsObject = true;
      * const item = new ItemValue(5);
      * const itemString = item.toJSON(); // Produces { value: 5 } instead of 5
      *
      * // `itemValueSerializeDisplayText` example
-     * settings.localization.itemValueSerializeDisplayText = true;
+     * settings.serialization.itemValueSerializeDisplayText = true;
      * const item = new ItemValue("item1");
      * const itemString = item.toJSON(); // Produces { value: "item1", text: "item1" } instead of "item1"
      * ```

package/typings/survey-element.d.ts

@@ -271,6 +271,8 @@ export declare class SurveyElement<E = any> extends SurveyElementCore implements
     set selectedElementInDesign(val: SurveyElement);
     updateCustomWidgets(): void;
     onSurveyLoad(): void;
+    private wasRenderedValue;
+    get wasRendered(): boolean;
     onFirstRendering(): void;
     endLoadingFromJson(): void;
     setVisibleIndex(index: number): number;

package/typings/survey-error.d.ts

@@ -6,7 +6,7 @@ export declare class SurveyError {
     private locTextValue;
     visible: boolean;
     constructor(text?: string, errorOwner?: ISurveyErrorOwner);
-    equalsTo(error: SurveyError): boolean;
+    equals(error: SurveyError): boolean;
     get locText(): LocalizableString;
     getText(): string;
     getErrorType(): string;

package/typings/survey-events-api.d.ts

@@ -694,7 +694,7 @@ export interface MatrixAllowRemoveRowEvent extends MatrixDynamicQuestionEventMix
 }
 export interface MatrixCellCreatingBaseEvent extends MatrixDropdownQuestionEventMixin {
     /**
-     * A matrix column to which the cell belongs.
+     * A [matrix column](https://surveyjs.io/form-library/documentation/api-reference/multi-select-matrix-column-values) to which the cell belongs.
      */
     column: MatrixDropdownColumn;
     /**
@@ -741,7 +741,7 @@ export interface MatrixAfterCellRenderEvent extends QuestionEventMixin, AfterRen
      */
     row: MatrixDropdownRowModelBase;
     /**
-     * A matrix column to which the cell belongs.
+     * A [matrix column](https://surveyjs.io/form-library/documentation/api-reference/multi-select-matrix-column-values) to which the cell belongs.
      */
     column: MatrixDropdownColumn | MatrixDropdownCell;
 }
@@ -751,7 +751,7 @@ export interface MatrixCellValueBaseEvent extends MatrixDropdownQuestionEventMix
      */
     row: MatrixDropdownRowModelBase;
     /**
-     * A matrix column to which the cell belongs.
+     * A [matrix column](https://surveyjs.io/form-library/documentation/api-reference/multi-select-matrix-column-values) to which the cell belongs.
      */
     column: MatrixDropdownColumn;
     /**

package/typings/survey.d.ts

@@ -781,6 +781,9 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
     get lazyRendering(): boolean;
     set lazyRendering(val: boolean);
     get isLazyRendering(): boolean;
+    lazyRenderingFirstBatchSizeValue: number;
+    get lazyRenderingFirstBatchSize(): number;
+    set lazyRenderingFirstBatchSize(val: number);
     private updateLazyRenderingRowsOnRemovingElements;
     /**
      * A list of triggers in the survey.
@@ -1620,6 +1623,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
      */
     get currentPage(): any;
     set currentPage(value: any);
+    tryNavigateToPage(page: PageModel): boolean;
     private updateCurrentPage;
     private get isCurrentPageAvailable();
     private isPageExistsInSurvey;
@@ -2398,6 +2402,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
     private getProcessedValuesWithoutQuestion;
     private getFirstName;
     private reduceFirstName;
+    private isClearingUnsedValues;
     private clearUnusedValues;
     hasVisibleQuestionByValueName(valueName: string): boolean;
     questionsByValueName(valueName: string): Array<IQuestion>;
@@ -2742,6 +2747,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
      * @returns The configuration of the previous layout element with the same `id`.
      */
     addLayoutElement(layoutElement: ISurveyLayoutElement): ISurveyLayoutElement;
+    findLayoutElement(layoutElementId: string): ISurveyLayoutElement;
     removeLayoutElement(layoutElementId: string): ISurveyLayoutElement;
     getContainerContent(container: LayoutElementContainer): any[];
     processPopupVisiblityChanged(question: Question, popup: PopupModel<any>, visible: boolean): void;

package/typings/surveyStrings.d.ts

@@ -40,6 +40,7 @@ export declare var surveyStrings: {
     requiredError: string;
     requiredErrorInPanel: string;
     requiredInAllRowsError: string;
+    eachRowUniqueError: string;
     numericError: string;
     minError: string;
     maxError: string;

package/typings/surveyToc.d.ts

@@ -1,10 +1,8 @@
 import { Action } from "./actions/action";
 import { ListModel } from "./list";
-import { PageModel } from "./page";
 import { PanelModelBase } from "./panel";
 import { PopupModel } from "./popup";
 import { SurveyModel } from "./survey";
-export declare function tryNavigateToPage(survey: SurveyModel, page: PageModel): boolean;
 export declare function tryFocusPage(survey: SurveyModel, panel: PanelModelBase): boolean;
 export declare function createTOCListModel(survey: SurveyModel, onAction?: () => void): ListModel<Action>;
 export declare function getTocRootCss(survey: SurveyModel, isMobile?: boolean): string;

package/typings/themes.d.ts

@@ -59,6 +59,20 @@ export interface ITheme {
      * An object with [advanced survey header settings](https://surveyjs.io/form-library/documentation/api-reference/iheader). Applies when `SurveyModel`'s [`headerView`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#headerView) property is set to `"advanced"`.
      */
     header?: IHeader;
+    /**
+     * Specifies whether the survey header uses only basic appearance settings or applies advanced settings from the survey theme.
+     *
+     * Possible values:
+     *
+     * - `"basic"` (default)\
+     * A basic header view applies only the [`title`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#title), [`description`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#description), and logo-related properties ([`logo`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#logo), [`logoPosition`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#logoPosition), etc.).
+     *
+     * - `"advanced"`\
+     * An advanced header view applies the same properties as the basic view, plus [header settings](https://surveyjs.io/form-library/documentation/api-reference/iheader) from the [survey theme](https://surveyjs.io/form-library/documentation/api-reference/itheme#header). The advanced view features a more flexible header layout, a capability to specify a background image, and other settings that give a more professional look to the survey header.
+     *
+     * [View Demo](https://surveyjs.io/form-library/examples/brand-your-survey-header/ (linkStyle))
+     */
+    headerView?: "advanced" | "basic";
     /**
      * An object with CSS variables.
      */