Interface LoaderContainerSettings

Container settings (ix.api.loader.container) that can be passed to the loader to define how the container that is to be opened should look like and behave.

Hierarchy

Properties

closeByButton? data? fup? html? ixApp? key? onAfterLoad? onAfterUnload? onBeforeLoad? onBeforeUnload? reloadByChange? vm?

Properties

Optional closeByButton

closeByButton?: boolean

Show close button in container.

Example

ix.api.loader.container({
  ixApp: {
      guid: "<APPLICATION-GUID>",
      pageGuid: "<PAGE-GUID>"
  },
  html: ix.api.dom.getHtml("<CONTAINER-GUID>"),
  closeByButton: true,
  data: {
      "company": "Test Company",
      "city": "Freiburg"
  }
});

Optional data

data?: {
    [key: string]: any;
}

Data to be sent to the server. It will be appended to the query string.

Type declaration

  • [key: string]: any

Example

// ix.api.loader.container example
ix.api.loader.container({
  ixApp: {
      guid: "<APPLICATION-GUID>",
      pageGuid: "<PAGE-GUID>"
  },
  html: ix.api.dom.getHtml("<CONTAINER-GUID>"),
  data: {
        "company": "Test Company",
        "city": "Freiburg"
  }
});

Optional fup

fup?: HTMLElement | IxPage

Reference to a functional part.

Optional html

html?: HTMLElement

An element in the Document Object Model (DOM) to determine current window / tooltip.

Example

// ix.api.loader.container example
ix.api.loader.container({
  ixApp: {
      guid: "<APPLICATION-GUID>",
      pageGuid: "<PAGE-GUID>"
  },
   html: ix.api.dom.getHtml("<CONTAINER-GUID>"),
});

Optional ixApp

ixApp?: IntrexxApp

Page which should be loaded. Defined by <APPLICATION-GUID> and <PAGE-GUID>.

// ix.api.loader.container example
ix.api.loader.container({
  ixApp: {
      guid: "<APPLICATION-GUID>",
      pageGuid: "<PAGE-GUID>"
  },
   html: ix.api.dom.getHtml("<CONTAINER-GUID>"),
});

Optional key

key?: string

The container identifier. Sets a data-key attribute to the container in which it gets loaded.

Example

ix.api.loader.container({
  ixApp: {
      guid: "<APPLICATION-GUID>",
      pageGuid: "<PAGE-GUID>"
  },
  key: "test-key",
  html: ix.api.dom.getHtml("<CONTAINER-GUID>"),
});

Optional onAfterLoad

onAfterLoad?: (() => void)

Type declaration

    • (): void

    • Callback function - fired after the container was loaded into an element.

      Returns void

      Example

      ix.api.loader.container({
        ixApp: {
            guid: "<APPLICATION-GUID>",
            pageGuid: "<PAGE-GUID>"
        },
        html: ix.api.dom.getHtml("<CONTAINER-GUID>"),
        onAfterLoad: () => {
           console.log("Loading done.");
        }
      });

Optional onAfterUnload

onAfterUnload?: (() => void)

Type declaration

    • (): void

    • Callback function - fired after the container finished unloading.

      Returns void

      Example

      ix.api.loader.container({
        ixApp: {
            guid: "<APPLICATION-GUID>",
            pageGuid: "<PAGE-GUID>"
        },
        html: ix.api.dom.getHtml("<CONTAINER-GUID>"),
        onAfterUnload: () => {
           console.log("Unload done.");
        }
      });

Optional onBeforeLoad

onBeforeLoad?: (() => void)

Type declaration

    • (): void

    • Callback function - fired before the container is loaded into an element.

      Returns void

      Example

      ix.api.loader.container({
        ixApp: {
            guid: "<APPLICATION-GUID>",
            pageGuid: "<PAGE-GUID>"
        },
        html: ix.api.dom.getHtml("<CONTAINER-GUID>"),
        onBeforeLoad: () => {
           console.log("Before load.");
        }
      });

Optional onBeforeUnload

onBeforeUnload?: (() => void)

Type declaration

    • (): void

    • Callback function - fired before the container will be closed.

      Returns void

      Example

      ix.api.loader.container({
        ixApp: {
            guid: "<APPLICATION-GUID>",
            pageGuid: "<PAGE-GUID>"
        },
        html: ix.api.dom.getHtml("<CONTAINER-GUID>"),
        onBeforeUnload: () => {
           console.log("Before unload.");
        }
      });

Optional reloadByChange

reloadByChange?: boolean

Reload current window if data got saved or deleted.

Example

ix.api.loader.container({
  ixApp: {
      guid: "<APPLICATION-GUID>",
      pageGuid: "<PAGE-GUID>"
  },
  html: ix.api.dom.getHtml("<CONTAINER-GUID>"),
  reloadByChange: true
});

Optional vm

vm?: string

Load a static VTL (Velocity Template Language) file.

Example

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

Settings

Member Visibility

Theme

On This Page