Skip to main content

Events

Global platform events.

Constructors​

new Events()​

new Events(): Events

Returns​

Events

Source​

src/events.ts:72

Properties​

PropertyModifierType
customEventBusprivateEventBus

Accessors​

onAIGenerationAbortRequest​

get onAIGenerationAbortRequest(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:103

onAIPanelToggleRequest​

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

Returns​

Observable <Widget<any>>

Source​

src/events.ts:105

onAccordionConstructed​

get onAccordionConstructed(): Observable <Accordion>

Returns​

Observable <Accordion>

Source​

src/events.ts:186

onBrowseNodeCreated​

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

Returns​

Observable <TreeViewNode<any>>

Source​

src/events.ts:194

onContextMenu​

get onContextMenu(): Observable<any>

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

Returns​

Observable<any>

Source​

src/events.ts:101

onContextMenuClosed​

get onContextMenuClosed(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:107

onCurrentCellChanged​

get onCurrentCellChanged(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:115

onCurrentObjectChanged​

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

Returns​

Observable <EventData <EventArgs>>

Source​

src/events.ts:113

onCurrentProjectChanged​

get onCurrentProjectChanged(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:158

onCurrentViewChanged​

get onCurrentViewChanged(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:109

onCurrentViewChanging​

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

Returns​

Observable <EventData <ViewArgs>>

Source​

src/events.ts:111

onDialogShown​

get onDialogShown(): Observable <Dialog<object>>

Returns​

Observable <Dialog<object>>

Source​

src/events.ts:119

onFileEdited​

get onFileEdited(): Observable <FileInfo>

File in the file share has been edited and saved by the user.

Returns​

Observable <FileInfo>

Source​

src/events.ts:156

onFileImportRequest​

get onFileImportRequest(): Observable <EventData <FileImportArgs>>

Returns​

Observable <EventData <FileImportArgs>>

Source​

src/events.ts:190

onFormCreating​

get onFormCreating(): Observable <EventData <ColumnsArgs>>

Returns​

Observable <EventData <ColumnsArgs>>

Source​

src/events.ts:184

onGridCellLinkClicked​

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

Returns​

Observable <EventData <GridCellArgs>>

Source​

src/events.ts:192

onInputCreated​

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

Returns​

Observable <InputBase<any>>

Source​

src/events.ts:117

onLog​

get onLog(): Observable <LogMessage>

Returns​

Observable <LogMessage>

Source​

src/events.ts:198

onPackageLoaded​

get onPackageLoaded(): Observable <Package>

Returns​

Observable <Package>

Source​

src/events.ts:188

onProjectClosed​

get onProjectClosed(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:170

onProjectClosing​

get onProjectClosing(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:168

onProjectModified​

get onProjectModified(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:172

onProjectOpened​

get onProjectOpened(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:166

onProjectSaved​

get onProjectSaved(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:162

onProjectSaving​

get onProjectSaving(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:164

onProjectUploaded​

get onProjectUploaded(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:160

onQueryFinished​

get onQueryFinished(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:128

onQueryStarted​

get onQueryStarted(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:126

onResetFilterRequest​

get onResetFilterRequest(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:144

onTableAdded​

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

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

Returns​

Observable <EventData <DataFrameArgs>>

Source​

src/events.ts:122

onTableRemoved​

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

Returns​

Observable <EventData <DataFrameArgs>>

Source​

src/events.ts:124

onTooltipClosed​

get onTooltipClosed(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:178

onTooltipRequest​

get onTooltipRequest(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:174

onTooltipShown​

get onTooltipShown(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:176

onViewAdded​

get onViewAdded(): Observable <View>

Returns​

Observable <View>

Source​

src/events.ts:134

onViewAdding​

get onViewAdding(): Observable <View>

Returns​

Observable <View>

Source​

src/events.ts:136

onViewChanged​

get onViewChanged(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:130

onViewChanging​

get onViewChanging(): Observable<any>

Returns​

Observable<any>

Source​

src/events.ts:132

onViewLayoutApplied​

get onViewLayoutApplied(): Observable <ViewInfo>

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

Returns​

Observable <ViewInfo>

Source​

src/events.ts:153

onViewLayoutApplying​

get onViewLayoutApplying(): Observable <ViewInfo>

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

Returns​

Observable <ViewInfo>

Source​

src/events.ts:150

onViewLayoutGenerated​

get onViewLayoutGenerated(): Observable <ViewInfo>

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

Returns​

Observable <ViewInfo>

Source​

src/events.ts:147

onViewRemoved​

get onViewRemoved(): Observable <View>

Returns​

Observable <View>

Source​

src/events.ts:138

onViewRemoving​

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

Returns​

Observable <EventData <ViewArgs>>

Source​

src/events.ts:140

onViewRenamed​

get onViewRenamed(): Observable <View>

Returns​

Observable <View>

Source​

src/events.ts:142

onViewerAdded​

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

Returns​

Observable <EventData <ViewerArgs>>

Source​

src/events.ts:180

onViewerClosed​

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

Returns​

Observable <EventData <ViewerArgs>>

Source​

src/events.ts:182

Methods​

fireCustomEvent()​

fireCustomEvent(eventId, args): void

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​

ParameterTypeDescription
eventIdstringsuch as 'd4-current-view-changed'
argsanyevent arguments

Returns​

void

Source​

src/events.ts:98

onCustomEvent()​

onCustomEvent(eventId): Observable<any>

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

Parameters​

ParameterType
eventIdstring

Returns​

Observable<any>

Source​

src/events.ts:84

onEvent()​

onEvent(eventId): Observable<any>

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

Parameters​

ParameterType
eventIdstring

Returns​

Observable<any>

Source​

src/events.ts:78