Events

Global platform events.

Constructors

new Events()

new Events(): Events

Returns

Events

Source

src/events.ts:73

Properties

Property	Modifier	Type
customEventBus	private	EventBus

Accessors

onAIGenerationAbortRequest

get onAIGenerationAbortRequest(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:100

---

onAccordionConstructed

get onAccordionConstructed(): Observable <Accordion>

Returns

Observable <Accordion>

Source

src/events.ts:181

---

onBrowseNodeCreated

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

Returns

Observable <TreeViewNode<any>>

Source

src/events.ts:189

---

onContextMenu

get onContextMenu(): Observable<any>

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

Returns

Observable<any>

Source

src/events.ts:98

---

onContextMenuClosed

get onContextMenuClosed(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:102

---

onCurrentCellChanged

get onCurrentCellChanged(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:110

---

onCurrentObjectChanged

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

Returns

Observable <EventData <EventArgs>>

Source

src/events.ts:108

---

onCurrentProjectChanged

get onCurrentProjectChanged(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:153

---

onCurrentViewChanged

get onCurrentViewChanged(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:104

---

onCurrentViewChanging

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

Returns

Observable <EventData <ViewArgs>>

Source

src/events.ts:106

---

onDialogShown

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

Returns

Observable <Dialog<object>>

Source

src/events.ts:114

---

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

---

onFileImportRequest

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

Returns

Observable <EventData <FileImportArgs>>

Source

src/events.ts:185

---

onFormCreating

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

Returns

Observable <EventData <ColumnsArgs>>

Source

src/events.ts:179

---

onGridCellLinkClicked

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

Returns

Observable <EventData <GridCellArgs>>

Source

src/events.ts:187

---

onInputCreated

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

Returns

Observable <InputBase<any>>

Source

src/events.ts:112

---

onPackageLoaded

get onPackageLoaded(): Observable <Package>

Returns

Observable <Package>

Source

src/events.ts:183

---

onProjectClosed

get onProjectClosed(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:165

---

onProjectClosing

get onProjectClosing(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:163

---

onProjectModified

get onProjectModified(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:167

---

onProjectOpened

get onProjectOpened(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:161

---

onProjectSaved

get onProjectSaved(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:157

---

onProjectSaving

get onProjectSaving(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:159

---

onProjectUploaded

get onProjectUploaded(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:155

---

onQueryFinished

get onQueryFinished(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:123

---

onQueryStarted

get onQueryStarted(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:121

---

onResetFilterRequest

get onResetFilterRequest(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:139

---

onTableAdded

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

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

Returns

Observable <EventData <DataFrameArgs>>

Source

src/events.ts:117

---

onTableRemoved

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

Returns

Observable <EventData <DataFrameArgs>>

Source

src/events.ts:119

---

onTooltipClosed

get onTooltipClosed(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:173

---

onTooltipRequest

get onTooltipRequest(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:169

---

onTooltipShown

get onTooltipShown(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:171

---

onViewAdded

get onViewAdded(): Observable <View>

Returns

Observable <View>

Source

src/events.ts:129

---

onViewAdding

get onViewAdding(): Observable <View>

Returns

Observable <View>

Source

src/events.ts:131

---

onViewChanged

get onViewChanged(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:125

---

onViewChanging

get onViewChanging(): Observable<any>

Returns

Observable<any>

Source

src/events.ts:127

---

onViewLayoutApplied

get onViewLayoutApplied(): Observable <ViewInfo>

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

Returns

Observable <ViewInfo>

Source

src/events.ts:148

---

onViewLayoutApplying

get onViewLayoutApplying(): Observable <ViewInfo>

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

Returns

Observable <ViewInfo>

Source

src/events.ts:145

---

onViewLayoutGenerated

get onViewLayoutGenerated(): Observable <ViewInfo>

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

Returns

Observable <ViewInfo>

Source

src/events.ts:142

---

onViewRemoved

get onViewRemoved(): Observable <View>

Returns

Observable <View>

Source

src/events.ts:133

---

onViewRemoving

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

Returns

Observable <EventData <ViewArgs>>

Source

src/events.ts:135

---

onViewRenamed

get onViewRenamed(): Observable <View>

Returns

Observable <View>

Source

src/events.ts:137

---

onViewerAdded

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

Returns

Observable <EventData <ViewerArgs>>

Source

src/events.ts:175

---

onViewerClosed

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

Returns

Observable <EventData <ViewerArgs>>

Source

src/events.ts:177

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

---

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

---

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