API Reference
@univerjs
@univerjs/data-validation
classes
Basedatavalidator

@univerjs/data-validation v0.3.0Docs


Class: abstract BaseDataValidator<DataType>

Type Parameters

Type ParameterDefault type
DataTypeCellValue

Constructors

new BaseDataValidator()

new BaseDataValidator<DataType>(localeService, injector): BaseDataValidator<DataType>

Parameters

ParameterType
localeServiceLocaleService
injectorInjector

Returns

BaseDataValidator<DataType>

Defined in

data-validation/src/validators/base-data-validator.ts:77 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueDefined in
canvasRenderpublicNullable<IBaseDataValidationWidget>nulldata-validation/src/validators/base-data-validator.ts:71 (opens in a new tab)
dropdownpublicundefined | stringundefineddata-validation/src/validators/base-data-validator.ts:73 (opens in a new tab)
formulaInputabstractstringundefineddata-validation/src/validators/base-data-validator.ts:69 (opens in a new tab)
idabstractstringundefineddata-validation/src/validators/base-data-validator.ts:61 (opens in a new tab)
injectorreadonlyInjectorundefineddata-validation/src/validators/base-data-validator.ts:79 (opens in a new tab)
localeServicereadonlyLocaleServiceundefineddata-validation/src/validators/base-data-validator.ts:78 (opens in a new tab)
operatorsabstractDataValidationOperator[]undefineddata-validation/src/validators/base-data-validator.ts:65 (opens in a new tab)
optionsInputpublicundefined | stringundefineddata-validation/src/validators/base-data-validator.ts:75 (opens in a new tab)
scopesabstractstring | string[]undefineddata-validation/src/validators/base-data-validator.ts:67 (opens in a new tab)
skipDefaultFontRenderpublicundefined | (rule, cellValue, pos) => booleanundefineddata-validation/src/validators/base-data-validator.ts:92 (opens in a new tab)
titleabstractstringundefineddata-validation/src/validators/base-data-validator.ts:63 (opens in a new tab)

Accessors

operatorNames

get operatorNames(): string[]

Returns

string[]

Defined in

data-validation/src/validators/base-data-validator.ts:84 (opens in a new tab)


titleStr

get titleStr(): string

Returns

string

Defined in

data-validation/src/validators/base-data-validator.ts:88 (opens in a new tab)

Methods

generateRuleErrorMessage()

generateRuleErrorMessage(rule): string

Parameters

ParameterType
ruleIDataValidationRuleBase

Returns

string

Defined in

data-validation/src/validators/base-data-validator.ts:103 (opens in a new tab)


generateRuleName()

generateRuleName(rule): string

Parameters

ParameterType
ruleIDataValidationRuleBase

Returns

string

Defined in

data-validation/src/validators/base-data-validator.ts:94 (opens in a new tab)


getExtraStyle()

getExtraStyle(
   rule, 
   value, 
ctx): Nullable<IStyleData>

Parameters

ParameterType
ruleIDataValidationRuleBase
valueNullable<CellValue>
ctxobject
ctx.styleIStyleData

Returns

Nullable<IStyleData>

Defined in

data-validation/src/validators/base-data-validator.ts:112 (opens in a new tab)


getRuleFinalError()

getRuleFinalError(rule): string

Parameters

ParameterType
ruleIDataValidationRule

Returns

string

Defined in

data-validation/src/validators/base-data-validator.ts:114 (opens in a new tab)


isEmptyCellValue()

isEmptyCellValue(cellValue): cellValue is undefined | null | void

Parameters

ParameterType
cellValueNullable<CellValue>

Returns

cellValue is undefined | null | void

Defined in

data-validation/src/validators/base-data-validator.ts:122 (opens in a new tab)


isValidType()

isValidType(
   cellInfo, 
   formula, 
rule): Promise<boolean>

Parameters

ParameterType
cellInfoIValidatorCellInfo<Nullable<CellValue>>
formulaIFormulaResult<any>
ruleIDataValidationRule

Returns

Promise<boolean>

Defined in

data-validation/src/validators/base-data-validator.ts:141 (opens in a new tab)


normalizeFormula()

normalizeFormula(
   rule, 
   unitId, 
   subUnitId): {
  formula1: rule.formula1;
  formula2: rule.formula2;
}

Parameters

ParameterType
ruleIDataValidationRule
unitIdstring
subUnitIdstring

Returns

{
  formula1: rule.formula1;
  formula2: rule.formula2;
}
NameTypeDefault valueDefined in
formula1undefined | stringrule.formula1data-validation/src/validators/base-data-validator.ts:136 (opens in a new tab)
formula2undefined | stringrule.formula2data-validation/src/validators/base-data-validator.ts:137 (opens in a new tab)

Defined in

data-validation/src/validators/base-data-validator.ts:134 (opens in a new tab)


parseFormula()

abstract parseFormula(
   rule, 
   unitId, 
subUnitId): Promise<IFormulaResult<any>>

Parameters

ParameterType
ruleIDataValidationRule
unitIdstring
subUnitIdstring

Returns

Promise<IFormulaResult<any>>

Defined in

data-validation/src/validators/base-data-validator.ts:130 (opens in a new tab)


transform()

transform(
   cellInfo, 
   formula, 
rule): IValidatorCellInfo<DataType>

Parameters

ParameterType
cellInfoIValidatorCellInfo<Nullable<CellValue>>
formulaIFormulaResult<any>
ruleIDataValidationRule

Returns

IValidatorCellInfo<DataType>

Defined in

data-validation/src/validators/base-data-validator.ts:145 (opens in a new tab)


validator()

validator(cellInfo, rule): Promise<boolean>

Parameters

ParameterType
cellInfoIValidatorCellInfo<Nullable<CellValue>>
ruleIDataValidationRule

Returns

Promise<boolean>

Defined in

data-validation/src/validators/base-data-validator.ts:181 (opens in a new tab)


validatorFormula()

abstract validatorFormula(
   rule, 
   unitId, 
   subUnitId): IFormulaValidResult

Parameters

ParameterType
ruleIDataValidationRule
unitIdstring
subUnitIdstring

Returns

IFormulaValidResult

Defined in

data-validation/src/validators/base-data-validator.ts:132 (opens in a new tab)


validatorIsBetween()

validatorIsBetween(
   cellInfo, 
   formula, 
rule): Promise<boolean>

Parameters

ParameterType
cellInfoIValidatorCellInfo<DataType>
formulaIFormulaResult<any>
ruleIDataValidationRule

Returns

Promise<boolean>

Defined in

data-validation/src/validators/base-data-validator.ts:157 (opens in a new tab)


validatorIsEqual()

validatorIsEqual(
   cellInfo, 
   formula, 
rule): Promise<boolean>

Parameters

ParameterType
cellInfoIValidatorCellInfo<DataType>
formulaIFormulaResult<any>
ruleIDataValidationRule

Returns

Promise<boolean>

Defined in

data-validation/src/validators/base-data-validator.ts:149 (opens in a new tab)


validatorIsGreaterThan()

validatorIsGreaterThan(
   cellInfo, 
   formula, 
rule): Promise<boolean>

Parameters

ParameterType
cellInfoIValidatorCellInfo<DataType>
formulaIFormulaResult<any>
ruleIDataValidationRule

Returns

Promise<boolean>

Defined in

data-validation/src/validators/base-data-validator.ts:165 (opens in a new tab)


validatorIsGreaterThanOrEqual()

validatorIsGreaterThanOrEqual(
   cellInfo, 
   formula, 
rule): Promise<boolean>

Parameters

ParameterType
cellInfoIValidatorCellInfo<DataType>
formulaIFormulaResult<any>
ruleIDataValidationRule

Returns

Promise<boolean>

Defined in

data-validation/src/validators/base-data-validator.ts:169 (opens in a new tab)


validatorIsLessThan()

validatorIsLessThan(
   cellInfo, 
   formula, 
rule): Promise<boolean>

Parameters

ParameterType
cellInfoIValidatorCellInfo<DataType>
formulaIFormulaResult<any>
ruleIDataValidationRule

Returns

Promise<boolean>

Defined in

data-validation/src/validators/base-data-validator.ts:173 (opens in a new tab)


validatorIsLessThanOrEqual()

validatorIsLessThanOrEqual(
   cellInfo, 
   formula, 
rule): Promise<boolean>

Parameters

ParameterType
cellInfoIValidatorCellInfo<DataType>
formulaIFormulaResult<any>
ruleIDataValidationRule

Returns

Promise<boolean>

Defined in

data-validation/src/validators/base-data-validator.ts:177 (opens in a new tab)


validatorIsNotBetween()

validatorIsNotBetween(
   cellInfo, 
   formula, 
rule): Promise<boolean>

Parameters

ParameterType
cellInfoIValidatorCellInfo<DataType>
formulaIFormulaResult<any>
ruleIDataValidationRule

Returns

Promise<boolean>

Defined in

data-validation/src/validators/base-data-validator.ts:161 (opens in a new tab)


validatorIsNotEqual()

validatorIsNotEqual(
   cellInfo, 
   formula, 
rule): Promise<boolean>

Parameters

ParameterType
cellInfoIValidatorCellInfo<DataType>
formulaIFormulaResult<any>
ruleIDataValidationRule

Returns

Promise<boolean>

Defined in

data-validation/src/validators/base-data-validator.ts:153 (opens in a new tab)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.