Class RepeatingUnits

Static properties and methods related to the repeating units

Hierarchy

RepeatingUnits

Index

Constructors

Methods

add addDynamically addEventListener count findTab get getElement getPostfixFieldId getRepeatingUnitId getRepeatingUnitIndex isRepeatingUnit remove removeEventListener

Constructors

constructor

new RepeatingUnits(): RepeatingUnits
Returns RepeatingUnits

Methods

`Static` add

add(repeatingUnitId: string, index?: number, autoSaveOnAdd?: boolean, enableScroll?: boolean, setInitialStatus?: boolean): Promise<number>
Adds a repeating unit.
Parameters
- repeatingUnitId: string
  
  The id of the repeating unit.
- Optional index: number
  
  The index, the repeating unit should be added at.
- Optional autoSaveOnAdd: boolean
  
  default true. Control auto save of form if repeating unit was added.
- Optional enableScroll: boolean
  
  default true. Control if auto scroll to newly created unit is active or not.
- Optional setInitialStatus: boolean
  
  default true. Control if StatusWatcher gets initialized or not.
Returns Promise<number>

`Static` addDynamically

addDynamically(tabId: string, index?: number): Promise<number>
Adds a repeating unit dynamically. Mainly for AdaptiveForms
Parameters
- tabId: string
  
  The id of the repeating unit.
- Optional index: number
  
  The index, the repeating unit should be added at.
Returns Promise<number>

`Static` addEventListener

addEventListener(repeatingUnitId: string, type: "removed" | "beforeadd" | "added" | "beforeremove", callback: ((result: number) => void | Promise<void>)): void
Adds an event listener to the repeating unit.
Parameters
- repeatingUnitId: string
  
  The id of the repeating unit.
- type: "removed" | "beforeadd" | "added" | "beforeremove"
  
  The type of the event listener. Allowed types are defined in RepeatingUnitEventsEnum.
- callback: ((result: number) => void | Promise<void>)
  
  The callback function, that gets called after the event is fired.
  - - (result: number): void | Promise<void>
    - Parameters
      
      result: number
      
      Returns void | Promise<void>
Returns void

`Static` count

count(repeatingUnitId: string): number
Returns the count of the repeating units.
Parameters
- repeatingUnitId: string
  
  The id of the repeating unit.
Returns number

`Static` findTab

findTab(repeatingUnitId: string): ITab
Finds the repeating unit tab, if found, the tab is returned.
Parameters
- repeatingUnitId: string
  
  The id of the repeating unit.
Returns ITab

`Static` get

get(repeatingUnitId: string): any
Gets the instance of the RepeatingUnit by given Id.
Parameters
- repeatingUnitId: string
  
  The id of the repeating unit.
Returns any

`Static` getElement

getElement(repeatingUnitId: string): HTMLElement
Gets the element, that the repeating unit is included
Parameters
- repeatingUnitId: string
  
  The id of the repeating unit.
Returns HTMLElement

`Static` getPostfixFieldId

getPostfixFieldId(element: HTMLElement): string
Gets the postfix id of an certain HTML Element. this is often useful, if you wish to change, set etc. a certain form control value at a certain repeating unit index position.
Parameters
- element: HTMLElement
Returns string

`Static` getRepeatingUnitId

getRepeatingUnitId(fieldId: string): string
Gets the id of the repeating unit, if the provided field id is included in a repeating unit.
Parameters
- fieldId: string
Returns string

`Static` getRepeatingUnitIndex

getRepeatingUnitIndex(element: HTMLElement): number
Gets the repeating unit index of an certain HTML Element.
Parameters
- element: HTMLElement
Returns number

`Static` isRepeatingUnit

isRepeatingUnit(element: HTMLElement): boolean
Checks if an element is included in a repeating unit;
Parameters
- element: HTMLElement
Returns boolean

`Static` remove

remove(repeatingUnitId: string, index: number, autoSaveOnRemove?: boolean, enableScroll?: boolean): Promise<number>
Removes a repeating unit at a certain index.
Parameters
- repeatingUnitId: string
  
  The id of the repeating unit.
- index: number
  
  The index, the repeating unit should be removed at.
- Optional autoSaveOnRemove: boolean
  
  default true. Control auto save of form if repeating unit was removed.
- Optional enableScroll: boolean
  
  default true. Control if auto scroll to newly created unit is active or not.
Returns Promise<number>

`Static` removeEventListener

removeEventListener(repeatingUnitId: string, type: "removed" | "beforeadd" | "added" | "beforeremove", callback: ((result: number) => void | Promise<void>)): void
Always remove previously registered events
Parameters
- repeatingUnitId: string
  
  The id of the repeating unit.
- type: "removed" | "beforeadd" | "added" | "beforeremove"
  
  The type of the event listener. Allowed types are defined in RepeatingUnitEventsEnum.
- callback: ((result: number) => void | Promise<void>)
  
  The callback function, that gets called after the event is fired.
  - - (result: number): void | Promise<void>
    - Parameters
      
      result: number
      
      Returns void | Promise<void>
Returns void

Class RepeatingUnits

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns RepeatingUnits

Methods

Static add

Parameters

repeatingUnitId: string

Optional index: number

Optional autoSaveOnAdd: boolean

Optional enableScroll: boolean

Optional setInitialStatus: boolean

Returns Promise<number>

Static addDynamically

Parameters

tabId: string

Optional index: number

Returns Promise<number>

Static addEventListener

Parameters

repeatingUnitId: string

type: "removed" | "beforeadd" | "added" | "beforeremove"

callback: ((result: number) => void | Promise<void>)

Parameters

result: number

Returns void | Promise<void>

Returns void

Static count

Parameters

repeatingUnitId: string

Returns number

Static findTab

Parameters

repeatingUnitId: string

Returns ITab

Static get

Parameters

repeatingUnitId: string

Returns any

Static getElement

Parameters

repeatingUnitId: string

Returns HTMLElement

Static getPostfixFieldId

Parameters

element: HTMLElement

Returns string

Static getRepeatingUnitId

Parameters

fieldId: string

Returns string

Static getRepeatingUnitIndex

Parameters

element: HTMLElement

Returns number

Static isRepeatingUnit

Parameters

element: HTMLElement

Returns boolean

Static remove

Parameters

repeatingUnitId: string

index: number

Optional autoSaveOnRemove: boolean

Optional enableScroll: boolean

Returns Promise<number>

Static removeEventListener

Parameters

repeatingUnitId: string

type: "removed" | "beforeadd" | "added" | "beforeremove"

callback: ((result: number) => void | Promise<void>)

Parameters

result: number

Returns void | Promise<void>

Returns void

Settings

`Static` add

`Optional` index: number

`Optional` autoSaveOnAdd: boolean

`Optional` enableScroll: boolean

`Optional` setInitialStatus: boolean

`Static` addDynamically

`Optional` index: number

`Static` addEventListener

`Static` count

`Static` findTab

`Static` get

`Static` getElement

`Static` getPostfixFieldId

`Static` getRepeatingUnitId

`Static` getRepeatingUnitIndex

`Static` isRepeatingUnit

`Static` remove

`Optional` autoSaveOnRemove: boolean

`Optional` enableScroll: boolean

`Static` removeEventListener