Atrium’s Client-side API

Atrium.closeTab([tab])

You can call this function from a page that is running in a portal tab to programmatically close down the tab in the portal.

Optional Parameters:

• tab: a reference to the tab to close. If not passed, the current active tab is closed.

Atrium.launchItem(itemId)

This function launches a given navigation item as a tab in the portal. The item will launch using the settings that have been configured for it in the Add/Update navigation item form

Parameters:

• itemId: a numeric value that represents the unique identifier for the item – this value is displayed on the add/update navigation item form.
  

Returns:

• a reference to the tab object being launched

Atrium.activateTab(tab)

This function activates a specific tab in the portal given the tab reference.

Parameters:

• tab: a reference to the tab object to activate.
  

Atrium.closeAllTabs ([keepHomePage])

This function closes all opened tabs in Atrium, except for the current active tab. You can also call this function to close all tabs except for the homepage tab.

Optional Parameters:

• keepHomePage: a boolean true or false value. When set to false, all tabs will be closed. Conversely, when set to true, all opened tabs will be closed except for the homepage tab. If not passed, all tabs will be closed keeping the homepage tab opened.
  

Atrium.getCurrentTab ()

This function gets the current active tab in Atrium.

Returns:

• a reference to the current active tab object