survey-core/typings/src/question_expression.d.ts

survey.js is a JavaScript Survey Library. It is a modern way to add a survey to your website. It uses JSON for survey metadata and results.

import { HashTable } from "./helpers";
import { Question } from "./question";
import { LocalizableString } from "./localizablestring";
/**
 * A class that describes the Expression question type. It is a read-only question type that calculates a value based on a specified expression.
 *
 * [View Demo](https://surveyjs.io/form-library/examples/questiontype-expression/ (linkStyle))
 */
export declare class QuestionExpressionModel extends Question {
    private expressionIsRunning;
    private expressionRunner;
    constructor(name: string);
    getType(): string;
    get hasInput(): boolean;
    /**
     * A string that formats a question value. Use `{0}` to reference the question value in the format string.
     * @see displayStyle
     */
    get format(): string;
    set format(val: string);
    get locFormat(): LocalizableString;
    /**
     * An expression used to calculate the question value.
     *
     * Refer to the following help topic for more information: [Expressions](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#expressions).
     */
    get expression(): string;
    set expression(val: string);
    locCalculation(): void;
    unlocCalculation(): void;
    protected runConditionCore(values: HashTable<any>, properties: HashTable<any>): void;
    protected canCollectErrors(): boolean;
    hasRequiredError(): boolean;
    private createRunner;
    /**
     * The maximum number of fraction digits. Applies only if the `displayStyle` property is not `"none"`. Accepts values in the range from -1 to 20, where -1 disables the property.
     *
     * Default value: -1
     * @see displayStyle
     * @see minimumFractionDigits
     * @see precision
     */
    get maximumFractionDigits(): number;
    set maximumFractionDigits(val: number);
    /**
     * The minimum number of fraction digits. Applies only if the `displayStyle` property is not `"none"`. Accepts values in the range from -1 to 20, where -1 disables the property.
     *
     * Default value: -1
     * @see displayStyle
     * @see maximumFractionDigits
     */
    get minimumFractionDigits(): number;
    set minimumFractionDigits(val: number);
    private runIfReadOnlyValue;
    get runIfReadOnly(): boolean;
    set runIfReadOnly(val: boolean);
    get formatedValue(): string;
    protected updateFormatedValue(): void;
    protected onValueChanged(): void;
    updateValueFromSurvey(newValue: any, clearData: boolean): void;
    protected getDisplayValueCore(keysAsText: boolean, value: any): any;
    /**
     * Specifies a display style for the question value.
     *
     * Possible values:
     *
     * - `"decimal"`
     * - `"currency"`
     * - `"percent"`
     * - `"date"`
     * - `"none"` (default)
     *
     * If you use the `"currency"` display style, you can also set the `currency` property to specify a currency other than USD.
     * @see currency
     * @see minimumFractionDigits
     * @see maximumFractionDigits
     * @see format
     */
    get displayStyle(): string;
    set displayStyle(val: string);
    /**
     * A three-letter currency code. Applies only if the `displayStyle` property is set to `"currency"`.
     *
     * Default value: "USD".
     * @see displayStyle
     * @see minimumFractionDigits
     * @see maximumFractionDigits
     * @see format
     */
    get currency(): string;
    set currency(val: string);
    /**
     * Specifies whether to use grouping separators in number representation. Separators depend on the selected [locale](https://surveyjs.io/form-library/documentation/surveymodel#locale).
     *
     * Default value: `true`
     */
    get useGrouping(): boolean;
    set useGrouping(val: boolean);
    /**
     * Specifies how many decimal digits to keep in the expression value.
     *
     * Default value: -1 (unlimited)
     * @see maximumFractionDigits
     */
    get precision(): number;
    set precision(val: number);
    private roundValue;
    protected getValueAsStr(val: any): string;
}
export declare function getCurrecyCodes(): Array<string>;