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): TFieldApiUnion;
    getFieldBy(predicate): TFieldApiUnion;
    getFieldByInternalLabel(internalLabel): TFieldApiUnion;
    getFields(predicate?): IFieldApi[];
    getGeneralAttribute(key): any;
    goTo(): void;
    setGeneralAttribute(key, value): void;
    setVisibility(visible): void;
}

Hierarchy (view full)

IAbstractFieldParent
IAbstractEntity
- ISectionApi

Index

Properties

formId getTypeAttribute id setTypeAttribute

Methods

getField getFieldBy getFieldByInternalLabel getFields getGeneralAttribute goTo setGeneralAttribute setVisibility

Properties

formId

formId: string

getTypeAttribute

getTypeAttribute: TGetTypeAttribute<"required" | "type" | "requireConfirmation" | "shouldForceSkipValidation" | "usePageBreak">

id

id: string

setTypeAttribute

setTypeAttribute: TSetTypeAttribute<"required" | "type" | "requireConfirmation" | "shouldForceSkipValidation" | "usePageBreak", any>

Methods

getField

getField(fieldId): TFieldApiUnion
Parameters
- fieldId: any
Returns TFieldApiUnion
Inherited from IAbstractFieldParent.getField

getFieldBy

getFieldBy(predicate): TFieldApiUnion
Parameters
- predicate: ((field) => boolean)
  - - (field): boolean
    - Parameters
      field: IFieldApi
      Returns boolean
Returns TFieldApiUnion
Inherited from IAbstractFieldParent.getFieldBy

getFieldByInternalLabel

getFieldByInternalLabel(internalLabel): TFieldApiUnion
Parameters
- internalLabel: string
Returns TFieldApiUnion
Inherited from IAbstractFieldParent.getFieldByInternalLabel

getFields

getFields(predicate?): IFieldApi[]
Parameters
- Optional predicate: ((field) => boolean)
  - - (field): boolean
    - Parameters
      field: IFieldDto
      Returns boolean
Returns IFieldApi[]
Inherited from IAbstractFieldParent.getFields

getGeneralAttribute

getGeneralAttribute(key): any
Parameters
- key: string
Returns any
Inherited from IAbstractEntity.getGeneralAttribute

goTo

goTo(): void
Scrolls to the targetted field

Returns void
Inherited from IAbstractEntity.goTo

setGeneralAttribute

setGeneralAttribute(key, value): void
Parameters
- key: string
- value: any
Returns void
Inherited from IAbstractEntity.setGeneralAttribute

setVisibility

setVisibility(visible): void
Parameters
- visible: boolean
Returns void
Inherited from IAbstractEntity.setVisibility