🎉 v0.1.17 is released. Read more →
API Reference
@univerjs
@univerjs/data-validation
classes
Basedatavalidator

@univerjs/data-validation v0.1.17 • Docs

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:73 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueDefined in
canvasRenderpublicNullable<IBaseDataValidationWidget>nulldata-validation/src/validators/base-data-validator.ts:67 (opens in a new tab)
dropdownpublicundefined | stringundefineddata-validation/src/validators/base-data-validator.ts:69 (opens in a new tab)
formulaInputabstractstringundefineddata-validation/src/validators/base-data-validator.ts:65 (opens in a new tab)
idabstractstringundefineddata-validation/src/validators/base-data-validator.ts:57 (opens in a new tab)
injectorreadonlyInjectorundefineddata-validation/src/validators/base-data-validator.ts:75 (opens in a new tab)
localeServicereadonlyLocaleServiceundefineddata-validation/src/validators/base-data-validator.ts:74 (opens in a new tab)
operatorsabstractDataValidationOperator[]undefineddata-validation/src/validators/base-data-validator.ts:61 (opens in a new tab)
optionsInputpublicundefined | stringundefineddata-validation/src/validators/base-data-validator.ts:71 (opens in a new tab)
scopesabstractstring | string[]undefineddata-validation/src/validators/base-data-validator.ts:63 (opens in a new tab)
titleabstractstringundefineddata-validation/src/validators/base-data-validator.ts:59 (opens in a new tab)

Accessors

operatorNames

get operatorNames(): string[]

Returns

string[]

Defined in

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

titleStr

get titleStr(): string

Returns

string

Defined in

data-validation/src/validators/base-data-validator.ts:84 (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:101 (opens in a new tab)

generateRuleName()

generateRuleName(rule): string

Parameters

ParameterType
ruleIDataValidationRuleBase

Returns

string

Defined in

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

getRuleFinalError()

getRuleFinalError(rule): string

Parameters

ParameterType
ruleIDataValidationRule

Returns

string

Defined in

data-validation/src/validators/base-data-validator.ts:110 (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:118 (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:130 (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:126 (opens in a new tab)

skipDefaultFontRender()

skipDefaultFontRender(
   rule, 
   cellValue, 
   pos): boolean

Parameters

ParameterType
ruleIDataValidationRule
cellValueNullable<CellValue>
posany

Returns

boolean

Defined in

data-validation/src/validators/base-data-validator.ts:88 (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:134 (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:170 (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:128 (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:146 (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:138 (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:154 (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:158 (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:162 (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:166 (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:150 (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:142 (opens in a new tab)

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