NotificationsOptions

Options related to System Status Messages and Notifications in Adaptable.

export interface

Properties

Property Details

closeWhenClicked

Closes Notification automatically when its clicked

closeWhenClicked?: boolean;

Default Value

false

Property Value

boolean

duration

How long (in ms) Notifications display for

duration?: number | 'always';

Default Value

3000

Property Value

number | 'always'

isDraggable

Can Notification be dragged

isDraggable?: boolean;

Default Value

false

Property Value

boolean

maxNotifications

How many Notifications can be displayed at one time

maxNotifications?: number;

Default Value

3

Property Value

number

maxSystemMessagesInStore

How many System Status Messages to hold in State; when limit is reached, oldest Message is removed

maxSystemMessagesInStore?: number;

Default Value

100

Property Value

number

pauseWhenHovering

Pauses the Notification when mouse hovers over it

pauseWhenHovering?: boolean;

Default Value

false

Property Value

boolean

position

Where Notification will appear (if anywhere)

position?: ToastPositions;

Default Value

'BottomRight'

Property Value

ToastPositions

showApplicationIcon

Displays the application icon in Notifications

showApplicationIcon?: boolean;

Default Value

false

Property Value

boolean

showProgressBar

Shows a Progress Bar in the Notification

showProgressBar?: boolean;

Default Value

false

Property Value

boolean

showSystemStatusMessageNotifications

Display System Status Messages as Notifications

showSystemStatusMessageNotifications?: boolean;

Default Value

false

Property Value

boolean

transition

How Notification will appear: Bounce, Slide, Zoom or Flip

transition?: 'Bounce' | 'Slide' | 'Zoom' | 'Flip';

Default Value

'Slide'

Property Value

'Bounce' | 'Slide' | 'Zoom' | 'Flip'