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

IFieldsConstraints

pentaho.visual.role. IFieldsConstraints

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

This interface extends IFieldsMetadata and adds additional properties that allow specifying field count constraints.

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

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

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

Extends

Members

Name Description
countMax : undefined | number | pentaho.type.spec.PropertyDynamicAttribute.<number>

Gets or sets the maximum number of fields that can be mapped for the visual role to be valid.

countMin : undefined | number | pentaho.type.spec.PropertyDynamicAttribute.<number>

Gets or sets the minimum number of fields that must be mapped for the visual role to be valid.

isRequired : undefined | boolean | pentaho.type.spec.PropertyDynamicAttribute.<boolean>

Gets or sets a value that indicates if at least one field must be mapped for the visual role to be valid.

Methods

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

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

Members Details

countMax: undefined | number | pentaho.type.spec.PropertyDynamicAttribute.<number>

Gets or sets the maximum number of fields that can be mapped for the visual role to be valid.

For more information on this property see PropertyType#countMax.

The function's keyArgs argument is given the keyword argument ignoreCurrentMode that, when true, indicates if the current mode, if any, should be ignored when evaluating.

Source: doc-js/pentaho/visual/role/IFieldsConstraints.jsdoc, line 68

countMin: undefined | number | pentaho.type.spec.PropertyDynamicAttribute.<number>

Gets or sets the minimum number of fields that must be mapped for the visual role to be valid.

For more information on this property see PropertyType#countMin.

The function's keyArgs argument is given the keyword argument ignoreCurrentMode that, when true, indicates if the current mode, if any, should be ignored when evaluating.

Source: doc-js/pentaho/visual/role/IFieldsConstraints.jsdoc, line 52

isRequired: undefined | boolean | pentaho.type.spec.PropertyDynamicAttribute.<boolean>

Gets or sets a value that indicates if at least one field must be mapped for the visual role to be valid.

For more information on this property see PropertyType#isRequired.

The function's keyArgs argument is given the keyword argument ignoreCurrentMode that, when true, indicates if the current mode, if any, should be ignored when evaluating.

Source: doc-js/pentaho/visual/role/IFieldsConstraints.jsdoc, line 36

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

Inherited From: pentaho.visual.role.IFieldsMetadata#countRangeOn

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