CodBi
    Preparing search index...

    Interface CodbiGlobal

    Das globale Codbi-Objekt, verfügbar über „window.codbi“. Sollte nur verwendet werden wenn es unbedingt erforderlich ist, Symbole extern sichtbar zu machen. Verwenden Sie ESM-Importe ansonsten.

    interface CodbiGlobal {
        autoCheckAttributes: boolean;
        baseURL: string;
        checkAttributes: () => Promise<boolean>;
        configTemplate: ConfigTemplate;
        extendEP(
            id: string,
            generator: (params: string[]) => unknown[] | Promise<unknown[]>,
        ): boolean;
        extendFunctionality(
            id: string,
            init: (toLoad: any, toProcess: Element) => any,
        ): boolean;
        injectLoadingAnim(destination: Element): void;
        loadConfig(toLoad: { [key: string]: unknown }): void;
        loadConfigs(toLoad: { targets: string; [key: string]: unknown }[]): void;
        log(
            level: "INFO" | "WARNING" | "ERROR",
            message: string,
            adjunct?: string,
        ): void;
        nncHandler(toHandle: string): void;
        registerEP(id: string, generator: (params: string[]) => unknown): boolean;
        registerFunctionality(
            id: string,
            init: (toLoad: any, toProcess: Element) => any,
        ): boolean;
        removeLoaderAnim(toRemoveFrom: Element): void;
        reportError(message: string): undefined;
    }

    Implemented by

    Index

    Properties

    autoCheckAttributes baseURL checkAttributes configTemplate

    Methods

    extendEP extendFunctionality injectLoadingAnim loadConfig loadConfigs log nncHandler registerEP registerFunctionality removeLoaderAnim reportError

    Properties

    autoCheckAttributes: boolean

    States whether CodbiGlobal.checkAttributes shall be invoked automatically or not.

    baseURL: string

    Stores the base URL e.g. "https://localhost/xima-formcycle".

    checkAttributes: () => Promise<boolean>

    See CodBi.checkAttributes.

    configTemplate: ConfigTemplate

    See CodBi.configTemplate.

    Methods

    • See CodBi.extendEP.

      Parameters

      • id: string
      • generator: (params: string[]) => unknown[] | Promise<unknown[]>

      Returns boolean

    • See CodBi.extendFunctionality.

      Parameters

      • id: string
      • init: (toLoad: any, toProcess: Element) => any

      Returns boolean

    • Fügt die CodBi-Loading-Animation nur nach dem angegebenen destination ein wenn noch keine Animation vorhanden ist.

      Parameters

      • destination: Element

        The Element that shall precede the Animation.

      Returns void

    • See CodBi.loadConfig.

      Parameters

      • toLoad: { [key: string]: unknown }

      Returns void

    • See CodBi.loadConfigs.

      Parameters

      • toLoad: { targets: string; [key: string]: unknown }[]

      Returns void

    • Protokolliert den bereitgestellten message unter Verwendung des angegebenen level.

      Parameters

      • level: "INFO" | "WARNING" | "ERROR"

        The log level to use ("INFO", "WARNING", "ERROR").

      • message: string

        The message to log.

      • Optionaladjunct: string

        An adjunct string to provide additional context or information. Wird nach einem Schrägstrich im Protokollkopf eingefügt ([[ CodBi / ] ... ]).

      Returns void

    • Handles the loading of all non native CodBi Standard-Configurations that're not native ones.

      Parameters

      • toHandle: string

      Returns void

    • See CodBi.registerEP.

      Parameters

      • id: string
      • generator: (params: string[]) => unknown

      Returns boolean

    • See CodBi.registerFunctionality.

      Parameters

      • id: string
      • init: (toLoad: any, toProcess: Element) => any

      Returns boolean

    • Entfernt die über eingefügte CodBi-Loading-Animation CodbiGlobal.injectLoadingAnimfrom the given {@link toRemoveFrom.

      Parameters

      • toRemoveFrom: Element

        The Element all CSS-Class-cCodBiLoader shall be entfernt von.

      Returns void

    • See CodBi.reportError.

      Parameters

      • message: string

      Returns undefined

    Settings

    Member Visibility

    On This Page

    Properties
    Methods