Class MetaForm

This class is responsible for handling all the heavy lifting work in the forms

Hierarchy

MetaForm

Implements

IMetaForm

Constructors

constructor

new MetaForm(schema: ISchema, eventEmitter: EventEmitter<string | symbol, any>): MetaForm
Parameters
- schema: ISchema
- eventEmitter: EventEmitter<string | symbol, any>
Returns MetaForm
- Defined in src/core/MetaForm.tsx:44

Properties

controls

controls: IElementTypes

`Optional` errorHandler

errorHandler?: TErrorCallback

`Private` eventEmitter

eventEmitter: EventEmitter<string | symbol, any>

`Optional` fns

form

form: IForm

`Optional` icons

icons?: IElementTypes

page

page: Page

rest

rest: Rest

`Private` schema

schema: ISchema

theme

theme: ITheme

Methods

api

api(type: string, url: string, params?: TParam[], currentValue?: TValue, sectionName?: string, isRemote?: boolean): Promise<any>
Parameters
- type: string
- url: string
- Optional params: TParam[]
- Optional currentValue: TValue
- Optional sectionName: string
- Optional isRemote: boolean
Returns Promise<any>
- Defined in src/core/MetaForm.tsx:150

applyDependencies

applyDependencies(section: string, fields: IField[]): void
Parameters
- section: string
- fields: IField[]
Returns void
- Defined in src/core/MetaForm.tsx:329

destroy

destroy(): void
Returns void
- Defined in src/core/MetaForm.tsx:132

emit

emit(eventType: string, payload?: IEventPayload): void
event emitter functions
Parameters
- eventType: string
- Optional payload: IEventPayload
Returns void
- Defined in src/core/MetaForm.tsx:120

getChangeEvents

getChangeEvents(section: string, field: string): any
Parameters
- section: string
- field: string
Returns any
- Defined in src/core/MetaForm.tsx:325

getControl

getControl(displayType: string): Element
Parameters
- displayType: string
Returns Element
- Defined in src/core/MetaForm.tsx:606

getData

getData(config: IFieldConfig, val: TValue, section: string, eventType?: string): Promise<IOption[]>
Parameters
- config: IFieldConfig
- val: TValue
- section: string
- Optional eventType: string
Returns Promise<IOption[]>
- Defined in src/core/MetaForm.tsx:189

getDependencies

getDependencies(section: string, field: string): any
Parameters
- section: string
- field: string
Returns any
- Defined in src/core/MetaForm.tsx:320

getField

getField(section: string, field: string): IFormField
Parameters
- section: string
- field: string
Returns IFormField
- Defined in src/core/MetaForm.tsx:277

getFieldDisplay

getFieldDisplay(section: string, field: string): any
Parameters
- section: string
- field: string
Returns any
- Defined in src/core/MetaForm.tsx:300

getFieldOptions

getFieldOptions(section: string, field: string): any
Parameters
- section: string
- field: string
Returns any
- Defined in src/core/MetaForm.tsx:308

getFieldProp

getFieldProp(section: string, field: string, prop: string): any
Parameters
- section: string
- field: string
- prop: string
Returns any
- Defined in src/core/MetaForm.tsx:292

getFn

getFn(fn: string): null | ((arg: TValue, ref?: IOption) => TValue)
Function mapper
Parameters
- fn: string
Returns null | ((arg: TValue, ref?: IOption) => TValue)
- Defined in src/core/MetaForm.tsx:580

getIcon

getIcon(type: string): "" | Element
icons
Parameters
- type: string
Returns "" | Element
- Defined in src/core/MetaForm.tsx:137

getPage

getPage(): Page
page functions

Returns Page
- Defined in src/core/MetaForm.tsx:96

getRestConfig

getRestConfig(): IConfig
rest functions

Returns IConfig
- Defined in src/core/MetaForm.tsx:146

getSection

getSection(pageNumber: number): null | object
Parameters
- pageNumber: number
Returns null | object
- Defined in src/core/MetaForm.tsx:238

getThemeProp

getThemeProp(themeName: string, prop: string): any
Theme functions
Parameters
- themeName: string
- prop: string
Returns any
- Defined in src/core/MetaForm.tsx:232

handleChangeEvents

handleChangeEvents(gSection: string, gField: string, fieldValue?: TValue, fieldRef?: IOption): void
Parameters
- gSection: string
- gField: string
- Optional fieldValue: TValue
- Optional fieldRef: IOption
Returns void
- Defined in src/core/MetaForm.tsx:426

handleDependencies

handleDependencies(section: string, fieldName: string, value: TValue, fieldDisplayed: boolean): Promise<undefined | boolean>
Parameters
- section: string
- fieldName: string
- value: TValue
- fieldDisplayed: boolean
Returns Promise<undefined | boolean>
- Defined in src/core/MetaForm.tsx:422

handleError

handleError(error: Error, section: string, field: string): void
Error handler
Parameters
- error: Error
- section: string
- field: string
Returns void
- Defined in src/core/MetaForm.tsx:592

init

init(): void
Returns void
- Defined in src/core/MetaForm.tsx:57

initField

initField(section: string, field: IField): void
Parameters
- section: string
- field: IField
Returns void
- Defined in src/core/MetaForm.tsx:253

listener

listener(eventType: string, fn: ((data: IEventPayload) => void)): void
Parameters
- eventType: string
- fn: ((data: IEventPayload) => void)
  - - (data: IEventPayload): void
    - Parameters
      
      data: IEventPayload
      
      Returns void
Returns void
- Defined in src/core/MetaForm.tsx:124

parseCondition

parseCondition(condition: TCondition[], section: string): any
Parameters
- condition: TCondition[]
- section: string
Returns any
- Defined in src/core/MetaForm.tsx:575

performDeepUpdate

performDeepUpdate(section: string, field: string, value: TValue, ref: IOption): void
Parameters
- section: string
- field: string
- value: TValue
- ref: IOption
Returns void
- Defined in src/core/MetaForm.tsx:551

removeListener

removeListener(event: string, fn?: ((data: IEventPayload) => void)): void
Parameters
- event: string
- Optional fn: ((data: IEventPayload) => void)
  - - (data: IEventPayload): void
    - Parameters
      
      data: IEventPayload
      
      Returns void
Returns void
- Defined in src/core/MetaForm.tsx:128

resetEndOfPage

resetEndOfPage(): void
Returns void
- Defined in src/core/MetaForm.tsx:114

setControls

setControls(controls: IElementTypes): void
Parameters
- controls: IElementTypes
Returns void
- Defined in src/core/MetaForm.tsx:613

setDisplayTypeFieldProp

setDisplayTypeFieldProp(displayType: string, section: string, field: string, resultOptions: IOption[], dependency: IDepdendencyItem): void
Parameters
- displayType: string
- section: string
- field: string
- resultOptions: IOption[]
- dependency: IDepdendencyItem
Returns void
- Defined in src/core/MetaForm.tsx:518

setEndOfPage

setEndOfPage(pageNumber: undefined | number): void
Parameters
- pageNumber: undefined | number
Returns void
- Defined in src/core/MetaForm.tsx:109

setError

setError(section: string, field: string, error: IError): void
validation functions
Parameters
- section: string
- field: string
- error: IError
Returns void
- Defined in src/core/MetaForm.tsx:557

setErrorHandler

setErrorHandler(errorHandler: TErrorCallback): void
Parameters
- errorHandler: TErrorCallback
Returns void
- Defined in src/core/MetaForm.tsx:602

setField

setField(section: string, field: string, value: TValue): void
Parameters
- section: string
- field: string
- value: TValue
Returns void
- Defined in src/core/MetaForm.tsx:281

setFieldDisabled

setFieldDisabled(section: string, field: string, disabled: boolean): void
Parameters
- section: string
- field: string
- disabled: boolean
Returns void
- Defined in src/core/MetaForm.tsx:316

setFieldDisplay

setFieldDisplay(section: string, field: string, display: boolean): void
Parameters
- section: string
- field: string
- display: boolean
Returns void
- Defined in src/core/MetaForm.tsx:304

setFieldOptions

setFieldOptions(section: string, field: string, options: undefined | IOption[]): void
Parameters
- section: string
- field: string
- options: undefined | IOption[]
Returns void
- Defined in src/core/MetaForm.tsx:312

setFieldProp

setFieldProp(section: string, field: string, prop: string, propVal: TValue | IError | TFieldRef[]): void
Parameters
- section: string
- field: string
- prop: string
- propVal: TValue | IError | TFieldRef[]
Returns void
- Defined in src/core/MetaForm.tsx:296

setFns

setFns(fns: IFnTypes): void
Parameters
- fns: IFnTypes
Returns void
- Defined in src/core/MetaForm.tsx:587

setIcons

setIcons(icons: IElementTypes): void
Parameters
- icons: IElementTypes
Returns void
- Defined in src/core/MetaForm.tsx:141

setPage

setPage(page: Page): void
Parameters
- page: Page
Returns void
- Defined in src/core/MetaForm.tsx:100

setSection

setSection(section: string): void
Parameters
- section: string
Returns void
- Defined in src/core/MetaForm.tsx:249

updateField

updateField(section: string, field: string, value: TValue): void
Parameters
- section: string
- field: string
- value: TValue
Returns void
- Defined in src/core/MetaForm.tsx:285

updatePage

updatePage(pageNumber: number): void
Parameters
- pageNumber: number
Returns void
- Defined in src/core/MetaForm.tsx:104

validate

validate(): boolean
Returns boolean
- Defined in src/core/MetaForm.tsx:561

Generated using TypeDoc