Skip to main content
Pentaho Documentation

action

pentaho.visual.action

The action namespace contains the standard action types used by visualizations.

Source: doc-js/pentaho/visual/action/_namespace.jsdoc, line 16

Child Namespaces

Name Summary
spec

The visual.action.spec namespace contains specification interfaces and type definitions.

Classes

Name Summary
Base

The visual.action.Base class is the base class of action types which are performed on a point whose target is a View.

Data

The visual.action.Data class is the base class of action types which are performed on a subset of a dataset and whose target is a View.

Execute

The Execute action is a synchronous action that is performed when the user interacts with a visual element, typically by double clicking it.

Select

The Select action is a synchronous action that is performed when the user interacts with a visual element, typically by clicking on it. This action has the alias "select", which can also be specified as the event name when calling on of action targets.

Members

Name Description
SelectionModes : function

The SelectionModes enumeration contains the collection of standard selection mode functions.

Members Details

SelectionModes: function

The SelectionModes enumeration contains the collection of standard selection mode functions.

Properties:
Name Default Value Description
replace : function function

Replaces the current selection filter with the provided filter.

toggle : function function

Adds the input filter to the current selection filter, if it is not already fully contained within the selection filter. Otherwise, removes the input filter from the current selection filter.

add : function function

Adds the input filter to the current selection filter.

remove : function function

Removes the input filter from the current selection filter.

Source: javascript/web/pentaho/visual/action/SelectionModes.js, line 35

Type Definitions

SelectionMode(current, input) : pentaho.data.filter.Abstract

The selection mode is a function that determines how the selection made by the user, contained in dataFilter, is merged with the view's current selection, selectionFilter.

The selection mode function is called with a this context being the target view.

Source: doc-js/pentaho/visual/action/SelectionMode.jsdoc, line 17

Parameters:
Name Default Value Summary
current : pentaho.data.filter.Abstract

The view's current selection filter.

input : pentaho.data.filter.Abstract

The user input data filter.

Returns:
Name Description
pentaho.data.filter.Abstract

The resulting filter.