ISelect

pentaho .visual .action .spec.ISelect

The visual.action.spec.ISelect interface describes a selection action instance using a generic, object form.

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

Extends

Name	Description
_ : `pentaho.type.spec.UTypeReference`	An inline type reference of the value's type.
dataFilter : `pentaho.data.filter.spec.IAbstract \| pentaho.data.filter.Abstract`	The data filter of the action instance.
description : `nonEmptyString`	The description of the action instance.
label : `nonEmptyString`	The label of the action instance.
position : `pentaho.visual.spec.IPoint`	The position where the action took place, in screen coordinates.
selectionMode : `string \| pentaho.visual.action.SelectionMode`	The selection mode of this action.

Members Details

_: `pentaho.type.spec.UTypeReference`
An inline type reference of the value's type. Source: doc-js/pentaho/type/spec/IInstance.jsdoc, line 27 Inherited From: pentaho.type.spec.IInstance#_

_: pentaho.type.spec.UTypeReference

An inline type reference of the value's type.

Source: doc-js/pentaho/type/spec/IInstance.jsdoc, line 27

Inherited From: pentaho.type.spec.IInstance#_

dataFilter: `pentaho.data.filter.spec.IAbstract \| pentaho.data.filter.Abstract`
The data filter of the action instance. When unspecified, the action targets the whole dataset. Source: doc-js/pentaho/visual/action/spec/IData.jsdoc, line 26 Inherited From: pentaho.visual.action.spec.IData#dataFilter

dataFilter: pentaho.data.filter.spec.IAbstract | pentaho.data.filter.Abstract

The data filter of the action instance.

When unspecified, the action targets the whole dataset.

Source: doc-js/pentaho/visual/action/spec/IData.jsdoc, line 26

Inherited From: pentaho.visual.action.spec.IData#dataFilter

description: `nonEmptyString`
The description of the action instance. When unspecified, the description of the action type, `pentaho.type.Type#description`, is used. Source: doc-js/pentaho/type/action/spec/IBase.jsdoc, line 38 Inherited From: pentaho.type.action.spec.IBase#description

description: nonEmptyString

The description of the action instance.

When unspecified, the description of the action type, pentaho.type.Type#description, is used.

Source: doc-js/pentaho/type/action/spec/IBase.jsdoc, line 38

Inherited From: pentaho.type.action.spec.IBase#description

label: `nonEmptyString`
The label of the action instance. When unspecified, the label of the action type, `pentaho.type.Type#label`, is used. Source: doc-js/pentaho/type/action/spec/IBase.jsdoc, line 26 Inherited From: pentaho.type.action.spec.IBase#label

label: nonEmptyString

The label of the action instance.

When unspecified, the label of the action type, pentaho.type.Type#label, is used.

Source: doc-js/pentaho/type/action/spec/IBase.jsdoc, line 26

Inherited From: pentaho.type.action.spec.IBase#label

position: `pentaho.visual.spec.IPoint`
The position where the action took place, in screen coordinates. Source: doc-js/pentaho/visual/action/spec/IBase.jsdoc, line 26 Inherited From: pentaho.visual.action.spec.IBase#position

position: pentaho.visual.spec.IPoint

The position where the action took place, in screen coordinates.

Source: doc-js/pentaho/visual/action/spec/IBase.jsdoc, line 26

Inherited From: pentaho.visual.action.spec.IBase#position

selectionMode: `string \| pentaho.visual.action.SelectionMode`
The selection mode of this action. When unspecified, or specified as a `Nully` value, the default value, which is the value of `defaultSelectionMode`, is used. Can be specified as the name of one of the standard selection modes, `SelectionModes`, to assume the corresponding selection mode function. Source: doc-js/pentaho/visual/action/spec/ISelect.jsdoc, line 26

selectionMode: string | pentaho.visual.action.SelectionMode

The selection mode of this action.

When unspecified, or specified as a Nully value, the default value, which is the value of defaultSelectionMode, is used.

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

Source: doc-js/pentaho/visual/action/spec/ISelect.jsdoc, line 26