@univerjs/data-validation v0.1.17 • Docs
Class: DataValidationManager<T>
Extends
Type Parameters
Type Parameter |
---|
T extends IDataValidationRule |
Constructors
new DataValidationManager()
new DataValidationManager<T>(
unitId,
subUnitId,
dataValidations): DataValidationManager<T>
Parameters
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
dataValidations | undefined | T [] |
Returns
Overrides
Defined in
data-validation/src/models/data-validation-manager.ts:33 (opens in a new tab)
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | Disposable ._disposed | core/src/shared/lifecycle.ts:93 (opens in a new tab) |
dataValidations$ | readonly | Observable <T []> | undefined | - | data-validation/src/models/data-validation-manager.ts:31 (opens in a new tab) |
subUnitId | readonly | string | undefined | - | data-validation/src/models/data-validation-manager.ts:30 (opens in a new tab) |
unitId | readonly | string | undefined | - | data-validation/src/models/data-validation-manager.ts:29 (opens in a new tab) |
Methods
addRule()
addRule(rule, index?): void
Parameters
Parameter | Type |
---|---|
rule | T | 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
Defined in
core/src/shared/lifecycle.ts:106 (opens in a new tab)
disposeWithMe()
protected disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
IDisposable
Inherited from
Defined in
core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
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
Parameter | Type |
---|---|
id | string |
Returns
undefined
| T
Defined in
data-validation/src/models/data-validation-manager.ts:62 (opens in a new tab)
getRuleIndex()
getRuleIndex(id): number
Parameters
Parameter | Type |
---|---|
id | string |
Returns
number
Defined in
data-validation/src/models/data-validation-manager.ts:66 (opens in a new tab)
removeRule()
removeRule(ruleId): void
Parameters
Parameter | Type |
---|---|
ruleId | string |
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
Parameter | Type |
---|---|
ruleId | string |
payload | IUpdateRulePayload |
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
Parameter | Type |
---|---|
_content | Nullable <CellValue > |
_rule | IDataValidationRule |
_pos | any |
_onComplete | (status , changed ) => void |
Returns
Defined in
data-validation/src/models/data-validation-manager.ts:138 (opens in a new tab)