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=Portuguesemessages.properties: Default messages file, for example:
myDashboard.title=Default titlemessages_[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
Base
Backbone.Events
Constructor
new Dashboard(options)Abstract
Base abstract dashboard class. It should not be required o
Members
_i18nCurrentLanguageCode : stringProtected
The dashboard's current language code.
_i18nSupport : objectProtected
Localization object.
addIns : ObjectProtected
Serves as a container for holding the registered add-ins.
args : Array.<`string`>Deprecated
Array of arguments.
blockUiOptions : ObjectProtected
Holds the dashboard jQuery.blockUI options.
CDF_ERROR_DIV : stringDeprecated
Legacy identifier of the HTML div element used for showing errors.
components : Array.<`cdf.components.BaseComponent`>Protected
Array which stores all components in the dashboard.
context : ObjectProtected
The dashboard context object used for holding user and server session data.
dataSources : Array.<`Object`>Protected
Map of key value pairs: data source name - data source value.
debug : numberProtected
The dashboard debug level.
ERROR_CODES : ObjectConstant Protected
Dashboard error codes.
escapeParameterValues : BooleanProtected
Defines if the parameter value needs to be encoded before being stored.
flatParameters : BooleanProtected
Defines if parameters are stored in flat names or in nested objects.
globalContext : booleanDeprecated
Determines if components and parameters are retrieved from the window object or from the dashboard instance.
initCounter : NumberDeprecated Protected
Init counter.
initialStorage : ObjectProtected
Holds the dashboard storage value available during the dashboard initialization.
isDisposed : booleanProtected
The dashboard is in a disposed state.
isSilent : booleanProtected
Allows disabling dashboard notifications.
lastServerResponse : NumberProtected
Last server response timestamp.
LEGACY_STORAGE : StringDeprecated Constant
Legacy storage parameter prefix.
legacyPriority : numberDeprecated Protected
Legacy dashboard components do not have priority, so we will assign a very low priority to them.
logLifecycle : booleanProtected
Flag indicating if the lifecycle events should be logged.
monthNames : Array.<`string`>Deprecated
Array of month names.
parameterModel : Backbone.ModelProtected
Backbone model connected with the parameters.
parameters : ArrayProtected
Store of key value pairs: parameter name - parameter value.
queryFactories : ObjectProtected
Container used for registering query types and instantiating queries.
refreshEngine : cdf.dashboard.RefreshEngineProtected
The RefreshEngine which manages the component refresh cycle.
runningCalls : NumberProtected
Running calls counter.
serverCheckResponseTimeout : NumberProtected
Timeout value in milliseconds.
storage : ObjectProtected
Allows a user to persist parameters server-side to be used across different dashboards.
STORAGE : StringConstant
Storage parameters prefix.
view : ObjectProtected
A view is a snapshot of the dashboard parameter's state, useful to restore a dashboard to a previous state.
viewFlags : ObjectConstant
Object used to store the available view flag values (read only).
viewParameters : ObjectProtected
Map containing the list of parameters of a dashboard and their view flag.
webAppPath : StringProtected
The current webapp path.
Methods
registerGlobalQuery(type, query)Static
Registers globally a new query type constructor to be used by any dashboard instance.
setBaseQuery(QueryClass)Static
Sets the BaseQuery class.
_disposeComponents()Protected
Clears resources associated with the dashboard components.
_disposeParameters()Protected
Clears resources associated with the dashboard instance parameters.
_disposeStorage()Protected
Clears resources associated with the dashboard storage.
_disposeViews()Protected
Clears resources associated with the dashboard instance views.
_throwIfDisposed()Protected
Throws an error if the Dashboard is already disposed.
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 | stringDeprecated
Calls an xaction.
checkServer() : boolean
Executes a jQuery.ajax to test the connection to the server.
cleanStorage()
Resets the storage value to an empty object and issues a jQuery.ajax request to delete the value stored in the server.
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.
dispose()
Clears resources associated with the dashboard instance, if it wasn't already disposed.
errorNotification(err, ph)
Displays an error notification if the dashboard is not in silent mode.
executeAjax(returnType, url, params, func) : Object | stringDeprecated
Executes an Ajax request.
fetchData(cd, params, callback)Deprecated
Fetches data from the server according to a query definition object.
fireChange(parameter, value)
Changes the value of a parameter, triggering a *parameter*:fireChange event.
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.
getComponent(name) : cdf.components.BaseComponent | undefined
Gets the component instance from a given name.
getComponentByName()
Alias for getComponent.
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 getQuery using the data source with the provided name.
getErrorObj(errorCode) : Object
Gets an error code message.
getMessagesPath() : stringAbstract
Gets the path from which to load the locale-specific properties files.
getParam(parameterName) : Object
Alias for getParameterValue.
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.<string>
Gets a list of the names of the dashboard parameters with the view flag set to viewFlags.UNBOUND.
getViewParameters() : Object
Gets a map with the dashboard parameters with the view flag set to viewFlags.VIEW or viewFlags.UNBOUND.
getWcdfSettings() : ObjectAbstract
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 parameter is bookmarkable.
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.<cdf.AddIn>
Lists registered add-ins of a given type and subtype.
listQueries() : Array.<String>
Lists the registered query types in this dashboard.
loadStorage()
Loads the storage value from the server.
loginAlert(newOpts)
Shows a login error notification if the dashboard is not in silent mode.
normalizeId(id) : stringAbstract
Normalizes a DOM element identifier.
parseXActionResult(obj, html) : ObjectDeprecated
Parses the xaction result.
pentahoAction(solution, path, action, params, func) : Object | stringDeprecated
Another way to call an xaction.
pentahoServiceAction(serviceMethod, returntype, solution, path, action, params, func) : Object | stringDeprecated
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 components array.
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 view.
saveStorage()
Saves the storage value in the server.
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 state.
setDataSource(name, obj)
Adds a data source overriding any existing one with the same name.
setGlobalContext(globalContext)Deprecated
Sets the globalContext value.
setI18nSupport(locale, i18nRef)
Sets the current locale and i18n options.
setParam(parameterName, parameterValue, isNotified) : undefined
Alias for setParameter.
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 debug level.
update(component)
Adds a component to the "to be updated" queue.
updateComponent(object)
Updates a specific component.
urlAction(url, params, func) : Object | stringDeprecated
Calls an arbitrary URL expecting the result c
Events
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
Name
Default Value
Summary
options : ObjectOptional
Object that can contain the context, storage and view.
Name
Default Value
Summary
context : ObjectOptional
The context of the dashboard retrieved from the server.
storage : ObjectOptional
The storage of the dashboard retrieved from the server.
view : ObjectOptional
The views of the dashboard retrieved from the server.
isSilent : booleanOptional
Allows disabling the dashboard notifications.
context : ObjectOptional
The context of the dashboard retrieved from the server.
storage : ObjectOptional
The storage of the dashboard retrieved from the server.
view : ObjectOptional
The views of the dashboard retrieved from the server.
isSilent : booleanOptional
Allows disabling the dashboard notifications.
Name
Default Value
Summary
options : ObjectOptional
Object that can contain the context, storage and view.
Name
Default Value
Summary
context : ObjectOptional
The context of the dashboard retrieved from the server.
storage : ObjectOptional
The storage of the dashboard retrieved from the server.
view : ObjectOptional
The views of the dashboard retrieved from the server.
isSilent : booleanOptional
Allows disabling the dashboard notifications.
context : ObjectOptional
The context of the dashboard retrieved from the server.
storage : ObjectOptional
The storage of the dashboard retrieved from the server.
view : ObjectOptional
The views of the dashboard retrieved from the server.
isSilent : booleanOptional
Allows disabling the dashboard notifications.
## Members Details
_i18nCurrentLanguageCode: stringProtected
The dashboard's current language code, used by other localizable components.
**Source:**dashboard/Dashboard.i18n.js, line 61
_i18nSupport: objectProtected
Localization object, which will contain the property/value map and the method to get a value from a property.
**Source:**dashboard/Dashboard.i18n.js, line 45
addIns: ObjectProtected
Serves as a container for holding the registered add-ins of the respective dashboard instance.
**Source:**dashboard/Dashboard.addIns.js, line 86
args: Array.<`string`>Deprecated
Array of arguments.
**Source:**dashboard/Dashboard.js, line 282
blockUiOptions: ObjectProtected
Holds the dashboard jQuery.blockUI options.
**Source:**dashboard/Dashboard.notifications.js, line 66
CDF_ERROR_DIV: stringDeprecated
Legacy identifier of the HTML div element used for showing errors.
**Source:**dashboard/Dashboard.legacy.js, line 199
**Default Value:**cdfErrorDiv
components: Array.<`cdf.components.BaseComponent`>Protected
Array of instances of BaseComponents in the dashboard.
**Source:**dashboard/Dashboard.components.js, line 41
context: ObjectProtected
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 Dashboard AMD module configuration. If no context configuration is available, it will be initialized as an empty object.
**Source:**dashboard/Dashboard.context.js, line 43
dataSources: Array.<`Object`>Protected
Map of key value pairs where the keys are the data source names and the values are the corresponding data source object.
**Source:**dashboard/Dashboard.dataSources.js, line 39
debug: numberProtected
The dashboard debug level.
**Source:**dashboard/Dashboard.js, line 329
**Default Value:**1
ERROR_CODES: ObjectConstant Protected
Contains the default dashboard error codes.
**Source:**dashboard/Dashboard.notifications.js, line 46
Name
Default Value
Description
QUERY_TIMEOUT : string
"Query timeout reached"
Query timeout error message.
COMPONENT_ERROR : string
"Error processing component"
Error processing component error message.
QUERY_TIMEOUT : string
"Query timeout reached"
Query timeout error message.
COMPONENT_ERROR : string
"Error processing component"
Error processing component error message.
escapeParameterValues: BooleanProtected
Defines if the parameter value needs to be encoded before being stored.
If true, then encode_prepare_arr is called before the parameter value gets stored.
**Source:**dashboard/Dashboard.parameters.js, line 74
flatParameters: BooleanProtected
Defines if parameters are stored in flat names or in nested objects.
For instance, storing parameter name "param1.param2" with flatParameters=true will create a parameter in the root of the parameter store, while with flatParameters=false, a nested object will be created.
**Source:**dashboard/Dashboard.parameters.js, line 85
globalContext: booleanDeprecated
Determines if components and parameters are retrieved from the window object or from the dashboard instance.
**Source:**dashboard/Dashboard.js, line 212
**Default Value:**false
initCounter: NumberDeprecated 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.
**Source:**dashboard/Dashboard.lifecycle.js, line 44
initialStorage: ObjectProtected
Holds the dashboard storage value available during the dashboard initialization.
**Source:**dashboard/Dashboard.storage.js, line 54
isDisposed: booleanProtected
The dashboard is in a disposed state.
**Source:**dashboard/Dashboard.js, line 339
**Default Value:**false
isSilent: booleanProtected
Allows disabling dashboard notifications.
**Source:**dashboard/Dashboard.js, line 295
lastServerResponse: NumberProtected
Last server response timestamp in milliseconds, which used to know if the session expired.
**Source:**dashboard/Dashboard.lifecycle.js, line 62
LEGACY_STORAGE: StringDeprecated 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: numberDeprecated Protected
Legacy dashboard components do not have priority, so we will assign a very low priority to them.
**Source:**dashboard/Dashboard.js, line 263
Default Value:-1000
logLifecycle: booleanProtected
Flag indicating if the lifecycle events should be logged.
**Source:**dashboard/Dashboard.js, line 273
**Default Value:**true
monthNames: Array.<`string`>Deprecated
Array of month names.
**Source:**dashboard/Dashboard.js, line 292
parameterModel: Backbone.ModelProtected
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: ArrayProtected
Object which stores key value pairs with parameter name - parameter value.
**Source:**dashboard/Dashboard.parameters.js, line 38
queryFactories: ObjectProtected
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.
**Source:**dashboard/Dashboard.query.js, line 69
refreshEngine: cdf.dashboard.RefreshEngineProtected
The RefreshEngine which manages the component refresh cycle.
**Source:**dashboard/Dashboard.js, line 201
runningCalls: NumberProtected
Running calls counter used to control the progress indicator in asynchronous calls.
**Source:**dashboard/Dashboard.lifecycle.js, line 53
serverCheckResponseTimeout: NumberProtected
Timeout value in milliseconds. If serverCheckResponseTimeout passes between ajax communications, then when the next updateComponent is called, the dashboard will first checkServer, showing a loginAlert if it is unable to connect to the server.
**Source:**dashboard/Dashboard.lifecycle.js, line 75
storage: ObjectProtected
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 Dashboard AMD module configuration. If no configuration is available, it will be initialized as an empty object.
**Source:**dashboard/Dashboard.storage.js, line 43
STORAGE: StringConstant
Storage parameters prefix.
This allows users to store parameters between dashboard renders.
**Source:**dashboard/Dashboard.parameters.js, line 105
**Default Value:**storage.
view: ObjectProtected
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 Dashboard AMD module configuration.
**Source:**dashboard/Dashboard.views.js, line 56
viewFlags: ObjectConstant
Object used to store the available view flag values (read only).
**Source:**dashboard/Dashboard.views.js, line 68
Name
Default Value
Description
UNUSED : string
"unused"
Flag value for unused parameters.
UNBOUND : string
"unbound"
Flag value for unbound parameters.
VIEW : string
"view"
Flag value for view parameters.
UNUSED : string
"unused"
Flag value for unused parameters.
UNBOUND : string
"unbound"
Flag value for unbound parameters.
VIEW : string
"view"
Flag value for view parameters.
viewParameters: ObjectProtected
Map containing the list of parameters of a dashboard. The keys are the parameter names and the values are the view flag value.
**Source:**dashboard/Dashboard.views.js, line 42
webAppPath: StringProtected
The current webapp path.
**Source:**dashboard/Dashboard.js, line 184
## Methods Details
registerGlobalQuery(type, query)Static
Registers globally a new query type constructor to be used by any dashboard instance.
If the query argument is an object, a new object will be created with a copy of the properties listed in the deepProperties list of the BaseQuery.
If query is a function it will be used to generate new query instances of the specified type with no dependency on the BaseQuery class.
The new query type will be registered at a global level and will be accessible by any dashboard instance. To register the query type on a single dashboard instance please see the registerQuery function.
**Source:**dashboard/Dashboard.query.js, line 293
See also:registerQuery
Name
Default Value
Summary
type : string
The type of the query constructor.
query : object | function
A set of properties specific of the query type being registered, or the constructor for the query type being registered.
type : string
The type of the query constructor.
query : object | function
A set of properties specific of the query type being registered, or the constructor for the query type being registered.
setBaseQuery(QueryClass)Static
Sets the BaseQuery class.
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:registerGlobalQuery , registerQuery
Name
Default Value
Summary
QueryClass : cdf.queries.BaseQuery
The default base query class.
QueryClass : cdf.queries.BaseQuery
The default base query class.
_disposeComponents()Protected
Dispose resources that the dashboard components may have, and that are no longer needed.
**Source:**dashboard/Dashboard.components.js, line 251
_disposeParameters()Protected
Dispose resources that the dashboard parameters may have, and that are no longer needed.
**Source:**dashboard/Dashboard.parameters.js, line 261
_disposeStorage()Protected
Dispose resources that the dashboard storage may have, and that are no longer needed.
**Source:**dashboard/Dashboard.storage.js, line 83
_disposeViews()Protected
Dispose resources that the dashboard views may have, and that are no longer needed.
**Source:**dashboard/Dashboard.views.js, line 99
_throwIfDisposed()Protected
Throws an error if the Dashboard is already disposed.
**Source:**dashboard/Dashboard.lifecycle.js, line 104
addComponent(component, options) : cdf.dashboard.Dashboard
Adds an instance of BaseComponent to the dashboard components array if it was not already added.
If the component does not have a valid property component.name, or if the property is not a valid string, an exception is thrown.
The options parameter is optional and when it is absent, the component is added to the end of the components array. The same rule is applied if options.index is false. If not, the new component is appended to the array at position options.index.
**Source:**dashboard/Dashboard.components.js, line 133
|Name|Description| |----|-----------| |`cdf.dashboard.Dashboard`|The dashboard instance where the component was added.|
Name
Default Value
Summary
component : cdf.components.BaseComponent
The new component to be added.
options : ObjectOptional
An option object.
Name
Default Value
Summary
index : NumberOptional
The index at which to add the component.
Name
Description
Error
The component is invalid.
Error
The component already exists in the dashboard instance.
index : NumberOptional
The index at which to add the component.
Error
The component is invalid.
Error
The component already exists in the dashboard instance.
Name
Default Value
Summary
component : cdf.components.BaseComponent
The new component to be added.
options : ObjectOptional
An option object.
Name
Default Value
Summary
index : NumberOptional
The index at which to add the component.
index : NumberOptional
The index at which to add the component.
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 addComponent for each component.
Along with the addComponent behaviour, if a component in the array fails to be added to the dashboard instance, an error is thrown and the execution stops.
**Source:**dashboard/Dashboard.components.js, line 107
See also:addComponent
Name
Default Value
Summary
components : Array.<cdf.components.BaseComponent>
The array of components to be added.
Name
Description
Error
Error if a component in the array is invalid or was already added.
Error
Error if a component in the array is invalid or was already added.
components : Array.<cdf.components.BaseComponent>
The array of components to be added.
addDataSource(name, obj, force)
Adds a data source given a name, the data source object to be added, and an optional boolean indicating if any data source with the same name should be deleted. If the name parameter is an object, its name property will be used as the data source name and the obj parameter will be used as the flag for indicating that previous data sources with the same name were overwritten.
**Source:**dashboard/Dashboard.dataSources.js, line 93
Name
Default Value
Summary
name : string | Object
The name of the data source.
obj : Object | boolean
The data source to be added.
force : boolean | undefinedOptional
false
A flag indicating if any previous data sources with the same name are to be replaced.
name : string | Object
The name of the data source.
obj : Object | boolean
The data source to be added.
force : boolean | undefinedOptional
false
A flag indicating if any previous data sources with the same name are to be replaced.
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 getParameterValue is used.
**Source:**dashboard/Dashboard.parameters.js, line 280
Name
Default Value
Summary
parameterName : string
The name of the parameter.
parameterValue : Object
The initial value of the parameter.
Name
Description
Object
The value assigned to the parameter or undefined if the parameter name is invalid.
Object
The value assigned to the parameter or undefined if the parameter name is invalid.