@univerjs/sheets-data-validation v0.3.0 • Docs

Class: SheetDataValidationModel

Extends

Disposable

Constructors

new SheetDataValidationModel()

new SheetDataValidationModel(
   _dataValidationModel, 
   _univerInstanceService, 
   _dataValidatorRegistryService, 
   _dataValidationCacheService, 
   _dataValidationFormulaService, 
   _dataValidationCustomFormulaService, 
   _commandService): SheetDataValidationModel

Parameters

Parameter	Type
`_dataValidationModel`	`DataValidationModel`
`_univerInstanceService`	`IUniverInstanceService`
`_dataValidatorRegistryService`	`DataValidatorRegistryService`
`_dataValidationCacheService`	`DataValidationCacheService`
`_dataValidationFormulaService`	`DataValidationFormulaService`
`_dataValidationCustomFormulaService`	`DataValidationCustomFormulaService`
`_commandService`	`ICommandService`

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$`	`readonly`	`Observable`<`IRuleChange`>	`undefined`	-	sheets-data-validation/src/models/sheet-data-validation-model.ts:36 (opens in a new tab)
`validStatusChange$`	`readonly`	`Observable`<`IValidStatusChange`>	`undefined`	-	sheets-data-validation/src/models/sheet-data-validation-model.ts:37 (opens in a new tab)

Methods

deleteUnitRules()

deleteUnitRules(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Defined in

sheets-data-validation/src/models/sheet-data-validation-model.ts:285 (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

Parameter	Type
`disposable`	`DisposableLike`

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

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

getRuleById()

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

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`ruleId`	`string`

Returns

undefined | ISheetDataValidationRule

Defined in

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

getRuleByLocation()

getRuleByLocation(
   unitId, 
   subUnitId, 
   row, 
   col): undefined | ISheetDataValidationRule

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`row`	`number`
`col`	`number`

Returns

undefined | ISheetDataValidationRule

Defined in

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

getRuleErrorMsg()

getRuleErrorMsg(
   unitId, 
   subUnitId, 
   ruleId): string

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`ruleId`	`string`

Returns

string

Defined in

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

getRuleIdByLocation()

getRuleIdByLocation(
   unitId, 
   subUnitId, 
   row, 
   col): undefined | string

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`row`	`number`
`col`	`number`

Returns

undefined | string

Defined in

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

getRuleIndex()

getRuleIndex(
   unitId, 
   subUnitId, 
   ruleId): number

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`ruleId`	`string`

Returns

number

Defined in

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

getRuleObjectMatrix()

getRuleObjectMatrix(unitId, subUnitId): RuleMatrix

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`

Returns

RuleMatrix

Defined in

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

getRules()

getRules(unitId, subUnitId): ISheetDataValidationRule[]

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`

Returns

ISheetDataValidationRule[]

Defined in

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

getSubUnitIds()

getSubUnitIds(unitId): string[]

Parameters

Parameter	Type
`unitId`	`string`

Returns

string[]

Defined in

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

getUnitRules()

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

Parameters

Parameter	Type
`unitId`	`string`

Returns

[string, ISheetDataValidationRule[]][]

Defined in

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

getValidator()

getValidator(type): undefined | BaseDataValidator<CellValue>

Parameters

Parameter	Type
`type`	`DataValidationType`

Returns

undefined | BaseDataValidator<CellValue>

Defined in

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

validator()

validator(
   cell, 
   rule, 
   pos, 
   _onCompete?): DataValidationStatus

Parameters

Parameter	Type
`cell`	`Nullable`<`ICellDataForSheetInterceptor`>
`rule`	`ISheetDataValidationRule`
`pos`	`ISheetLocation`
`_onCompete`?	(`status`, `changed`) => `void`

Returns

DataValidationStatus

Defined in

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

Datavalidationmodel Sheetsdatavalidationvalidatorservice

Class: SheetDataValidationModel

Extends

Constructors

new SheetDataValidationModel()

Parameters

Returns

Overrides

Defined in

Properties

Methods

deleteUnitRules()

Parameters

Returns

Defined in

dispose()

Returns

Inherited from

Defined in

disposeWithMe()

Parameters

Returns

Inherited from

Defined in

ensureNotDisposed()

Returns

Inherited from

Defined in

getAll()

Returns

Defined in

getRuleById()

Parameters

Returns

Defined in

getRuleByLocation()

Parameters

Returns

Defined in

getRuleErrorMsg()

Parameters

Returns

Defined in

getRuleIdByLocation()

Parameters

Returns

Defined in

getRuleIndex()

Parameters

Returns

Defined in

getRuleObjectMatrix()

Parameters

Returns

Defined in

getRules()

Parameters

Returns

Defined in

getSubUnitIds()

Parameters

Returns

Defined in

getUnitRules()

Parameters

Returns

Defined in

getValidator()

Parameters

Returns

Defined in

validator()

Parameters

Returns

Defined in