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 Property.Type#fields property.

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

Extends

Name	Description
countMax : `undefined \| number \| pentaho.type.spec.PropertyDynamicAttribute.<<code>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.<<code>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.<<code>boolean>`	Gets or sets a value that indicates if at least one `field` must be mapped for the visual role to be valid.

Name	Description
countRangeOn(model) : `pentaho.IRange.<<code>number`>	Evaluates the field count range of a visual role property on a given model.

Members Details

countMax: `undefined \| number \| pentaho.type.spec.PropertyDynamicAttribute.<<code>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 `Property.Type#countMax`. Source: doc-js/pentaho/visual/role/IFieldsConstraints.jsdoc, line 60

countMax: undefined | number | pentaho.type.spec.PropertyDynamicAttribute.<<code>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 Property.Type#countMax.

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

countMin: `undefined \| number \| pentaho.type.spec.PropertyDynamicAttribute.<<code>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 `Property.Type#countMin`. Source: doc-js/pentaho/visual/role/IFieldsConstraints.jsdoc, line 48

countMin: undefined | number | pentaho.type.spec.PropertyDynamicAttribute.<<code>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 Property.Type#countMin.

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

isRequired: `undefined \| boolean \| pentaho.type.spec.PropertyDynamicAttribute.<<code>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 `Property.Type#isRequired`. Source: doc-js/pentaho/visual/role/IFieldsConstraints.jsdoc, line 36

isRequired: undefined | boolean | pentaho.type.spec.PropertyDynamicAttribute.<<code>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 Property.Type#isRequired.

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

Methods Details

countRangeOn(model) : pentaho.IRange.<<code>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.base.AbstractModel`		The model.

Returns:
Name	Description
`pentaho.IRange.<<code>number`>	The field count range.