AlertProperties

Additional properties that specify how a particular Alert will ALWAYS behave

export interface

Properties

Property Details

DisplayNotification

Displays a notification when Alert is triggered

DisplayNotification?: boolean;

Property Value

boolean

HighlightCell

Colours updated Row using MessageType of triggering Alert Definition

HighlightCell?: boolean | AdaptableStyle;

Property Value

boolean |AdaptableStyle

HighlightRow

Colours updated Row using MessageType of triggering Alert Definition

HighlightRow?: boolean | AdaptableStyle;

Property Value

boolean |AdaptableStyle

JumpToCell

Grid will 'jump' to the changed cell which triggered the Alert

JumpToCell?: boolean;

Property Value

boolean

JumpToRow

Grid will 'jump' to the newly added row which triggered the Alert

JumpToRow?: boolean;

Property Value

boolean

LogToConsole

Logs the Alert message to the console

LogToConsole?: boolean;

Property Value

boolean

NotificationDuration

Notifiction duration(defaults to NotificationOptions.duration)

NotificationDuration?: NotificationsOptions['duration'];

Property Value

NotificationsOptions['duration']

PreventEdit

Automatically prevent any cell edit which triggered the Alert (i.e. validation)

PreventEdit?: boolean;

Default Value

false

Property Value

boolean

ShowInDiv

Shows Alert text in the div specificed in alertContainer property of Container Options

ShowInDiv?: boolean;

Property Value

boolean