RuleBasedAlertDefinition
Alert that fires when data matches a rule in the given column scope
TypeScript
export interface RuleBasedAlertDefinition extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| AlertForm | string |AlertButtonForm | Form to display in Alert with buttons and inputs |
| AlertProperties | RuleAlertProperties | Properties which set what happens when the Alert is triggered (notification and grid behaviours) |
| Rule | AlertRule | When Alert should be triggered |
| Scope | ColumnScope | Where Alert can be triggered: one, some or all columns or DataTypes |
| IsReadOnly | boolean | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
| IsSuspended | boolean | Suspends (i.e. turns off) an Adaptable Object |
Property Details
AlertForm
Form to display in Alert with buttons and inputs
TypeScript
AlertForm?: string | AlertButtonForm;Property Value
string |AlertButtonForm
AlertProperties
Properties which set what happens when the Alert is triggered (notification and grid behaviours)
TypeScript
AlertProperties?: RuleAlertProperties;Property Value
Rule
When Alert should be triggered
TypeScript
Rule: AlertRule;Property Value
Scope
Where Alert can be triggered: one, some or all columns or DataTypes
TypeScript
Scope: ColumnScope;Property Value
IsSuspended
Inherited from SuspendableObject
Suspends (i.e. turns off) an Adaptable Object
TypeScript
IsSuspended?: boolean;Property Value
boolean
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
TypeScript
IsReadOnly?: boolean;Property Value
boolean