FUnvierDataValidationMixin

GitHubEdit on GitHub
packages@univerjs/sheets-data-validation

APIs

newDataValidation

Creates a new instance of FDataValidationBuilder

Deprecated use univerAPI.newDataValidation() as instead.

Signature

static newDataValidation(): FDataValidationBuilder

Returns

  • (FDataValidationBuilder) — A new instance of the FDataValidationBuilder class

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires a number between 1 and 10 fot the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireNumberBetween(1, 10)
  .setOptions({
    allowBlank: true,
    showErrorMessage: true,
    error: 'Please enter a number between 1 and 10',
  })
  .build()
fRange.setDataValidation(rule)

newDataValidation

Creates a new instance of FDataValidationBuilder

Signature

newDataValidation(): FDataValidationBuilder

Returns

  • (FDataValidationBuilder) — A new instance of the FDataValidationBuilder class

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires a number between 1 and 10 fot the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireNumberBetween(1, 10)
  .setOptions({
    allowBlank: true,
    showErrorMessage: true,
    error: 'Please enter a number between 1 and 10',
  })
  .build()
fRange.setDataValidation(rule)