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

@univerjs/data-validation v0.1.17Docs


Class: DataValidationManager<T>

Extends

Type Parameters

Type Parameter
T extends IDataValidationRule

Constructors

new DataValidationManager()

new DataValidationManager<T>(
   unitId, 
   subUnitId, 
dataValidations): DataValidationManager<T>

Parameters

ParameterType
unitIdstring
subUnitIdstring
dataValidationsundefined | T[]

Returns

DataValidationManager<T>

Overrides

Disposable.constructor

Defined in

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

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedcore/src/shared/lifecycle.ts:93 (opens in a new tab)
dataValidations$readonlyObservable<T[]>undefined-data-validation/src/models/data-validation-manager.ts:31 (opens in a new tab)
subUnitIdreadonlystringundefined-data-validation/src/models/data-validation-manager.ts:30 (opens in a new tab)
unitIdreadonlystringundefined-data-validation/src/models/data-validation-manager.ts:29 (opens in a new tab)

Methods

addRule()

addRule(rule, index?): void

Parameters

ParameterType
ruleT | T[]
index?number

Returns

void

Defined in

data-validation/src/models/data-validation-manager.ts:70 (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)


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

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


getDataValidations()

getDataValidations(): T[]

Returns

T[]

Defined in

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


getRuleById()

getRuleById(id): undefined | T

Parameters

ParameterType
idstring

Returns

undefined | T

Defined in

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


getRuleIndex()

getRuleIndex(id): number

Parameters

ParameterType
idstring

Returns

number

Defined in

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


removeRule()

removeRule(ruleId): void

Parameters

ParameterType
ruleIdstring

Returns

void

Defined in

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


toJSON()

toJSON(): T[]

Returns

T[]

Defined in

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


updateRule()

updateRule(ruleId, payload): T

Parameters

ParameterType
ruleIdstring
payloadIUpdateRulePayload

Returns

T

Defined in

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


validator()

validator(
   _content, 
   _rule, 
   _pos, 
   _onComplete): DataValidationStatus

Parameters

ParameterType
_contentNullable<CellValue>
_ruleIDataValidationRule
_posany
_onComplete(status, changed) => void

Returns

DataValidationStatus

Defined in

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


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