CellValidationApi

Provides run-time access to the Cell Validation function

TypeScript
export interface CellValidationApi

Methods

| | | |

Method Details

addCellValidation

Adds a Cell Validation Rule to State

TypeScript
addCellValidation(cellValidationRule: CellValidationRule): void;
Deprecated

Use AlertApi and alerts with PreventEdit=true

Parameters
ParameterTypeDescription
cellValidationRuleCellValidationRuleCell Validation Rule to add
Returns

void

deleteCellValidation

Removes a Cell Validation Rule from State

TypeScript
deleteCellValidation(cellValidationRule: CellValidationRule): void;
Deprecated

Use AlertApi and alerts with PreventEdit=true

Parameters
ParameterTypeDescription
cellValidationRuleCellValidationRuleCell Validation Rule to delete
Returns

void

getAllCellValidation

Retrieves Cell Validation Rules from State

TypeScript
getAllCellValidation(): CellValidationRule[];
Deprecated

Use AlertApi and alerts with PreventEdit=true

Returns

CellValidationRule[]

getCellValidationPredicateDefs

Retrieves all Predicate Defs available for Cell Validation Function

TypeScript
getCellValidationPredicateDefs(): AdaptablePredicateDef[];
Deprecated

Use AlertApi and alerts with PreventEdit=true

Returns

AdaptablePredicateDef[]

getCellValidationPredicateDefsForScope

Retrieves all Cell Validation Predicate Defs which match given Scope

TypeScript
getCellValidationPredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
Deprecated

Use AlertApi and alerts with PreventEdit=true

Parameters
ParameterTypeDescription
scopeAdaptableScopeScope to check
Returns

AdaptablePredicateDef[]

getCellValidationState

Retrieves Cell Validation section from AdapTable State

TypeScript
getCellValidationState(): CellValidationState;
Deprecated

Use AlertApi and alerts with PreventEdit=true

Returns

CellValidationState

showCellValidationPopup

Opens Cell Validation popup screen

TypeScript
showCellValidationPopup(): void;
Deprecated

Use AlertApi and alerts with PreventEdit=true

Returns

void