Interface LoaderTooltipSettings

Tooltip settings (ix.api.loader.tooltip).

Hierarchy

Properties

data? fup? html? ixApp? onAfterLoad? onAfterUnload? onBeforeLoad? onBeforeUnload? reloadByChange? vm? windowSettings?

Properties

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 onAfterLoad

onAfterLoad?: (() => void)

Type declaration

    • (): void

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

      Returns void

      Example

      // open page in a tooltip (default position is at middle of the page if no windowSettings are set)
      ix.api.loader.tooltip({
        ixApp: {
            guid: "<APPLICATION-GUID>",
            pageGuid: "<PAGE-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.tooltip({
        ixApp: {
            guid: "<APPLICATION-GUID>",
            pageGuid: "<PAGE-GUID>"
        },
        onAfterUnload: () => {
           console.log("Unload done.");
        }
      });

Optional onBeforeLoad

onBeforeLoad?: (() => void)

Type declaration

    • (): void

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

      Returns void

      Example

      ix.api.loader.tooltip({
        ixApp: {
            guid: "<APPLICATION-GUID>",
            pageGuid: "<PAGE-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.tooltip({
        ixApp: {
            guid: "<APPLICATION-GUID>",
            pageGuid: "<PAGE-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("<GUID>"),
});

Optional windowSettings

windowSettings?: IxTooltipSettings

Tooltip settings which can be set.

Example

ix.api.loader.tooltip({
  ixApp: {
      guid: "E0287A45904DBE104D6B41480185F9100D30F4B1",
      pageGuid: "51085A829CC28D74281FDAA42EA5636C9FD7BBCD"
  },
  windowSettings: {
      modal: true,
      closeByEsc: true,
      closeByClick: true
  }
});

Settings

Member Visibility

Theme

On This Page