survey-core/typings/src/trigger.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 { Base } from "./base";
import { ISurvey } from "./base-interfaces";
/**
 * A base class for all triggers.
 * A trigger calls a method when the expression change the result: from false to true or from true to false.
 * Please note, it runs only one changing the expression result.
 */
export declare class Trigger extends Base {
    static idCounter: number;
    static operatorsValue: HashTable<Function>;
    static get operators(): HashTable<Function>;
    private conditionRunner;
    private idValue;
    constructor();
    get id(): number;
    getType(): string;
    toString(): string;
    isGhost: boolean;
    protected get isInternal(): boolean;
    get operator(): string;
    set operator(value: string);
    get value(): any;
    set value(val: any);
    get name(): string;
    set name(val: string);
    get expression(): string;
    set expression(val: string);
    protected canBeExecuted(isOnNextPage: boolean): boolean;
    protected canBeExecutedOnComplete(): boolean;
    protected isExecutingOnNextPage: boolean;
    protected isExecutingOnNavigation: boolean;
    checkExpression(options: {
        isOnNextPage: boolean;
        isOnComplete: boolean;
        isOnNavigation: boolean;
        keys: any;
        values: HashTable<any>;
        properties?: HashTable<any>;
    }): void;
    protected canSuccessOnEmptyExpression(): boolean;
    check(value: any): void;
    get requireValidQuestion(): boolean;
    private perform;
    private triggerResult;
    protected onSuccess(values: HashTable<any>, properties: HashTable<any>): void;
    protected onFailure(): void;
    protected onSuccessExecuted(): void;
    endLoadingFromJson(): void;
    private oldPropertiesChanged;
    private onExpressionChanged;
    buildExpression(): string;
    private isCheckRequired;
    protected getUsedVariables(): string[];
    private createConditionRunner;
    private get isRequireValue();
}
export interface ISurveyTriggerOwner {
    getObjects(pages: string[], questions: string[]): any[];
    setCompleted(trigger: Trigger): void;
    canBeCompleted(trigger: Trigger, isCompleted: boolean): void;
    triggerExecuted(trigger: Trigger): void;
    setTriggerValue(name: string, value: any, isVariable: boolean): any;
    copyTriggerValue(name: string, fromName: string, copyDisplayValue: boolean): void;
    focusQuestion(name: string): boolean;
}
/**
 * It extends the Trigger base class and add properties required for SurveyJS classes.
 */
export declare class SurveyTrigger extends Trigger {
    protected ownerValue: ISurveyTriggerOwner;
    constructor();
    get owner(): ISurveyTriggerOwner;
    setOwner(owner: ISurveyTriggerOwner): void;
    getSurvey(live?: boolean): ISurvey;
    protected isRealExecution(): boolean;
    protected onSuccessExecuted(): void;
}
/**
 * If expression returns true, it makes questions/pages visible.
 * Ohterwise it makes them invisible.
 */
export declare class SurveyTriggerVisible extends SurveyTrigger {
    pages: string[];
    questions: string[];
    constructor();
    getType(): string;
    protected onSuccess(values: HashTable<any>, properties: HashTable<any>): void;
    protected onFailure(): void;
    private onTrigger;
    protected onItemSuccess(item: any): void;
    protected onItemFailure(item: any): void;
}
/**
 * If expression returns true, it completes the survey.
 */
export declare class SurveyTriggerComplete extends SurveyTrigger {
    constructor();
    getType(): string;
    get requireValidQuestion(): boolean;
    protected isRealExecution(): boolean;
    protected onSuccess(values: HashTable<any>, properties: HashTable<any>): void;
    protected onFailure(): void;
}
/**
 * If expression returns true, the value from property **setValue** will be set to **setToName**
 */
export declare class SurveyTriggerSetValue extends SurveyTrigger {
    constructor();
    getType(): string;
    protected canBeExecuted(isOnNextPage: boolean): boolean;
    protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
    get setToName(): string;
    set setToName(val: string);
    get setValue(): any;
    set setValue(val: any);
    get isVariable(): boolean;
    set isVariable(val: boolean);
    protected onSuccess(values: HashTable<any>, properties: HashTable<any>): void;
}
/**
 * If expression returns true, the survey go to question **gotoName** and focus it.
 */
export declare class SurveyTriggerSkip extends SurveyTrigger {
    constructor();
    getType(): string;
    get requireValidQuestion(): boolean;
    get gotoName(): string;
    set gotoName(val: string);
    protected canBeExecuted(isOnNextPage: boolean): boolean;
    protected onSuccess(values: HashTable<any>, properties: HashTable<any>): void;
}
/**
 * If expression returns true, the **runExpression** will be run. If **setToName** property is not empty then the result of **runExpression** will be set to it.
 */
export declare class SurveyTriggerRunExpression extends SurveyTrigger {
    constructor();
    getType(): string;
    get setToName(): string;
    set setToName(val: string);
    get runExpression(): string;
    set runExpression(val: string);
    protected canBeExecuted(isOnNextPage: boolean): boolean;
    protected onSuccess(values: HashTable<any>, properties: HashTable<any>): boolean;
    private onCompleteRunExpression;
}
/**
 * If expression returns true, the value from question **fromName** will be set into **setToName**.
 */
export declare class SurveyTriggerCopyValue extends SurveyTrigger {
    constructor();
    protected canBeExecuted(isOnNextPage: boolean): boolean;
    get setToName(): string;
    set setToName(val: string);
    get fromName(): string;
    set fromName(val: string);
    get copyDisplayValue(): boolean;
    set copyDisplayValue(val: boolean);
    getType(): string;
    protected onSuccess(values: HashTable<any>, properties: HashTable<any>): void;
    protected canSuccessOnEmptyExpression(): boolean;
    protected getUsedVariables(): string[];
}