Skip to main content

Pentaho+ documentation has moved!

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

 

Hitachi Vantara Lumada and Pentaho Documentation

Interaction

pentaho.visual.action. Interaction

The visual.action.Interaction class is the base class of the actions which originate from the user directly interacting with the view.

Interaction actions cannot be executed if the associated model is isDirty.

AMD Module

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

Extends

Constructor

Name Description
new Interaction(spec)
Abstract

Creates an interaction instance given its specification.

Members

Name Description
eventName : string

Gets the event name of the action.

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 Interaction(spec)
Abstract

Creates an interaction instance given its specification.

Source: javascript/web/pentaho/visual/action/Interaction.js, line 23

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

An interaction specification.

Members Details

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

Inherited From: pentaho.action.Base#eventName

Methods Details

clone() : pentaho.action.Base

Creates a shallow clone of this action.

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

Inherited From: pentaho.action.Base#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

Inherited From: pentaho.action.Base#validate

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

A non-empty array of errors or null.