Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

IAddUsage

pentaho.visual.role. IAddUsage

The IAddUsage interface exposes information about the result of a hypothetical, valid add operation, of a field to a visual role.

Source: doc-js/pentaho/visual/role/IAddUsage.jsdoc, line 17

See also: pentaho.visual.role.util

Members

Name Description
fieldName :  string

The name of the field being added.

fieldPosition :  number

The index at which the field's final position.

mode :  pentaho.visual.role.Mode

The resultin visual role's mode of operation.

name :  string

The name of the visual role.

propType :  pentaho.visual.role.AbstractPropertyType

The visual role's property type.

replaceTarget :  boolean

Indicates if the field will replace another existing field at fieldPosition

Members Details

fieldName:  string

The name of the field being added.

Source: doc-js/pentaho/visual/role/IAddUsage.jsdoc, line 35

fieldPosition:  number

The index at which the field's final position.

This index is relative to the visual role's original list of fields. So, if, for example, a field is moved, it does not account for the shift introduced by the removal from the old position.

Source: doc-js/pentaho/visual/role/IAddUsage.jsdoc, line 43

mode:  pentaho.visual.role.Mode

The resultin visual role's mode of operation.

Source: doc-js/pentaho/visual/role/IAddUsage.jsdoc, line 71

name:  string

The name of the visual role.

Source: doc-js/pentaho/visual/role/IAddUsage.jsdoc, line 27

propType:  pentaho.visual.role.AbstractPropertyType

The visual role's property type.

Source: doc-js/pentaho/visual/role/IAddUsage.jsdoc, line 63

replaceTarget:  boolean

Indicates if the field will replace another existing field at fieldPosition

Source: doc-js/pentaho/visual/role/IAddUsage.jsdoc, line 55