EventApi
Responsible for publishing the many Events that AdapTable fires
TypeScript
export interfaceMethods
| Method | Description |
|---|---|
| destroy() | |
| emit(eventName, data) | |
| emitSync(eventName, data) | |
| emitSync(eventName, data) | |
| emitSync(eventName) | |
| off(eventName, callback) | Unsubscribe from GridSorted |
| off(eventName, callback) | Unsubscribe from ThemeChanged |
| off(eventName, callback) | Unsubscribe from SystemStatusMessageDisplayed |
| off(eventName, callback) | Unsubscribe from AlertFired |
| off(eventName, callback) | Unsubscribe from DataImported |
| off(eventName, callback) | Unsubscribe from FlashingCellDisplayed |
| off(eventName, callback) | Unsubscribe from LayoutChanged |
| off(eventName, callback) | Unsubscribe from CalculatedColumnChanged |
| off(eventName, callback) | Unsubscribe from CustomToolbarConfigured |
| off(eventName, callback) | Unsubscribe from DashboardChanged |
| off(eventName, callback) | Unsubscribe from AdaptableStateChanged |
| off(eventName, callback) | Unsubscribe from GridFilterApplied |
| off(eventName, callback) | Unsubscribe from AdaptableStateReloaded |
| off(eventName, callback) | Unsubscribe from LiveDataChanged |
| off(eventName, callback) | Unsubscribe from RowFormSubmitted |
| off(eventName, callback) | Unsubscribe from DataSetSelected |
| off(eventName, callback) | Unsubscribe from ChartChanged |
| off(eventName, callback) | Unsubscribe from CommentChanged |
| off(eventName, callback) | Unsubscribe from AdaptableReady |
| off(eventName, callback) | Unsubscribe from Fdc3Message |
| off(eventName, callback) | Unsubscribe from ScheduleTriggered |
| off(eventName, callback) | Unsubscribe from ColumnFilterApplied |
| off(eventName, callback) | Unsubscribe from CellChanged |
| off(eventName, callback) | Unsubscribe from RowChanged |
| off(eventName, callback) | Unsubscribe from TeamSharingEntityChanged |
| off(eventName, callback) | Unsubscribe from CellSelectionChanged |
| off(eventName, callback) | Unsubscribe from RowSelectionChanged |
| on(eventName, callback) | Event fired whenever AdapTable is Sorted |
| on(eventName, callback) | Event fired whenever the selected theme of AdapTable is changed |
| on(eventName, callback) | Event fired whenever a System Status Message is displayed in AdapTable |
| on(eventName, callback) | Event fired whenever an Alert is triggered in AdapTable. |
| on(eventName, callback) | Event fired when Data has been imported |
| on(eventName, callback) | Event fired whenever Cell Flashing is triggered in AdapTable. |
| on(eventName, callback) | Event fired whenever the current Layout updates in AdapTable |
| on(eventName, callback) | Event fired whenever a Calculated Columns is created / updated / deleted in AdapTable |
| on(eventName, callback) | Event fired whenever Configure Button is clicked in a Custom Toolbar |
| on(eventName, callback) | Event fired whenever Dashboard State changes Primarily used for rendering Custom toolbars. |
| on(eventName, callback) | Event fired whenever Adaptable State changes |
| on(eventName, callback) | |
| on(eventName, callback) | Event fired whenever Adaptable State is reloaded |
| on(eventName, callback) | Event fired whenever a change occurs relating to live reports / data Used in conjunction with AdapTable's partners OpenFin or ipushpull |
| on(eventName, callback) | Event fired when a Row Form is submitted |
| on(eventName, callback) | Event fired when a DataSet is Selected |
| on(eventName, callback) | Event fired when a Chart is Changed |
| on(eventName, callback) | Event fired when a Comment is Changed |
| on(eventName, callback) | Fired when Adaptable is up and running - has no arguments. |
| on(eventName, callback) | Fired when Adaptable is destroyed |
| on(eventName, callback) | Event fired when an FDC3 message is sent(Raise Intent or Broadcast Context) or received (Intent or Context) |
| on(eventName, callback) | Event fired whenever a Schedule is triggered in AdapTable |
| on(eventName, callback) | Event fired whenever a Column Filter is Applied in AdapTable |
| on(eventName, callback) | Event fired whenever a cell changes in the Grid |
| on(eventName, callback) | Event fired when a row is added, deleted or updated in the Grid |
| on(eventName, callback) | Event fired whenever a Shared Entity in Team Sharing changes |
| on(eventName, callback) | Event fired whenever the Cell Selection in AdapTable changes. |
| on(eventName, callback) | Event fired whenever the Row Selection in AdapTable changes. |
Method Details
destroy
TypeScript
destroy(): void;Returns
void
emit
TypeScript
emit(eventName: 'RowFormSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataImported' | 'DataSetSelected' | 'ColumnFilterApplied' | 'Fdc3Message' | 'RowChanged' | 'GridSorted' | 'LayoutChanged' | 'CalculatedColumnChanged' | 'LiveDataChanged' | 'ScheduleTriggered' | 'SearchChanged' | 'CellSelectionChanged' | 'RowSelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'GridFilterApplied' | 'CommentChanged', data?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
| eventName | 'RowFormSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataImported' | 'DataSetSelected' | 'ColumnFilterApplied' | 'Fdc3Message' | 'RowChanged' | 'GridSorted' | 'LayoutChanged' | 'CalculatedColumnChanged' | 'LiveDataChanged' | 'ScheduleTriggered' | 'SearchChanged' | 'CellSelectionChanged' | 'RowSelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'GridFilterApplied' | 'CommentChanged' |
| data | any |
Returns
Promise<any>
emitSync
TypeScript
emitSync(eventName: 'DashboardChanged', data?: any): any[];Parameters
| Parameter | Type |
|---|---|
| eventName | 'DashboardChanged' |
| data | any |
Returns
any[]
emitSync
TypeScript
emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];Parameters
| Parameter | Type |
|---|---|
| eventName | 'FlashingCellDisplayed' |
| data | any |
Returns
any[]
emitSync
TypeScript
emitSync(eventName: 'AdaptableDestroy'): any[];Parameters
| Parameter | Type |
|---|---|
| eventName | 'AdaptableDestroy' |
Returns
any[]
off
Unsubscribe from GridSorted
TypeScript
off(eventName: 'GridSorted', callback: (gridSortedInfo: GridSortedInfo) => void): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'GridSorted' | GridSorted |
| callback | (gridSortedInfo:GridSortedInfo) => void |
Returns
void
off
Unsubscribe from ThemeChanged
TypeScript
off(eventName: 'ThemeChanged', callback: (themeChangedInfo: ThemeChangedInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'ThemeChanged' |
| callback | (themeChangedInfo:ThemeChangedInfo) => void |
Returns
void
off
Unsubscribe from SystemStatusMessageDisplayed
TypeScript
off(eventName: 'SystemStatusMessageDisplayed', callback: (SystemStatusMessageDisplayedInfo: SystemStatusMessageDisplayedInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'SystemStatusMessageDisplayed' |
| callback | (SystemStatusMessageDisplayedInfo:SystemStatusMessageDisplayedInfo) => void |
Returns
void
off
Unsubscribe from AlertFired
TypeScript
off(eventName: 'AlertFired', callback: (alertFiredInfo: AlertFiredInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'AlertFired' |
| callback | (alertFiredInfo:AlertFiredInfo) => void |
Returns
void
off
Unsubscribe from DataImported
TypeScript
off(eventName: 'DataImported', callback: (dataImportedInfo: DataImportedInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'DataImported' |
| callback | (dataImportedInfo:DataImportedInfo) => void |
Returns
void
off
Unsubscribe from FlashingCellDisplayed
TypeScript
off(eventName: 'FlashingCellDisplayed', callback: (flashingCellDisplayedInfo: FlashingCellDisplayedInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'FlashingCellDisplayed' |
| callback | (flashingCellDisplayedInfo:FlashingCellDisplayedInfo) => void |
Returns
void
off
Unsubscribe from LayoutChanged
TypeScript
off(eventName: 'LayoutChanged', callback: (layoutChangedInfo: LayoutChangedInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'LayoutChanged' |
| callback | (layoutChangedInfo:LayoutChangedInfo) => void |
Returns
void
off
Unsubscribe from CalculatedColumnChanged
TypeScript
off(eventName: 'CalculatedColumnChanged', callback: (calculatedColumnChangedInfo: CalculatedColumnChangedInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'CalculatedColumnChanged' |
| callback | (calculatedColumnChangedInfo:CalculatedColumnChangedInfo) => void |
Returns
void
off
Unsubscribe from CustomToolbarConfigured
TypeScript
off(eventName: 'CustomToolbarConfigured', callback: (customToolbarConfiguredInfo: CustomToolbarConfiguredInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'CustomToolbarConfigured' |
| callback | (customToolbarConfiguredInfo:CustomToolbarConfiguredInfo) => void |
Returns
void
off
Unsubscribe from DashboardChanged
TypeScript
off(eventName: 'DashboardChanged', callback: (dashboardChangedInfo: DashboardChangedInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'DashboardChanged' |
| callback | (dashboardChangedInfo:DashboardChangedInfo) => void |
Returns
void
off
Unsubscribe from AdaptableStateChanged
TypeScript
off(eventName: 'AdaptableStateChanged', callback: (adaptableStateChangedInfo: AdaptableStateChangedInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'AdaptableStateChanged' |
| callback | (adaptableStateChangedInfo:AdaptableStateChangedInfo) => void |
Returns
void
off
Unsubscribe from GridFilterApplied
TypeScript
off(eventName: 'GridFilterApplied', callback: (gridFilterAppliedInfo: GridFilterAppliedInfo) => void): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'GridFilterApplied' | GridFilterApplied |
| callback | (gridFilterAppliedInfo:GridFilterAppliedInfo) => void |
Returns
void
off
Unsubscribe from AdaptableStateReloaded
TypeScript
off(eventName: 'AdaptableStateReloaded', callback: (adaptableStateReloadedInfo: AdaptableStateReloadedInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'AdaptableStateReloaded' |
| callback | (adaptableStateReloadedInfo:AdaptableStateReloadedInfo) => void |
Returns
void
off
Unsubscribe from LiveDataChanged
TypeScript
off(eventName: 'LiveDataChanged', callback: (liveDataChangedInfo: LiveDataChangedInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'LiveDataChanged' |
| callback | (liveDataChangedInfo:LiveDataChangedInfo) => void |
Returns
void
off
Unsubscribe from RowFormSubmitted
TypeScript
off(eventName: 'RowFormSubmittedInfo', callback: (rowFormSubmittedInfo: RowFormSubmittedInfo) => void): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'RowFormSubmittedInfo' | RowFormSubmitted |
| callback | (rowFormSubmittedInfo:RowFormSubmittedInfo) => void |
Returns
void
off
Unsubscribe from DataSetSelected
TypeScript
off(eventName: 'DataSetSelected', callback: (dataSetSelectedInfo: DataSetSelectedInfo) => void): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'DataSetSelected' | DataSetSelected |
| callback | (dataSetSelectedInfo:DataSetSelectedInfo) => void |
Returns
void
off
Unsubscribe from ChartChanged
TypeScript
off(eventName: 'ChartChanged', callback: (chartChangedInfo: ChartChangedInfo) => void): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'ChartChanged' | ChartChanged |
| callback | (chartChangedInfo:ChartChangedInfo) => void |
Returns
void
off
Unsubscribe from CommentChanged
TypeScript
off(eventName: 'CommentChanged', callback: (commentChangedInfo: CommentChangedInfo) => void): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'CommentChanged' | |
| callback | (commentChangedInfo:CommentChangedInfo) => void |
Returns
void
off
Unsubscribe from AdaptableReady
TypeScript
off(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'AdaptableReady' |
| callback | (adaptableReadyInfo:AdaptableReadyInfo) => void |
Returns
void
off
Unsubscribe from Fdc3Message
TypeScript
off(eventName: 'Fdc3Message', callback: (fdc3MessageInfo: Fdc3MessageInfo) => void): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'Fdc3Message' | Fdc3Message |
| callback | (fdc3MessageInfo:Fdc3MessageInfo) => void |
Returns
void
off
Unsubscribe from ScheduleTriggered
TypeScript
off(eventName: 'ScheduleTriggered', callback: (scheduleTriggeredInfo: ScheduleTriggeredInfo) => void): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'ScheduleTriggered' | ScheduleTriggered |
| callback | (scheduleTriggeredInfo:ScheduleTriggeredInfo) => void |
Returns
void
off
Unsubscribe from ColumnFilterApplied
TypeScript
off(eventName: 'ColumnFilterApplied', callback: (columnFilterAppliedInfo: ColumnFilterAppliedInfo) => void): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'ColumnFilterApplied' | ColumnFilterApplied |
| callback | (columnFilterAppliedInfo:ColumnFilterAppliedInfo) => void |
Returns
void
off
Unsubscribe from CellChanged
TypeScript
off(eventName: 'CellChanged', callback: (cellChangedInfo: CellChangedInfo) => void): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'CellChanged' | CellChanged |
| callback | (cellChangedInfo:CellChangedInfo) => void |
Returns
void
off
Unsubscribe from RowChanged
TypeScript
off(eventName: 'RowChanged', callback: (rowChangedInfo: RowChangedInfo) => void): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'RowChanged' | RowChanged |
| callback | (rowChangedInfo:RowChangedInfo) => void |
Returns
void
off
Unsubscribe from TeamSharingEntityChanged
TypeScript
off(eventName: 'TeamSharingEntityChanged', callback: (TeamSharingEntityChangedInfo: TeamSharingEntityChangedInfo) => void): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'TeamSharingEntityChanged' | TeamSharingEntityChanged |
| callback | (TeamSharingEntityChangedInfo:TeamSharingEntityChangedInfo) => void |
Returns
void
off
Unsubscribe from CellSelectionChanged
TypeScript
off(eventName: 'CellSelectionChanged', callback: (cellSelectionChangedInfo: CellSelectionChangedInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'CellSelectionChanged' |
| callback | (cellSelectionChangedInfo:CellSelectionChangedInfo) => void |
Returns
void
off
Unsubscribe from RowSelectionChanged
TypeScript
off(eventName: 'RowSelectionChanged', callback: (rowSelectionChangedInfo: RowSelectionChangedInfo) => void): void;Parameters
| Parameter | Type |
|---|---|
| eventName | 'RowSelectionChanged' |
| callback | (rowSelectionChangedInfo:RowSelectionChangedInfo) => void |
Returns
void
on
Event fired whenever AdapTable is Sorted
TypeScript
on(eventName: 'GridSorted', callback: (gridSortedInfo: GridSortedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'GridSorted' | GridSorted |
| callback | (gridSortedInfo:GridSortedInfo) => void | GridSortedInfo which contains current Column Sorts |
Returns
VoidFunction
on
Event fired whenever the selected theme of AdapTable is changed
TypeScript
on(eventName: 'ThemeChanged', callback: (themeChangedInfo: ThemeChangedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'ThemeChanged' | ThemeChanged |
| callback | (themeChangedInfo:ThemeChangedInfo) => void | ThemeChangedInfo which just contains the name of the current Theme |
Returns
VoidFunction
on
Event fired whenever a System Status Message is displayed in AdapTable
TypeScript
on(eventName: 'SystemStatusMessageDisplayed', callback: (systemStatusMessageDisplayedInfo: SystemStatusMessageDisplayedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'SystemStatusMessageDisplayed' | SystemStatusMessageDisplayed |
| callback | (systemStatusMessageDisplayedInfo:SystemStatusMessageDisplayedInfo) => void | SystemStatusMessageDisplayed which provides SystemStatusMessageInfo |
Returns
VoidFunction
on
Event fired whenever an Alert is triggered in AdapTable.
TypeScript
on(eventName: 'AlertFired', callback: (alertFiredInfo: AlertFiredInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'AlertFired' | AlertFired |
| callback | (alertFiredInfo:AlertFiredInfo) => void | AlertFiredInfo which wrap the Alert that was fired |
Returns
VoidFunction
on
Event fired when Data has been imported
TypeScript
on(eventName: 'DataImported', callback: (dataImportedInfo: DataImportedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'DataImported' | DataImported |
| callback | (dataImportedInfo:DataImportedInfo) => void | DataImportedInfo which contains the imported data |
Returns
VoidFunction
on
Event fired whenever Cell Flashing is triggered in AdapTable.
TypeScript
on(eventName: 'FlashingCellDisplayed', callback: (flashingCellDisplayedInfo: FlashingCellDisplayedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'FlashingCellDisplayed' | FlashingCellDisplayed |
| callback | (flashingCellDisplayedInfo:FlashingCellDisplayedInfo) => void | FlashingCellDisplayedInfo which wrap the AdaptableFlashingCell that was displayed |
Returns
VoidFunction
on
Event fired whenever the current Layout updates in AdapTable
TypeScript
on(eventName: 'LayoutChanged', callback: (layoutChangedInfo: LayoutChangedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'LayoutChanged' | LayoutChanged |
| callback | (layoutChangedInfo:LayoutChangedInfo) => void | LayoutChanged which includes just the name of the currently selected Layout. |
Returns
VoidFunction
on
Event fired whenever a Calculated Columns is created / updated / deleted in AdapTable
TypeScript
on(eventName: 'CalculatedColumnChanged', callback: (calculatedColumnChangedInfo: CalculatedColumnChangedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'CalculatedColumnChanged' | CalculatedColumnChanged |
| callback | (calculatedColumnChangedInfo:CalculatedColumnChangedInfo) => void | CalculatedColumnChanged which includes the action and details of the Calculated Column |
Returns
VoidFunction
on
Event fired whenever Configure Button is clicked in a Custom Toolbar
TypeScript
on(eventName: 'CustomToolbarConfigured', callback: (customToolbarConfiguredInfo: CustomToolbarConfiguredInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'CustomToolbarConfigured' | CustomToolbarConfigured |
| callback | (customToolbarConfiguredInfo:CustomToolbarConfiguredInfo) => void | CustomToolbarConfiguredInfo which contains the Custom Toolbar |
Returns
VoidFunction
on
Event fired whenever Dashboard State changes Primarily used for rendering Custom toolbars.
TypeScript
on(eventName: 'DashboardChanged', callback: (dashboardChangedInfo: DashboardChangedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'DashboardChanged' | DashboardChanged |
| callback | (dashboardChangedInfo:DashboardChangedInfo) => void | DashboardChangedInfo which includes the full Dashboard State |
Returns
VoidFunction
on
Event fired whenever Adaptable State changes
TypeScript
on(eventName: 'AdaptableStateChanged', callback: (adaptableStateChangedInfo: AdaptableStateChangedInfo) => void): () => void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'AdaptableStateChanged' | AdaptableStateChanged |
| callback | (adaptableStateChangedInfo:AdaptableStateChangedInfo) => void | AdaptableStateChangedInfo |
Returns
() => void
on
TypeScript
on(eventName: 'GridFilterApplied', callback: (gridFilterAppliedInfo: GridFilterAppliedInfo) => void): VoidFunction;Parameters
| Parameter | Type |
|---|---|
| eventName | 'GridFilterApplied' |
| callback | (gridFilterAppliedInfo:GridFilterAppliedInfo) => void |
Returns
VoidFunction
on
Event fired whenever Adaptable State is reloaded
TypeScript
on(eventName: 'AdaptableStateReloaded', callback: (adaptableStateReloadedInfo: AdaptableStateReloadedInfo) => void): () => void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'AdaptableStateReloaded' | AdaptableStateReloaded |
| callback | (adaptableStateReloadedInfo:AdaptableStateReloadedInfo) => void | AdaptableStateReloadedInfo |
Returns
() => void
on
Event fired whenever a change occurs relating to live reports / data Used in conjunction with AdapTable's partners OpenFin or ipushpull
TypeScript
on(eventName: 'LiveDataChanged', callback: (liveDataChangedInfo: LiveDataChangedInfo) => void): () => void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'LiveDataChanged' | LiveDataChanged |
| callback | (liveDataChangedInfo:LiveDataChangedInfo) => void | LiveDataChangedInfo which includes details of what triggered the event and the live report which is affected. |
Returns
() => void
on
Event fired when a Row Form is submitted
TypeScript
on(eventName: 'RowFormSubmitted', callback: (rowFormSubmittedInfo: RowFormSubmittedInfo) => void): () => void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'RowFormSubmitted' | RowFormSubmitted |
| callback | (rowFormSubmittedInfo:RowFormSubmittedInfo) => void | RowFormSubmitted |
Returns
() => void
on
Event fired when a DataSet is Selected
TypeScript
on(eventName: 'DataSetSelected', callback: (dataSetSelectedInfo: DataSetSelectedInfo) => void): () => void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'DataSetSelected' | DataSetSelected |
| callback | (dataSetSelectedInfo:DataSetSelectedInfo) => void | DataSetSelectedInfo |
Returns
() => void
on
Event fired when a Chart is Changed
TypeScript
on(eventName: 'ChartChanged', callback: (chartChangedInfo: ChartChangedInfo) => void): () => void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'ChartChanged' | ChartChanged |
| callback | (chartChangedInfo:ChartChangedInfo) => void | ChartChangedInfo |
Returns
() => void
on
Event fired when a Comment is Changed
TypeScript
on(eventName: 'CommentChanged', callback: (commentChangedInfo: CommentChangedInfo) => void): () => void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'CommentChanged' | CommentChanged |
| callback | (commentChangedInfo:CommentChangedInfo) => void |
Returns
() => void
on
Fired when Adaptable is up and running - has no arguments.
TypeScript
on(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'AdaptableReady' | AdaptableReady |
| callback | (adaptableReadyInfo:AdaptableReadyInfo) => void | An AdaptableReadyInfo object which contains the adaptableApi and GridOptions |
Returns
VoidFunction
on
Fired when Adaptable is destroyed
TypeScript
on(eventName: 'AdaptableDestroy', callback: () => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'AdaptableDestroy' | AdaptableDestroy |
| callback | () => void | A callback for listening to AdaptableDestroy |
Returns
VoidFunction
on
Event fired when an FDC3 message is sent(Raise Intent or Broadcast Context) or received (Intent or Context)
TypeScript
on(eventName: 'Fdc3Message', callback: (fdc3MessageInfo: Fdc3MessageInfo) => void): () => void;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'Fdc3Message' | Fdc3Message |
| callback | (fdc3MessageInfo:Fdc3MessageInfo) => void | Fdc3MessageInfo |
Returns
() => void
on
Event fired whenever a Schedule is triggered in AdapTable
TypeScript
on(eventName: 'ScheduleTriggered', callback: (scheduleTriggeredInfo: ScheduleTriggeredInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'ScheduleTriggered' | ScheduleTriggered |
| callback | (scheduleTriggeredInfo:ScheduleTriggeredInfo) => void | ScheduleTriggered which provides details of the Schedule that was triggered |
Returns
VoidFunction
on
Event fired whenever a Column Filter is Applied in AdapTable
TypeScript
on(eventName: 'ColumnFilterApplied', callback: (columnFilterAppliedInfo: ColumnFilterAppliedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'ColumnFilterApplied' | ColumnFilterApplied |
| callback | (columnFilterAppliedInfo:ColumnFilterAppliedInfo) => void | ColumnFilterApplied which provides details of the Column Filter that was applied |
Returns
VoidFunction
on
Event fired whenever a cell changes in the Grid
TypeScript
on(eventName: 'CellChanged', callback: (cellChangedInfo: CellChangedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'CellChanged' | CellChanged |
| callback | (cellChangedInfo:CellChangedInfo) => void | CellChangedInfo which includes full details of what changed |
Returns
VoidFunction
on
Event fired when a row is added, deleted or updated in the Grid
TypeScript
on(eventName: 'RowChanged', callback: (rowChangedInfo: RowChangedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'RowChanged' | RowChanged |
| callback | (rowChangedInfo:RowChangedInfo) => void | RowChangedInfo which includes full details of changed Rows |
Returns
VoidFunction
on
Event fired whenever a Shared Entity in Team Sharing changes
TypeScript
on(eventName: 'TeamSharingEntityChanged', callback: (TeamSharingEntityChangedInfo: TeamSharingEntityChangedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'TeamSharingEntityChanged' | TeamSharingEntityChanged |
| callback | (TeamSharingEntityChangedInfo:TeamSharingEntityChangedInfo) => void | TeamSharingEntityChangedInfo which includes full details of what changed |
Returns
VoidFunction
on
Event fired whenever the Cell Selection in AdapTable changes.
TypeScript
on(eventName: 'CellSelectionChanged', callback: (cellSelectionChangedInfo: CellSelectionChangedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'CellSelectionChanged' | CellSelectionChanged |
| callback | (cellSelectionChangedInfo:CellSelectionChangedInfo) => void | CellSelectionChangedInfo which contains information of any cells that are selected. |
Returns
VoidFunction
on
Event fired whenever the Row Selection in AdapTable changes.
TypeScript
on(eventName: 'RowSelectionChanged', callback: (rowSelectionChangedInfo: RowSelectionChangedInfo) => void): VoidFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| eventName | 'RowSelectionChanged' | RowSelectionChanged |
| callback | (rowSelectionChangedInfo:RowSelectionChangedInfo) => void | RowSelectionChangedInfo which contains information of any rows that are selected. |
Returns
VoidFunction