Overview

The Loader-API provides methods for loading Intrexx application pages into various types of containers. The type of container can be specified using the appropriate API method or settings.

Stage

The main container where your application is loaded and displayed.

Tooltip

A small pop-up that displays additional information.

Container

A generic container element, such as a div group. Used to load a Intrexx page, Velocity script or Groovy script into a container.

Load

Similar to "Container", but uses the load function.

Usage

The functions in this module can be accessed using the syntax ix.api.loader.functionName();

Example

// Load a page into the stage
ix.api.loader.stage({
  ixApp: {
    guid: "<APPLICATION-GUID>",
    pageGuid: "<PAGE-GUID>"
  },
  data: {
    "company": "INTREXX GmbH",
    "city": "Freiburg"
  }
});

// Load a page into a tooltip
ix.api.loader.tooltip({
  ixApp: {
    guid: "<APP-GUID>",
    pageGuid: "<PAGE-GUID>",
  },
  windowSettings: {
    position: "element",
    alignment: "below_left",
    htmlTarget: ix.api.dom.getHtml("<ELEMENT-TO-POSITION-TOOLTIP-GUID>")
  },
});

// Load a vm script into a container
ix.api.loader.container({
  vm: "internal/system/vm/html/include/sample.vm",
  html: ix.api.dom.getHtml("<GUID>"),
});

// Load a page into a container using the load function
ix.api.loader.load({
  ixApp: {
    guid: "<APP-GUID>",
    pageGuid: "<PAGE-GUID>"
  },
  html: "<CONTAINER-GUID>",
});
Copy