survey-core 1.12.21 → 1.12.22

package/typings/src/question_matrix.d.ts

@@ -0,0 +1,198 @@
+import { HashTable } from "./helpers";
+import { ItemValue } from "./itemvalue";
+import { QuestionMatrixBaseModel } from "./martixBase";
+import { Base } from "./base";
+import { SurveyError } from "./survey-error";
+import { LocalizableString, ILocalizableOwner } from "./localizablestring";
+import { IConditionObject, IQuestionPlainData } from "./question";
+import { IPlainDataOptions } from "./base-interfaces";
+import { ConditionRunner } from "./conditions";
+export interface IMatrixData {
+    onMatrixRowChanged(row: MatrixRowModel): void;
+    getCorrectedRowValue(value: any): any;
+    cssClasses: any;
+    isDisabledStyle: boolean;
+    isInputReadOnly: boolean;
+    isDisabledAttr: boolean;
+    isReadOnlyAttr: boolean;
+    hasErrorInRow(row: MatrixRowModel): boolean;
+}
+export declare class MatrixRowModel extends Base {
+    item: ItemValue;
+    fullName: string;
+    private data;
+    cellClick: any;
+    constructor(item: ItemValue, fullName: string, data: IMatrixData, value: any);
+    get name(): string;
+    get text(): string;
+    get locText(): LocalizableString;
+    get value(): any;
+    set value(val: any);
+    setValueDirectly(val: any): void;
+    get isReadOnly(): boolean;
+    get isReadOnlyAttr(): boolean;
+    get isDisabledAttr(): boolean;
+    get rowTextClasses(): string;
+    get hasError(): boolean;
+    set hasError(val: boolean);
+    get rowClasses(): string;
+}
+export interface IMatrixCellsOwner extends ILocalizableOwner {
+    getRows(): Array<any>;
+    getColumns(): Array<any>;
+}
+export declare class MatrixCells extends Base {
+    cellsOwner: IMatrixCellsOwner;
+    private values;
+    private locs;
+    constructor(cellsOwner: IMatrixCellsOwner);
+    getType(): string;
+    get isEmpty(): boolean;
+    onValuesChanged: () => void;
+    private locNotification;
+    private valuesChanged;
+    getDefaultCellLocText(column: any): LocalizableString;
+    getCellDisplayLocText(row: any, column: any): LocalizableString;
+    private getCellLocCore;
+    private get defaultRowValue();
+    private getCellLocData;
+    private getCellLocDataFromValue;
+    getCellText(row: any, column: any): string;
+    setCellText(row: any, column: any, val: string): void;
+    private updateValues;
+    getDefaultCellText(column: any): string;
+    setDefaultCellText(column: any, val: string): void;
+    getCellDisplayText(row: any, column: any): string;
+    get rows(): Array<any>;
+    get columns(): Array<any>;
+    private getCellRowColumnValue;
+    getJson(): any;
+    setJson(value: any, isLoading?: boolean): void;
+    locStrsChanged(): void;
+    private runFuncOnLocs;
+    protected createString(): LocalizableString;
+}
+/**
+  * A class that describes the Single-Select Matrix question type.
+  *
+  * [View Demo](https://surveyjs.io/form-library/examples/single-selection-matrix-table-question/ (linkStyle))
+  */
+export declare class QuestionMatrixModel extends QuestionMatrixBaseModel<MatrixRowModel, ItemValue> implements IMatrixData, IMatrixCellsOwner {
+    private isRowChanging;
+    private cellsValue;
+    constructor(name: string);
+    getType(): string;
+    /**
+     * The name of a component used to render cells.
+     */
+    get cellComponent(): string;
+    set itemComponent(value: string);
+    get hasSingleInput(): boolean;
+    /**
+     * Specifies whether each row requires an answer. If a respondent skips a row, the question displays a validation error.
+     * @see isRequired
+     * @see eachRowUnique
+     * @see validators
+     */
+    get eachRowRequired(): boolean;
+    set eachRowRequired(val: boolean);
+    /**
+     * @deprecated Use the [`eachRowRequired`](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-question-model#eachRowRequired) property instead.
+     */
+    get isAllRowRequired(): boolean;
+    set isAllRowRequired(val: boolean);
+    /**
+     * Specifies whether answers in all rows should be unique. If any answers duplicate, the question displays a validation error.
+     * @see eachRowRequired
+     * @see validators
+     */
+    get eachRowUnique(): boolean;
+    set eachRowUnique(val: boolean);
+    get hasRows(): boolean;
+    /**
+     * Specifies a sort order for matrix rows.
+     *
+     * Possible values:
+     *
+     * - `"initial"` (default) - Preserves the original order of the `rows` array.
+     * - `"random"` - Arranges matrix rows in random order each time the question is displayed.
+     * @see rows
+     */
+    get rowOrder(): string;
+    set rowOrder(val: string);
+    /**
+     * @deprecated Use the [`rowOrder`](https://surveyjs.io/form-library/documentation/api-reference/matrix-table-question-model#rowOrder) property instead.
+     */
+    get rowsOrder(): string;
+    set rowsOrder(val: string);
+    /**
+     * Specifies whether to hide the question when the matrix has no visible rows.
+     * @see rowsVisibleIf
+     */
+    get hideIfRowsEmpty(): boolean;
+    set hideIfRowsEmpty(val: boolean);
+    getRows(): Array<any>;
+    getColumns(): Array<any>;
+    addColumn(value: any, text?: string): ItemValue;
+    getItemClass(row: any, column: any): string;
+    get itemSvgIcon(): string;
+    locStrsChanged(): void;
+    protected getQuizQuestionCount(): number;
+    protected getCorrectAnswerCount(): number;
+    protected runConditionCore(values: HashTable<any>, properties: HashTable<any>): void;
+    protected createRowsVisibleIfRunner(): ConditionRunner;
+    protected onRowsChanged(): void;
+    protected getVisibleRows(): Array<MatrixRowModel>;
+    protected sortVisibleRows(array: Array<MatrixRowModel>): Array<MatrixRowModel>;
+    endLoadingFromJson(): void;
+    protected isNewValueCorrect(val: any): boolean;
+    protected processRowsOnSet(newRows: Array<any>): MatrixRowModel[];
+    get visibleRows(): Array<MatrixRowModel>;
+    /**
+     * An array of matrix cells. Use this array to get or set cell values.
+     *
+     * [View Demo](https://surveyjs.io/form-library/examples/questiontype-matrix-rubric/ (linkStyle))
+     */
+    get cells(): MatrixCells;
+    set cells(value: 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;
+    getDefaultCellText(column: any): string;
+    getCellDisplayText(row: any, column: any): string;
+    private emptyLocalizableString;
+    getCellDisplayLocText(row: any, column: any): LocalizableString;
+    supportAutoAdvance(): boolean;
+    private errorsInRow;
+    protected onCheckForErrors(errors: Array<SurveyError>, isOnValueChanged: boolean, fireCallback: boolean): void;
+    private hasValuesInAllRows;
+    private checkErrorsAllRows;
+    private addErrorIntoRow;
+    private refreshRowsErrors;
+    protected getIsAnswered(): boolean;
+    private createMatrixRow;
+    protected onMatrixRowCreated(row: MatrixRowModel): void;
+    protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
+    protected getDisplayValueCore(keysAsText: boolean, value: any): any;
+    getPlainData(options?: IPlainDataOptions): IQuestionPlainData;
+    addConditionObjectsByContext(objects: Array<IConditionObject>, context: any): void;
+    getConditionJson(operator?: string, path?: string): any;
+    clearIncorrectValues(): void;
+    protected clearValueIfInvisibleCore(reason: string): void;
+    protected clearInvisibleColumnValues(): void;
+    protected clearInvisibleValuesInRows(): void;
+    protected clearInvisibleValuesInRowsAndColumns(inRows: boolean, inColumns: boolean, inCorrectRows: boolean): void;
+    private getVisibleColumnByValue;
+    protected getFirstInputElementId(): string;
+    onMatrixRowChanged(row: MatrixRowModel): void;
+    getCorrectedRowValue(value: any): any;
+    hasErrorInRow(row: MatrixRowModel): boolean;
+    protected getSearchableItemValueKeys(keys: Array<string>): void;
+    private get SurveyModel();
+    getColumnHeaderWrapperComponentName(cell: ItemValue): string;
+    getColumnHeaderWrapperComponentData(cell: ItemValue): any;
+    getRowHeaderWrapperComponentName(cell: ItemValue): string;
+    getRowHeaderWrapperComponentData(cell: ItemValue): any;
+}

package/typings/src/question_matrixdropdown.d.ts

@@ -0,0 +1,56 @@
+import { QuestionMatrixDropdownModelBase, MatrixDropdownRowModelBase, IMatrixDropdownData } from "./question_matrixdropdownbase";
+import { ItemValue } from "./itemvalue";
+import { LocalizableString } from "./localizablestring";
+import { IProgressInfo } from "./base-interfaces";
+export declare class MatrixDropdownRowModel extends MatrixDropdownRowModelBase {
+    name: string;
+    private item;
+    constructor(name: string, item: ItemValue, data: IMatrixDropdownData, value: any);
+    get rowName(): string;
+    get text(): string;
+    get locText(): LocalizableString;
+    protected isItemVisible(): boolean;
+    isRowEnabled(): boolean;
+    protected isRowHasEnabledCondition(): boolean;
+    protected setRowsVisibleIfValues(values: any): void;
+}
+/**
+  * A class that describes the Multi-Select Matrix question type. Multi-Select Matrix allows you to use the [Dropdown](https://surveyjs.io/form-library/documentation/questiondropdownmodel), [Checkbox](https://surveyjs.io/form-library/documentation/questioncheckboxmodel), [Radiogroup](https://surveyjs.io/form-library/documentation/questionradiogroupmodel), [Text](https://surveyjs.io/form-library/documentation/questiontextmodel), and [Comment](https://surveyjs.io/form-library/documentation/questioncommentmodel) question types as cell editors.
+ *
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-matrixdropdown/ (linkStyle))
+ */
+export declare class QuestionMatrixDropdownModel extends QuestionMatrixDropdownModelBase implements IMatrixDropdownData {
+    constructor(name: string);
+    getType(): string;
+    /**
+     * A title for the total row. Applies if at least one column displays total values.
+     * @see rowTitleWidth
+     * @see columns
+     */
+    get totalText(): string;
+    set totalText(val: string);
+    get locTotalText(): LocalizableString;
+    getFooterText(): LocalizableString;
+    getRowTitleWidth(): string;
+    /**
+     * Specifies whether to hide the question when the matrix has no visible rows.
+     * @see rowsVisibleIf
+     */
+    get hideIfRowsEmpty(): boolean;
+    set hideIfRowsEmpty(val: boolean);
+    protected getDisplayValueCore(keysAsText: boolean, value: any): any;
+    protected getConditionObjectRowName(index: number): string;
+    protected getConditionObjectRowText(index: number): string;
+    protected getConditionObjectsRowIndeces(): Array<number>;
+    protected isNewValueCorrect(val: any): boolean;
+    clearIncorrectValues(): void;
+    private getRowByKey;
+    private defaultValuesInRows;
+    protected clearGeneratedRows(): void;
+    private getRowValueForCreation;
+    protected generateRows(): Array<MatrixDropdownRowModel>;
+    protected createMatrixRow(item: ItemValue, value: any): MatrixDropdownRowModel;
+    protected getFilteredDataCore(): any;
+    protected getSearchableItemValueKeys(keys: Array<string>): void;
+    protected updateProgressInfoByValues(res: IProgressInfo): void;
+}