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

Select

pentaho.visual.action Select

The Select action is a synchronous, data and positioned action that is performed when the user interacts with a visual element, typically by clicking on it.

AMD Module

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

See also: pentaho.visual.action.spec.ISelect , pentaho.visual.action.spec.ISelectConfig

Extends

Constructor

Name Description
new Select(spec)

Creates a select action given its specification.

Members

Name Description
id
Static
base :  function
Protected

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

dataFilter :  pentaho.data.filter.Abstract

Gets or sets the data filter of this action.

eventName :  string

Gets the event name of the action.

position :  pentaho.visual.spec.IPoint

Gets or sets the position where the action took place, in screen coordinates.

selectionMode :  pentaho.visual.action.SelectionMode

Gets or sets the selection mode of this action.

Methods

Name Description
_fillSpec()
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 Select(spec)

Creates a select action given its specification.

Source: javascript/web/pentaho/visual/action/Select.js, line 55

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

A select action specification.

See also: pentaho.visual.action.spec.ISelect , pentaho.visual.action.spec.ISelectConfig

Members Details

id:
Static

Source: javascript/web/pentaho/visual/action/Select.js, line 113

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.visual.action.mixins.Positioned#base

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

Inherited From: pentaho.visual.action.mixins.Data#dataFilter

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

Overrides: pentaho.visual.action.mixins.Positioned#eventName

position:  pentaho.visual.spec.IPoint

Gets or sets the position where the action took place, in screen coordinates.

Source: javascript/web/pentaho/visual/action/mixins/Positioned.js, line 61

Inherited From: pentaho.visual.action.mixins.Positioned#position

selectionMode:  pentaho.visual.action.SelectionMode

Gets or sets the selection mode of this action.

The default value is the value of defaultSelectionMode.

Setting to a Nully value assumes the default value.

Can be set to the name of one of the standard selection modes, SelectionModes, to assume the corresponding selection mode function.

Source: javascript/web/pentaho/visual/action/Select.js, line 81

Methods Details

_fillSpec()

Source: javascript/web/pentaho/visual/action/Select.js, line 102

clone() : pentaho.action.Base

Creates a shallow clone of this action.

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

Overrides: pentaho.visual.action.mixins.Positioned#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

Overrides: pentaho.visual.action.mixins.Positioned#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

Overrides: pentaho.visual.action.mixins.Positioned#validate

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

A non-empty array of errors or null.