Options
Menu

The Loader-API provides a handful of methods for loading Intrexx application pages in an output container, depending on the chosen API method or the settings passed to the loader method.

Index

Functions

container

  • Loads an Intrexx page in a container (former embedded tooltip).

    example
    ix.loader.container({
        vm: "internal/system/vm/html/include/sample.vm",
        html: ix.util.getHtml("<GUID>"),
    });
    
    example
    ix.loader.container({
        vm: "internal/system/vm/html/include/sample.vm",
        html: ix.util.getHtml("<GUID>"),
        ixApp: {
            guid: "<APP-GUID>",
            pageGuid: "<PAGE-GUID>"
        },
        onBeforeUnload: () => {
            // function code
        },
        data: {
            rq_param1: "Hello world!",
        }
    });
    

    Parameters

    Returns true | Deferred<any, any, any> | Promise<any, any, any>

isExternalUri

  • isExternalUri(url: string): boolean
  • Helper method that gives information if a given URL is to be considered as a portal intern URL or not.

    Parameters

    • url: string

    Returns boolean

load

  • load(settings: LoadSettings): true | Deferred<any, any, any> | Promise<any, any, any>
  • Loads an Intrexx page into the current container.
    Note that to determine what the current container is, an additional HTML element in the DOM is needed as a reference point.

    example
    ix.loader.load({
        ixApp: {
            guid: "<APP-GUID>",
            pageGuid: "<PAGE-GUID>"
        },
        html: <HTMLElement>,
    });
    

    Parameters

    Returns true | Deferred<any, any, any> | Promise<any, any, any>

stage

  • stage(settings: StageSettings): true | Deferred<any, any, any> | Promise<any, any, any>
  • Loads an Intrexx page to the stage container (full page load).

    example
    ix.loader.stage({
        ixApp: {
            guid: "<APP-GUID>",
            pageGuid: "<PAGE-GUID>"
        },
        data: {
            "rq_param1": "Hello world!"
        }
    });
    

    Parameters

    Returns true | Deferred<any, any, any> | Promise<any, any, any>

tooltip

  • Loads an Intrexx page and display it in a tooltip.
    The measurements of the tooltip and the positioning depends on the passed tooltip settings.

    example
    ix.loader.tooltip({
        ixApp: {
            guid: "<APP-GUID>",
            pageGuid: "<PAGE-GUID>"
        }
    });
    
    example
    ix.loader.tooltip({
        ixApp: {
            guid: "<APP-GUID>",
            pageGuid: "<PAGE-GUID>",
        },
        windowSettings: {
            position: "embedded",
            htmlTarget: ix.util.getHtml("<CONTAINER-GUID>")
        },
        onBeforeUnload: () => {
            // function code
        },
        data: {
            "rq_param1": "Hello world!"
        }
    });
    
    example

    Fullscreen tooltip

    // open fullscreen tooltip
    ix.loader.tooltip({
        ixApp: {
            guid: "<APP-GUID>",
            pageGuid: "<PAGE-GUID>",
        },
        windowSettings: {
            position: "window",
            alignment: "top_left",
            width: -1,
            height: -1,
            key: "fooBar"
        },
        onBeforeUnload: () => {
            // function code
        },
        data: {
            "rq_param1": "Hello world!"
        }
    });
    
    // close tooltip (by key)
    var tooltip = ix.tooltip.getByKey("fooBar");
    tooltip.close();
    

    Parameters

    Returns true | Deferred<any, any, any> | Promise<any, any, any>