Dashboard
cdf.dashboard. Dashboard
Base abstract dashboard class. This class is abstract, so it should not be required or instantiated directly.
Instead, use one of its extending subclasses: Blueprint
, Bootstrap
or Clean
.
Each dashboard instance can be localized by adding, in the same directory, the following properties files:
- messages_supported_languages.properties - Defines supported languages, if not present, i18n support will not be loaded, for example:
en=English pt=Portuguese
- messages.properties: Default messages file, for example:
myDashboard.title=Default title
- messages_[language_code].properties: Language code messages file, for example:
myDashboard.title=Title # for messages_en.properties myDashboard.title=Título # for messages_pt.properties
Usage:
dashboard.i18nSupport.prop("myDashboard.title");
Extends
Constructor
Name | Description |
---|---|
new Dashboard(options) Abstract | Base abstract dashboard class. It should not be required or instantiated directly. |
Members
Name | Description |
---|---|
_i18nCurrentLanguageCode : Protected | The dashboard's current language code. |
_i18nSupport : Protected | Localization object. |
addIns : Protected | Serves as a container for holding the registered add-ins. |
args : Deprecated | Array of arguments. |
blockUiOptions : Protected | Holds the dashboard jQuery.blockUI options. |
CDF_ERROR_DIV : Deprecated | Legacy identifier of the HTML div element used for showing errors. |
components : Protected | Array which stores all components in the dashboard. |
context : Protected | The dashboard context |
dataSources : Protected | Map of key value pairs: data source name - data source value. |
debug : Protected | The dashboard debug level. |
ERROR_CODES : Constant Protected | Dashboard error codes. |
escapeParameterValues : Protected | Defines if the parameter value needs to be encoded before being stored. |
flatParameters : Protected | Defines if parameters are stored in flat names or in nested objects. |
globalContext : Deprecated | Determines if components and parameters are retrieved from the |
initCounter : Deprecated Protected | Init counter. |
initialStorage : Protected | Holds the dashboard |
isSilent : Protected | Allows disabling dashboard notifications. |
lastServerResponse : Protected | Last server response timestamp. |
LEGACY_STORAGE : Deprecated Constant | Legacy storage parameter prefix. |
legacyPriority : Deprecated Protected | Legacy dashboard components do not have priority, so we will assign a very low priority to them. |
logLifecycle : Protected | Flag indicating if the lifecycle events should be logged. |
monthNames : Deprecated | Array of month names. |
parameterModel : Protected | Backbone model connected with the parameters. |
parameters : Protected | Store of key value pairs: parameter name - parameter value. |
queryFactories : Protected | Container used for registering query types and instantiating queries. |
refreshEngine : Protected | The |
runningCalls : Protected | Running calls counter. |
serverCheckResponseTimeout : Protected | Timeout value in milliseconds. |
storage : Protected | Allows a user to persist parameters server-side to be used across different dashboards. |
STORAGE : Constant | Storage parameters prefix. |
view : Protected | A view is a snapshot of the dashboard parameter's state, useful to restore a dashboard to a previous state. |
viewFlags : Constant | Object used to store the available view flag values (read only). |
viewParameters : Protected | Map containing the list of parameters of a dashboard and their |
webAppPath : Protected | The current webapp path. |
Methods
Name | Description |
---|---|
registerGlobalQuery(type, query) Static | Registers globally a new query type constructor to be used by any dashboard instance. |
setBaseQuery(QueryClass) Static | Sets the |
addComponent(component, options) : cdf.dashboard.Dashboard | Adds an instance of a component to the dashboard. |
addComponents(components) | Adds an array of component instances to the dashboard. |
addDataSource(name, obj, force) | Adds a new data source. |
addParameter(parameterName, parameterValue) : Object | Adds a new parameter to the parameter module. |
blockUIwithDrag() | Renders a blocking div which can be dragged. |
callPentahoAction(obj, solution, path, action, parameters, callback) : Object | string Deprecated | Calls an xaction. |
checkServer() : boolean | Executes a jQuery.ajax to test the connection to the server. |
cleanStorage() | Resets the |
createAndCleanErrorDiv() Deprecated | Creates an empty HTML div element for showing errors. |
decrementRunningCalls() | Decrements the running calls counter. |
detectQueryType(qd) : String | undefined | Given a query definition object, returns its query type. |
errorNotification(err, ph) | Displays an error notification if the dashboard is not in silent mode. |
executeAjax(returnType, url, params, func) : Object | string Deprecated | Executes an Ajax request. |
fetchData(cd, params, callback) Deprecated | Fetches data from the server according to a query definition |
fireChange(parameter, value) | Changes the value of a parameter, triggering a |
generateBookmarkState() : Object | Generates a bookmark state using stored values. |
getAddIn(type, subType, addInName) : cdf.AddIn | Gets the add-in from the add-in registry. |
getBaseQuery() : cdf.queries.BaseQuery | Gets the base query object constructor from where other query types can be extended. |
getBookmarkState() : Object | Gets the bookmark state URL decoded. |
getComp() | Alias for |
getComponent(name) : cdf.components.BaseComponent | undefined | Gets the component instance from a given name. |
getComponentByName() | Alias for |
getComponentIndex(compOrNameOrIndex) : number | Gets the index of a component. |
getDataSource(obj) : Object | undefined | Gets the data source with the provided name. |
getDataSourceQuery(obj) : Object | undefined | Gets a query from |
getErrorObj(errorCode) : Object | Gets an error code message. |
getMessagesPath() : string Abstract | Gets the path from which to load the locale-specific properties files. |
getParam(parameterName) : Object | Alias for |
getParameterValue(parameterName) : Object | Gets a parameter value. |
getQuery(type, opts) : cdf.queries.BaseQuery | Given a type and options, returns the query object for running that particular query. |
getRunningCalls() : number | Returns the number of running calls. |
getSettingsValue(key, value) Deprecated | Gets a setting value from the server. |
getUnboundParameters() : Array.<<code>string > | Gets a list of the names of the dashboard parameters with the view flag set to |
getViewParameters() : Object | Gets a map with the dashboard parameters with the view flag set to |
getWcdfSettings() : Object Abstract | Gets the dashboard's wcdfSettings. |
getWebAppPath() : string | Gets the current webapp path. |
handleServerError() | Handles a server error. |
hasAddIn(type, subType, addInName) : boolean | Checks if the add-in exists in the add-in registry. |
hasQuery(type) : boolean | Determines if a given query type is registered in the current dashboard. |
hideProgressIndicator(force) | Hides the progress indicator if the dashboard is not in silent mode. |
incrementRunningCalls() | Increments the running calls counter. |
init(components) | Dashboard's initialization function. |
isBookmarkable(parameter) : boolean | Checks if a |
isComponentUpdating(the) | Cheks if a component is being updated in the dashboard lifecycle. |
isValidQueryDefinition(queryDefinition) : boolean | Tests if a query definition is valid or not. |
isViewParameter(parameter) : string | Returns the view flag value of a given parameter. |
listAddIns(type, subType) : Array.<<code>cdf.AddIn > | Lists registered add-ins of a given type and subtype. |
listQueries() : Array.<<code>String > | Lists the registered query types in this dashboard. |
loadStorage() | Loads the |
loginAlert(newOpts) | Shows a login error notification if the dashboard is not in silent mode. |
normalizeId(id) : string Abstract | Normalizes a DOM element identifier. |
parseXActionResult(obj, html) : Object Deprecated | Parses the xaction result. |
pentahoAction(solution, path, action, params, func) : Object | string Deprecated | Another way to call an xaction. |
pentahoServiceAction(serviceMethod, returntype, solution, path, action, params, func) : Object | string Deprecated | Calls an xaction. |
persistBookmarkables(param) | Persists a bookmark state. |
processChange(object_name) | Processes a change in a component. |
registerAddIn(type, subType, addIn) | Registers an add-in to be used only by this dashboard instance. |
registerGlobalAddIn(type, subType, addIn) | Registers a global add-in. |
registerQuery(type, query) | Registers a new query type constructor to be used by the dashboard instance. |
removeComponent(compOrNameOrIndex) : cdf.components.BaseComponent | undefined | Removes a component from the |
removeDataSource(obj) | Removes the data source with the provided name. |
resetAll() | Resets the dashboard. |
resetRunningCalls() | Resets the running calls counter and hides the progress indicator. |
restoreBookmarkables() | Restores the bookmark state. |
restoreView() | Restores the dashboard parameters stored in a |
saveStorage() | Saves the |
setAddInDefaults(type, subType, addInName, defaults) | Sets the default options of an add-in. |
setBookmarkable(parameter, value) | Sets a pair parameter/value as bookmarkable. |
setBookmarkState(state) | Overrides a bookmark state with a given |
setDataSource(name, obj) | Adds a data source overriding any existing one with the same name. |
setGlobalContext(globalContext) Deprecated | Sets the |
setI18nSupport(locale, i18nRef) | Sets the current locale and i18n options. |
setParam(parameterName, parameterValue, isNotified) : undefined | Alias for |
setParameter(parameterName, parameterValue, isNotified) | Stores a parameter with a certain value. |
setParameterViewMode(parameter, value) | Sets the view flag for a given parameter. |
setSettingsValue(name, object) Deprecated | Sets a setting in the server. |
showErrorTooltip() Deprecated | Creates a tooltip for showing errors. |
showProgressIndicator() | Makes the progress indicator visible if the dashboard is not in silent mode. |
syncDebugLevel() : number | Sets the |
update(component) | Adds a component to the "to be updated" queue. |
updateComponent(object) | Updates a specific component. |
urlAction(url, params, func) : Object | string Deprecated | Calls an arbitrary URL expecting the result content type to be xml. |
Events
Name | Description |
---|---|
cdf:loginError | Event triggered when login fails. |
cdf:postInit | Event triggered after dashboard initialization. |
cdf:preInit | Event triggered before dashboard initialization. |
cdf:serverError | Event triggered when a server error occurs. |
parameterName:fireChange(obj) | Event triggered when the dashboard parameter value changes. |
Constructor Details
new Dashboard(options) Abstract | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Abstract constructor for the Dashboard object. Source: dashboard/Dashboard.js, line 55
|
Members Details
_i18nCurrentLanguageCode: Protected |
---|
The dashboard's current language code, used by other localizable components. |
_i18nSupport: Protected |
---|
Localization object, which will contain the property/value map and the method to get a value from a property. |
addIns: Protected |
---|
Serves as a container for holding the registered add-ins of the respective dashboard instance. |
args: Deprecated |
---|
Array of arguments. Source: dashboard/Dashboard.js, line 281 |
blockUiOptions: Protected |
---|
Holds the dashboard jQuery.blockUI options. |
CDF_ERROR_DIV: Deprecated |
---|
Legacy identifier of the HTML div element used for showing errors. Source: dashboard/Dashboard.legacy.js, line 199 Default Value: cdfErrorDiv |
components: Protected |
---|
Array of instances of |
context: Protected |
---|
The dashboard context is used for holding user and server session information, such as the current locale and session timeout settings. It can be initialized in two different ways. The main way is via the dashboard constructor. If not, it will be initialized via the |
dataSources: Protected |
---|
Map of key value pairs where the keys are the data source names and the values are the corresponding data source |
debug: Protected |
---|
The dashboard debug level. Source: dashboard/Dashboard.js, line 328 Default Value: 1 |
ERROR_CODES: Constant Protected | |||||||||
---|---|---|---|---|---|---|---|---|---|
Contains the default dashboard error codes.
|
escapeParameterValues: Protected |
---|
Defines if the parameter value needs to be encoded before being stored. If true, then |
flatParameters: Protected |
---|
Defines if parameters are stored in flat names or in nested objects. For instance, storing parameter name "param1.param2" with |
globalContext: Deprecated |
---|
Determines if components and parameters are retrieved from the Source: dashboard/Dashboard.js, line 211 Default Value: false |
initCounter: Deprecated Protected |
---|
Counter which stores the number of components in the dashboard being initialized. This counter is incremented for every component in the dashboard that is initialized and decremented afterwards. The end result after the initialization process should be zero. |
initialStorage: Protected |
---|
Holds the dashboard |
isSilent: Protected |
---|
Allows disabling dashboard notifications. Source: dashboard/Dashboard.js, line 294 |
lastServerResponse: Protected |
---|
Last server response timestamp in milliseconds, which used to know if the session expired. |
LEGACY_STORAGE: Deprecated Constant |
---|
Legacy storage parameter prefix. This allows users to store parameters between dashboard renders. Source: dashboard/Dashboard.parameters.js, line 96 Default Value: Dashboards.storage. |
legacyPriority: Deprecated Protected |
---|
Legacy dashboard components do not have priority, so we will assign a very low priority to them. Source: dashboard/Dashboard.js, line 262 Default Value: -1000 |
logLifecycle: Protected |
---|
Flag indicating if the lifecycle events should be logged. Source: dashboard/Dashboard.js, line 272 Default Value: true |
monthNames: Deprecated |
---|
Array of month names. Source: dashboard/Dashboard.js, line 291 |
parameterModel: Protected |
---|
Backbone model connected with the parameters to provide an events system over the CDF parameters. Source: dashboard/Dashboard.parameters.js, line 48 See also: Backbone.Model |
parameters: Protected |
---|
Object which stores key value pairs with parameter name - parameter value. |
queryFactories: Protected |
---|
Container used for registering query types and instantiating queries. Implements the factory pattern, providing a generic interface for creating query instances of the specified type. Query types registered in this container will be accessible only by the dashboard instance. |
refreshEngine: Protected |
---|
The Source: dashboard/Dashboard.js, line 200 |
runningCalls: Protected |
---|
Running calls counter used to control the progress indicator in asynchronous calls. |
serverCheckResponseTimeout: Protected |
---|
Timeout value in milliseconds. If |
storage: Protected |
---|
The dashboard storage is used for persisting parameters on the server and making them available to other dashboards. It is sometimes referred to as a user parameter store. It can be initialized in two different ways. The main way is via the dashboard constructor. Otherwise, it will be initialized via the |
STORAGE: Constant |
---|
Storage parameters prefix. This allows users to store parameters between dashboard renders. Source: dashboard/Dashboard.parameters.js, line 105 Default Value: storage. |
view: Protected |
---|
Holds a snapshot of the dashboard parameter's state, which is useful to restore a dashboard to a previous state. It can be initialized in two different ways. The main way is via the dashboard constructor. If not, it will be initialized via the |
viewFlags: Constant | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Object used to store the available view flag values (read only).
|
viewParameters: Protected |
---|
Map containing the list of parameters of a dashboard. The keys are the parameter names and the values are the |
webAppPath: Protected |
---|
The current webapp path. Source: dashboard/Dashboard.js, line 183 |
Methods Details
registerGlobalQuery(type, query) Static | |||||||||
---|---|---|---|---|---|---|---|---|---|
Registers globally a new query type constructor to be used by any dashboard instance. If the If The new query Source: dashboard/Dashboard.query.js, line 293
See also: |
setBaseQuery(QueryClass) Static | ||||||
---|---|---|---|---|---|---|
Sets the Registered query types will extend from the base query type unless a valid constructor function is provided during registration. Source: dashboard/Dashboard.query.js, line 270
See also: |
addComponent(component, options) : cdf.dashboard.Dashboard | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Adds an instance of
If the The Source: dashboard/Dashboard.components.js, line 133
|
addComponents(components) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Adds one or more components to the dashboard. If a component was already added, it will not be replaced. It iterates through the array and calls Along with the Source: dashboard/Dashboard.components.js, line 107
See also: |
addDataSource(name, obj, force) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Adds a data source given a name, the data source object to be added, and an optional Source: dashboard/Dashboard.dataSources.js, line 93
|
addParameter(parameterName, parameterValue) : Object | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Adds a new parameter to the parameter module. Receives a parameter name and an initial value, which will be used if the parameter is not available in the parameter model. Otherwise, the value returned by Source: dashboard/Dashboard.parameters.js, line 267
|
blockUIwithDrag() |
---|
Renders a blocking div which can be dragged. |
callPentahoAction(obj, solution, path, action, parameters, callback) : Object | string Deprecated | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Calls an xaction. Source: dashboard/Dashboard.legacy.js, line 56
See also: |
checkServer() : boolean | ||||
---|---|---|---|---|
Executes a jQuery.ajax to test the connection to the server. Uses HTTP POST to avoid cache. Source: dashboard/Dashboard.notifications.js, line 264
|
cleanStorage() |
---|
Resets the |
createAndCleanErrorDiv() Deprecated |
---|
Creates an empty HTML div element, with identifier |
decrementRunningCalls() |
---|
Decrements the running calls counter and if it reaches 0, hides the progress indicator. |
detectQueryType(qd) : String | undefined | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Given a query definition object, returns its query type. The query can have three groups of types. First Source: dashboard/Dashboard.query.js, line 154
|
errorNotification(err, ph) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Displays an error notification if the dashboard is not in silent mode. Source: dashboard/Dashboard.notifications.js, line 215
|
executeAjax(returnType, url, params, func) : Object | string Deprecated | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Executes an Ajax request. If no Source: dashboard/Dashboard.legacy.js, line 103
|
fetchData(cd, params, callback) Deprecated | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Fetches data from the server according to a query definition Source: dashboard/Dashboard.legacy.js, line 337
|
fireChange(parameter, value) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Changes the value of a parameter with the provided name. Triggers the Because some browsers will not draw the blockUI widgets until the script has finished, we find the list of components to update, then execute the actual update in a function wrapped in a setTimeout so the running script has the opportunity to finish. Source: dashboard/Dashboard.lifecycle.js, line 754
Fires: cdf.event:cdf , cdf.dashboard.Dashboard#event:parameterName:fireChange |
generateBookmarkState() : Object | ||||
---|---|---|---|---|
Generates a bookmark state using stored values. Source: dashboard/Dashboard.bookmarkable.js, line 147
|
getAddIn(type, subType, addInName) : cdf.AddIn | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the add-in with the specified name, subtype and type from the add-in registry for this dashboard. Source: dashboard/Dashboard.addIns.js, line 155
|
getBaseQuery() : cdf.queries.BaseQuery | ||||
---|---|---|---|---|
Gets the base query object constructor from where other query types can be extended. Source: dashboard/Dashboard.query.js, line 88
|
getBookmarkState() : Object | ||||
---|---|---|---|---|
Gets the bookmark state URL decoded. Source: dashboard/Dashboard.bookmarkable.js, line 215
|
getComp() |
---|
Alias for |
getComponent(name) : cdf.components.BaseComponent | undefined | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the component given a string representing the component's name. This method iterates over the components array and searches for the component with the name used as the argument. If the component with that name is not found, then Source: dashboard/Dashboard.components.js, line 65
Example var myComponent = myDashboard.getComponent("myInputComponent"); |
getComponentByName() |
---|
Alias for |
getComponentIndex(compOrNameOrIndex) : number | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Get the index of the array If Source: dashboard/Dashboard.components.js, line 177
|
getDataSource(obj) : Object | undefined | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a data source according to the provided name or query definition object with a Source: dashboard/Dashboard.dataSources.js, line 142
|
getDataSourceQuery(obj) : Object | undefined | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a query from Source: dashboard/Dashboard.dataSources.js, line 158
|
getErrorObj(errorCode) : Object | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Given an error code, returns the registered error object associated with that code. Source: dashboard/Dashboard.notifications.js, line 155
|
getMessagesPath() : string Abstract | ||||
---|---|---|---|---|
Gets the path from which to load the locale-specific properties files. If this method returns It will be overridden returning the appropriate dashboard path in embedded scenarios. Source: dashboard/Dashboard.i18n.js, line 146
|
getParam(parameterName) : Object | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Alias for Source: dashboard/Dashboard.parameters.js, line 306
|
getParameterValue(parameterName) : Object | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets the parameter value from a given parameter name. If the argument is invalid, Source: dashboard/Dashboard.parameters.js, line 289
|
getQuery(type, opts) : cdf.queries.BaseQuery | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Given a type and options, returns the query object for running that particular query. If a data source name is provided as an option, it also includes all options from it. Source: dashboard/Dashboard.query.js, line 203
See also: Example // MDX query using an explicit type and a query definition object dashboard.getQuery("mdx", {jndi: "SampleData", catalog: ...}); // MDX query using a query definition object dashboard.getQuery({queryType: "mdx", jndi: "SampleData", catalog: ...}); // MDX query using a data source dashboard.addDataSource("myDatasource", {queryType: "mdx", jndi: "SampleData", catalog: ...}); dashboard.getQuery({dataSource: "myDatasource"}); // defaults to a CDA query dashboard.addDataSource("myDatasource", {dataAccessId: "query1", path: "/public/queries.cda"}); dashboard.getQuery({dataSource: "myDatasource"}); |
getRunningCalls() : number | ||||
---|---|---|---|---|
Returns the number of running calls. Source: dashboard/Dashboard.lifecycle.js, line 117
|
getSettingsValue(key, value) Deprecated | |||||||||
---|---|---|---|---|---|---|---|---|---|
Gets a setting value from the server. Source: dashboard/Dashboard.legacy.js, line 309
|
getUnboundParameters() : Array.<<code>string > | ||||
---|---|---|---|---|
Gets a list of the names of the dashboard parameters with the view flag set to Source: dashboard/Dashboard.views.js, line 183
|
getViewParameters() : Object | ||||
---|---|---|---|---|
Gets a map with the pairs parameter name - parameter value, with all dashboard parameters with the view flag set to Source: dashboard/Dashboard.views.js, line 162
|
getWcdfSettings() : Object Abstract | ||||
---|---|---|---|---|
Gets the dashboard's wcdfSettings. It will be overridden returning the proper wcdf settings in embedded scenarios. Source: dashboard/Dashboard.js, line 385
|
getWebAppPath() : string | ||||
---|---|---|---|---|
Gets the current webapp path. Source: dashboard/Dashboard.js, line 373
|
handleServerError() |
---|
Handles a server error. Source: dashboard/Dashboard.notifications.js, line 202 Fires: cdf.event:cdf , cdf.dashboard.Dashboard#event:cdf:serverError |
hasAddIn(type, subType, addInName) : boolean | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Checks if the add-in with the specified name, subtype and type exists in the add-in registry for this dashboard. Source: dashboard/Dashboard.addIns.js, line 139
|
hasQuery(type) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a given query type is registered in the current dashboard. Source: dashboard/Dashboard.query.js, line 136
|
hideProgressIndicator(force) | ||||||
---|---|---|---|---|---|---|
Hides the progress indicator if the dashboard is not in silent mode. Optionally, resets the running calls counter. Source: dashboard/Dashboard.notifications.js, line 136
|
incrementRunningCalls() |
---|
Increments the running calls counter. |
init(components) | ||||||
---|---|---|---|---|---|---|
Dashboard's initialization function. Calling this method will trigger the dashboard execution and render. Source: dashboard/Dashboard.lifecycle.js, line 152
|
isBookmarkable(parameter) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Checks if a Source: dashboard/Dashboard.bookmarkable.js, line 137
|
isComponentUpdating(the) | ||||||
---|---|---|---|---|---|---|
When a component is upodated in the dashboard it goes through a series of states, and tracking all those states can be difficult. This function eases that by checking in all the appropriate lifecycle states if the component is being updated. Source: dashboard/Dashboard.lifecycle.js, line 823
|
isValidQueryDefinition(queryDefinition) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Tests if a query definition is valid or not. It checks if the return value of the Source: dashboard/Dashboard.query.js, line 242
See also: |
isViewParameter(parameter) : string | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Returns the view flag value of a given parameter. Source: dashboard/Dashboard.views.js, line 147
|
listAddIns(type, subType) : Array.<<code>cdf.AddIn > | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Lists registered add-ins of a given type and subtype. Source: dashboard/Dashboard.addIns.js, line 194
|
listQueries() : Array.<<code>String > | ||||
---|---|---|---|---|
Lists the registered query types in this dashboard. Source: dashboard/Dashboard.query.js, line 252
|
loadStorage() |
---|
Retrieves the |
loginAlert(newOpts) | ||||||
---|---|---|---|---|---|---|
Shows a login error notification if the dashboard is not in silent mode. Provides a default implementation for the login alert which pops up when the login session expires. Source: dashboard/Dashboard.notifications.js, line 238
Fires: cdf.event:cdf , cdf.dashboard.Dashboard#event:cdf:loginError |
normalizeId(id) : string Abstract | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Normalizes a DOM element identifier. This method is meant to be used when we need to directly manipulate a DOM element. It will be overridden returning the proper identifier in embedded scenarios. Source: dashboard/Dashboard.js, line 400
|
parseXActionResult(obj, html) : Object Deprecated | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parses the xaction result. If errors are detected they will be writen in the appropriate DOM object of the provided Source: dashboard/Dashboard.legacy.js, line 246
|
pentahoAction(solution, path, action, params, func) : Object | string Deprecated | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Another way to call an xaction. Source: dashboard/Dashboard.legacy.js, line 158
See also: |
pentahoServiceAction(serviceMethod, returntype, solution, path, action, params, func) : Object | string Deprecated | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Calls an xaction. Source: dashboard/Dashboard.legacy.js, line 177
See also: |
persistBookmarkables(param) | ||||||
---|---|---|---|---|---|---|
If Source: dashboard/Dashboard.bookmarkable.js, line 167
|
processChange(object_name) | ||||||
---|---|---|---|---|---|---|
Given the component with name We get the
Source: dashboard/Dashboard.lifecycle.js, line 715
|
registerAddIn(type, subType, addIn) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Registers an add-in to be used only by this dashboard instance. Source: dashboard/Dashboard.addIns.js, line 122
|
registerGlobalAddIn(type, subType, addIn) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Registers a global add-in, to be used in all instances of dashboards sharing the same context. Essentially, it calls the static method with the same name. Source: dashboard/Dashboard.addIns.js, line 109
|
registerQuery(type, query) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Registers a new query type constructor to be used by the dashboard instance. If the If The new query type will be registered at the dashboard instance level and will not be accessible to other dashboards. To register the query type globally see the Source: dashboard/Dashboard.query.js, line 108
|
removeComponent(compOrNameOrIndex) : cdf.components.BaseComponent | undefined | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Removes a component from the If argument is a Source: dashboard/Dashboard.components.js, line 215
See also: |
removeDataSource(obj) | ||||||
---|---|---|---|---|---|---|
Removes the data source with the provided name. If Source: dashboard/Dashboard.dataSources.js, line 193
|
resetAll() |
---|
Resets the dashboard, clearing all the components, and re-updating them. |
resetRunningCalls() |
---|
Resets the running calls counter and hides the progress indicator. |
restoreBookmarkables() |
---|
This method uses |
restoreView() |
---|
Restores the dashboard parameters stored in a |
saveStorage() |
---|
Saves the |
setAddInDefaults(type, subType, addInName, defaults) | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Sets the default options of an add-in. Source: dashboard/Dashboard.addIns.js, line 177
|
setBookmarkable(parameter, value) | |||||||||
---|---|---|---|---|---|---|---|---|---|
It sets Source: dashboard/Dashboard.bookmarkable.js, line 122
|
setBookmarkState(state) | ||||||
---|---|---|---|---|---|---|
Overrides a bookmark state with a given Source: dashboard/Dashboard.bookmarkable.js, line 190
|
setDataSource(name, obj) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Adds a data source. If a data source already exists with the same name, it is replaced with the new one. Source: dashboard/Dashboard.dataSources.js, line 175
|
setGlobalContext(globalContext) Deprecated | ||||||
---|---|---|---|---|---|---|
Sets the Source: dashboard/Dashboard.js, line 363
|
setI18nSupport(locale, i18nRef) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Sets the current locale and i18n options. Source: dashboard/Dashboard.i18n.js, line 131
|
setParam(parameterName, parameterValue, isNotified) : undefined | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Alias for Source: dashboard/Dashboard.parameters.js, line 356
|
setParameter(parameterName, parameterValue, isNotified) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Stores a parameter value with a certain parameter name. If the parameter name is not valid, Since parameters are stored using the Backbone event model, an extra parameter - If Source: dashboard/Dashboard.parameters.js, line 326
|
setParameterViewMode(parameter, value) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Sets the view flag for a given parameter. If none is provided it defaults to Source: dashboard/Dashboard.views.js, line 132
|
setSettingsValue(name, object) Deprecated | |||||||||
---|---|---|---|---|---|---|---|---|---|
Sets a setting in the server. Source: dashboard/Dashboard.legacy.js, line 290
|
showErrorTooltip() Deprecated |
---|
Creates an empty HTML div element for showing error messages. |
showProgressIndicator() |
---|
Makes the progress indicator visible if the dashboard is not in silent mode. By default this is a draggable blocking div which shows a spinner. |
syncDebugLevel() : number | ||||
---|---|---|---|---|
Sets the Source: dashboard/Dashboard.js, line 341
|
update(component) | ||||||
---|---|---|---|---|---|---|
Adds a component to the "to be updated" queue and starts a timer. If the timer finishes before this method is called again, the Source: dashboard/Dashboard.lifecycle.js, line 603
|
updateComponent(object) | ||||||
---|---|---|---|---|---|---|
Updates a specific component. Source: dashboard/Dashboard.lifecycle.js, line 635
|
urlAction(url, params, func) : Object | string Deprecated | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Calls an arbitrary URL expecting the result content type to be xml. Source: dashboard/Dashboard.legacy.js, line 82
See also: |
Events Details
cdf:loginError |
---|
Event triggered when login fails. |
cdf:postInit |
---|
Event triggered after the dashboard finishes initializing. |
cdf:preInit |
---|
Event triggered before the dashboard starts initializing. |
cdf:serverError |
---|
Event triggered when a server error occurs. |
parameterName:fireChange(obj) | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Event triggered when the dashboard parameter value changes. The name of the event is formed using the name of the parameter and the suffix Source: dashboard/_doc/events.jsdoc, line 35
|