Namespace: MetacatUI

MetacatUI

The global object that contains all of the MetacatUI top-level classes, variables, and functions.
Source:

Members

altHeaderView :AltHeaderView

The view that displays a header on every MetacatUI view that uses the "AltHeader" header type. This header is usually for decorative / aesthetic purposes only.
Type:
  • AltHeaderView
Source:

footerView :FooterView

The view that displays the main footer of the MetacatUI page. It has informational and navigational links in it and is displayed on every page, except for views that hide it for full-screen display.
Type:
Source:

mapKey :string

The Google Maps API key for this MetacatUI deployment. This should be set in the {@see AppConfig} object.
Type:
  • string
Source:
See:

metacatUIVersion :string

The version of this installation of MetacatUI.
Type:
  • string
Source:

navbarView :NavbarView

The view that displays a navigation menu on every MetacatUI page and controls the navigation between pages in MetacatUI.
Type:
Source:

root :string

The root path of this MetacatUI deployment. This should point to the `src` directory that was deployed, which contains the `index.html` file for MetacatUI. This root path is used throughout the app to construct URLs to pages, images, etc.
Type:
  • string
Default Value:
  • "/metacatui"
Source:

rootDataPackage :string

The top-level DataPackage that is currently being viewed or edited in MetacatUI.
Type:
  • string
Source:

theme :string

The theme name for this MetacatUI deployment. This is defined in the AppConfig#theme. If no theme is defined, the default theme is used.
Type:
  • string
Default Value:
  • "default"
Source:

Methods

initApp()

Loads the RequireJS library and the `app.js` file, which contains all of the RequireJS configurations. The appjs is where the bulk of the application initialization happens (for example, creating top-level models and views, initializing the application router, and rendering the top-level {@see AppView}).
Source:

loadTheme()

This function gets configuration settings from the {@see AppConfig}, such as `root`, `theme`, etc. and loads the theme configuration file. When the theme configuration file is loaded, the rest of the app is initialized, in {@see MetacatUI.initApp}
Source: