# 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 * Base * Backbone.Events ## Constructor | Name | Description | | ------------------------------ | ---------------------------------------------------------- | | new Dashboard(options)Abstract | Base abstract dashboard class. It should not be required o | ## Members | Name | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | \_i18nCurrentLanguageCode : `string`Protected | The dashboard's current language code. | | \_i18nSupport : `object`Protected | Localization object. | | addIns : `Object`Protected | Serves as a container for holding the registered add-ins. | | args : ``Array.<`string`>``Deprecated | Array of arguments. | | blockUiOptions : `Object`Protected | Holds the dashboard jQuery.blockUI options. | | CDF\_ERROR\_DIV : `string`Deprecated | 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 : `Object`Protected | 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 : `number`Protected | The dashboard debug level. | | ERROR\_CODES : `Object`Constant Protected | Dashboard error codes. | | escapeParameterValues : `Boolean`Protected | Defines if the parameter value needs to be encoded before being stored. | | flatParameters : `Boolean`Protected | Defines if parameters are stored in flat names or in nested objects. | | globalContext : `boolean`Deprecated | Determines if components and parameters are retrieved from the `window` `object` or from the dashboard instance. | | initCounter : `Number`Deprecated Protected | Init counter. | | initialStorage : `Object`Protected | Holds the dashboard `storage` value available during the dashboard initialization. | | isDisposed : `boolean`Protected | The dashboard is in a disposed state. | | isSilent : `boolean`Protected | Allows disabling dashboard notifications. | | lastServerResponse : `Number`Protected | Last server response timestamp. | | LEGACY\_STORAGE : `String`Deprecated Constant | Legacy storage parameter prefix. | | legacyPriority : `number`Deprecated Protected | Legacy dashboard components do not have priority, so we will assign a very low priority to them. | | logLifecycle : `boolean`Protected | Flag indicating if the lifecycle events should be logged. | | monthNames : ``Array.<`string`>``Deprecated | Array of month names. | | parameterModel : `Backbone.Model`Protected | Backbone model connected with the parameters. | | parameters : `Array`Protected | Store of key value pairs: parameter name - parameter value. | | queryFactories : `Object`Protected | Container used for registering query types and instantiating queries. | | refreshEngine : `cdf.dashboard.RefreshEngine`Protected | The `RefreshEngine` which manages the component refresh cycle. | | runningCalls : `Number`Protected | Running calls counter. | | serverCheckResponseTimeout : `Number`Protected | Timeout value in milliseconds. | | storage : `Object`Protected | Allows a user to persist parameters server-side to be used across different dashboards. | | STORAGE : `String`Constant | Storage parameters prefix. | | view : `Object`Protected | A view is a snapshot of the dashboard parameter's state, useful to restore a dashboard to a previous state. | | viewFlags : `Object`Constant | Object used to store the available view flag values (read only). | | viewParameters : `Object`Protected | Map containing the list of parameters of a dashboard and their `view flag`. | | webAppPath : `String`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 `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` \| `string`Deprecated | 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` \| `string`Deprecated | 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() : `string`Abstract | 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() : `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 `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) : `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 `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` \| `string`Deprecated | Calls an arbitrary URL expecting the result c | ## 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

| | | | Name | Default Value | Summary | | options : `Object`Optional | | Object that can contain the context, storage and view. | | Name | Default Value | Summary | | context : `Object`Optional | | The context of the dashboard retrieved from the server. | | storage : `Object`Optional | | The storage of the dashboard retrieved from the server. | | view : `Object`Optional | | The views of the dashboard retrieved from the server. | | isSilent : `boolean`Optional | | Allows disabling the dashboard notifications. | \## Members Details | \_i18nCurrentLanguageCode: `string`Protected | | --------------------------------------------------------------------------------------------------------------------------------------------- | |

The dashboard's current language code, used by other localizable components.

\*\*Source:\*\*dashboard/Dashboard.i18n.js, line 61

| | \_i18nSupport: `object`Protected | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |

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: `Object`Protected | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

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: `Object`Protected | | --------------------------------------------------------------------------------------------------------------------- | |

Holds the dashboard jQuery.blockUI options.

\*\*Source:\*\*dashboard/Dashboard.notifications.js, line 66

| | CDF\_ERROR\_DIV: `string`Deprecated | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |

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: `Object`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 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: `number`Protected | | --------------------------------------------------------------------------------------------------------------------- | |

The dashboard debug level.

\*\*Source:\*\*dashboard/Dashboard.js, line 329

\*\*Default Value:\*\*1

| | ERROR\_CODES: `Object`Constant 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. | | escapeParameterValues: `Boolean`Protected | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |

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: `Boolean`Protected | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

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: `boolean`Deprecated | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

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: `Number`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.

\*\*Source:\*\*dashboard/Dashboard.lifecycle.js, line 44

| | initialStorage: `Object`Protected | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

Holds the dashboard storage value available during the dashboard initialization.

\*\*Source:\*\*dashboard/Dashboard.storage.js, line 54

| | isDisposed: `boolean`Protected | | ------------------------------------------------------------------------------------------------------------------------------------ | |

The dashboard is in a disposed state.

\*\*Source:\*\*dashboard/Dashboard.js, line 339

\*\*Default Value:\*\*false

| | isSilent: `boolean`Protected | | ------------------------------------------------------------------------------------------------------ | |

Allows disabling dashboard notifications.

\*\*Source:\*\*dashboard/Dashboard.js, line 295

| | lastServerResponse: `Number`Protected | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

Last server response timestamp in milliseconds, which used to know if the session expired.

\*\*Source:\*\*dashboard/Dashboard.lifecycle.js, line 62

| | LEGACY\_STORAGE: `String`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: `number`Deprecated 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: `boolean`Protected | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | |

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.Model`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: `Array`Protected | | ------------------------------------------------------------------------------------------------------------------------------------------------- | |

Object which stores key value pairs with parameter name - parameter value.

\*\*Source:\*\*dashboard/Dashboard.parameters.js, line 38

| | queryFactories: `Object`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.

\*\*Source:\*\*dashboard/Dashboard.query.js, line 69

| | refreshEngine: `cdf.dashboard.RefreshEngine`Protected | | -------------------------------------------------------------------------------------------------------------------------------------- | |

The RefreshEngine which manages the component refresh cycle.

\*\*Source:\*\*dashboard/Dashboard.js, line 201

| | runningCalls: `Number`Protected | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | |

Running calls counter used to control the progress indicator in asynchronous calls.

\*\*Source:\*\*dashboard/Dashboard.lifecycle.js, line 53

| | serverCheckResponseTimeout: `Number`Protected | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

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: `Object`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 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: `String`Constant | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

Storage parameters prefix.

This allows users to store parameters between dashboard renders.

\*\*Source:\*\*dashboard/Dashboard.parameters.js, line 105

\*\*Default Value:\*\*storage.

| | view: `Object`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 Dashboard AMD module configuration.

\*\*Source:\*\*dashboard/Dashboard.views.js, line 56

| | viewFlags: `Object`Constant | | | | ---------------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------- | |

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. | | viewParameters: `Object`Protected | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

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: `String`Protected | | ------------------------------------------------------------------------------------- | |

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. | | **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. | | **\_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 : `Object`Optional | | An option object. | | | | | | | | | | | Name | Default Value | Summary | | | | | | | | | | | index : `Number`Optional | | The index at which to add the component. | | | | | | | | | | | Name | Description | | | | | | | | | | | | `Error` | The component is invalid. | | | | | | | | | | | | `Error` | The component already exists in the dashboard instance. | | | | | | | | | | | | **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. | | | **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` \| `undefined`Optional | 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. | | | **blockUIwithDrag**() | | ---------------------------------------------------------------------------------------------------------------------- | |

Renders a blocking div which can be dragged.

\*\*Source:\*\*dashboard/Dashboard.notifications.js, line 99

| | **callPentahoAction**(obj, solution, path, action, parameters, callback) : `Object` \| `string`Deprecated | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | |

Calls an xaction.

\*\*Source:\*\*dashboard/Dashboard.legacy.js, line 56

See also:pentahoAction , parseXActionResult

| | | | Name | Default Value | Summary | | obj : `Object` | | DOM object where the response from the xaction should be written. | | solution : `string` | | The solution folder. | | path : `string` | | Path to the xaction. Can be the full path, in which case you do not need the solution and action. | | action : `string` | | The xaction name. | | parameters : `Object` | | Parameter object to send to the xaction. | | callback : `function` | | Callback function to call when the xaction responds. | | Name | Description | | | `Object` \| `string` | If `callback` is a `function` it returns the value of executing `pentahoAction`. Otherwise, it returns the value of executing `parseXActionResult`. | | | **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

| | | Name | Description | | `boolean` | `true` if able to connect, `false` otherwise. | | **cleanStorage**() | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

Resets the storage value to an empty object and deletes the value stored in the server.

\*\*Source:\*\*dashboard/Dashboard.storage.js, line 163

| | **createAndCleanErrorDiv**()Deprecated | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

Creates an empty HTML div element, with identifier CDF\_ERROR\_DIV for showing error messages.

\*\*Source:\*\*dashboard/Dashboard.legacy.js, line 208

| | **decrementRunningCalls**() | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

Decrements the running calls counter and if it reaches 0, hides the progress indicator.

\*\*Source:\*\*dashboard/Dashboard.lifecycle.js, line 145

| | **detectQueryType**(qd) : `String` \| `undefined` | | | | | | | | | | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------- | - | ---- | ----------- | - | ----------------------- | --------------------------------------------------- | ---- | - | - | |

Given a query definition object, returns its query type. The query can have three groups of types. First cda, with queries using the CDA plugin. Then legacy, using xactions, and an arbitrary value for CPK data sources.

\*\*Source:\*\*dashboard/Dashboard.query.js, line 154

| Name | Description | | ---- | ----------- | | `String` \| `undefined` | The query type or `undefined` if none was detected. |

| | | | Name | Default Value | Summary | | | | | | | | | | | qd : `Object` | | The query definition object. | | | | | | | | | | | Name | Default Value | Summary | | | | | | | | | | | dataSource : `String`Optional | | The name of the data source. | | | | | | | | | | | queryType : `String`Optional | | The query type in case it is from CPK. | | | | | | | | | | | query : `Object`Optional | | The query in case of it being legacy. | | | | | | | | | | | path : `String`Optional | | The path of the CDA file holding the query. | | | | | | | | | | | dataAccessId : `String`Optional | | The name of the query in the CDA file . | | | | | | | | | | | **dispose**() | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |

Dispose resources that the dashboard may have and that are no longer needed, if it wasn't already disposed.

\*\*Source:\*\*dashboard/Dashboard.js, line 421

| | **errorNotification**(err, ph) | | | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------ | |

Displays an error notification if the dashboard is not in silent mode.

\*\*Source:\*\*dashboard/Dashboard.notifications.js, line 215

| | | | Name | Default Value | Summary | | err : `Object` | | An object containing a `msg` property with the error message to display. | | ph : `Object`Optional | | A reference to the HTML element to attach the error message. | | **executeAjax**(returnType, url, params, func) : `Object` \| `string`Deprecated | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------- | |

Executes an Ajax request. If no func callback is provided, it executes asynchronously and returns a jQuery XMLHttpRequest (jqXHR) object. Otherwise, it executes jQuery.ajax synchronously and returns the result of the HTTP request.

\*\*Source:\*\*dashboard/Dashboard.legacy.js, line 103

| | | | Name | Default Value | Summary | | returnType : `string` | | The expected return type. | | url : `string` | | The URL to call. | | params : `Object` | | The parameters object. | | func : `function` | | Callback function. | | Name | Description | | | `Object` \| `string` | If no `func` callback is provided, it returns a jqXHR object. Otherwise, it returns the result of the HTTP request. | | | **fetchData**(cd, params, callback)Deprecated | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------- | |

Fetches data from the server according to a query definition object. This method is deprecated, so a Query instance should be used instead.

\*\*Source:\*\*dashboard/Dashboard.legacy.js, line 337

| | | | Name | Default Value | Summary | | cd : `Object` | | The query definition object. | | params : `Object` | | The parameters to use in the query. | | callback : `function` | | The callback `function` to be called with results. | | **fireChange**(parameter, value) | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------ | |

Changes the value of a parameter with the provided name. Triggers the *parameter*:fireChange event and updates the components which listen for changes on the aforementioned parameter.

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 766

Fires: cdf.event:cdf , cdf.dashboard.Dashboard#event:parameterName:fireChange

| | | | Name | Default Value | Summary | | parameter : `string` | | The name of the parameter on which to fire the change. | | value : `Object` | | Value for the parameter. | | **generateBookmarkState**() : `Object` | | | ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | |

Generates a bookmark state using stored values.

\*\*Source:\*\*dashboard/Dashboard.bookmarkable.js, line 147

| | | Name | Description | | `Object` | An object with the state of the parameters previously marked as bookmarkable. | | **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

| | | | Name | Default Value | Summary | | type : `string` | | Type of the add-in, usually the component type where this add-in will be available. | | subType : `string` | | The subtype of the add-in. | | addInName : `string` | | The add-in name. | | Name | Description | | | `cdf.AddIn` \| `null` | The add-in if one is found, `null` otherwise. | | | **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

| | | Name | Description | | `cdf.queries.BaseQuery` | The base query constructor. | | **getBookmarkState**() : `Object` | | | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | |

Gets the bookmark state URL decoded.

\*\*Source:\*\*dashboard/Dashboard.bookmarkable.js, line 215

| | | Name | Description | | `Object` | An object with the current bookmark state. | | **getComp**() | | ----------------------------------------------------------------------------------------------------------- | |

Alias for getComponent.

\*\*Source:\*\*dashboard/Dashboard.components.js, line 81

| | **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 undefined is returned.

\*\*Source:\*\*dashboard/Dashboard.components.js, line 65

Example

| | | | Name | Default Value | Summary | | name : `String` | | The component's name. | | Name | Description | | | `cdf.components.BaseComponent` | The instance of `BaseComponent` with the given name. | | | `undefined` | /p | | | `1` | ``var` `myComponent = myDashboard.getComponent(``"myInputComponent"`);` | | | **getComponentByName**() | | ----------------------------------------------------------------------------------------------------------- | |

Alias for getComponent.

\*\*Source:\*\*dashboard/Dashboard.components.js, line 89

| | **getComponentIndex**(compOrNameOrIndex) : `number` | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -------------------------------------------- | |

Get the index of the array components that contains the component.

If compOrNameOrIndex is a string, it searches the component that first matches such name. If compOrNameOrIndex is a number, it returns component index on the components array. Lastly, if compOrNameOrIndex is a component instance, it returns the index where it is in components array.

\*\*Source:\*\*dashboard/Dashboard.components.js, line 180

| | | | Name | Default Value | Summary | | compOrNameOrIndex : `cdf.components.BaseComponent` \| `string` \| `number` | | The name, index, or the component to search. | | Name | Description | | | `number` | The index where the component is at or `-1` if not found. | | | **getDataSource**(obj) : `Object` \| `undefined` | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------- | |

Gets a data source according to the provided name or query definition object with a dataSource property.

\*\*Source:\*\*dashboard/Dashboard.dataSources.js, line 142

| | | | Name | Default Value | Summary | | obj : `string` \| `Object` | | The name of the data source or an `object` from which to extract the name from. | | Name | Description | | | `Object` \| `undefined` | The data source or `undefined` if none is found. | | | **getDataSourceQuery**(obj) : `Object` \| `undefined` | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | |

Gets a query from getQuery using the data source with the provided name.

\*\*Source:\*\*dashboard/Dashboard.dataSources.js, line 158

| | | | Name | Default Value | Summary | | obj : `string` \| `Object` | | The name of the data source or an `object` from which to extract the name from. | | Name | Description | | | `Object` \| `undefined` | The query built using the target data source or `undefined` if no data source was found. | | | **getErrorObj**(errorCode) : `Object` | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | --------------- | |

Given an error code, returns the registered error object associated with that code.

\*\*Source:\*\*dashboard/Dashboard.notifications.js, line 155

| | | | Name | Default Value | Summary | | errorCode : `string` | | The error code. | | Name | Description | | | `Object` | An object with a `msg` property containing the error code message or an empty object if the code is not registered. | | | **getMessagesPath**() : `string`Abstract | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | |

Gets the path from which to load the locale-specific properties files.

If this method returns undefined, which is the most common case, the path will be the dashboard's path.

It will be overridden returning the appropriate dashboard path in embedded scenarios.

\*\*Source:\*\*dashboard/Dashboard.i18n.js, line 143

| | | Name | Description | | `string` | The path to the dashboard's locale-specific text files. | | **getParam**(parameterName) : `Object` | | | | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | ------------------- | |

Alias for getParameterValue.

\*\*Source:\*\*dashboard/Dashboard.parameters.js, line 319

| | | | Name | Default Value | Summary | | parameterName : `String` | | The parameter name. | | Name | Description | | | `Object` | The parameter value or `undefined` if the parameter name is invalid. | | | **getParameterValue**(parameterName) : `Object` | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------- | |

Gets the parameter value from a given parameter name.

If the argument is invalid, undefined is returned.

\*\*Source:\*\*dashboard/Dashboard.parameters.js, line 302

| | | | Name | Default Value | Summary | | parameterName : `String` | | The parameter name. | | Name | Description | | | `Object` | The value of the parameter or `undefined` if the parameter name is invalid. | | \\\\\\ \
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

|Name|Description| |----|-----------| |`cdf.queries.BaseQuery`|The query instance from the required `type` extended with the options in `opts`.|

See also:getDataSource

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"});


</td></tr></tbody>
</table><table id="GETRUNNINGCALLS"><thead><tr><th>

**getRunningCalls**() : `number`

\\
Returns the number of running calls. \*\*Source:\*\*dashboard/Dashboard.lifecycle.js, line 127 | Name | Description | | -------- | -------------------------------------------- | | `number` | Number of actual running calls to the server | \
\\\\\\\\\\\ \
**getSettingsValue**(key, value)Deprecated \
Gets a setting value from the server. \*\*Source:\*\*dashboard/Dashboard.legacy.js, line 309 | Name | Default Value | Summary | | ------------------ | ------------- | ------------------- | | key : `string` |   | Key to the setting. | | value : `function` |   | Callback function. | \
\\\\\\\\\\\ \
**getUnboundParameters**() : `Array.<`string`>` \
Gets a list of the names of the dashboard parameters with the view flag set to `viewFlags.UNBOUND`. \*\*Source:\*\*dashboard/Dashboard.views.js, line 194 | Name | Description | | ----------------------- | ---------------------------------------------------- | | `Array.<`string`>` | List containing the names of the unbound parameters. | \
\\\\\\\\\\\ \
**getViewParameters**() : `Object` \
Gets a map with the pairs parameter name - parameter value, with all dashboard parameters with the view flag set to `viewFlags.VIEW` or `viewFlags.UNBOUND`. \*\*Source:\*\*dashboard/Dashboard.views.js, line 173 | Name | Description | | -------- | --------------------------------------------------- | | `Object` | Map containing the viewable and unbound parameters. | \
\\\\\\\\\\\ \
**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 396 | Name | Description | | -------- | ------------------------------------- | | `Object` | The dashboard's wcdf settings object. | \
\\\\\\\\\\\ \
**getWebAppPath**() : `string` \
Gets the current webapp path. \*\*Source:\*\*dashboard/Dashboard.js, line 384 | Name | Description | | -------- | ------------------------------------------ | | `string` | The current webapp path (e.g. "/pentaho"). | \
\\\\\\\\\\\ \
**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 | Name | Default Value | Summary | | -------------------- | ------------- | ----------------------------------------------------------------------------------- | | type : `string` |   | Type of the add-in, usually the component type where this add-in will be available. | | subType : `string` |   | The subtype of the add-in. | | addInName : `string` |   | The add-in name. | | Name | Description | | --------- | ----------------------------------------------- | | `boolean` | `true` if the add-in exists, `false` otherwise. | \
\\\\\\\\\\\ \
**hasQuery**(type) : `boolean` \
Determines if a given query type is registered in the current dashboard. \*\*Source:\*\*dashboard/Dashboard.query.js, line 136 | Name | Default Value | Summary | | --------------- | ------------- | --------------- | | type : `string` |   | The query type. | | Name | Description | | --------- | ---------------------------------------------------------------- | | `boolean` | `true` if the query type has been registered for this dashboard. | \
\\\\\\\\\\\ \
**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 | Name | Default Value | Summary | | ----------------- | ------------- | ---------------------------------------------------------------------- | | force : `boolean` |   | `true` if the running calls counter should be reset, `false` otherwise | \
\\\\\\\\\\\ \
**incrementRunningCalls**() \
Increments the running calls counter. \*\*Source:\*\*dashboard/Dashboard.lifecycle.js, line 135 \
\\\\\\\\\\\ \
**init**(components) \
Dashboard's initialization function. Calling this method will trigger the dashboard execution and render. \*\*Source:\*\*dashboard/Dashboard.lifecycle.js, line 162 | Name | Default Value | Summary | | ------------------------------------------------------------------ | ------------- | ------------------------------------------------ | | components : `Array.<`cdf.components.BaseComponent`>`Optional |   | List of components to be added to the dashboard. | \
\\\\\\\\\\\ \
**isBookmarkable**(parameter) : `boolean` \
Checks if a `parameter` is bookmarkable. \*\*Source:\*\*dashboard/Dashboard.bookmarkable.js, line 137 | Name | Default Value | Summary | | -------------------- | ------------- | ------------------- | | parameter : `string` |   | The parameter name. | | Name | Description | | --------- | --------------------------------------------------------- | | `boolean` | `true` if `parameter` is bookmarkable, `false` otherwise. | \
\\\\\\\\\\\ \
**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 835 | Name | Default Value | Summary | | ------------------------------------ | ------------- | --------------------------------------- | | the : `cdf.components.BaseComponent` |   | component to check if is being updated. | \
\\\\\\\\\\\ \
**isValidQueryDefinition**(queryDefinition) : `boolean` \
Tests if a query definition is valid or not. It checks if the return value of the `detectQueryType` is not `undefined`. \*\*Source:\*\*dashboard/Dashboard.query.js, line 242 | Name | Default Value | Summary | | -------------------------- | ------------- | ---------------------------- | | queryDefinition : `Object` |   | The query definition object. | | Name | Description | | --------- | ---------------------------------------- | | `boolean` | `true` if the query definition is valid. | **See also:**`detectQueryType` \
\\\\\\\\\\\ \
**isViewParameter**(parameter) : `string` \
Returns the view flag value of a given parameter. \*\*Source:\*\*dashboard/Dashboard.views.js, line 158 | Name | Default Value | Summary | | -------------------- | ------------- | -------------------------- | | parameter : `string` |   | The name of the parameter. | | Name | Description | | -------- | ------------------------------ | | `string` | The parameter view flag value. | \
\\\\\\\\\\\ \
**listAddIns**(type, subType) : `Array.<`cdf.AddIn`>` \
Lists registered add-ins of a given type and subtype. \*\*Source:\*\*dashboard/Dashboard.addIns.js, line 194 | Name | Default Value | Summary | | ------------------ | ------------- | ----------------------------------------------------------------------------------- | | type : `string` |   | Type of the add-in, usually the component type where this add-in will be available. | | subType : `string` |   | The subtype of the add-in. | | Name | Description | | -------------------------- | ---------------------------------------------------------------- | | `Array.<`cdf.AddIn`>` | An `array` containing the add-ins of the given type and subtype. | \
\\\\\\\\\\\ \
**listQueries**() : `Array.<`String`>` \
Lists the registered query types in this dashboard. \*\*Source:\*\*dashboard/Dashboard.query.js, line 252 | Name | Description | | ----------------------- | ------------------------------------------------- | | `Array.<`String`>` | An `array` containing the registered query types. | \
\\\\\\\\\\\ \
**loadStorage**() \
Retrieves the `storage` value from the server using a jQuery.ajax request and saves it in the dashboard `storage` property. \*\*Source:\*\*dashboard/Dashboard.storage.js, line 94 \
\\\\\\\\\\\ \
**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 | Name | Default Value | Summary | | ------------------ | ------------- | ----------------------------- | | newOpts : `Object` |   | Options for the login pop-up. | **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 411 | Name | Default Value | Summary | | ------------- | ------------- | ---------------------------------------- | | id : `string` |   | The DOM element identifier to normalize. | | Name | Description | | -------- | -------------------------- | | `string` | The normalized identifier. | \
\\\\\\\\\\\ \
**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 `obj` component. \*\*Source:\*\*dashboard/Dashboard.legacy.js, line 246 | Name | Default Value | Summary | | ------------------------------------ | ------------- | ------------------------------------------ | | obj : `cdf.components.BaseComponent` |   | The target component. | | html : `string` |   | HTML string containing the xaction result. | | Name | Description | | ------------------ | ---------------------------------------------------------------------------------------------------- | | `Object` \| `null` | A DOM object containing the xaction result if no errors are detected. Otherwise, `null` is returned. | \
\\\\\\\\\\\ \
**pentahoAction**(solution, path, action, params, func) : `Object` | `string`Deprecated \
Another way to call an xaction. \*\*Source:\*\*dashboard/Dashboard.legacy.js, line 158 | Name | Default Value | Summary | | ------------------- | ------------- | ------------------------------------------------------------------------------------------------- | | solution : `string` |   | Solution folder. | | path : `string` |   | Path to the xaction. Can be the full path, in which case you do not need the solution and action. | | action : `string` |   | The xaction name. | | params : `Object` |   | Parameter object to send to the xaction. | | func : `function` |   | Callback function to call when the xaction responds. | | Name | Description | | -------------------- | ----------------------------------------------------- | | `Object` \| `string` | The return value of executing `pentahoServiceAction`. | **See also:**`pentahoServiceAction` \
\\\\\\\\\\\ \
**pentahoServiceAction**(serviceMethod, returntype, solution, path, action, params, func) : `Object` | `string`Deprecated \
Calls an xaction. \*\*Source:\*\*dashboard/Dashboard.legacy.js, line 177 | Name | Default Value | Summary | | ------------------------ | ------------- | ------------------------------------------------------------------------------------------------ | | serviceMethod : `string` |   | Dom object where the response from the xaction should be written. | | returntype : `string` |   | Expected return type of the response. | | solution : `string` |   | Solution folder. | | path : `string` |   | Path to the xaction. Can be the full path, in which case you do not need the solution and action | | action : `string` |   | The xaction name. | | params : `Object` |   | Parameter object to send to the xaction. | | func : `function` |   | Callback function to call when the xaction responds. | | Name | Description | | -------------------- | -------------------------------------------- | | `Object` \| `string` | The return value of executing `executeAjax`. | **See also:**`executeAjax` \
\\\\\\\\\\\ \
**persistBookmarkables**(param) \
If `param` is a bookmarkable parameter, this method uses `generateBookmarkState` to generate a bookmark state with the values stored and `setBookmarkState` to persist them. \*\*Source:\*\*dashboard/Dashboard.bookmarkable.js, line 167 | Name | Default Value | Summary | | ---------------- | ------------- | -------------------------- | | param : `string` |   | The name of the parameter. | \
\\\\\\\\\\\ \
**processChange**(object\_name) \
Given the component with name `object_name`, a change is processed as follows: We get the `parameter` and the `value` from the component (`getValue()`). Then we do the actual processing: 1. component.`preChange(value)` 2. dashboard.`fireChange(`parameter`,`value`)` 3. component.`postChange(value)` \*\*Source:\*\*dashboard/Dashboard.lifecycle.js, line 727 | Name | Default Value | Summary | | ----------------------- | ------------- | ------------------- | | object\_name : `string` |   | The component name. | \
\\\\\\\\\\\ \
**registerAddIn**(type, subType, addIn) \
Registers an add-in to be used only by this dashboard instance. \*\*Source:\*\*dashboard/Dashboard.addIns.js, line 122 | Name | Default Value | Summary | | ------------------- | ------------- | ----------------------------------------------------------------------------------- | | type : `string` |   | Type of the add-in, usually the component type where this add-in will be available. | | subType : `string` |   | The subtype of the add-in. | | addIn : `cdf.AddIn` |   | The add-in instance to register. | \
\\\\\\\\\\\ \
**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 | Name | Default Value | Summary | | ------------------- | ------------- | --------------------------------------------------------------------------------------- | | type : `string` |   | The type of the add-in, usually the component type where this add-in will be available. | | subType : `string` |   | The subtype of the add-in. | | addIn : `cdf.AddIn` |   | The add-in instance to register. | \
\\\\\\\\\\\ \
**registerQuery**(type, query) \
Registers a new query type constructor to be used by the 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 the dashboard instance level and will not be accessible to other dashboards. To register the query type globally see the `registerGlobalQuery` function. \*\*Source:\*\*dashboard/Dashboard.query.js, line 108 | 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. | \
\\\\\\\\\\\ \
**removeComponent**(compOrNameOrIndex) : `cdf.components.BaseComponent` | `undefined` \
Removes a component from the `components` array, calling `getComponentIndex` to retrieve the correct component. Additionally, all the cdf events are removed, returning the component instance removed. If argument is a `BaseComponent` instance that exists in the `components` array, it will be removed. If `compOrNameOrIndex` is a string, the first component with such name is removed from the `components` array. The other case is if `compOrNameOrIndex` is a number. In this scenario, the component in such a position in the `components` array is removed. \*\*Source:\*\*dashboard/Dashboard.components.js, line 218 | Name | Default Value | Summary | | -------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------------- | | compOrNameOrIndex : `cdf.components.BaseComponent` \| `string` \| `number` |   | The component object, the name of the component, or the index of the component to be removed. | | Name | Description | | ------------------------------ | ---------------------------- | | `cdf.components.BaseComponent` | The removed component. | | `undefined` | The component was not found. | **See also:**`getComponentIndex` \
\\\\\\\\\\\ \
**removeDataSource**(obj) \
Removes the data source with the provided name. If `obj` is a query definition `object`, the data source name will be extracted from its `dataSource` property. \*\*Source:\*\*dashboard/Dashboard.dataSources.js, line 193 | Name | Default Value | Summary | | -------------------------- | ------------- | ------------------------------------------------------------------------ | | obj : `string` \| `Object` |   | The name of the data source or an object from which to extract the name. | \
\\\\\\\\\\\ \
**resetAll**() \
Resets the dashboard, clearing all the components, and re-updating them. \*\*Source:\*\*dashboard/Dashboard.lifecycle.js, line 702 \
\\\\\\\\\\\ \
**resetRunningCalls**() \
Resets the running calls counter and hides the progress indicator. \*\*Source:\*\*dashboard/Dashboard.lifecycle.js, line 114 \
\\\\\\\\\\\ \
**restoreBookmarkables**() \
This method uses `getBookmarkState` to read the bookmark state and then `setParameter` to set each parameter/value read in the dashboard. \*\*Source:\*\*dashboard/Dashboard.bookmarkable.js, line 250 \
\\\\\\\\\\\ \
**restoreView**() \
Restores the dashboard parameters stored in a `view`. Because we are storing the parameters in OrientDB, and it has some serious issues when storing nested objects, we need to marshal the parameters into a JSON object and convert that JSON into a Base64 blob before the storage operation. So, to restore the view parameters we need to revert this process. \*\*Source:\*\*dashboard/Dashboard.views.js, line 115 \*\*See also:\*\*OrientDB , Base64 \
\\\\\\\\\\\ \
**saveStorage**() \
Saves the `storage` value in the server using a jQuery.ajax request. \*\*Source:\*\*dashboard/Dashboard.storage.js, line 127 \
\\\\\\\\\\\ \
**setAddInDefaults**(type, subType, addInName, defaults) \
Sets the default options of an add-in. \*\*Source:\*\*dashboard/Dashboard.addIns.js, line 177 | Name | Default Value | Summary | | -------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | type : `string` |   | Type of the add-in, usually the component type where this add-in will be available. | | subType : `string` |   | The subtype of the add-in. | | addInName : `string` |   | The add-in name. | | defaults : `Object` |   | The default options. This is a JSON object specifying the default options. The options are dependent on which add-in is being used. | \
\\\\\\\\\\\ \
**setBookmarkable**(parameter, value) \
It sets `parameter` as bookmarkable, with value equal to `true` or `value` if provided. \*\*Source:\*\*dashboard/Dashboard.bookmarkable.js, line 122 | Name | Default Value | Summary | | ------------------------ | ------------- | --------------------------------------- | | parameter : `string` |   | The name of the parameter to be stored. | | value : `Object`Optional |   | The value for the parameter. | \
\\\\\\\\\\\ \
**setBookmarkState**(state) \
Overrides a bookmark state with a given `state`. \*\*Source:\*\*dashboard/Dashboard.bookmarkable.js, line 190 | Name | Default Value | Summary | | ---------------- | ------------- | --------------------------------------------- | | state : `Object` |   | The new state to override the existing state. | \
\\\\\\\\\\\ \
**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 | Name | Default Value | Summary | | ----------------------------- | ------------- | ---------------------------- | | name : `string` \| `Object` |   | The name of the data source. | | obj : `Object` \| `undefined` |   | The data source to be added. | \
\\\\\\\\\\\ \
**setGlobalContext**(globalContext)Deprecated \
Sets the `globalContext` value. \*\*Source:\*\*dashboard/Dashboard.js, line 374 | Name | Default Value | Summary | | ------------------------- | ------------- | ----------------------------------------------------- | | globalContext : `boolean` |   | Flag indicating if global context is to be activated. | \
\\\\\\\\\\\ \
**setI18nSupport**(locale, i18nRef) \
Sets the current locale and i18n options. \*\*Source:\*\*dashboard/Dashboard.i18n.js, line 128 | Name | Default Value | Summary | | ------------------ | ------------- | ----------------------- | | locale : `string` |   | Locale code. | | i18nRef : `Object` |   | Additional i18 options. | \
\\\\\\\\\\\ \
**setParam**(parameterName, parameterValue, isNotified) : `undefined` \
Alias for `setParameter`. \*\*Source:\*\*dashboard/Dashboard.parameters.js, line 369 | Name | Default Value | Summary | | ------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------- | | parameterName : `String` |   | The parameter name. | | parameterValue : `Object` |   | The value of the parameter. | | isNotified : `Boolean` |   | A flag indicating if a `*parameterName*:fireChange` event is to be triggered when the parameter value changes. | | Name | Description | | ----------- | ------------------------------- | | `undefined` | If parameter name is not valid. | \
\\\\\\\\\\\ \
**setParameter**(parameterName, parameterValue, isNotified) \
Stores a parameter value with a certain parameter name. If the parameter name is not valid, `undefined` is returned immediately. Since parameters are stored using the Backbone event model, an extra parameter - `isNotified` - can be used to control the Backbone event listeners. If `escapeParameterValues` is `true`, then `encode_prepare_arr` is called before the parameter value is stored. \*\*Source:\*\*dashboard/Dashboard.parameters.js, line 339 | Name | Default Value | Summary | | ------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------- | | parameterName : `String` |   | The parameter name. | | parameterValue : `Object` |   | The value of the parameter. | | isNotified : `Boolean` |   | A flag indicating if a `*parameterName*:fireChange` event is to be triggered when the parameter value changes. | \
\\\\\\\\\\\ \
**setParameterViewMode**(parameter, value) \
Sets the view flag for a given parameter. If none is provided it defaults to `viewFlags.VIEW`. \*\*Source:\*\*dashboard/Dashboard.views.js, line 143 | Name | Default Value | Summary | | -------------------- | ------------- | --------------------------------------------------------------------------------------------------- | | parameter : `string` |   | The name of the parameter. | | value : `string` | "view" | The value of the view flag for the parameter. If none is provided, it defaults to `viewFlags.VIEW`. | \
\\\\\\\\\\\ \
**setSettingsValue**(name, object)Deprecated \
Sets a setting in the server. \*\*Source:\*\*dashboard/Dashboard.legacy.js, line 290 | Name | Default Value | Summary | | ----------------- | ------------- | ---------------------- | | name : `string` |   | Name of the setting. | | object : `Object` |   | Value for the setting. | \
\\\\\\\\\\\ \
**showErrorTooltip**()Deprecated \
Creates an empty HTML div element for showing error messages. \*\*Source:\*\*dashboard/Dashboard.legacy.js, line 221 \
\\\\\\\\\\\ \
**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. \*\*Source:\*\*dashboard/Dashboard.notifications.js, line 122 \
\\\\\\\\\\\ \
**syncDebugLevel**() : `number` \
Sets the `debug` level. If the URL parameter `debug` has value of `true` and the value of the URL parameter `debugLevel` is a valid numeric value, it will set the debug level according to the latter. If an error occurs while reading the URL parameters, or `debug` is not set to `true`, the debug level is set to `1`. \*\*Source:\*\*dashboard/Dashboard.js, line 352 | Name | Description | | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `number` | The new `debug` level value according to the `debugLevel` URL parameter. It is `1` if an error occurs while parsing the URL, if the `debugLevel` has an invalid numeric value, or if the `debug` parameter is not set to `true`. | \
\\\\\\\\\\\ \
**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 `updateAll` method is called, updating all the components in the queue. \*\*Source:\*\*dashboard/Dashboard.lifecycle.js, line 615 | Name | Default Value | Summary | | ------------------------------------------ | ------------- | ------------------------ | | component : `cdf.components.BaseComponent` |   | The component to update. | \
\\\\\\\\\\\ \
**updateComponent**(object) \
Updates a specific component. \*\*Source:\*\*dashboard/Dashboard.lifecycle.js, line 647 | Name | Default Value | Summary | | --------------------------------------- | ------------- | ------------------------ | | object : `cdf.components.BaseComponent` |   | The component to update. | \
\\\\\\\\\\\ \
**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 | Name | Default Value | Summary | | ----------------- | ------------- | --------------------- | | url : `string` |   | The URL to call. | | params : `Object` |   | The parameter object. | | func : `function` |   | Callback function. | | Name | Description | | -------------------- | -------------------------------------------- | | `Object` \| `string` | The return value of executing `executeAjax`. | **See also:**`executeAjax` \
## Events Details \\\\\\\\\\\ \
**cdf:loginError** \
Event triggered when login fails. \*\*Source:\*\*dashboard/\_doc/events.jsdoc, line 48 \
\\\\\\\\\\\ \
**cdf:postInit** \
Event triggered after the dashboard finishes initializing. \*\*Source:\*\*dashboard/\_doc/events.jsdoc, line 27 \
\\\\\\\\\\\ \
**cdf:preInit** \
Event triggered before the dashboard starts initializing. \*\*Source:\*\*dashboard/\_doc/events.jsdoc, line 19 \
\\\\\\\\\\\ \
**cdf:serverError** \
Event triggered when a server error occurs. \*\*Source:\*\*dashboard/\_doc/events.jsdoc, line 56 \
\\\\\\\\\\\ \
***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 `:fireChange`. \*\*Source:\*\*dashboard/\_doc/events.jsdoc, line 35 \\\\\\\\\\\\\\\ \
Name \ Default Value \ Summary \
obj : `object` \   \ An object containing the parameter name and the new value. | Name | Default Value | Summary | | -------------------- | ------------- | -------------------------- | | parameter : `string` |   | The name of the parameter. | | value : `object` |   | The new parameter value. | \
\
NameDefault ValueSummarytype : String | ObjectOptional"cda"A string with the query type, or a valid data source or query definition object.opts : ObjectOptional An object containing the query options.NameDefault ValueSummarydataSource : StringOptional The data source of the query.queryType : StringOptional The query type.