@univerjs/sheets-data-validation v0.5.0-beta.1 • Docs

Class: FDataValidationBuilder

Builder for data validation rules.

Set the data validation for cell A1 to require a value from B1:B10.
var rule = FUniver.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

Constructors

new FDataValidationBuilder()

new FDataValidationBuilder(rule?): FDataValidationBuilder

Parameters

Parameter	Type
`rule`?	`IDataValidationRule`

Returns

FDataValidationBuilder

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:33

Methods

build()

build(): FDataValidation

Builds an FDataValidation instance based on the _rule property of the current class

Returns

FDataValidation

A new instance of the FDataValidation class

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:46

copy()

copy(): FDataValidationBuilder

Creates a duplicate of the current DataValidationBuilder object

Returns

FDataValidationBuilder

A new instance of the DataValidationBuilder class

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:55

getAllowInvalid()

getAllowInvalid(): boolean

Determines whether invalid data is allowed

Returns

boolean

True if invalid data is allowed, False otherwise

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:67

getCriteriaType()

getCriteriaType(): DataValidationType

Gets the data validation type of the rule

Returns

DataValidationType

The data validation type

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:76

getCriteriaValues()

getCriteriaValues(): any[]

Gets the values used for criteria evaluation

Returns

any[]

An array containing the operator, formula1, and formula2 values

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:85

getHelpText()

getHelpText(): undefined | string

Gets the help text information, which is used to provide users with guidance and support

Returns

undefined | string

Returns the help text information. If there is no error message, it returns an undefined value.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:94

requireCheckbox()

requireCheckbox(checkedValue?, uncheckedValue?): FDataValidationBuilder

Sets the data validation type to CHECKBOX and sets the checked and unchecked values

Parameters

Parameter	Type	Description
`checkedValue`?	`string`	The value when the checkbox is checked (Optional)
`uncheckedValue`?	`string`	The value when the checkbox is unchecked (Optional)

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:105

requireDateAfter()

requireDateAfter(date): FDataValidationBuilder

Set the data validation type to DATE and configure the validation rules to be after a specific date

Parameters

Parameter	Type	Description
`date`	`Date`	The date to compare against. The formatted date string will be set as formula1

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:119

requireDateBefore()

requireDateBefore(date): FDataValidationBuilder

Set the data validation type to DATE and configure the validation rules to be before a specific date

Parameters

Parameter	Type	Description
`date`	`Date`	The date to compare against. The formatted date string will be set as formula1

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:133

requireDateBetween()

requireDateBetween(start, end): FDataValidationBuilder

Set the data validation type to DATE and configure the validation rules to be within a specific date range

Parameters

Parameter	Type	Description
`start`	`Date`	The starting date of the range. The formatted date string will be set as formula1
`end`	`Date`	The ending date of the range. The formatted date string will be set as formula2

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:149

requireDateEqualTo()

requireDateEqualTo(date): FDataValidationBuilder

Set the data validation type to DATE and configure the validation rules to be equal to a specific date

Parameters

Parameter	Type	Description
`date`	`Date`	The date to compare against. The formatted date string will be set as formula1

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:164

requireDateNotBetween()

requireDateNotBetween(start, end): FDataValidationBuilder

Set the data validation type to DATE and configure the validation rules to be not within a specific date range

Parameters

Parameter	Type	Description
`start`	`Date`	The starting date of the date range
`end`	`Date`	The ending date of the date range

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:180

requireDateOnOrAfter()

requireDateOnOrAfter(date): FDataValidationBuilder

Set the data validation type to DATE and configure the validation rules to be on or after a specific date

Parameters

Parameter	Type	Description
`date`	`Date`	The date to compare against. The formatted date string will be set as formula1

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:195

requireDateOnOrBefore()

requireDateOnOrBefore(date): FDataValidationBuilder

Set the data validation type to DATE and configure the validation rules to be on or before a specific date

Parameters

Parameter	Type	Description
`date`	`Date`	The date to compare against. The formatted date string will be set as formula1

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:210

requireFormulaSatisfied()

requireFormulaSatisfied(formula): FDataValidationBuilder

Requires that a custom formula be satisfied. Sets the data validation type to CUSTOM and configures the validation rule based on the provided formula string.

Parameters

Parameter	Type	Description
`formula`	`string`	The formula string that needs to be satisfied.

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:226

requireNumberBetween()

requireNumberBetween(
   start, 
   end, 
   isInteger?): FDataValidationBuilder

Requires the user to enter a number within a specific range, which can be integer or decimal. Sets the data validation type based on the isInteger parameter and configures the validation rules for the specified number range.

Parameters

Parameter	Type	Description
`start`	`number`	The starting value of the number range.
`end`	`number`	The ending value of the number range.
`isInteger`?	`boolean`	Indicates whether the required number is an integer. Default is undefined, meaning it can be an integer or decimal.

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:242

requireNumberEqualTo()

requireNumberEqualTo(num, isInteger?): FDataValidationBuilder

Requires the user to enter a number that is equal to a specific value, which can be an integer or a decimal. Sets the data validation type based on the isInteger parameter and configures the validation rules for the specified number.

Parameters

Parameter	Type	Description
`num`	`number`	The number to which the entered number should be equal.
`isInteger`?	`boolean`	Indicates whether the required number is an integer. Default is undefined, meaning it can be an integer or a decimal.

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:259

requireNumberGreaterThan()

requireNumberGreaterThan(num, isInteger?): FDataValidationBuilder

Requires the user to enter a number that is greater than a specific value, which can be an integer or a decimal. Sets the data validation type based on the isInteger parameter and configures the validation rules for the specified number.

Parameters

Parameter	Type	Description
`num`	`number`	The number to which the entered number should be greater.
`isInteger`?	`boolean`	Indicates whether the required number is an integer. Default is undefined, meaning it can be an integer or a decimal.

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:275

requireNumberGreaterThanOrEqualTo()

requireNumberGreaterThanOrEqualTo(num, isInteger?): FDataValidationBuilder

Requires the user to enter a number that is greater than or equal to a specific value, which can be an integer or a decimal. Sets the data validation type based on the isInteger parameter and configures the validation rules for the specified number.

Parameters

Parameter	Type	Description
`num`	`number`	The number to which the entered number should be greater than or equal.
`isInteger`?	`boolean`	Indicates whether the required number is an integer. Default is undefined, meaning it can be an integer or a decimal.

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:291

requireNumberLessThan()

requireNumberLessThan(num, isInteger?): FDataValidationBuilder

Requires the user to enter a number that is less than a specific value, which can be an integer or a decimal. Sets the data validation type based on the isInteger parameter and configures the validation rules for the specified number.

Parameters

Parameter	Type	Description
`num`	`number`	The number to which the entered number should be less.
`isInteger`?	`boolean`	Indicates whether the required number is an integer. Default is undefined, meaning it can be an integer or a decimal.

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:307

requireNumberLessThanOrEqualTo()

requireNumberLessThanOrEqualTo(num, isInteger?): FDataValidationBuilder

Sets the data validation rule to require a number less than or equal to a specified value The specified value can be an integer or a decimal

Parameters

Parameter	Type	Description
`num`	`number`	The number to which the entered number should be less than or equal
`isInteger`?	`boolean`	Indicates whether the required number is an integer

Returns

FDataValidationBuilder

The current instance of the DataValidationBuilder class, allowing for method chaining

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:323

requireNumberNotBetween()

requireNumberNotBetween(
   start, 
   end, 
   isInteger?): FDataValidationBuilder

Sets a data validation rule that requires the user to enter a number outside a specified range The specified range includes all integers and decimals

Parameters

Parameter	Type	Description
`start`	`number`	The starting point of the specified range
`end`	`number`	The end point of the specified range
`isInteger`?	`boolean`	Optional parameter, indicating whether the number to be verified is an integer. Default value is false

Returns

FDataValidationBuilder

An instance of the FDataValidationBuilder class, allowing for method chaining

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:340

requireNumberNotEqualTo()

requireNumberNotEqualTo(num, isInteger?): FDataValidationBuilder

Creates a data validation rule that requires the user to enter a number that is not equal to a specific value The specific value can be an integer or a decimal

Parameters

Parameter	Type	Description
`num`	`number`	The number to which the entered number should not be equal
`isInteger`?	`boolean`	Indicates whether the required number is an integer. Default is undefined, meaning it can be an integer or a decimal

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:357

requireValueInList()

requireValueInList(
   values, 
   multiple?, 
   showDropdown?): FDataValidationBuilder

Sets a data validation rule that requires the user to enter a value from a list of specific values. The list can be displayed in a dropdown, and the user can choose multiple values according to the settings.

Parameters

Parameter	Type	Description
`values`	`string`[]	An array containing the specific values that the user can enter.
`multiple`?	`boolean`	Optional parameter indicating whether the user can select multiple values. Default is false, meaning only one value can be selected.
`showDropdown`?	`boolean`	Optional parameter indicating whether to display the list in a dropdown. Default is true, meaning the list will be displayed as a dropdown.

Returns

FDataValidationBuilder

An instance of the FDataValidationBuilder class, allowing for method chaining.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:374

requireValueInRange()

requireValueInRange(
   range, 
   multiple?, 
   showDropdown?): FDataValidationBuilder

Sets a data validation rule that requires the user to enter a value within a specific range. The range is defined by an FRange object, which contains the unit ID, sheet name, and cell range.

Parameters

Parameter	Type	Description
`range`	`FRange`	An FRange object representing the range of values that the user can enter.
`multiple`?	`boolean`	Optional parameter indicating whether the user can select multiple values. Default is false, meaning only one value can be selected.
`showDropdown`?	`boolean`	Optional parameter indicating whether to display the list in a dropdown. Default is true, meaning the list will be displayed as a dropdown.

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:392

setAllowInvalid()

setAllowInvalid(allowInvalidData): FDataValidationBuilder

Sets whether to allow invalid data and configures the error style for data validation. If invalid data is not allowed, the error style will be set to STOP, indicating that data entry must stop upon encountering an error. If invalid data is allowed, the error style will be set to WARNING, indicating that a warning will be displayed when invalid data is entered, but data entry can continue.

Parameters

Parameter	Type	Description
`allowInvalidData`	`boolean`	A boolean value indicating whether to allow invalid data.

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:413

setHelpText()

setHelpText(helpText): FDataValidationBuilder

Sets the help text and enables the display of error messages for data validation. This method allows you to set a custom help text that will be displayed when the user enters invalid data.

Parameters

Parameter	Type	Description
`helpText`	`string`	The text to display as help information.

Returns

FDataValidationBuilder

The current instance of the FDataValidationBuilder class to allow for method chaining.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:425

setOptions()

setOptions(options): this

Sets the options for the data validation rule. For details of options, please refer to https://univer.ai/typedoc/@univerjs/core/interfaces/IDataValidationRuleOptions

Parameters

Parameter	Type	Description
`options`	`Partial`<`IDataValidationRuleOptions`>	The options to set for the data validation rule.

Returns

this

The current instance of the FDataValidationBuilder class to allow for method chaining.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:456

withCriteriaValues()

withCriteriaValues(type, values): this

Sets the criteria values for data validation. This method is used to configure the validation rules based on specific criteria values.

Parameters

Parameter	Type	Description
`type`	`DataValidationType`	The type of data validation.
`values`	[`DataValidationOperator`, `string`, `string`]	An array containing the criteria values. The array should have three elements: [operator, formula1, formula2]. operator is a DataValidationOperator enum value, formula1 is the first formula, and formula2 is the second formula.

Returns

this

The current instance of the FDataValidationBuilder class, allowing for method chaining.

Defined in

sheets-data-validation/src/facade/f-data-validation-builder.ts:441

Fdatavalidation Readme