@univerjs/data-validation v0.3.0 • Docs
Class: abstract
BaseDataValidator<DataType>
Type Parameters
Type Parameter | Default type |
---|---|
DataType | CellValue |
Constructors
new BaseDataValidator()
new BaseDataValidator<DataType>(localeService, injector): BaseDataValidator<DataType>
Parameters
Parameter | Type |
---|---|
localeService | LocaleService |
injector | Injector |
Returns
BaseDataValidator
<DataType
>
Defined in
data-validation/src/validators/base-data-validator.ts:77 (opens in a new tab)
Properties
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
Parameter | Type |
---|---|
rule | IDataValidationRuleBase |
Returns
string
Defined in
data-validation/src/validators/base-data-validator.ts:103 (opens in a new tab)
generateRuleName()
generateRuleName(rule): string
Parameters
Parameter | Type |
---|---|
rule | IDataValidationRuleBase |
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
Parameter | Type |
---|---|
rule | IDataValidationRuleBase |
value | Nullable <CellValue > |
ctx | object |
ctx.style | IStyleData |
Returns
Defined in
data-validation/src/validators/base-data-validator.ts:112 (opens in a new tab)
getRuleFinalError()
getRuleFinalError(rule): string
Parameters
Parameter | Type |
---|---|
rule | IDataValidationRule |
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
Parameter | Type |
---|---|
cellValue | Nullable <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
Parameter | Type |
---|---|
cellInfo | IValidatorCellInfo <Nullable <CellValue >> |
formula | IFormulaResult <any > |
rule | IDataValidationRule |
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
Parameter | Type |
---|---|
rule | IDataValidationRule |
unitId | string |
subUnitId | string |
Returns
{
formula1: rule.formula1;
formula2: rule.formula2;
}
Name | Type | Default value | Defined in |
---|---|---|---|
formula1 | undefined | string | rule.formula1 | data-validation/src/validators/base-data-validator.ts:136 (opens in a new tab) |
formula2 | undefined | string | rule.formula2 | data-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
Parameter | Type |
---|---|
rule | IDataValidationRule |
unitId | string |
subUnitId | string |
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
Parameter | Type |
---|---|
cellInfo | IValidatorCellInfo <Nullable <CellValue >> |
formula | IFormulaResult <any > |
rule | IDataValidationRule |
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
Parameter | Type |
---|---|
cellInfo | IValidatorCellInfo <Nullable <CellValue >> |
rule | IDataValidationRule |
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
Parameter | Type |
---|---|
rule | IDataValidationRule |
unitId | string |
subUnitId | string |
Returns
Defined in
data-validation/src/validators/base-data-validator.ts:132 (opens in a new tab)
validatorIsBetween()
validatorIsBetween(
cellInfo,
formula,
rule): Promise<boolean>
Parameters
Parameter | Type |
---|---|
cellInfo | IValidatorCellInfo <DataType > |
formula | IFormulaResult <any > |
rule | IDataValidationRule |
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
Parameter | Type |
---|---|
cellInfo | IValidatorCellInfo <DataType > |
formula | IFormulaResult <any > |
rule | IDataValidationRule |
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
Parameter | Type |
---|---|
cellInfo | IValidatorCellInfo <DataType > |
formula | IFormulaResult <any > |
rule | IDataValidationRule |
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
Parameter | Type |
---|---|
cellInfo | IValidatorCellInfo <DataType > |
formula | IFormulaResult <any > |
rule | IDataValidationRule |
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
Parameter | Type |
---|---|
cellInfo | IValidatorCellInfo <DataType > |
formula | IFormulaResult <any > |
rule | IDataValidationRule |
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
Parameter | Type |
---|---|
cellInfo | IValidatorCellInfo <DataType > |
formula | IFormulaResult <any > |
rule | IDataValidationRule |
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
Parameter | Type |
---|---|
cellInfo | IValidatorCellInfo <DataType > |
formula | IFormulaResult <any > |
rule | IDataValidationRule |
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
Parameter | Type |
---|---|
cellInfo | IValidatorCellInfo <DataType > |
formula | IFormulaResult <any > |
rule | IDataValidationRule |
Returns
Promise
<boolean
>
Defined in
data-validation/src/validators/base-data-validator.ts:153 (opens in a new tab)