Events

Global platform events.

Constructors

new Events()

new Events(): Events

Returns

Events

Source

src/events.ts:74

Properties

Property	Modifier	Type
customEventBus	private	EventBus

Accessors

onAIGenerationAbortRequest

get onAIGenerationAbortRequest(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:101

---

onAIPanelToggleRequest

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

Returns

Observable <Widget<any>>

Source

src/events.ts:103

---

onAccordionConstructed

get onAccordionConstructed(): Observable <Accordion>

Returns

Observable <Accordion>

Source

src/events.ts:184

---

onBrowseNodeCreated

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

Returns

Observable <TreeViewNode<any>>

Source

src/events.ts:192

---

onContextMenu

get onContextMenu(): Observable<any>

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

Returns

Observable<any>

Source

src/events.ts:99

---

onContextMenuClosed

get onContextMenuClosed(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:105

---

onCurrentCellChanged

get onCurrentCellChanged(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:113

---

onCurrentObjectChanged

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

Returns

Observable <EventData <EventArgs>>

Source

src/events.ts:111

---

onCurrentProjectChanged

get onCurrentProjectChanged(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:156

---

onCurrentViewChanged

get onCurrentViewChanged(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:107

---

onCurrentViewChanging

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

Returns

Observable <EventData <ViewArgs>>

Source

src/events.ts:109

---

onDialogShown

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

Returns

Observable <Dialog<object>>

Source

src/events.ts:117

---

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:154

---

onFileImportRequest

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

Returns

Observable <EventData <FileImportArgs>>

Source

src/events.ts:188

---

onFormCreating

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

Returns

Observable <EventData <ColumnsArgs>>

Source

src/events.ts:182

---

onGridCellLinkClicked

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

Returns

Observable <EventData <GridCellArgs>>

Source

src/events.ts:190

---

onInputCreated

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

Returns

Observable <InputBase<any>>

Source

src/events.ts:115

---

onLog

get onLog(): Observable <LogMessage>

Returns

Observable <LogMessage>

Source

src/events.ts:196

---

onPackageLoaded

get onPackageLoaded(): Observable <Package>

Returns

Observable <Package>

Source

src/events.ts:186

---

onProjectClosed

get onProjectClosed(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:168

---

onProjectClosing

get onProjectClosing(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:166

---

onProjectModified

get onProjectModified(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:170

---

onProjectOpened

get onProjectOpened(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:164

---

onProjectSaved

get onProjectSaved(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:160

---

onProjectSaving

get onProjectSaving(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:162

---

onProjectUploaded

get onProjectUploaded(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:158

---

onQueryFinished

get onQueryFinished(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:126

---

onQueryStarted

get onQueryStarted(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:124

---

onResetFilterRequest

get onResetFilterRequest(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:142

---

onTableAdded

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

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

Returns

Observable <EventData <DataFrameArgs>>

Source

src/events.ts:120

---

onTableRemoved

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

Returns

Observable <EventData <DataFrameArgs>>

Source

src/events.ts:122

---

onTooltipClosed

get onTooltipClosed(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:176

---

onTooltipRequest

get onTooltipRequest(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:172

---

onTooltipShown

get onTooltipShown(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:174

---

onViewAdded

get onViewAdded(): Observable <View>

Returns

Observable <View>

Source

src/events.ts:132

---

onViewAdding

get onViewAdding(): Observable <View>

Returns

Observable <View>

Source

src/events.ts:134

---

onViewChanged

get onViewChanged(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:128

---

onViewChanging

get onViewChanging(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:130

---

onViewLayoutApplied

get onViewLayoutApplied(): Observable <ViewInfo>

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

Returns

Observable <ViewInfo>

Source

src/events.ts:151

---

onViewLayoutApplying

get onViewLayoutApplying(): Observable <ViewInfo>

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

Returns

Observable <ViewInfo>

Source

src/events.ts:148

---

onViewLayoutGenerated

get onViewLayoutGenerated(): Observable <ViewInfo>

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

Returns

Observable <ViewInfo>

Source

src/events.ts:145

---

onViewRemoved

get onViewRemoved(): Observable <View>

Returns

Observable <View>

Source

src/events.ts:136

---

onViewRemoving

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

Returns

Observable <EventData <ViewArgs>>

Source

src/events.ts:138

---

onViewRenamed

get onViewRenamed(): Observable <View>

Returns

Observable <View>

Source

src/events.ts:140

---

onViewerAdded

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

Returns

Observable <EventData <ViewerArgs>>

Source

src/events.ts:178

---

onViewerClosed

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

Returns

Observable <EventData <ViewerArgs>>

Source

src/events.ts:180

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

src/events.ts:96

---

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

src/events.ts:88

---

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>

Source

src/events.ts:81