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

Data

pentaho.visual.action.mixins. Data

The visual.action.mixins.Data class is a mixin class for visual actions which are performed on a subset of a dataset.

The actual subset is determined by the data filter property.

The mixin adds spec.IData to the specification of an action.

AMD Module

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

Extends

Constructor

Name Description
new Data()
Abstract

This class was not designed to be constructed directly. It was designed to be used as a mixin.

Members

Name Description
dataFilter : pentaho.data.filter.Abstract

Gets or sets the data filter of this action.

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 Data()
Abstract

This class was not designed to be constructed directly. It was designed to be used as a mixin.

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

Members Details

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

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.