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

IFieldsMetadata

pentaho.visual.role. IFieldsMetadata

The IFieldsMetadata interface exposes metadata information about the fields of visual roles' mappings.

Objects of this interface are part of visual role properties and are exposed in the AbstractPropertyType#fields property.

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

See also: pentaho.visual.role.AbstractMapping#fields

Methods

Name Description
countRangeOn(model, keyArgs) : pentaho.IRange.<number>

Evaluates the field count range of a visual role property on a given model.

Methods Details

countRangeOn(model, keyArgs) : pentaho.IRange.<number>

Evaluates the field count range of a visual role property on a given model.

The count range constraints the valid number of elements of the fields property of mappings of the associated visual role.

Source: doc-js/pentaho/visual/role/IFieldsMetadata.jsdoc, line 31

Parameters:
Name Default Value Summary
model : pentaho.visual.AbstractModel

The model.

keyArgs : object
Optional

The keyword arguments object.

Parameters:
Name Default Value Summary
ignoreCurrentMode : boolean
Optional
false

Indicates that the current mode, if any, should be ignored when determining the count range. When false and there is a current mode, the count range is that of the current mode.

Returns:
Name Description
pentaho.IRange.<number>

The field count range.

See also: pentaho.type.PropertyType#countRangeOn