Events
Global platform events.
Constructors
new Events()
new Events():
Events
Returns
Source
Properties
Property | Modifier | Type |
---|---|---|
customEventBus | private | EventBus |
Accessors
onAccordionConstructed
get
onAccordionConstructed():Observable
<Accordion
>
Returns
Observable
<Accordion
>
Source
onBrowseNodeCreated
get
onBrowseNodeCreated():Observable
<TreeViewNode
<any
>>
Returns
Observable
<TreeViewNode
<any
>>
Source
onContextMenu
get
onContextMenu():Observable
<any
>
Sample: https://public.datagrok.ai/js/samples/events/viewer-events
Returns
Observable
<any
>
Source
onContextMenuClosed
get
onContextMenuClosed():Observable
<any
>
Returns
Observable
<any
>
Source
onCurrentCellChanged
get
onCurrentCellChanged():Observable
<any
>
Returns
Observable
<any
>
Source
onCurrentObjectChanged
get
onCurrentObjectChanged():Observable
<any
>
Returns
Observable
<any
>
Source
onCurrentProjectChanged
get
onCurrentProjectChanged():Observable
<any
>
Returns
Observable
<any
>
Source
onCurrentViewChanged
get
onCurrentViewChanged():Observable
<any
>
Returns
Observable
<any
>
Source
onDialogShown
get
onDialogShown():Observable
<Dialog
>
Returns
Observable
<Dialog
>
Source
onFileEdited
get
onFileEdited():Observable
<FileInfo
>
File in the file share has been edited and saved by the user.
Returns
Observable
<FileInfo
>
Source
onFileImportRequest
get
onFileImportRequest():Observable
<FileImportArgs
>
Returns
Observable
<FileImportArgs
>
Source
onFormCreating
get
onFormCreating():Observable
<EventData
<ColumnsArgs
>>
Returns
Observable
<EventData
<ColumnsArgs
>>
Source
onGridCellLinkClicked
get
onGridCellLinkClicked():Observable
<EventData
<GridCellArgs
>>
Returns
Observable
<EventData
<GridCellArgs
>>
Source
onInputCreated
get
onInputCreated():Observable
<InputBase
<any
>>
Returns
Observable
<InputBase
<any
>>
Source
onPackageLoaded
get
onPackageLoaded():Observable
<Package
>
Returns
Observable
<Package
>
Source
onProjectClosed
get
onProjectClosed():Observable
<any
>
Returns
Observable
<any
>
Source
onProjectClosing
get
onProjectClosing():Observable
<any
>
Returns
Observable
<any
>
Source
onProjectModified
get
onProjectModified():Observable
<any
>
Returns
Observable
<any
>
Source
onProjectOpened
get
onProjectOpened():Observable
<any
>
Returns
Observable
<any
>
Source
onProjectSaved
get
onProjectSaved():Observable
<any
>
Returns
Observable
<any
>
Source
onProjectSaving
get
onProjectSaving():Observable
<any
>
Returns
Observable
<any
>
Source
onProjectUploaded
get
onProjectUploaded():Observable
<any
>
Returns
Observable
<any
>
Source
onQueryFinished
get
onQueryFinished():Observable
<any
>
Returns
Observable
<any
>
Source
onQueryStarted
get
onQueryStarted():Observable
<any
>
Returns
Observable
<any
>
Source
onResetFilterRequest
get
onResetFilterRequest():Observable
<any
>
Returns
Observable
<any
>
Source
onTableAdded
get
onTableAdded():Observable
<EventData
<DataFrameArgs
>>
Sample: https://public.datagrok.ai/js/samples/events/global-events
Returns
Observable
<EventData
<DataFrameArgs
>>
Source
onTableRemoved
get
onTableRemoved():Observable
<EventData
<DataFrameArgs
>>
Returns
Observable
<EventData
<DataFrameArgs
>>
Source
onTooltipClosed
get
onTooltipClosed():Observable
<any
>
Returns
Observable
<any
>
Source
onTooltipRequest
get
onTooltipRequest():Observable
<any
>
Returns
Observable
<any
>
Source
onTooltipShown
get
onTooltipShown():Observable
<any
>
Returns
Observable
<any
>
Source
onViewAdded
get
onViewAdded():Observable
<View
>
Returns
Observable
<View
>
Source
onViewAdding
get
onViewAdding():Observable
<View
>
Returns
Observable
<View
>
Source
onViewChanged
get
onViewChanged():Observable
<any
>
Returns
Observable
<any
>
Source
onViewLayoutApplied
get
onViewLayoutApplied():Observable
<ViewInfo
>
Sample: https://public.datagrok.ai/js/samples/events/layout-events
Returns
Observable
<ViewInfo
>
Source
onViewLayoutApplying
get
onViewLayoutApplying():Observable
<ViewInfo
>
Sample: https://public.datagrok.ai/js/samples/events/layout-events
Returns
Observable
<ViewInfo
>
Source
onViewLayoutGenerated
get
onViewLayoutGenerated():Observable
<ViewInfo
>
Sample: https://public.datagrok.ai/js/samples/events/layout-events
Returns
Observable
<ViewInfo
>
Source
onViewRemoved
get
onViewRemoved():Observable
<View
>
Returns
Observable
<View
>
Source
onViewRemoving
Returns
Observable
<EventData
<ViewArgs
>>
Source
onViewRenamed
get
onViewRenamed():Observable
<View
>
Returns
Observable
<View
>
Source
onViewerAdded
get
onViewerAdded():Observable
<EventData
<ViewerArgs
>>
Returns
Observable
<EventData
<ViewerArgs
>>
Source
onViewerClosed
get
onViewerClosed():Observable
<EventData
<ViewerArgs
>>
Returns
Observable
<EventData
<ViewerArgs
>>
Source
Methods
fireCustomEvent()
fireCustomEvent(
eventId
,args
):void
Observes events with the specified eventId. Sample: https://public.datagrok.ai/js/samples/events/custom-events
Parameters
Parameter | Type | Description |
---|---|---|
eventId | string | |
args | any | event arguments |
Returns
void
Source
onCustomEvent()
onCustomEvent(
eventId
):Observable
<any
>
Observes custom events with the specified eventId. Sample: https://public.datagrok.ai/js/samples/events/custom-events
Parameters
Parameter | Type |
---|---|
eventId | string |
Returns
Observable
<any
>
Source
onEvent()
onEvent(
eventId
):Observable
<any
>
Observes platform events with the specified eventId. Sample: https://public.datagrok.ai/js/samples/ui/ui-events
Parameters
Parameter | Type |
---|---|
eventId | string |
Returns
Observable
<any
>