@formstack/forms-renderer
    Preparing search index...

    Interface IFormApi

    interface IFormApi {
        applyTheme(theme: any): void;
        empty(): Promise<void>;
        getField(fieldId: any): TFieldApiUnion;
        getFieldBy(predicate: (field: IFieldApi) => boolean): TFieldApiUnion;
        getFieldByInternalLabel(internalLabel: string): TFieldApiUnion;
        getFields(predicate?: (field: IFieldDto) => boolean): IFieldApi[];
        getFieldsByTableHeaderId(headerId: string): TFieldApiUnion[];
        getFieldsByTableId(tableId: string): TFieldApiUnion[];
        getFieldsByTableInternalLabel(internalLabel: string): TFieldApiUnion[];
        getPagingContext(): IPagingContext;
        getSection(sectionId: any): ISectionApi;
        getSections(predicate?: (section: any) => boolean): any[];
        getSubmissionJSON(): IValidateFormSubmissionDto;
        isRendered(): boolean;
        isWithErrors(): boolean;
        notifyFormEventListeners(type: FormEvents, data: any): Promise<any>;
        registerFormEventListener(listener: IFormEventListener): void;
        reset(): Promise<void>;
        setValues(values: { [fieldId: string]: IFieldValueUnion }): Promise<void>;
        unregisterFormEventListener(listener: IFormEventListener): void;
    }

    Hierarchy (View Summary)

    Index

    Methods

    • Parameters

      • theme: any

      Returns void

    • Returns Promise<void>

    • Parameters

      • Optionalpredicate: (section: any) => boolean

      Returns any[]

    • Returns IValidateFormSubmissionDto

    • Returns boolean

    • Returns boolean

    • Parameters

      Returns Promise<any>

    • Returns Promise<void>