@univerjs/sheets-data-validation v0.4.0 • Docs

Class: ListValidator

Extends

• BaseDataValidator

Extended by

• ListMultipleValidator

Constructors

new ListValidator()

new ListValidator(localeService, injector): ListValidator

Parameters

Returns

ListValidator

Inherited from

BaseDataValidator.constructor

Defined in

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

Properties

Accessors

operatorNames

get operatorNames(): string[]

Returns

string[]

Inherited from

BaseDataValidator.operatorNames

Defined in

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

titleStr

get titleStr(): string

Returns

string

Inherited from

BaseDataValidator.titleStr

Defined in

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

Methods

generateRuleErrorMessage()

generateRuleErrorMessage(): string

Returns

string

Overrides

BaseDataValidator.generateRuleErrorMessage

Defined in

sheets-data-validation/src/validators/list-validator.ts:166 (opens in a new tab)

generateRuleName()

generateRuleName(): string

Returns

string

Overrides

BaseDataValidator.generateRuleName

Defined in

sheets-data-validation/src/validators/list-validator.ts:162 (opens in a new tab)

getExtraStyle()

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

Parameters

Returns

Nullable<IStyleData>

Overrides

BaseDataValidator.getExtraStyle

Defined in

sheets-data-validation/src/validators/list-validator.ts:119 (opens in a new tab)

getList()

getList(
   rule, 
   currentUnitId?, 
   currentSubUnitId?): string[]

Parameters

Returns

string[]

Defined in

sheets-data-validation/src/validators/list-validator.ts:170 (opens in a new tab)

getListAsync()

getListAsync(
   rule, 
   currentUnitId?, 
currentSubUnitId?): Promise<string[]>

Parameters

Returns

Promise<string[]>

Defined in

sheets-data-validation/src/validators/list-validator.ts:185 (opens in a new tab)

getListWithColor()

getListWithColor(
   rule, 
   currentUnitId?, 
   currentSubUnitId?): {
  color: string;
  label: string;
 }[]

Parameters

Returns

{ color: string; label: string; }[]

Defined in

sheets-data-validation/src/validators/list-validator.ts:200 (opens in a new tab)

getListWithColorMap()

getListWithColorMap(
   rule, 
   currentUnitId?, 
currentSubUnitId?): Record<string, string>

Parameters

Returns

Record<string, string>

Defined in

sheets-data-validation/src/validators/list-validator.ts:207 (opens in a new tab)

getRuleFinalError()

getRuleFinalError(rule): string

Parameters

Returns

string

Inherited from

BaseDataValidator.getRuleFinalError

Defined in

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

isEmptyCellValue()

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

Parameters

Returns

cellValue is undefined | null | void

Inherited from

BaseDataValidator.isEmptyCellValue

Defined in

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

isValidType()

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

Parameters

Returns

Promise<boolean>

Overrides

BaseDataValidator.isValidType

Defined in

sheets-data-validation/src/validators/list-validator.ts:155 (opens in a new tab)

normalizeFormula()

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

Parameters

Returns

{
  formula1: rule.formula1;
  formula2: rule.formula2;
}

Inherited from

BaseDataValidator.normalizeFormula

Defined in

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

parseCellValue()

parseCellValue(cellValue): string[]

Parameters

Returns

string[]

Defined in

sheets-data-validation/src/validators/list-validator.ts:140 (opens in a new tab)

parseFormula()

parseFormula(
   rule, 
   unitId, 
subUnitId): Promise<IFormulaResult<undefined | string[]>>

Parameters

Returns

Promise<IFormulaResult<undefined | string[]>>

Overrides

BaseDataValidator.parseFormula

Defined in

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

skipDefaultFontRender()

skipDefaultFontRender(rule): boolean

Parameters

Returns

boolean

Overrides

BaseDataValidator.skipDefaultFontRender

Defined in

sheets-data-validation/src/validators/list-validator.ts:97 (opens in a new tab)

transform()

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

Parameters

Returns

IValidatorCellInfo<CellValue>

Inherited from

BaseDataValidator.transform

Defined in

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

validator()

validator(cellInfo, rule): Promise<boolean>

Parameters

Returns

Promise<boolean>

Inherited from

BaseDataValidator.validator

Defined in

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

validatorFormula()

validatorFormula(
   rule, 
   unitId, 
   subUnitId): IFormulaValidResult

Parameters

Returns

IFormulaValidResult

Overrides

BaseDataValidator.validatorFormula

Defined in

sheets-data-validation/src/validators/list-validator.ts:101 (opens in a new tab)

validatorIsBetween()

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

Parameters

Returns

Promise<boolean>

Inherited from

BaseDataValidator.validatorIsBetween

Defined in

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

validatorIsEqual()

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

Parameters

Returns

Promise<boolean>

Inherited from

BaseDataValidator.validatorIsEqual

Defined in

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

validatorIsGreaterThan()

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

Parameters

Returns

Promise<boolean>

Inherited from

BaseDataValidator.validatorIsGreaterThan

Defined in

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

validatorIsGreaterThanOrEqual()

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

Parameters

Returns

Promise<boolean>

Inherited from

BaseDataValidator.validatorIsGreaterThanOrEqual

Defined in

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

validatorIsLessThan()

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

Parameters

Returns

Promise<boolean>

Inherited from

BaseDataValidator.validatorIsLessThan

Defined in

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

validatorIsLessThanOrEqual()

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

Parameters

Returns

Promise<boolean>

Inherited from

BaseDataValidator.validatorIsLessThanOrEqual

Defined in

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

validatorIsNotBetween()

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

Parameters

Returns

Promise<boolean>

Inherited from

BaseDataValidator.validatorIsNotBetween

Defined in

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

validatorIsNotEqual()

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

Parameters

Returns

Promise<boolean>

Inherited from

BaseDataValidator.validatorIsNotEqual

Defined in

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