Skip to main content

Class: Events

dg.Events

Global platform events.

Constructors​

constructor​

• new Events()

Defined in​

src/events.ts:72

Properties​

customEventBus​

• Private customEventBus: EventBus

Defined in​

src/events.ts:70

Accessors​

onAccordionConstructed​

• get onAccordionConstructed(): Observable<Accordion>

Returns​

Observable<Accordion>

Defined in​

src/events.ts:174

onBrowseNodeCreated​

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

Returns​

Observable<TreeViewNode<any>>

Defined in​

src/events.ts:180

onContextMenu​

• get onContextMenu(): Observable<any>

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

Returns​

Observable<any>

Defined in​

src/events.ts:97

onContextMenuClosed​

• get onContextMenuClosed(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:99

onCurrentCellChanged​

• get onCurrentCellChanged(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:105

onCurrentObjectChanged​

• get onCurrentObjectChanged(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:103

onCurrentProjectChanged​

• get onCurrentProjectChanged(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:146

onCurrentViewChanged​

• get onCurrentViewChanged(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:101

onDialogShown​

• get onDialogShown(): Observable<Dialog>

Returns​

Observable<Dialog>

Defined in​

src/events.ts:109

onFileEdited​

• get onFileEdited(): Observable<FileInfo>

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

Returns​

Observable<FileInfo>

Defined in​

src/events.ts:144

onFormCreating​

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

Returns​

Observable<EventData<ColumnsArgs>>

Defined in​

src/events.ts:172

onGridCellLinkClicked​

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

Returns​

Observable<EventData<GridCellArgs>>

Defined in​

src/events.ts:178

onInputCreated​

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

Returns​

Observable<InputBase<any>>

Defined in​

src/events.ts:107

onPackageLoaded​

• get onPackageLoaded(): Observable<Package>

Returns​

Observable<Package>

Defined in​

src/events.ts:176

onProjectClosed​

• get onProjectClosed(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:158

onProjectClosing​

• get onProjectClosing(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:156

onProjectModified​

• get onProjectModified(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:160

onProjectOpened​

• get onProjectOpened(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:154

onProjectSaved​

• get onProjectSaved(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:150

onProjectSaving​

• get onProjectSaving(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:152

onProjectUploaded​

• get onProjectUploaded(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:148

onQueryFinished​

• get onQueryFinished(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:118

onQueryStarted​

• get onQueryStarted(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:116

onResetFilterRequest​

• get onResetFilterRequest(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:132

onTableAdded​

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

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

Returns​

Observable<EventData<DataFrameArgs>>

Defined in​

src/events.ts:112

onTableRemoved​

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

Returns​

Observable<EventData<DataFrameArgs>>

Defined in​

src/events.ts:114

onTooltipClosed​

• get onTooltipClosed(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:166

onTooltipRequest​

• get onTooltipRequest(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:162

onTooltipShown​

• get onTooltipShown(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:164

onViewAdded​

• get onViewAdded(): Observable<View>

Returns​

Observable<View>

Defined in​

src/events.ts:122

onViewAdding​

• get onViewAdding(): Observable<View>

Returns​

Observable<View>

Defined in​

src/events.ts:124

onViewChanged​

• get onViewChanged(): Observable<any>

Returns​

Observable<any>

Defined in​

src/events.ts:120

onViewLayoutApplied​

• get onViewLayoutApplied(): Observable<ViewInfo>

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

Returns​

Observable<ViewInfo>

Defined in​

src/events.ts:141

onViewLayoutApplying​

• get onViewLayoutApplying(): Observable<ViewInfo>

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

Returns​

Observable<ViewInfo>

Defined in​

src/events.ts:138

onViewLayoutGenerated​

• get onViewLayoutGenerated(): Observable<ViewInfo>

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

Returns​

Observable<ViewInfo>

Defined in​

src/events.ts:135

onViewRemoved​

• get onViewRemoved(): Observable<View>

Returns​

Observable<View>

Defined in​

src/events.ts:126

onViewRemoving​

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

Returns​

Observable<EventData<ViewArgs>>

Defined in​

src/events.ts:128

onViewRenamed​

• get onViewRenamed(): Observable<View>

Returns​

Observable<View>

Defined in​

src/events.ts:130

onViewerAdded​

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

Returns​

Observable<EventData<ViewerArgs>>

Defined in​

src/events.ts:168

onViewerClosed​

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

Returns​

Observable<EventData<ViewerArgs>>

Defined in​

src/events.ts:170

Methods​

fireCustomEvent​

▸ fireCustomEvent(eventId, args): void

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

Parameters​

NameTypeDescription
eventIdstring
argsanyevent arguments

Returns​

void

Defined in​

src/events.ts:94

onCustomEvent​

▸ onCustomEvent(eventId): Observable<any>

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

Parameters​

NameType
eventIdstring

Returns​

Observable<any>

Defined in​

src/events.ts:86

onEvent​

▸ onEvent(eventId): Observable<any>

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

Parameters​

NameType
eventIdstring

Returns​

Observable<any>

Defined in​

src/events.ts:79