Class actuate.DashboardString. Optional. Container object or name of a container in the current document ID of container where controls are to be rendered.Table 4-5 describes actuate.Dashboard functions.
Table 4-5 The personal dashboard uses an embedded template file. Returns the dashboard name used by the dashboard object. Returns whether there are unsaved changes on the dashboard. Returns whether the dashboard is a personal dashboard. Unloads JavaScript variables that are no longer needed by the dashboard. save( ) saveAs( ) Sets the time interval before executing an automatic save for a personal dashboard. Sets the container for rendering the dashboard page HTML fragment. setSize( ) submit( ) Submits the dashboard page component request. Forces the dashboard framework to use a personal dashboard.Function. The callback function to use after the dashboard finishes downloading. This function must take the returned dashboard object as an input parameter.Boolean. When the isEmbedded parameter is true, the personal dashboard uses an embedded template file. The default value is false.This example specifies that the personal dashboard myDashboard uses an embedded template file:This example displays the name of the active tab for the myDashboard dashboard object in an alert box:This example unloads JavaScript variables and displays the dashboard object’s dashboard name in an alert box:alert("JS variables unloaded for " + myDashboard.getDashboardName( ));Registers an event handler to activate for parameter eventName. This function can assign several handlers to a single event.Function. The function to execute when the event occurs. The handler must take two arguments: The dashboard instance that fired the event and an event object specific to the event type.This example registers the errorHandler( ) function to respond to the ON_EXCEPTION event:myDashboard.registerEventHandler(actuate.dashboard.EventConstants.ON_EXCEPTION, errorHandler);This example removes the errorHandler( ) function from responding to the ON_EXCEPTION event:myDashboard.removeEventHandler(actuate.dashboard.EventConstants.ON_EXCEPTION, errorHandler);Renders the dashboard definitions content to the container. The submit API calls the renderContent API internally. The renderContent( ) function assumes that the user has already a list of DashboardDefinition to process.Array of objects. Each object is some piece of dashboard metadata and as many can be added as needed. Typically, this array contains the following metadata:
Dependency information between gadgets to support publishing and subscribing mechanismThis example renders the myDash dashboard object using the dashboardDefinition array defs and calls afterRender( ) once complete:myDash.save( );String. Optional. Fully qualified path in which to save the dashboard. The default value is the path for the original dashboard file, if one exists, or the path for the user’s home directory.Boolean. Optional. True indicates to replace the latest version of the file. False indicates to create a new version.To set the dashboard height to 400 pixels, use code similar to the following:actuate.RequestOptions object. Request options, if any, to apply to the connection. See actuate.RequestOptions for details on the options that this parameter can set.This example connects a dashboard component to the iPortal service and adds a custom URL parameter:myDashboard.setService("http://localhost:8700/iportal", myRequestOptions.setCustomParameters({myParam: "myValue"});To set the dashboard height to 400 pixels and the width to 800 pixels, use code similar to the following:Sets the template path. This function overwrites the template path that is used by Information Console.To set the dashboard width to 800 pixels, use code similar to the following:To show the gadget gallery for the myDashboard dashboard object, use code similar to the following:Submits requests to the server for the dashboard. When this function is called, an AJAX request is triggered to submit all pending operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the dashboard container.This example submits the dashboard name that was set with setDashboardName( ):dash.submit( );Boolean. A value of true sets the dashboard framework to ignore any value set by the setDashboardName( ) method. The dashboard framework creates a new personal dashboard file for the logged in user when no personal dashboard file is present.To force the use of a personal dashboard for the myDashboard object, use code similar to the following:
|
|
Copyright Actuate Corporation 2012 |