dundas.entities.DashboardService Class

 

Inheritance Hierarchy

 
Class
   dundas.Component
      dundas.Service
         dundas.entities.ViewService
            dundas.entities.DashboardService
 

Constructors

 
  Name Description
init Initializes the DashboardService. Called during construction. Inherited from dundas.Component.
 
 

Properties

 
  Name Description
eventsManager Inherited from dundas.Service.
isDisposed Gets a value indicating whether this instance has been disposed. Inherited from dundas.Component.
site Gets or sets the site that this component is a part of. Inherited from dundas.Component.
uniqueId Gets or sets the unique ID of this component within the site. Inherited from dundas.Component.
 
 

Methods

 
  Name Description
bind Subscribe a handler for an event. Inherited from dundas.Service.
createDashboard Creates a dashboard based on the dashboard given. The ID field should be left blank, as it will be populated after the object is created.
createDelegate Helper for creating delegate functions. Inherited from dundas.Component.
createLocalUserCopy Creates a local user copy of a view, along with any metric sets that are not sub entries.
createTimeout Creates a timeout. Inherited from dundas.Component.
dispatch Dispatches a call by creating a delegate and running it right away on a timer. Inherited from dundas.Component.
dispose Inherited from dundas.Component.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
generateAndStoreViewThumbnail Generates a thumbnail for the dashboard.
getCodeLibraryRecursiveReferenceIds Recursively gets the code library reference IDs in the reverse order as a flat list so that they can be included in script includes on a web page.
getDashboardById Gets the desired dashboard by ID.
getService Gets the requested service. Inherited from dundas.Component.
onLoaded Called when the service is loaded. Inherited from dundas.Service.
subscribe Subscribe or unsubscribe an event handler for an event. Inherited from dundas.Service.
subscribeOnce Subscribe a one time handler for an event. Inherited from dundas.Service.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
trackUsage Tracks usage for the dashboard.
trigger Triggers an event. Inherited from dundas.Service.
unbind Unsubscribe an event. Inherited from dundas.Service.
updateDashboard Updates the given dashboard.