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

@univerjs/sheets-data-validation v0.2.14Docs


Class: DataValidationModel

Extends

Constructors

new DataValidationModel()

new DataValidationModel(_logService): DataValidationModel

Parameters

ParameterType
_logServiceILogService

Returns

DataValidationModel

Overrides

Disposable.constructor

Defined in

data-validation/src/models/data-validation-model.ts:55 (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>undefined-data-validation/src/models/data-validation-model.ts:52 (opens in a new tab)
ruleChangeDebounce$publicObservable<IRuleChange>undefined-data-validation/src/models/data-validation-model.ts:53 (opens in a new tab)

Methods

addRule()

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

Parameters

ParameterType
unitIdstring
subUnitIdstring
ruleIDataValidationRule | IDataValidationRule[]
sourceDataValidationChangeSource
index?number

Returns

void

Defined in

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


deleteUnitRules()

deleteUnitRules(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Defined in

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


getAll()

getAll(): readonly [string, [string, IDataValidationRule[]][]][]

Returns

readonly [string, [string, IDataValidationRule[]][]][]

Defined in

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


getRuleById()

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

Parameters

ParameterType
unitIdstring
subUnitIdstring
ruleIdstring

Returns

undefined | IDataValidationRule

Defined in

data-validation/src/models/data-validation-model.ts:212 (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:217 (opens in a new tab)


getRules()

getRules(unitId, subUnitId): IDataValidationRule[]

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

IDataValidationRule[]

Defined in

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


getSubUnitIds()

getSubUnitIds(unitId): string[]

Parameters

ParameterType
unitIdstring

Returns

string[]

Defined in

data-validation/src/models/data-validation-model.ts:245 (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:227 (opens in a new tab)


removeRule()

removeRule(
   unitId, 
   subUnitId, 
   ruleId, 
   source): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
ruleIdstring
sourceDataValidationChangeSource

Returns

void

Defined in

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


updateRule()

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

Parameters

ParameterType
unitIdstring
subUnitIdstring
ruleIdstring
payloadIUpdateRulePayload
sourceDataValidationChangeSource

Returns

void

Defined in

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


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