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
base :  function
Protected

If a method has been overridden, then the base method provides access to the overridden method.

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.

extend(source, keyArgs) : object

Extend an object with the properties of another.

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

base:  function
Protected

If a method has been overridden, then the base method provides access to the overridden method.

Can also be called from within a constructor function.

Source: javascript/web/pentaho/lang/Base.js, line 299

Inherited From: pentaho.lang.Base#base

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.

extend(source, keyArgs) : object

Extend an object with the properties of another.

Methods that are overridden are accessible through this.base.

This object is extended, but its class doesn't change.

Source: javascript/web/pentaho/lang/Base.js, line 1040

Inherited From: pentaho.lang.Base#extend

Parameters:
Name Default Value Summary
source : object

The instance specification.

keyArgs : object
Optional

The keyword arguments.

Parameters:
Name Default Value Summary
exclude : object
Optional

A map of property names to exclude from source.

Returns:
Name Description
object

This object.

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.