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

Update

pentaho.visual.action. Update

The visual.action.Update class is the class of actions which represent an IView being updated.

The update action is asynchronous.

AMD Module

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

Extends

Constructor

Name Description
new Update(spec)

Creates an update action instance given its specification.

Members

Name Description
id
Static
isSync
Static
changeset : pentaho.type.action.ComplexChangeset

Gets the complex changeset describing the model changes since the last update execution, if any.

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 Update(spec)

Creates an update action instance given its specification.

Source: javascript/web/pentaho/visual/action/Update.js, line 24

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

An update action specification.

Members Details

id:
Static

Source: javascript/web/pentaho/visual/action/Update.js, line 69

isSync:
Static

Source: javascript/web/pentaho/visual/action/Update.js, line 74

changeset: pentaho.type.action.ComplexChangeset

Gets the complex changeset describing the model changes since the last update execution, if any.

When null, it indicates that everything might have changed.

Source: javascript/web/pentaho/visual/action/Update.js, line 44

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.