CodBi
    Preparing search index...

    Interface CodbiGlobal

    The global codbi object, available via window.codbi. Should only be used when it is absolutely necessary to expose symbols externally. Use ESM imports otherwise.

    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

    • Injects the CodBi-Loading-Animation after the given destination, only if there is no animation present yet.

      Parameters

      • destination: Element

        The Element that shall precede the Animation.

      Returns void

    • Logs the provided message using the specified 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. Will be placed after a slash in the log header ([[ CodBi / ] ... ]).

      Returns void

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

      Parameters

      • toHandle: string

      Returns void

    • Removes the CodBi-Loading-Animation that was inserted via CodbiGlobal.injectLoadingAnimfrom the given {@link toRemoveFrom.

      Parameters

      • toRemoveFrom: Element

        The Element all CSS-Class-cCodBiLoader shall be removed from.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods