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

    Interface ISectionApi

    Section API

    interface ISectionApi {
        formId: string;
        getTypeAttribute: TGetTypeAttribute<
            | "required"
            | "type"
            | "requireConfirmation"
            | "shouldForceSkipValidation"
            | "usePageBreak",
        >;
        id: string;
        setTypeAttribute: TSetTypeAttribute<
            | "required"
            | "type"
            | "requireConfirmation"
            | "shouldForceSkipValidation"
            | "usePageBreak",
            any,
        >;
        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[];
        getGeneralAttribute(key: string): any;
        getParentTableMetadata(): any;
        goTo(): void;
        setGeneralAttribute(key: string, value: any): void;
        setVisibility(visible: boolean): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    formId getTypeAttribute id setTypeAttribute

    Methods

    getField getFieldBy getFieldByInternalLabel getFields getFieldsByTableHeaderId getFieldsByTableId getFieldsByTableInternalLabel getGeneralAttribute getParentTableMetadata goTo setGeneralAttribute setVisibility

    Properties

    formId: string
    getTypeAttribute: TGetTypeAttribute<
        | "required"
        | "type"
        | "requireConfirmation"
        | "shouldForceSkipValidation"
        | "usePageBreak",
    >
    id: string
    setTypeAttribute: TSetTypeAttribute<
        | "required"
        | "type"
        | "requireConfirmation"
        | "shouldForceSkipValidation"
        | "usePageBreak",
        any,
    >

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods