loadSimpleHubIframe

Loads a simple Managed Hub iFrame into a location within Workspace.

Syntax

loadSimpleHubIframe(interfaceObject, source, subscribe, publish, location);

Parameters

  • interfaceObject - (Object) Object that launches the custom interface.
  • source - (string) A source URL for the web application of the Managed Hub iFrame. If null or an empty string, the source specified in customInterfaces.xml is used.
  • subscribe - (string) A comma-separated string of event topics to which this custom interface subscribes. If null, the subscriptions specified in customInterfaces.xml are used. If no subscriptions are desired, an empty string must be passed.
  • publish - (string) A comma-separated string of event topics which this custom interface publishes. If null, the publish events specified in customInterfaces.xml are used. If no publish events are desired, an empty string must be passed.
  • location - (string) (Optional) Either "areaD", "dialog", or "browser". If null or an empty string, the location specified in customInterfaces.xml is used, however, if "script" is specified in the definition, this parameter must be supplied, and an exception is thrown if location is not provided.

    The method throws an exception if the specified location is not valid, given the location of the menu item or toolbar button (interfaceObject) that launches the interface (see Valid Custom Interface Locations).

Returns

Returns the parent container for the Managed Hub iFrame that has been loaded, as follows:

  • jsx3.gui.Dialog (if 'dialog' location is specified)
  • jsx3.gui.Window (if 'browser' location is specified)
  • jsx3.gui.Block (if 'areaD' location is specified)