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

@univerjs/data-validation v0.1.17Docs


Class: DataValidationModel<T>

Extends

Type Parameters

Type ParameterDefault type
T extends IDataValidationRuleIDataValidationRule

Constructors

new DataValidationModel()

new DataValidationModel<T>(_logService): DataValidationModel<T>

Parameters

ParameterType
_logServiceILogService

Returns

DataValidationModel<T>

Overrides

Disposable.constructor

Defined in

data-validation/src/models/data-validation-model.ts:49 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedcore/src/shared/lifecycle.ts:93 (opens in a new tab)
ruleChange$publicObservable<IRuleChange<T>>undefined-data-validation/src/models/data-validation-model.ts:45 (opens in a new tab)
ruleChangeDebounce$publicObservable<IRuleChange<T>>undefined-data-validation/src/models/data-validation-model.ts:46 (opens in a new tab)
validStatusChange$publicObservable<IValidStatusChange>undefined-data-validation/src/models/data-validation-model.ts:47 (opens in a new tab)

Methods

addRule()

addRule(
   unitId, 
   subUnitId, 
   rule, 
   index?): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
ruleT | T[]
index?number

Returns

void

Defined in

data-validation/src/models/data-validation-model.ts:95 (opens in a new tab)


deleteUnitRules()

deleteUnitRules(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Defined in

data-validation/src/models/data-validation-model.ts:187 (opens in a new tab)


dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

core/src/shared/lifecycle.ts:106 (opens in a new tab)


disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

core/src/shared/lifecycle.ts:96 (opens in a new tab)


ensureManager()

ensureManager(unitId, subUnitId): DataValidationManager<T>

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

DataValidationManager<T>

Defined in

data-validation/src/models/data-validation-model.ts:66 (opens in a new tab)


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

core/src/shared/lifecycle.ts:100 (opens in a new tab)


getRuleById()

getRuleById(
   unitId, 
   subUnitId, 
   ruleId): undefined | T

Parameters

ParameterType
unitIdstring
subUnitIdstring
ruleIdstring

Returns

undefined | T

Defined in

data-validation/src/models/data-validation-model.ts:143 (opens in a new tab)


getRuleIndex()

getRuleIndex(
   unitId, 
   subUnitId, 
   ruleId): number

Parameters

ParameterType
unitIdstring
subUnitIdstring
ruleIdstring

Returns

number

Defined in

data-validation/src/models/data-validation-model.ts:148 (opens in a new tab)


getRules()

getRules(unitId, subUnitId): T[]

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

T[]

Defined in

data-validation/src/models/data-validation-model.ts:153 (opens in a new tab)


getSubUnitIds()

getSubUnitIds(unitId): string[]

Parameters

ParameterType
unitIdstring

Returns

string[]

Defined in

data-validation/src/models/data-validation-model.ts:191 (opens in a new tab)


getUnitRules()

getUnitRules(unitId): [string, IDataValidationRule[]][]

Parameters

ParameterType
unitIdstring

Returns

[string, IDataValidationRule[]][]

Defined in

data-validation/src/models/data-validation-model.ts:173 (opens in a new tab)


removeRule()

removeRule(
   unitId, 
   subUnitId, 
   ruleId): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
ruleIdstring

Returns

void

Defined in

data-validation/src/models/data-validation-model.ts:125 (opens in a new tab)


setManagerCreator()

setManagerCreator(creator): void

Parameters

ParameterType
creator(unitId, subUnitId) => DataValidationManager<T>

Returns

void

Defined in

data-validation/src/models/data-validation-model.ts:62 (opens in a new tab)


updateRule()

updateRule(
   unitId, 
   subUnitId, 
   ruleId, 
   payload): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
ruleIdstring
payloadIUpdateRulePayload

Returns

void

Defined in

data-validation/src/models/data-validation-model.ts:109 (opens in a new tab)


validator()

validator(
   content, 
   rule, 
   pos): DataValidationStatus

Parameters

ParameterType
contentNullable<CellValue>
ruleT
posany

Returns

DataValidationStatus

Defined in

data-validation/src/models/data-validation-model.ts:158 (opens in a new tab)


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