Class RepeatingUnits

Static properties and methods related to the repeating units

Constructors

constructor

Methods

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

Constructors

constructor

Methods

Staticadd

  • 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.

    • Optionalindex: number

      The index, the repeating unit should be added at.

    • OptionalautoSaveOnAdd: boolean

      default true. Control auto save of form if repeating unit was added.

    • OptionalenableScroll: boolean

      default true. Control if auto scroll to newly created unit is active or not.

    • OptionalsetInitialStatus: boolean

      default true. Control if StatusWatcher gets initialized or not.

    Returns Promise<number>

StaticaddDynamically

  • addDynamically(tabId: string): Promise<number>

  • Adds a repeating unit dynamically. Mainly for AdaptiveForms

    Parameters

    • tabId: string

      The id of the repeating unit.

    Returns Promise<number>

StaticaddEventListener

  • 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.

    Returns void

StaticaddMultipleDynamically

  • addMultipleDynamically(tabId: string, count: number): Promise<number>

  • Adds multiple repeating units dynamically. Mainly for AdaptiveForms

    Parameters

    • tabId: string

      The id of the repeating unit.

    • count: number

      The count of repeating units to add.

    Returns Promise<number>

Staticcount

  • count(repeatingUnitId: string): number

  • Returns the count of the repeating units.

    Parameters

    • repeatingUnitId: string

      The id of the repeating unit.

    Returns number

StaticfindTab

  • 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

Staticget

  • get(repeatingUnitId: string): any

  • Gets the instance of the RepeatingUnit by given Id.

    Parameters

    • repeatingUnitId: string

      The id of the repeating unit.

    Returns any

StaticgetDataSource

  • getDataSource<T extends { ID: string }>(tabId: string): T[]

  • Gets the data source of a repeating unit if a mapping is defined.

    Type Parameters

    • T extends { ID: string }

    Parameters

    • tabId: string

      The id of the repeating unit.

    Returns T[]

StaticgetElement

  • getElement(repeatingUnitId: string): HTMLElement

  • Gets the element, that the repeating unit is included

    Parameters

    • repeatingUnitId: string

      The id of the repeating unit.

    Returns HTMLElement

StaticgetPostfixFieldId

  • 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

StaticgetRepeatingUnitId

  • 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

StaticgetRepeatingUnitIndex

  • getRepeatingUnitIndex(element: HTMLElement): number

  • Gets the repeating unit index of an certain HTML Element.

    Parameters

    • element: HTMLElement

    Returns number

StaticisRepeatingUnit

  • isRepeatingUnit(element: HTMLElement): boolean

  • Checks if an element is included in a repeating unit;

    Parameters

    • element: HTMLElement

    Returns boolean

Staticremove

  • 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.

    • OptionalautoSaveOnRemove: boolean

      default true. Control auto save of form if repeating unit was removed.

    • OptionalenableScroll: boolean

      default true. Control if auto scroll to newly created unit is active or not.

    Returns Promise<number>

StaticremoveEventListener

  • 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.

    Returns void

StaticsetDataSource

  • setDataSource<T extends { ID: string }>(tabId: string): Promise<T[]>

  • Sets the data source of a repeating unit if a mapping is defined.

    Type Parameters

    • T extends { ID: string }

    Parameters

    • tabId: string

      The id of the repeating unit.

    Returns Promise<T[]>

Settings

Member Visibility

On This Page

Constructors
Methods