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

Base

pentaho.lang Base

Base Class for JavaScript Inheritance.

Based on Generic.js by Dean Edwards, and later edited by Kenneth Powers.

AMD Module

require(["pentaho/lang/Base"], function(Base) { /* code goes here */ });

Constructor

Name Description
new Base(spec)

Creates a new Base object.

Members

Name Description
base :  function
Protected

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

Methods

Name Description
extend(source, keyArgs) : object

Extend an object with the properties of another.

Constructor Details

new Base(spec)

Creates a new Base object.

If spec is specified, the new object is extended with it.

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

Parameters:
Name Default Value Summary
spec : object
Optional

An extension specification.

Members Details

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

Overrides: pentaho.lang.Base#base

Methods Details

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

Overrides: 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.

pentaho.action Base

The action.Base class represents a certain model of actions.

Synchronous or Asynchronous

An action can be synchronous or asynchronous, as determined by the type property, pentaho.action.Base.isSync. The execution of a synchronous action is completed synchronously, while that of an asynchronous action only completes asynchronously.

Execution

Actions are executed at and by target objects, which implement the interface ITarget, by being passed as the argument to the ITarget#act method.

Targets control the exact implementation of the execution of an action, which is returned from the act method, in the form of an Execution. However, it is the action that imposes whether execution is synchronous or not, and the phases by which execution goes through, which are, for all action types:

  1. "init" - the execution is being initialized and a chance is given to mutate the action and change what will be done;
  2. "will" - action is now frozen and the action can be canceled based on what will be done;
  3. "do" - the action is executed;
  4. "finally" - the action execution has finished successfully or not.

For more information, see Execution.

AMD Module

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

Extends

Constructor

Name Description
new Base()
Abstract

Members

Name Description
base :  function
Protected

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

Methods

Name Description
extend(source, keyArgs) : object

Extend an object with the properties of another.

Constructor Details

new Base()
Abstract

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

Members Details

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

Overrides: pentaho.lang.Base#base

Methods Details

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

Overrides: 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.

Base

The Scene class represents one distinct visual state which is represented visually by one or more visual elements.

Scenes are not needed to implement visualization views. However, their use simplifies their implementation in many use cases.

Scenes have a map of visual variables, vars whose values are inherited from parent to child scenes.

To create scenes, most view implementations can simply use the [scene.Base.buildScenesFlat] method. This method creates one parent scene having one child scene per row of the model's dataset. In child scenes, for each visual role there will be a correspondingly named variable having the value of the visual role.

For handling user interaction, the scene instances' createFilter method provides an easy way to create a filter that selects the data from which the scene was generated based on its distinguishing field values. This filter can then be passed to a data action such as Select or Execute.

When communicating with external parties, field values must be used and visual variable values are not generally meaningful. The invert method allows directly obtaining the distinguishing field values that are associated with a scene.

Extends

Constructor

Name Description
new Base(parent, model)

Creates a scene instance.

Members

Name Description
base :  function
Protected

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

Methods

Name Description
extend(source, keyArgs) : object

Extend an object with the properties of another.

Constructor Details

new Base(parent, model)

Creates a scene instance.

Source: javascript/web/pentaho/visual/scene/Base.js, line 64

Parameters:
Name Default Value Summary
parent : pentaho.visual.scene.Base

The parent scene, if any.

model : pentaho.visual.Model

The model. Required if parent is not specified.

Members Details

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

Overrides: pentaho.lang.Base#base

Methods Details

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

Overrides: 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.