ValidationRuleConfiguration

Description

A ValidationRuleConfiguration is an interface that offers the possibility to set options for a ValidationRule.

Properties

Property

Type

Description

key

string

References the corresponding ValidationRuleDefinition from the DataGridOptions.validationRules.

options?

ValidationRuleOptionsCollection

A list of key/value elements to pass to the ValidationRuleDefinition.validate function.

Example

Used as keys to identify the id of ValidationRuleDefinition with the ColumnDefinition.validationRules property.

const columnDefinition = {

  id: "currency",

  validationRules: [{ key: "range", options: { min: 0, max: 10, errorMessage: "Error here" } }]

 };

The “range” value is one of the available default ValidationRule. The options redefine the default values of the “range” ValidationRule: min, max and errorMessage.