dundas.Bootstrap Class

 

Inheritance Hierarchy

 
Class
   dundas.Bootstrap
      dundas.views.admin.Bootstrap
      dundas.views.BaseViewBootstrap
      dundas.views.cubeperspective.Bootstrap
      dundas.views.datacube.Bootstrap
      dundas.views.embedded.Bootstrap
      dundas.views.error.Bootstrap
      dundas.views.hierarchy.Bootstrap
      dundas.views.home.Bootstrap
      dundas.views.ListViewBaseBootstrap
      dundas.views.logon.Bootstrap
      dundas.views.metricset.Bootstrap
      dundas.views.passwordreset.Bootstrap
      dundas.views.slideshow.Bootstrap
 

Constructors

 
  Name Description
init Initializes the primary bootstrap. All base services should be initialized here. Called during construction. The properties rootServices and rootContainer will be available after this call for use.
 
 

Properties

 
  Name Description
baseViewService Gets the base view service. This is the service that corresponds to the current MVC View.
currentDialogShown Gets a value with the current dialog being shown. This is a shortcut method provided to help custom screen implementers.
currentPage Gets the current page.
currentProjectId Gets the current context project ID (the current project the user is working with).
currentSession Gets the current context session.
currentSessionId Gets the current context session ID.
hasNoCookieSession Gets a value indicating whether the session ID has been overriden and not present in a cookie.
originalQueryString Gets a value with the original query string of the raw request on the server. If a shortlink was used, then the longlink's query string is is the value, not the shortlink's.
rootContainer Gets the root container for all services and components for the bootstrap (see dundas.Container).
rootServices Gets the root holder of all services for the bootstrap (see dundas.ServiceContainer).
 
 

Methods

 
  Name Description
callWebApi Calls the server web API with the specified path, payload, and type.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getService Gets a service by the supplied service type from rootServices.
getTopWindow Gets the top-most window that is a Dundas BI window container. This might be the one on this window, but it may also be the parent (if it's embedded). This might not be window.top if it's in an iFrame which is not a Dundas BI container.
getWindow Gets the window associated with this bootstrap's context.
invalidateCurrentSession Forces the bootstrap to re-populate the currentSession property from the server.
onMessage This method should be called when window postMessage is invoked to allow communication cross domain.
onReady Called after the base bootstrap has finished logic for ready() call (no callbacks), but has not yet resolved the listeners. This should be overridden by derived classes to do logic when ready.
onResize This method should be called when the window re-sizes. There should only be 1 handler for re-size, and this should be the one handling it. Anyone overriding this method must called this._super() for the base re-sizing to work.
overrideSession Method used to override the session to ignore the session storage. This should mostly be used by third party integrators who want to use the JavaScript API without actually running the web app, or to do things like augment the current application privileges for the UI without actually changing them on the server.
overrideSessionId Method used to override the session ID to ignore the cookie. This should mostly be used by third party integrators who want to use the JavaScript API without actually running the web app.
ready Sets a callback for when the bootstrap has loaded the screen. Anyone overriding this method must call the base.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.