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 the actions defined by the Visualization API. |
Execute | The Execute action is a synchronous, data and positioned action that is performed when the user interacts with a visual element, typically by double clicking it. |
Interaction | The visual.action.Interaction class is the base class of the actions which originate from the user directly interacting with the view. |
ModelChangedError | The ModelChangedError class is a user error that signals the inability of a view to proceed an operation due to the associated model having changed in between. |
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. |
Update | The visual.action.Update class is the class of actions which represent an IView being updated. |
UpdateExecution | The execution class for an Update action in a Model . |
Members
Name | Description |
SelectionModes : function | The SelectionModes enumeration contains the collection of standard selection mode functions. |
WellKnownErrorNames : string | The WellKnownErrorNames enum is the class of well-known names of errors which occur during visual actions. |
Members Details
SelectionModes: function |
The SelectionModes enumeration contains the collection of standard selection mode functions. Properties: Name | Default Value | Description | replace : function | | Replaces the current selection filter with the provided filter. | toggle : 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 | | Adds the input filter to the current selection filter. | remove : function | | Removes the input filter from the current selection filter. | Source: javascript/web/pentaho/visual/action/SelectionModes.js, line 36 |
WellKnownErrorNames: string |
The WellKnownErrorNames enum is the class of well-known names of errors which occur during visual actions. Error codes are present in the value of an Error 's name property. Properties: Name | Default Value | Description | emptyData : string | empty-data | This error can result from an Update action when the given dataset does not have any rows or when all of its rows do not have data which can be rendered. This can be the case, for example, if all of the rows in a dataset only have null measure values. | invalidData : string | invalid-data | This error can result from an Update action when the model's dataset contains data which is invalid for the visualization. This can be the case, for example, if a Pie chart receives rows for which the sum of all measure values is 0. | bigData : string | big-data | This error can result from an Update action when the model's dataset is too big for being rendered by a view. Frequently, the rendering complexity is not dependent on the number of rows, but, instead, is dependent on the product between the distinct number of tuples of certain column sets. | modelChanged : string | model-changed | This error can result from any visual actions to signal that the model has changed, invalidating or disabling the execution. For example, during an asynchronous Update execution, the view can detect that the model has changed since the start of the execution and, by signaling the error, request that the update action be repeated. Additionally, this error can be used by a Select or Execute action execution to indicate that the action cannot be performed when the model has changed since the last update execution. The name of the ModelChangedError error. | Source: javascript/web/pentaho/visual/action/WellKnownErrorNames.js, line 30 |