Skip to main content
Pentaho Documentation

global

Methods

Name Description
_unlink()
_unlink()

Methods Details

Events Details

cdf:loginError

Event triggered when login fails.

Source: dashboard/_doc/events.jsdoc, line 48

Inherited From: cdf.dashboard.Dashboard#event:cdf:loginError

cdf:postInit

Event triggered after the dashboard finishes initializing.

Source: dashboard/_doc/events.jsdoc, line 27

Inherited From: cdf.dashboard.Dashboard#event:cdf:postInit

cdf:preInit

Event triggered before the dashboard starts initializing.

Source: dashboard/_doc/events.jsdoc, line 19

Inherited From: cdf.dashboard.Dashboard#event:cdf:preInit

cdf:serverError

Event triggered when a server error occurs.

Source: dashboard/_doc/events.jsdoc, line 56

Inherited From: cdf.dashboard.Dashboard#event:cdf:serverError

parameterName:fireChange

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

Inherited From: cdf.dashboard.Dashboard#event:parameterName:fireChange

Parameters:
Name Default Value Summary
obj : object

An object containing the parameter name and the new value.

Parameters:
Name Default Value Summary
parameter : string

The name of the parameter.

value : object

The new parameter value.

cdf:loginError

Event triggered when login fails.

Source: dashboard/_doc/events.jsdoc, line 48

Inherited From: cdf.dashboard.Dashboard#event:cdf:loginError

cdf:postInit

Event triggered after the dashboard finishes initializing.

Source: dashboard/_doc/events.jsdoc, line 27

Inherited From: cdf.dashboard.Dashboard#event:cdf:postInit

cdf:preInit

Event triggered before the dashboard starts initializing.

Source: dashboard/_doc/events.jsdoc, line 19

Inherited From: cdf.dashboard.Dashboard#event:cdf:preInit

cdf:serverError

Event triggered when a server error occurs.

Source: dashboard/_doc/events.jsdoc, line 56

Inherited From: cdf.dashboard.Dashboard#event:cdf:serverError

parameterName:fireChange

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

Inherited From: cdf.dashboard.Dashboard#event:parameterName:fireChange

Parameters:
Name Default Value Summary
obj : object

An object containing the parameter name and the new value.

Parameters:
Name Default Value Summary
parameter : string

The name of the parameter.

value : object

The new parameter value.

cdf:loginError

Event triggered when login fails.

Source: dashboard/_doc/events.jsdoc, line 48

Inherited From: cdf.dashboard.Dashboard#event:cdf:loginError

cdf:postInit

Event triggered after the dashboard finishes initializing.

Source: dashboard/_doc/events.jsdoc, line 27

Inherited From: cdf.dashboard.Dashboard#event:cdf:postInit

cdf:preInit

Event triggered before the dashboard starts initializing.

Source: dashboard/_doc/events.jsdoc, line 19

Inherited From: cdf.dashboard.Dashboard#event:cdf:preInit

cdf:serverError

Event triggered when a server error occurs.

Source: dashboard/_doc/events.jsdoc, line 56

Inherited From: cdf.dashboard.Dashboard#event:cdf:serverError

parameterName:fireChange

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

Inherited From: cdf.dashboard.Dashboard#event:parameterName:fireChange

Parameters:
Name Default Value Summary
obj : object

An object containing the parameter name and the new value.

Parameters:
Name Default Value Summary
parameter : string

The name of the parameter.

value : object

The new parameter value.

cdf:error

Event triggered when an error occurs.

Source: components/_doc/events.jsdoc, line 46

Inherited From: cdf.components.UnmanagedComponent#event:cdf:error

cdf:postExecution

Event triggered after a component finishes executing.

Source: components/_doc/events.jsdoc, line 38

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postExecution

cdf:postFetch

Event triggered after an UnmanagedComponent fetches data.

Source: components/_doc/events.jsdoc, line 54

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postFetch

Parameters:
Name Default Value Summary
data : object

The data returned from the jQuery.ajax call.

cdf:preExecution

Event triggered before a component starts executing.

Source: components/_doc/events.jsdoc, line 30

Inherited From: cdf.components.UnmanagedComponent#event:cdf:preExecution

cdf:render

Event triggered after the render callback executes and before endExec executes.

Source: components/_doc/events.jsdoc, line 64

Inherited From: cdf.components.UnmanagedComponent#event:cdf:render

all

The all event is a special event which will trigger the bound callbacks when any event occurs. This event is mainly used for logging purposes.

Source: components/_doc/events.jsdoc, line 19

Inherited From: cdf.components.BaseComponent#event:all

See also: Backbone Events catalog.

all

The all event is a special event which will trigger the bound callbacks when any event occurs. This event is mainly used for logging purposes.

Source: components/_doc/events.jsdoc, line 19

See also: Backbone Events catalog.

cdf:error

Event triggered when an error occurs.

Source: components/_doc/events.jsdoc, line 46

Inherited From: cdf.components.UnmanagedComponent#event:cdf:error

cdf:postExecution

Event triggered after a component finishes executing.

Source: components/_doc/events.jsdoc, line 38

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postExecution

cdf:postFetch

Event triggered after an UnmanagedComponent fetches data.

Source: components/_doc/events.jsdoc, line 54

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postFetch

Parameters:
Name Default Value Summary
data : object

The data returned from the jQuery.ajax call.

cdf:preExecution

Event triggered before a component starts executing.

Source: components/_doc/events.jsdoc, line 30

Inherited From: cdf.components.UnmanagedComponent#event:cdf:preExecution

cdf:render

Event triggered after the render callback executes and before endExec executes.

Source: components/_doc/events.jsdoc, line 64

Inherited From: cdf.components.UnmanagedComponent#event:cdf:render

all

The all event is a special event which will trigger the bound callbacks when any event occurs. This event is mainly used for logging purposes.

Source: components/_doc/events.jsdoc, line 19

Inherited From: cdf.components.BaseComponent#event:all

See also: Backbone Events catalog.

cdf:error

Event triggered when an error occurs.

Source: components/_doc/events.jsdoc, line 46

Inherited From: cdf.components.UnmanagedComponent#event:cdf:error

cdf:postExecution

Event triggered after a component finishes executing.

Source: components/_doc/events.jsdoc, line 38

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postExecution

cdf:postFetch

Event triggered after an UnmanagedComponent fetches data.

Source: components/_doc/events.jsdoc, line 54

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postFetch

Parameters:
Name Default Value Summary
data : object

The data returned from the jQuery.ajax call.

cdf:preExecution

Event triggered before a component starts executing.

Source: components/_doc/events.jsdoc, line 30

Inherited From: cdf.components.UnmanagedComponent#event:cdf:preExecution

cdf:render

Event triggered after the render callback executes and before endExec executes.

Source: components/_doc/events.jsdoc, line 64

Inherited From: cdf.components.UnmanagedComponent#event:cdf:render

all

The all event is a special event which will trigger the bound callbacks when any event occurs. This event is mainly used for logging purposes.

Source: components/_doc/events.jsdoc, line 19

Inherited From: cdf.components.BaseComponent#event:all

See also: Backbone Events catalog.

cdf:error

Event triggered when an error occurs.

Source: components/_doc/events.jsdoc, line 46

Inherited From: cdf.components.UnmanagedComponent#event:cdf:error

cdf:postExecution

Event triggered after a component finishes executing.

Source: components/_doc/events.jsdoc, line 38

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postExecution

cdf:postFetch

Event triggered after an UnmanagedComponent fetches data.

Source: components/_doc/events.jsdoc, line 54

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postFetch

Parameters:
Name Default Value Summary
data : object

The data returned from the jQuery.ajax call.

cdf:preExecution

Event triggered before a component starts executing.

Source: components/_doc/events.jsdoc, line 30

Inherited From: cdf.components.UnmanagedComponent#event:cdf:preExecution

cdf:render

Event triggered after the render callback executes and before endExec executes.

Source: components/_doc/events.jsdoc, line 64

Inherited From: cdf.components.UnmanagedComponent#event:cdf:render

all

The all event is a special event which will trigger the bound callbacks when any event occurs. This event is mainly used for logging purposes.

Source: components/_doc/events.jsdoc, line 19

Inherited From: cdf.components.BaseComponent#event:all

See also: Backbone Events catalog.

all

The all event is a special event which will trigger the bound callbacks when any event occurs. This event is mainly used for logging purposes.

Source: components/_doc/events.jsdoc, line 19

Inherited From: cdf.components.BaseComponent#event:all

See also: Backbone Events catalog.

cdf:error

Event triggered when an error occurs.

Source: components/_doc/events.jsdoc, line 46

Inherited From: cdf.components.UnmanagedComponent#event:cdf:error

cdf:postExecution

Event triggered after a component finishes executing.

Source: components/_doc/events.jsdoc, line 38

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postExecution

cdf:postFetch

Event triggered after an UnmanagedComponent fetches data.

Source: components/_doc/events.jsdoc, line 54

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postFetch

Parameters:
Name Default Value Summary
data : object

The data returned from the jQuery.ajax call.

cdf:preExecution

Event triggered before a component starts executing.

Source: components/_doc/events.jsdoc, line 30

Inherited From: cdf.components.UnmanagedComponent#event:cdf:preExecution

cdf:render

Event triggered after the render callback executes and before endExec executes.

Source: components/_doc/events.jsdoc, line 64

Inherited From: cdf.components.UnmanagedComponent#event:cdf:render

all

The all event is a special event which will trigger the bound callbacks when any event occurs. This event is mainly used for logging purposes.

Source: components/_doc/events.jsdoc, line 19

Inherited From: cdf.components.BaseComponent#event:all

See also: Backbone Events catalog.

cdf:error

Event triggered when an error occurs.

Source: components/_doc/events.jsdoc, line 46

Inherited From: cdf.components.UnmanagedComponent#event:cdf:error

cdf:postExecution

Event triggered after a component finishes executing.

Source: components/_doc/events.jsdoc, line 38

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postExecution

cdf:postFetch

Event triggered after an UnmanagedComponent fetches data.

Source: components/_doc/events.jsdoc, line 54

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postFetch

Parameters:
Name Default Value Summary
data : object

The data returned from the jQuery.ajax call.

cdf:preExecution

Event triggered before a component starts executing.

Source: components/_doc/events.jsdoc, line 30

Inherited From: cdf.components.UnmanagedComponent#event:cdf:preExecution

cdf:render

Event triggered after the render callback executes and before endExec executes.

Source: components/_doc/events.jsdoc, line 64

Inherited From: cdf.components.UnmanagedComponent#event:cdf:render

all

The all event is a special event which will trigger the bound callbacks when any event occurs. This event is mainly used for logging purposes.

Source: components/_doc/events.jsdoc, line 19

Inherited From: cdf.components.BaseComponent#event:all

See also: Backbone Events catalog.

cdf:error

Event triggered when an error occurs.

Source: components/_doc/events.jsdoc, line 46

Inherited From: cdf.components.UnmanagedComponent#event:cdf:error

cdf:postExecution

Event triggered after a component finishes executing.

Source: components/_doc/events.jsdoc, line 38

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postExecution

cdf:postFetch

Event triggered after an UnmanagedComponent fetches data.

Source: components/_doc/events.jsdoc, line 54

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postFetch

Parameters:
Name Default Value Summary
data : object

The data returned from the jQuery.ajax call.

cdf:preExecution

Event triggered before a component starts executing.

Source: components/_doc/events.jsdoc, line 30

Inherited From: cdf.components.UnmanagedComponent#event:cdf:preExecution

cdf:render

Event triggered after the render callback executes and before endExec executes.

Source: components/_doc/events.jsdoc, line 64

Inherited From: cdf.components.UnmanagedComponent#event:cdf:render

all

The all event is a special event which will trigger the bound callbacks when any event occurs. This event is mainly used for logging purposes.

Source: components/_doc/events.jsdoc, line 19

Inherited From: cdf.components.BaseComponent#event:all

See also: Backbone Events catalog.

cdf:error

Event triggered when an error occurs.

Source: components/_doc/events.jsdoc, line 46

Inherited From: cdf.components.UnmanagedComponent#event:cdf:error

cdf:postExecution

Event triggered after a component finishes executing.

Source: components/_doc/events.jsdoc, line 38

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postExecution

cdf:postFetch

Event triggered after an UnmanagedComponent fetches data.

Source: components/_doc/events.jsdoc, line 54

Inherited From: cdf.components.UnmanagedComponent#event:cdf:postFetch

Parameters:
Name Default Value Summary
data : object

The data returned from the jQuery.ajax call.

cdf:preExecution

Event triggered before a component starts executing.

Source: components/_doc/events.jsdoc, line 30

Inherited From: cdf.components.UnmanagedComponent#event:cdf:preExecution

cdf:render

Event triggered after the render callback executes and before endExec executes.

Source: components/_doc/events.jsdoc, line 64

Inherited From: cdf.components.UnmanagedComponent#event:cdf:render

all

The all event is a special event which will trigger the bound callbacks when any event occurs. This event is mainly used for logging purposes.

Source: components/_doc/events.jsdoc, line 19

Inherited From: cdf.components.BaseComponent#event:all

See also: Backbone Events catalog.

cdf:error

Event triggered when an error occurs.

Source: components/_doc/events.jsdoc, line 46

cdf:postExecution

Event triggered after a component finishes executing.

Source: components/_doc/events.jsdoc, line 38

cdf:postFetch

Event triggered after an UnmanagedComponent fetches data.

Source: components/_doc/events.jsdoc, line 54

Parameters:
Name Default Value Summary
data : object

The data returned from the jQuery.ajax call.

cdf:preExecution

Event triggered before a component starts executing.

Source: components/_doc/events.jsdoc, line 30

cdf:render

Event triggered after the render callback executes and before endExec executes.

Source: components/_doc/events.jsdoc, line 64

all

The all event is a special event which will trigger the bound callbacks when any event occurs. This event is mainly used for logging purposes.

Source: components/_doc/events.jsdoc, line 19

Inherited From: cdf.components.BaseComponent#event:all

See also: Backbone Events catalog.

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

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

Parameters:
Name Default Value Summary
obj : object

An object containing the parameter name and the new value.

Parameters:
Name Default Value Summary
parameter : string

The name of the parameter.

value : object

The new parameter value.

cdf

This event is triggered along with any other dashboard or component main event. Can be used in a more generic way, e.g., to proxy dashboard/component lifecycle events.

Source: _doc/events.jsdoc, line 14