@univerjs/sheets-data-validation v0.5.1 • Docs
Interface: IFWorkbookDataValidationMixin
Methods
getValidatorStatus()
getValidatorStatus(this): Promise<Record<string, ObjectMatrix<Nullable<DataValidationStatus>>>>get data validation validator status for current workbook
Parameters
| Parameter | Type |
|---|---|
this | FWorkbook |
Returns
Promise<Record<string, ObjectMatrix<Nullable<DataValidationStatus>>>>
matrix of validator status
Defined in
sheets-data-validation/src/facade/f-workbook.ts:44
onBeforeAddDataValidation()
onBeforeAddDataValidation(this, callback): IDisposableThe onBeforeAddDataValidation event is fired before the data validation rule is added.
Parameters
| Parameter | Type | Description |
|---|---|---|
this | FWorkbook | - |
callback | (params, options) => false | void | Callback function that will be called when the event is fired |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
sheets-data-validation/src/facade/f-workbook.ts:69
onBeforeDeleteAllDataValidation()
onBeforeDeleteAllDataValidation(this, callback): IDisposableThe onBeforeDeleteAllDataValidation event is fired before delete all data validation rules.
Parameters
| Parameter | Type | Description |
|---|---|---|
this | FWorkbook | - |
callback | (params, options) => false | void | Callback function that will be called when the event is fired |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
sheets-data-validation/src/facade/f-workbook.ts:118
onBeforeDeleteDataValidation()
onBeforeDeleteDataValidation(this, callback): IDisposableThe onBeforeDeleteDataValidation event is fired before the data validation rule is deleted.
Parameters
| Parameter | Type | Description |
|---|---|---|
this | FWorkbook | - |
callback | (params, options) => false | void | Callback function that will be called when the event is fired |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
sheets-data-validation/src/facade/f-workbook.ts:108
onBeforeUpdateDataValidationCriteria()
onBeforeUpdateDataValidationCriteria(this, callback): IDisposableThe onBeforeUpdateDataValidationCriteria event is fired before the data validation rule is updated.
Parameters
| Parameter | Type | Description |
|---|---|---|
this | FWorkbook | - |
callback | (params, options) => false | void | Callback function that will be called when the event is fired |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
sheets-data-validation/src/facade/f-workbook.ts:79
onBeforeUpdateDataValidationOptions()
onBeforeUpdateDataValidationOptions(this, callback): IDisposableThe onBeforeUpdateDataValidationOptions event is fired before the data validation rule is updated.
Parameters
| Parameter | Type | Description |
|---|---|---|
this | FWorkbook | - |
callback | (params, options) => false | void | Callback function that will be called when the event is fired |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
sheets-data-validation/src/facade/f-workbook.ts:98
onBeforeUpdateDataValidationRange()
onBeforeUpdateDataValidationRange(this, callback): IDisposableThe onBeforeUpdateDataValidationRange event is fired before the data validation rule is updated.
Parameters
| Parameter | Type | Description |
|---|---|---|
this | FWorkbook | - |
callback | (params, options) => false | void | Callback function that will be called when the event is fired |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
sheets-data-validation/src/facade/f-workbook.ts:89
onDataValidationChange()
onDataValidationChange(callback): IDisposableThe onDataValidationChange event is fired when the data validation rule of this sheet is changed.
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | (ruleChange) => void | Callback function that will be called when the event is fired |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
sheets-data-validation/src/facade/f-workbook.ts:51
onDataValidationStatusChange()
onDataValidationStatusChange(callback): IDisposableThe onDataValidationStatusChange event is fired when the data validation status of this sheet is changed.
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | (statusChange) => void | Callback function that will be called when the event is fired |
Returns
A disposable object that can be used to unsubscribe from the event
Defined in
sheets-data-validation/src/facade/f-workbook.ts:60