@univerjs/data-validation v0.1.17 • Docs
Class: DataValidationModel<T>
Extends
Type Parameters
Type Parameter | Default type |
---|---|
T extends IDataValidationRule | IDataValidationRule |
Constructors
new DataValidationModel()
new DataValidationModel<T>(_logService): DataValidationModel<T>
Parameters
Parameter | Type |
---|---|
_logService | ILogService |
Returns
Overrides
Defined in
data-validation/src/models/data-validation-model.ts:49 (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) |
ruleChange$ | public | Observable <IRuleChange <T >> | undefined | - | data-validation/src/models/data-validation-model.ts:45 (opens in a new tab) |
ruleChangeDebounce$ | public | Observable <IRuleChange <T >> | undefined | - | data-validation/src/models/data-validation-model.ts:46 (opens in a new tab) |
validStatusChange$ | public | Observable <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
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
rule | T | 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
Parameter | Type |
---|---|
unitId | string |
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
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)
ensureManager()
ensureManager(unitId, subUnitId): DataValidationManager<T>
Parameters
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
Returns
Defined in
data-validation/src/models/data-validation-model.ts:66 (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)
getRuleById()
getRuleById(
unitId,
subUnitId,
ruleId): undefined | T
Parameters
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
ruleId | string |
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
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
ruleId | string |
Returns
number
Defined in
data-validation/src/models/data-validation-model.ts:148 (opens in a new tab)
getRules()
getRules(unitId, subUnitId): T[]
Parameters
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
Returns
T
[]
Defined in
data-validation/src/models/data-validation-model.ts:153 (opens in a new tab)
getSubUnitIds()
getSubUnitIds(unitId): string[]
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
string
[]
Defined in
data-validation/src/models/data-validation-model.ts:191 (opens in a new tab)
getUnitRules()
getUnitRules(unitId): [string, IDataValidationRule[]][]
Parameters
Parameter | Type |
---|---|
unitId | string |
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
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
ruleId | string |
Returns
void
Defined in
data-validation/src/models/data-validation-model.ts:125 (opens in a new tab)
setManagerCreator()
setManagerCreator(creator): void
Parameters
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
ruleId | string |
payload | IUpdateRulePayload |
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
Parameter | Type |
---|---|
content | Nullable <CellValue > |
rule | T |
pos | any |
Returns
Defined in
data-validation/src/models/data-validation-model.ts:158 (opens in a new tab)