Skip to main content

Pentaho+ documentation is moving!

The new product documentation portal is here. Check it out now at docs.hitachivantara.com

 

Hitachi Vantara Lumada and Pentaho Documentation

Execute

pentaho.visual.action. Execute

The Execute action is a synchronous, data and positioned action that is performed when the user interacts with a visual element, typically by double clicking it.

AMD Module

require(["pentaho/visual/action/Execute"], function(Execute) { /* code goes here */ });

See also: pentaho.visual.action.spec.IExecute

Extends

Constructor

Name Description
new Execute(spec)

Creates an execute action given its specification.

Members

Name Description
id
Static
dataFilter : pentaho.data.filter.Abstract

Gets or sets the data filter of this action.

eventName : string

Gets the event name of the action.

position : pentaho.visual.spec.IPoint

Gets or sets the position where the action took place, in screen coordinates.

Methods

Name Description
clone() : pentaho.action.Base

Creates a shallow clone of this action.

validate() : Array.<pentaho.lang.UserError>

Determines if the given action is valid.

Constructor Details

new Execute(spec)

Creates an execute action given its specification.

Source: javascript/web/pentaho/visual/action/Execute.js, line 25

Parameters:
Name Default Value Summary
spec : pentaho.visual.action.spec.IExecute
Optional

An execute action specification.

See also: pentaho.visual.action.spec.IExecute

Example

define(["pentaho/visual/action/Execute"], function(ExecuteAction) {

 // ...

 // Listen to the execute event
 model.on(ExecuteAction.id, {

 do: function(action) {

 var dataFilter = action.dataFilter;

 alert("Executed on rows where " + (dataFilter && dataFilter.$contentKey));

 // Mark action as done.
 action.done();
 }
 });

 // ...

 // Act "execute" on data rows that have "country" = "us".

 model.act(new ExecuteAction({
 dataFilter: {
 _: "=",
 p: "country",
 v: "us"
 }
 });
});

Members Details

id:
Static

Source: javascript/web/pentaho/visual/action/Execute.js, line 82

dataFilter: pentaho.data.filter.Abstract

Gets or sets the data filter of this action.

When set to a filter specification, pentaho.data.filter.spec.IAbstract, it is converted into a filter object. Any registered visual filter type can be safely loaded synchronously.

When null, the action targets the entire dataset.

Source: javascript/web/pentaho/visual/action/mixins/Data.js, line 73

Inherited From: pentaho.visual.action.mixins.Data#dataFilter

eventName: string

Gets the event name of the action.

The default implementation returns the value of pentaho.action.Base.id.

Source: javascript/web/pentaho/action/Base.js, line 82

Overrides: pentaho.visual.action.mixins.Positioned#eventName

position: pentaho.visual.spec.IPoint

Gets or sets the position where the action took place, in screen coordinates.

Source: javascript/web/pentaho/visual/action/mixins/Positioned.js, line 61

Inherited From: pentaho.visual.action.mixins.Positioned#position

Methods Details

clone() : pentaho.action.Base

Creates a shallow clone of this action.

Source: javascript/web/pentaho/action/Base.js, line 103

Overrides: pentaho.visual.action.mixins.Positioned#clone

Returns:
Name Description
pentaho.action.Base

The action clone.

validate() : Array.<pentaho.lang.UserError>

Determines if the given action is valid.

The default implementation does nothing and considers the instance valid. Override to implement an action's specific validation logic.

Source: javascript/web/pentaho/action/Base.js, line 94

Overrides: pentaho.visual.action.mixins.Positioned#validate

Returns:
Name Description
Array.<pentaho.lang.UserError> | null

A non-empty array of errors or null.