Skip to main content

Events

Defined in: js-api/src/events.ts:90

Global platform events.

Constructors​

Constructor​

new Events(): Events

Defined in: js-api/src/events.ts:93

Returns​

Events

Accessors​

onAccordionConstructed​

Get Signature​

get onAccordionConstructed(): Observable<Accordion>

Defined in: js-api/src/events.ts:247

You can use it to dynamically add panes for the context panel

Returns​

Observable<Accordion>

onAIGenerationAbortRequest​

Get Signature​

get onAIGenerationAbortRequest(): Observable<any>

Defined in: js-api/src/events.ts:120

Fires when the user asks to abort the running AI generation (the stop control of the AI panel).

Returns​

Observable<any>

onAIPanelToggleRequest​

Get Signature​

get onAIPanelToggleRequest(): Observable<Widget<any>>

Defined in: js-api/src/events.ts:123

Fires when something asks the AI panel to open or close; emits the requesting widget.

Returns​

Observable<Widget<any>>

onBrowseNodeCreated​

Get Signature​

get onBrowseNodeCreated(): Observable<TreeViewNode<any>>

Defined in: js-api/src/events.ts:267

Fires when a node is added to the Browse tree — the hook for decorating or extending it.

Returns​

Observable<TreeViewNode<any>>

onBrowseTreeRefreshed​

Get Signature​

get onBrowseTreeRefreshed(): Observable<EventData<BrowseTreeRefreshArgs>>

Defined in: js-api/src/events.ts:129

Fires after the Browse tree finished rebuilding and re-resolving the current path.

Returns​

Observable<EventData<BrowseTreeRefreshArgs>>

onContextMenu​

Get Signature​

get onContextMenu(): Observable<any>

Defined in: js-api/src/events.ts:117

Sample: https://public.datagrok.ai/js/samples/events/viewer-events

Returns​

Observable<any>

onContextMenuClosed​

Get Signature​

get onContextMenuClosed(): Observable<any>

Defined in: js-api/src/events.ts:126

Fires after a context menu closes.

Returns​

Observable<any>

onContextMenuShown​

Get Signature​

get onContextMenuShown(): Observable<any>

Defined in: js-api/src/events.ts:136

Fires once a context menu popup is in the DOM; onContextMenu fires before the popup is built.

Returns​

Observable<any>

onCurrentCellChanged​

Get Signature​

get onCurrentCellChanged(): Observable<any>

Defined in: js-api/src/events.ts:148

Fires when the current cell of the current table changes.

Returns​

Observable<any>

onCurrentObjectChanged​

Get Signature​

get onCurrentObjectChanged(): Observable<EventData<EventArgs>>

Defined in: js-api/src/events.ts:145

Fires when the current object (the one shown in the context panel) changes.

Returns​

Observable<EventData<EventArgs>>

onCurrentProjectChanged​

Get Signature​

get onCurrentProjectChanged(): Observable<any>

Defined in: js-api/src/events.ts:205

Fires when the current project changes.

Returns​

Observable<any>

onCurrentViewChanged​

Get Signature​

get onCurrentViewChanged(): Observable<EventData<ViewChangeArgs>>

Defined in: js-api/src/events.ts:139

Fires after the current view changes; args.previous and args.current are the two views.

Returns​

Observable<EventData<ViewChangeArgs>>

onCurrentViewChanging​

Get Signature​

get onCurrentViewChanging(): Observable<EventData<ViewArgs>>

Defined in: js-api/src/events.ts:142

Fires before the current view changes; preventDefault() keeps the current one.

Returns​

Observable<EventData<ViewArgs>>

onDialogShown​

Get Signature​

get onDialogShown(): Observable<Dialog<{ }>>

Defined in: js-api/src/events.ts:154

Fires when a Dialog is shown.

Returns​

Observable<Dialog<{ }>>

onEntityShared​

Get Signature​

get onEntityShared(): Observable<Entity>

Defined in: js-api/src/events.ts:261

Occurs when an entity is shared with users or groups via the share dialog.

Returns​

Observable<Entity>

onFileDragEnter​

Get Signature​

get onFileDragEnter(): Observable<EventData<any>>

Defined in: js-api/src/events.ts:258

Occurs when files are dragged into the application window, before the platform shows its drop overlay. Call EventData.preventDefault to suppress the overlay and handle the drop yourself (attach your own DOM dragover/drop handlers to your view).

Returns​

Observable<EventData<any>>

onFileEdited​

Get Signature​

get onFileEdited(): Observable<FileInfo>

Defined in: js-api/src/events.ts:202

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: js-api/src/events.ts:253

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: js-api/src/events.ts:244

Fires when the default row form is being built; change args.columns to control its fields.

Returns​

Observable<EventData<ColumnsArgs>>

onGridCellLinkClicked​

Get Signature​

get onGridCellLinkClicked(): Observable<EventData<GridCellArgs>>

Defined in: js-api/src/events.ts:264

Fires when a link inside any grid cell is clicked; args.gridCell and args.link.

Returns​

Observable<EventData<GridCellArgs>>

onInputCreated​

Get Signature​

get onInputCreated(): Observable<InputBase<any>>

Defined in: js-api/src/events.ts:151

Fires when a platform input is created, before it is shown — the hook for decorating inputs globally.

Returns​

Observable<InputBase<any>>

onLog​

Get Signature​

get onLog(): Observable<LogMessage>

Defined in: js-api/src/events.ts:272

Every log message the client produces (debug, info, warning, error, audit, usage).

Returns​

Observable<LogMessage>

onPackageLoaded​

Get Signature​

get onPackageLoaded(): Observable<Package>

Defined in: js-api/src/events.ts:250

Occurs when a package is successfully loaded.

Returns​

Observable<Package>

onProjectClosed​

Get Signature​

get onProjectClosed(): Observable<any>

Defined in: js-api/src/events.ts:223

Fires after a project is closed.

Returns​

Observable<any>

onProjectClosing​

Get Signature​

get onProjectClosing(): Observable<any>

Defined in: js-api/src/events.ts:220

Fires before a project is closed.

Returns​

Observable<any>

onProjectModified​

Get Signature​

get onProjectModified(): Observable<any>

Defined in: js-api/src/events.ts:226

Fires when an open project becomes dirty (its tables or views changed).

Returns​

Observable<any>

onProjectOpened​

Get Signature​

get onProjectOpened(): Observable<any>

Defined in: js-api/src/events.ts:217

Fires after a project is opened in the workspace.

Returns​

Observable<any>

onProjectSaved​

Get Signature​

get onProjectSaved(): Observable<any>

Defined in: js-api/src/events.ts:211

Fires after a project is saved to the server.

Returns​

Observable<any>

onProjectSaving​

Get Signature​

get onProjectSaving(): Observable<any>

Defined in: js-api/src/events.ts:214

Fires before a project is saved to the server.

Returns​

Observable<any>

onProjectUploaded​

Get Signature​

get onProjectUploaded(): Observable<any>

Defined in: js-api/src/events.ts:208

Same event as onProjectSaved: fires after a project is saved to the server.

Returns​

Observable<any>

onQueryFinished​

Get Signature​

get onQueryFinished(): Observable<any>

Defined in: js-api/src/events.ts:166

Fires when a data query finishes, whether it succeeded or failed.

Returns​

Observable<any>

onQueryStarted​

Get Signature​

get onQueryStarted(): Observable<any>

Defined in: js-api/src/events.ts:163

Fires when a data query starts executing.

Returns​

Observable<any>

onResetFilterRequest​

Get Signature​

get onResetFilterRequest(): Observable<any>

Defined in: js-api/src/events.ts:190

Fires when the user asks to reset all filters of the current table.

Returns​

Observable<any>

onServerMessage​

Get Signature​

get onServerMessage(): Observable<IServerMessageEventArgs>

Defined in: js-api/src/events.ts:275

Messages the server pushes over the web socket; eventType names the message kind, message carries the payload.

Returns​

Observable<IServerMessageEventArgs>

onTableAdded​

Get Signature​

get onTableAdded(): Observable<EventData<DataFrameArgs>>

Defined in: js-api/src/events.ts:157

Sample: https://public.datagrok.ai/js/samples/events/global-events

Returns​

Observable<EventData<DataFrameArgs>>

onTableRemoved​

Get Signature​

get onTableRemoved(): Observable<EventData<DataFrameArgs>>

Defined in: js-api/src/events.ts:160

Fires when a table is closed and leaves the workspace.

Returns​

Observable<EventData<DataFrameArgs>>

onTooltipClosed​

Get Signature​

get onTooltipClosed(): Observable<any>

Defined in: js-api/src/events.ts:235

Fires after a tooltip closes.

Returns​

Observable<any>

onTooltipRequest​

Get Signature​

get onTooltipRequest(): Observable<any>

Defined in: js-api/src/events.ts:229

Fires when a tooltip is about to be shown; handlers can preventDefault() to suppress it.

Returns​

Observable<any>

onTooltipShown​

Get Signature​

get onTooltipShown(): Observable<any>

Defined in: js-api/src/events.ts:232

Fires after a tooltip is shown.

Returns​

Observable<any>

onTreeNodeChildrenLoaded​

Get Signature​

get onTreeNodeChildrenLoaded(): Observable<any>

Defined in: js-api/src/events.ts:133

Fires once every child a tree group's expansion asked for is in the DOM; emits that group. Reaches this bus from trees whose root routes to it, which includes the Browse tree.

Returns​

Observable<any>

onViewAdded​

Get Signature​

get onViewAdded(): Observable<View>

Defined in: js-api/src/events.ts:175

Fires after a view is added to the workspace.

Returns​

Observable<View>

onViewAdding​

Get Signature​

get onViewAdding(): Observable<View>

Defined in: js-api/src/events.ts:178

Fires before a view is added to the workspace.

Returns​

Observable<View>

onViewChanged​

Get Signature​

get onViewChanged(): Observable<any>

Defined in: js-api/src/events.ts:169

Fires after the set of views in the current project changes; see also onCurrentViewChanged for the active view.

Returns​

Observable<any>

onViewChanging​

Get Signature​

get onViewChanging(): Observable<any>

Defined in: js-api/src/events.ts:172

Fires before the set of views in the current project changes.

Returns​

Observable<any>

onViewerAdded​

Get Signature​

get onViewerAdded(): Observable<EventData<ViewerArgs>>

Defined in: js-api/src/events.ts:238

Fires after a viewer is added to a view; args.viewer is the viewer.

Returns​

Observable<EventData<ViewerArgs>>

onViewerClosed​

Get Signature​

get onViewerClosed(): Observable<EventData<ViewerArgs>>

Defined in: js-api/src/events.ts:241

Fires after a viewer is closed.

Returns​

Observable<EventData<ViewerArgs>>

onViewLayoutApplied​

Get Signature​

get onViewLayoutApplied(): Observable<ViewInfo>

Defined in: js-api/src/events.ts:199

Sample: https://public.datagrok.ai/js/samples/events/layout-events

Returns​

Observable<ViewInfo>

onViewLayoutApplying​

Get Signature​

get onViewLayoutApplying(): Observable<ViewInfo>

Defined in: js-api/src/events.ts:196

Sample: https://public.datagrok.ai/js/samples/events/layout-events

Returns​

Observable<ViewInfo>

onViewLayoutGenerated​

Get Signature​

get onViewLayoutGenerated(): Observable<ViewInfo>

Defined in: js-api/src/events.ts:193

Sample: https://public.datagrok.ai/js/samples/events/layout-events

Returns​

Observable<ViewInfo>

onViewRemoved​

Get Signature​

get onViewRemoved(): Observable<View>

Defined in: js-api/src/events.ts:181

Fires after a view is closed.

Returns​

Observable<View>

onViewRemoving​

Get Signature​

get onViewRemoving(): Observable<EventData<ViewArgs>>

Defined in: js-api/src/events.ts:184

Fires before a view is closed; preventDefault() keeps it open.

Returns​

Observable<EventData<ViewArgs>>

onViewRenamed​

Get Signature​

get onViewRenamed(): Observable<View>

Defined in: js-api/src/events.ts:187

Fires after a view is renamed.

Returns​

Observable<View>

Methods​

fireCustomEvent()​

fireCustomEvent(eventId, args): void

Defined in: js-api/src/events.ts:114

Fires a custom event that onCustomEvent subscribers receive. Sample: https://public.datagrok.ai/js/samples/events/custom-events

Parameters​

ParameterType
eventIdstring
argsany

Returns​

void

onCustomEvent()​

onCustomEvent(eventId): Observable<any>

Defined in: js-api/src/events.ts:108

Observes custom events with the specified eventId. Sample: https://public.datagrok.ai/js/samples/events/custom-events

Parameters​

ParameterType
eventIdstring

Returns​

Observable<any>

onEvent()​

onEvent(eventId): Observable<any>

Defined in: js-api/src/events.ts:102

Observes platform events with the specified eventId (such as 'd4-current-view-changed'; see EVENT_TYPE). To find an event's id, open the Inspector (Alt+I), go to the "Client Log" tab, perform the action you want to intercept, and click the event to see its parameters; the context panel also generates the JavaScript handler code for it. Sample: https://public.datagrok.ai/js/samples/ui/ui-events

Parameters​

ParameterType
eventIdstring

Returns​

Observable<any>