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

Class: CheckboxValidator

Extends

BaseDataValidator

Constructors

new CheckboxValidator()

new CheckboxValidator(localeService, injector): CheckboxValidator

Parameters

Parameter	Type
`localeService`	`LocaleService`
`injector`	`Injector`

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
`canvasRender`	`public`	`Nullable`<`IBaseDataValidationWidget`>	`null`	-	`BaseDataValidator`.`canvasRender`	data-validation/src/validators/base-data-validator.ts:69 (opens in a new tab)
`dropdown`	`public`	`undefined` \| `string`	`undefined`	-	`BaseDataValidator`.`dropdown`	data-validation/src/validators/base-data-validator.ts:70 (opens in a new tab)
`formulaInput`	`public`	`undefined` \| `string`	`undefined`	-	`BaseDataValidator`.`formulaInput`	data-validation/src/validators/base-data-validator.ts:68 (opens in a new tab)
`id`	`public`	`string`	`DataValidationType.CHECKBOX`	`BaseDataValidator`.`id`	-	sheets-data-validation/src/validators/checkbox-validator.ts:52 (opens in a new tab)
`injector`	`readonly`	`Injector`	`undefined`	-	`BaseDataValidator`.`injector`	data-validation/src/validators/base-data-validator.ts:77 (opens in a new tab)
`localeService`	`readonly`	`LocaleService`	`undefined`	-	`BaseDataValidator`.`localeService`	data-validation/src/validators/base-data-validator.ts:76 (opens in a new tab)
`operators`	`public`	`DataValidationOperator`[]	`[]`	`BaseDataValidator`.`operators`	-	sheets-data-validation/src/validators/checkbox-validator.ts:54 (opens in a new tab)
`optionsInput`	`public`	`undefined` \| `string`	`undefined`	-	`BaseDataValidator`.`optionsInput`	data-validation/src/validators/base-data-validator.ts:71 (opens in a new tab)
`scopes`	`public`	`string` \| `string`[]	`undefined`	`BaseDataValidator`.`scopes`	-	sheets-data-validation/src/validators/checkbox-validator.ts:55 (opens in a new tab)
`title`	`public`	`string`	`'dataValidation.checkbox.title'`	`BaseDataValidator`.`title`	-	sheets-data-validation/src/validators/checkbox-validator.ts:53 (opens in a new tab)

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(rule): string

Parameters

Parameter	Type
`rule`	`IDataValidationRuleBase`

Returns

string

Overrides

BaseDataValidator.generateRuleErrorMessage

Defined in

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

generateRuleName()

generateRuleName(rule): string

Parameters

Parameter	Type
`rule`	`IDataValidationRuleBase`

Returns

string

Inherited from

BaseDataValidator.generateRuleName

Defined in

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

getExtraStyle()

getExtraStyle(rule, value): {
  tb: WrapStrategy.CLIP;
}

Parameters

Parameter	Type
`rule`	`IDataValidationRule`
`value`	`Nullable`<`CellValue`>

Returns

{
  tb: WrapStrategy.CLIP;
}

Name	Type	Default value	Defined in
`tb`	`WrapStrategy`	WrapStrategy.CLIP	sheets-data-validation/src/validators/checkbox-validator.ts:111 (opens in a new tab)

Overrides

BaseDataValidator.getExtraStyle

Defined in

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

getRuleFinalError()

getRuleFinalError(rule): string

Parameters

Parameter	Type
`rule`	`IDataValidationRule`

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

Parameter	Type
`cellValue`	`Nullable`<`CellValue`>

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

Parameter	Type
`cellInfo`	`IValidatorCellInfo`<`CellValue`>
`formula`	`IFormulaResult`<`any`>
`rule`	`IDataValidationRule`

Returns

Promise<boolean>

Overrides

BaseDataValidator.isValidType

Defined in

sheets-data-validation/src/validators/checkbox-validator.ts:129 (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:134 (opens in a new tab)
`formula2`	`undefined` \| `string`	rule.formula2	data-validation/src/validators/base-data-validator.ts:135 (opens in a new tab)

Inherited from

BaseDataValidator.normalizeFormula

Defined in

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

parseFormula()

parseFormula(
   rule, 
   unitId, 
subUnitId): Promise<ICheckboxFormulaResult>

Parameters

Parameter	Type
`rule`	`IDataValidationRule`
`unitId`	`string`
`subUnitId`	`string`

Returns

Promise<ICheckboxFormulaResult>

Overrides

BaseDataValidator.parseFormula

Defined in

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

parseFormulaSync()

parseFormulaSync(
   rule, 
   unitId, 
   subUnitId): {
  formula1: Nullable<CellValue>;
  formula2: Nullable<CellValue>;
  originFormula1: Nullable<CellValue>;
  originFormula2: Nullable<CellValue>;
}

Parameters

Parameter	Type
`rule`	`IDataValidationRule`
`unitId`	`string`
`subUnitId`	`string`

Returns

{
  formula1: Nullable<CellValue>;
  formula2: Nullable<CellValue>;
  originFormula1: Nullable<CellValue>;
  originFormula2: Nullable<CellValue>;
}

Name	Type	Defined in
`formula1`	`Nullable`<`CellValue`>	sheets-data-validation/src/validators/checkbox-validator.ts:122 (opens in a new tab)
`formula2`	`Nullable`<`CellValue`>	sheets-data-validation/src/validators/checkbox-validator.ts:123 (opens in a new tab)
`originFormula1`	`Nullable`<`CellValue`>	sheets-data-validation/src/validators/checkbox-validator.ts:124 (opens in a new tab)
`originFormula2`	`Nullable`<`CellValue`>	sheets-data-validation/src/validators/checkbox-validator.ts:125 (opens in a new tab)

Defined in

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

skipDefaultFontRender()

skipDefaultFontRender(
   rule, 
   cellValue, 
   pos): boolean

Parameters

Parameter	Type
`rule`	`ISheetDataValidationRule`
`cellValue`	`Nullable`<`CellValue`>
`pos`	`object`
`pos.subUnitId`	`string`
`pos.unitId`	`string`

Returns

boolean

Overrides

BaseDataValidator.skipDefaultFontRender

Defined in

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

transform()

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

Parameters

Parameter	Type
`cellInfo`	`IValidatorCellInfo`<`Nullable`<`CellValue`>>
`formula`	`IFormulaResult`<`any`>
`rule`	`IDataValidationRule`

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

Parameter	Type
`cellInfo`	`IValidatorCellInfo`<`Nullable`<`CellValue`>>
`rule`	`IDataValidationRule`

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

Parameter	Type
`rule`	`IDataValidationRule`
`unitId`	`string`
`subUnitId`	`string`

Returns

IFormulaValidResult

Overrides

BaseDataValidator.validatorFormula

Defined in

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

validatorIsBetween()

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

Parameters

Parameter	Type
`cellInfo`	`IValidatorCellInfo`<`CellValue`>
`formula`	`IFormulaResult`<`any`>
`rule`	`IDataValidationRule`

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

Parameter	Type
`cellInfo`	`IValidatorCellInfo`<`CellValue`>
`formula`	`IFormulaResult`<`any`>
`rule`	`IDataValidationRule`

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

Parameter	Type
`cellInfo`	`IValidatorCellInfo`<`CellValue`>
`formula`	`IFormulaResult`<`any`>
`rule`	`IDataValidationRule`

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

Parameter	Type
`cellInfo`	`IValidatorCellInfo`<`CellValue`>
`formula`	`IFormulaResult`<`any`>
`rule`	`IDataValidationRule`

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

Parameter	Type
`cellInfo`	`IValidatorCellInfo`<`CellValue`>
`formula`	`IFormulaResult`<`any`>
`rule`	`IDataValidationRule`

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

Parameter	Type
`cellInfo`	`IValidatorCellInfo`<`CellValue`>
`formula`	`IFormulaResult`<`any`>
`rule`	`IDataValidationRule`

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

Parameter	Type
`cellInfo`	`IValidatorCellInfo`<`CellValue`>
`formula`	`IFormulaResult`<`any`>
`rule`	`IDataValidationRule`

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

Parameter	Type
`cellInfo`	`IValidatorCellInfo`<`CellValue`>
`formula`	`IFormulaResult`<`any`>
`rule`	`IDataValidationRule`

Returns

Promise<boolean>

Inherited from

BaseDataValidator.validatorIsNotEqual

Defined in

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

Readme Datavalidationcacheservice