Events
Defined in: src/events.ts:91
Global platform events.
Constructors
Constructor
new Events():
Events
Defined in: src/events.ts:94
Returns
Events
Accessors
onAccordionConstructed
Get Signature
get onAccordionConstructed():
Observable<Accordion>
Defined in: src/events.ts:209
You can use it to dynamically add panes for the context panel
Returns
Observable<Accordion>
onAIGenerationAbortRequest
Get Signature
get onAIGenerationAbortRequest():
Observable<any>
Defined in: src/events.ts:125
Returns
Observable<any>
onAIPanelToggleRequest
Get Signature
get onAIPanelToggleRequest():
Observable<Widget<any>>
Defined in: src/events.ts:127
Returns
Observable<Widget<any>>
onBrowseNodeCreated
Get Signature
get onBrowseNodeCreated():
Observable<TreeViewNode<any>>
Defined in: src/events.ts:219
Returns
Observable<TreeViewNode<any>>
onContextMenu
Get Signature
get onContextMenu():
Observable<any>
Defined in: src/events.ts:123
Sample: https://public.datagrok.ai/js/samples/events/viewer-events
Returns
Observable<any>
onContextMenuClosed
Get Signature
get onContextMenuClosed():
Observable<any>
Defined in: src/events.ts:129
Returns
Observable<any>
onCurrentCellChanged
Get Signature
get onCurrentCellChanged():
Observable<any>
Defined in: src/events.ts:137
Returns
Observable<any>
onCurrentObjectChanged
Get Signature
get onCurrentObjectChanged():
Observable<EventData<EventArgs>>
Defined in: src/events.ts:135
Returns
Observable<EventData<EventArgs>>
onCurrentProjectChanged
Get Signature
get onCurrentProjectChanged():
Observable<any>
Defined in: src/events.ts:180
Returns
Observable<any>
onCurrentViewChanged
Get Signature
get onCurrentViewChanged():
Observable<any>
Defined in: src/events.ts:131
Returns
Observable<any>
onCurrentViewChanging
Get Signature
get onCurrentViewChanging():
Observable<EventData<ViewArgs>>
Defined in: src/events.ts:133
Returns
Observable<EventData<ViewArgs>>
onDialogShown
Get Signature
get onDialogShown():
Observable<Dialog<{ }>>
Defined in: src/events.ts:141
Returns
Observable<Dialog<{ }>>
onFileEdited
Get Signature
get onFileEdited():
Observable<FileInfo>
Defined in: src/events.ts:178
File in the file share has been edited and saved by the user.
Returns
Observable<FileInfo>
onFileImportRequest
Get Signature
get onFileImportRequest():
Observable<EventData<FileImportArgs>>
Defined in: src/events.ts:215
You can use it to override the default implementation of file import.
Returns
Observable<EventData<FileImportArgs>>
onFormCreating
Get Signature
get onFormCreating():
Observable<EventData<ColumnsArgs>>
Defined in: src/events.ts:206
Returns
Observable<EventData<ColumnsArgs>>
onGridCellLinkClicked
Get Signature
get onGridCellLinkClicked():
Observable<EventData<GridCellArgs>>
Defined in: src/events.ts:217
Returns
Observable<EventData<GridCellArgs>>
onInputCreated
Get Signature
get onInputCreated():
Observable<InputBase<any>>
Defined in: src/events.ts:139
Returns
Observable<InputBase<any>>
onLog
Get Signature
get onLog():
Observable<LogMessage>
Defined in: src/events.ts:223
Returns
Observable<LogMessage>
onPackageLoaded
Get Signature
get onPackageLoaded():
Observable<Package>
Defined in: src/events.ts:212
Occurs when a package is successfully loaded.
Returns
Observable<Package>
onProjectClosed
Get Signature
get onProjectClosed():
Observable<any>
Defined in: src/events.ts:192
Returns
Observable<any>
onProjectClosing
Get Signature
get onProjectClosing():
Observable<any>
Defined in: src/events.ts:190
Returns
Observable<any>
onProjectModified
Get Signature
get onProjectModified():
Observable<any>
Defined in: src/events.ts:194
Returns
Observable<any>
onProjectOpened
Get Signature
get onProjectOpened():
Observable<any>
Defined in: src/events.ts:188
Returns
Observable<any>
onProjectSaved
Get Signature
get onProjectSaved():
Observable<any>
Defined in: src/events.ts:184
Returns
Observable<any>
onProjectSaving
Get Signature
get onProjectSaving():
Observable<any>
Defined in: src/events.ts:186
Returns
Observable<any>
onProjectUploaded
Get Signature
get onProjectUploaded():
Observable<any>
Defined in: src/events.ts:182
Returns
Observable<any>
onQueryFinished
Get Signature
get onQueryFinished():
Observable<any>
Defined in: src/events.ts:150
Returns
Observable<any>
onQueryStarted
Get Signature
get onQueryStarted():
Observable<any>
Defined in: src/events.ts:148
Returns
Observable<any>
onResetFilterRequest
Get Signature
get onResetFilterRequest():
Observable<any>
Defined in: src/events.ts:166
Returns
Observable<any>
onServerMessage
Get Signature
get onServerMessage():
Observable<IServerMessageEventArgs>
Defined in: src/events.ts:225
Returns
Observable<IServerMessageEventArgs>
onTableAdded
Get Signature
get onTableAdded():
Observable<EventData<DataFrameArgs>>
Defined in: src/events.ts:144
Sample: https://public.datagrok.ai/js/samples/events/global-events
Returns
Observable<EventData<DataFrameArgs>>
onTableRemoved
Get Signature
get onTableRemoved():
Observable<EventData<DataFrameArgs>>
Defined in: src/events.ts:146
Returns
Observable<EventData<DataFrameArgs>>
onTooltipClosed
Get Signature
get onTooltipClosed():
Observable<any>
Defined in: src/events.ts:200
Returns
Observable<any>
onTooltipRequest
Get Signature
get onTooltipRequest():
Observable<any>
Defined in: src/events.ts:196
Returns
Observable<any>
onTooltipShown
Get Signature
get onTooltipShown():
Observable<any>
Defined in: src/events.ts:198
Returns
Observable<any>
onViewAdded
Get Signature
get onViewAdded():
Observable<View>
Defined in: src/events.ts:156
Returns
Observable<View>
onViewAdding
Get Signature
get onViewAdding():
Observable<View>
Defined in: src/events.ts:158
Returns
Observable<View>
onViewChanged
Get Signature
get onViewChanged():
Observable<any>
Defined in: src/events.ts:152
Returns
Observable<any>
onViewChanging
Get Signature
get onViewChanging():
Observable<any>
Defined in: src/events.ts:154
Returns
Observable<any>
onViewerAdded
Get Signature
get onViewerAdded():
Observable<EventData<ViewerArgs>>
Defined in: src/events.ts:202
Returns
Observable<EventData<ViewerArgs>>
onViewerClosed
Get Signature
get onViewerClosed():
Observable<EventData<ViewerArgs>>
Defined in: src/events.ts:204
Returns
Observable<EventData<ViewerArgs>>
onViewLayoutApplied
Get Signature
get onViewLayoutApplied():
Observable<ViewInfo>
Defined in: src/events.ts:175
Sample: https://public.datagrok.ai/js/samples/events/layout-events
Returns
Observable<ViewInfo>
onViewLayoutApplying
Get Signature
get onViewLayoutApplying():
Observable<ViewInfo>
Defined in: src/events.ts:172
Sample: https://public.datagrok.ai/js/samples/events/layout-events
Returns
Observable<ViewInfo>
onViewLayoutGenerated
Get Signature
get onViewLayoutGenerated():
Observable<ViewInfo>
Defined in: src/events.ts:169
Sample: https://public.datagrok.ai/js/samples/events/layout-events
Returns
Observable<ViewInfo>
onViewRemoved
Get Signature
get onViewRemoved():
Observable<View>
Defined in: src/events.ts:160
Returns
Observable<View>
onViewRemoving
Get Signature
Defined in: src/events.ts:162
Returns
Observable<EventData<ViewArgs>>
onViewRenamed
Get Signature
get onViewRenamed():
Observable<View>
Defined in: src/events.ts:164
Returns
Observable<View>
Methods
fireCustomEvent()
fireCustomEvent(
eventId,args):void
Defined in: src/events.ts:120
Observes events with the specified eventId. To see which events are getting fired, use the Inspector tool. Open it (Alt+I), go to the "Client Log" tab, and perform the action that you want to intercept. In the panel, you will see one or more of the events, click on them to inspect event parameters. To simplify the development process, we also generate JavaScript code for handling this particular event, copy-paste it from the context panel into your code if needed. Sample: https://public.datagrok.ai/js/samples/events/custom-events
Parameters
| Parameter | Type | Description |
|---|---|---|
eventId | string | such as 'd4-current-view-changed' |
args | any | event arguments |
Returns
void
onCustomEvent()
onCustomEvent(
eventId):Observable<any>
Defined in: src/events.ts:106
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>
onEvent()
onEvent(
eventId):Observable<any>
Defined in: src/events.ts:100
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>