Viewer<TSettings>

Defined in: src/viewer.ts:80

Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers

See

Use Viewer to control the viewers. To develop a custom viewer, JsViewer.

Example

let view = grok.shell.addTableView(grok.data.demo.demog());
view.scatterPlot({
    x: 'height',
    y: 'weight',
    size: 'age',
    color: 'race',
  });

Extends

• Widget<TSettings>

Extended by

• FormViewer
• Grid
• JsViewer
• FilterGroup
• LineChartViewer
• ScatterPlotViewer
• DensityPlotViewer
• HistogramViewer
• BarChartViewer
• PieChartViewer
• PcPlot
• BoxPlot
• CorrelationPlot
• TreeMap
• MatrixPlot
• TileViewer
• ConfusionMatrix
• RocCurve
• CalendarViewer
• PivotViewer
• NetworkDiagramViewer
• TrellisPlotViewer

Type Parameters

Type Parameter	Default type
TSettings	any

Constructors

Constructor

new Viewer<TSettings>(dart, root?): Viewer<TSettings>

Defined in: src/viewer.ts:86

Parameters

Parameter	Type
dart	any
root?	HTMLElement

Returns

Viewer<TSettings>

Constructs

Viewer

Overrides

Widget.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	Widget._functions	src/widgets/base.ts:243
_properties	protected	Property[]	[]	-	Widget._properties	src/widgets/base.ts:242
_root	protected	HTMLElement	undefined	-	Widget._root	src/widgets/base.ts:241
dart	public	any	undefined	-	Widget.dart	src/widgets/base.ts:246
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	Widget.factory	src/widgets/base.ts:239
isDetached	public	boolean	false	-	Widget.isDetached	src/widgets/base.ts:247
props	public	TSettings & ObjectPropertyBag	undefined	-	Widget.props	src/widgets/base.ts:244
subs	public	Subscription[]	undefined	-	Widget.subs	src/widgets/base.ts:245
tags	public	any	undefined	-	-	src/viewer.ts:82
temp	public	any	undefined	Contains auxiliary information	Widget.temp	src/widgets/base.ts:236
CORE_VIEWER_TYPES	static	string[]	undefined	-	-	src/viewer.ts:388

Accessors

children

Get Signature

get children(): Widget<any>[]

Defined in: src/widgets/base.ts:320

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

Widget.children

---

dataFrame

Get Signature

get dataFrame(): DataFrame

Defined in: src/viewer.ts:225

Returns

DataFrame

Set Signature

set dataFrame(t): void

Defined in: src/viewer.ts:226

Parameters

Parameter	Type
t	DataFrame

Returns

void

---

descriptor

Get Signature

get descriptor(): WidgetDescriptor

Defined in: src/viewer.ts:100

Descriptor of this widget.

Returns

WidgetDescriptor

---

filter

Get Signature

get filter(): BitSet

Defined in: src/viewer.ts:93

combined filter of the viewer

Returns

BitSet

Set Signature

set filter(f): void

Defined in: src/viewer.ts:96

Parameters

Parameter	Type
f	BitSet

Returns

void

---

helpUrl

Get Signature

get helpUrl(): string

Defined in: src/viewer.ts:229

Help URL

Returns

string

Set Signature

set helpUrl(s): void

Defined in: src/viewer.ts:230

Parameters

Parameter	Type
s	string

Returns

void

---

meta

Get Signature

get meta(): ViewerMetaHelper

Defined in: src/viewer.ts:198

Returns

ViewerMetaHelper

---

onAfterDrawOverlay

Get Signature

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

Defined in: src/viewer.ts:125

Fires after rendering of the overlay canvas (interactive layer).

Returns

Observable<EventData<any>>

---

onAfterDrawScene

Get Signature

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

Defined in: src/viewer.ts:121

Fires after rendering of the main canvas.

Returns

Observable<EventData<any>>

---

onAfterLayout

Get Signature

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

Defined in: src/viewer.ts:117

Fires after the viewer completes a layout pass.

Returns

Observable<EventData<any>>

---

onBeforeDrawOverlay

Get Signature

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

Defined in: src/viewer.ts:123

Fires before rendering of the overlay canvas (interactive layer).

Returns

Observable<EventData<any>>

---

onBeforeDrawScene

Get Signature

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

Defined in: src/viewer.ts:119

Fires before rendering of the main canvas.

Returns

Observable<EventData<any>>

---

onContextMenu

Get Signature

get onContextMenu(): Observable<Menu>

Defined in: src/viewer.ts:333

Returns

Observable<Menu>

---

onDartPropertyChanged

Get Signature

get onDartPropertyChanged(): Observable<null>

Defined in: src/viewer.ts:359

Returns

Observable<null>

---

onDataEvent

Get Signature

get onDataEvent(): Observable<ViewerEvent>

Defined in: src/viewer.ts:105

Returns

Observable<ViewerEvent>

---

onDataFrameChanged

Get Signature

get onDataFrameChanged(): Observable<any>

Defined in: src/viewer.ts:113

Fires when the viewer's underlying DataFrame is replaced (table attached).

Returns

Observable<any>

---

onDataRowClicked

Get Signature

get onDataRowClicked(): Observable<ViewerEvent>

Defined in: src/viewer.ts:109

Returns

Observable<ViewerEvent>

---

onDataSelected

Get Signature

get onDataSelected(): Observable<ViewerEvent>

Defined in: src/viewer.ts:107

Returns

Observable<ViewerEvent>

---

onDetached

Get Signature

get onDetached(): Observable<any>

Defined in: src/viewer.ts:374

Occurs when viewer is detached.

Returns

Observable<any>

---

onPropertyValueChanged

Get Signature

get onPropertyValueChanged(): Observable<EventData<Property>>

Defined in: src/viewer.ts:110

Returns

Observable<EventData<Property>>

---

onResized

Get Signature

get onResized(): Observable<null>

Defined in: src/viewer.ts:115

Fires when the viewer is resized.

Returns

Observable<null>

---

onTooltipCreated

Get Signature

get onTooltipCreated(): Observable<ViewerEvent>

Defined in: src/viewer.ts:106

Returns

Observable<ViewerEvent>

---

onViewerRendered

Get Signature

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

Defined in: src/viewer.ts:127

Fires after the viewer is rendered.

Returns

Observable<EventData<any>>

---

parent

Get Signature

get parent(): Widget<any> | null

Defined in: src/widgets/base.ts:317

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

Widget.parent

---

root

Get Signature

get root(): HTMLElement

Defined in: src/viewer.ts:194

Visual root.

Returns

HTMLElement

Overrides

Widget.root

---

table

Get Signature

get table(): DataFrame

Defined in: src/viewer.ts:210

Returns

DataFrame

---

tableView

Get Signature

get tableView(): TableView | null

Defined in: src/viewer.ts:220

Returns a view this viewer is associated with, or null

Returns

TableView | null

---

type

Get Signature

get type(): string

Defined in: src/viewer.ts:206

Returns viewer type (see VIEWER constants)

Returns

string

Overrides

Widget.type

---

view

Get Signature

get view(): View | null

Defined in: src/viewer.ts:215

Returns a view this viewer is associated with, or null

Returns

View | null

Methods

apply()

apply(properties): Widget

Defined in: src/widgets/base.ts:284

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

Widget.apply

---

close()

close(): void

Defined in: src/viewer.ts:188

Closes and detaches the viewer.

Returns

void

---

copyViewersLook()

copyViewersLook(other): void

Defined in: src/viewer.ts:376

Parameters

Parameter	Type
other	Viewer

Returns

void

---

detach()

detach(): void

Defined in: src/widgets/base.ts:329

Gets called when a widget is detached and will no longer be used. Typically used for unsubscribing from events. Be sure to call super.detach() if this method is overridden.

Returns

void

Inherited from

Widget.detach

---

getDartProperties()

getDartProperties(): any[]

Defined in: src/widgets/base.ts:305

Returns

any[]

Inherited from

Widget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

Defined in: src/widgets/base.ts:299

Functions that are applicable to this particular widget. Used in the UI to display context actions, and for the AI integrations.

Returns

Func[]

Inherited from

Widget.getFunctions

---

getInfo()

getInfo(): object

Defined in: src/viewer.ts:179

Returns

object

---

getOptions()

getOptions(includeDefaults?): object

Defined in: src/viewer.ts:175

Gets the serialized viewer options. [includeDefaults] flag specifies whether the properties with the default values should be returned. Not including default properties makes it more clean and efficient for serialization purposes.

See also setOptions Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/scatter-plot

Parameters

Parameter	Type	Default value
includeDefaults	boolean	false

Returns

object

Name	Type	Defined in
id	string	src/viewer.ts:175
look	object	src/viewer.ts:175
type	string	src/viewer.ts:175

---

getProperties()

getProperties(): Property[]

Defined in: src/viewer.ts:183

Returns all properties of this widget.

Returns

Property[]

Overrides

Widget.getProperties

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: src/viewer.ts:103

Returns the widget's runtime structure for automated testing and introspection.

Returns

IWidgetStatus

Overrides

Widget.getWidgetStatus

---

initDartObject()

initDartObject(dart): void

Defined in: src/viewer.ts:129

Parameters

Parameter	Type
dart	any

Returns

void

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: src/viewer.ts:338

Observes platform events with the specified eventId.

Parameters

Parameter	Type	Default value
eventId	string | null	null

Returns

Observable<any>

Overrides

Widget.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

Defined in: src/widgets/base.ts:311

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Widget.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

Defined in: src/widgets/base.ts:303

Gets called when viewer's property is changed.

Parameters

Parameter	Type	Description
property	Property | null	or null, if multiple properties were changed.

Returns

void

Inherited from

Widget.onPropertyChanged

---

removeFromView()

removeFromView(): any

Defined in: src/viewer.ts:380

Returns

any

---

setOptions()

setOptions(map): void

Defined in: src/viewer.ts:163

Sets viewer options. See also getOptions Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/scatter-plot

Parameters

Parameter	Type	Description
map	{[key: string]: any; type?: string; }	-
map.type?	string	-

Returns

void

---

sourceRowsChanged()

sourceRowsChanged(): void

Defined in: src/widgets/base.ts:309

Returns

void

Inherited from

Widget.sourceRowsChanged

---

sub()

sub(subscription): void

Defined in: src/widgets/base.ts:277

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

Widget.sub

---

toCompactLook()

toCompactLook(): void

Defined in: src/viewer.ts:355

Returns

void

---

toDart()

toDart(): any

Defined in: src/widgets/base.ts:269

Returns

any

Inherited from

Widget.toDart

---

barChart()

static barChart(t, options?): Viewer<IBarChartSettings>

Defined in: src/viewer.ts:240

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IBarChartSettings>

Returns

Viewer<IBarChartSettings>

---

boxPlot()

static boxPlot(t, options?): BoxPlot

Defined in: src/viewer.ts:256

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IBoxPlotSettings>

Returns

BoxPlot

---

calendar()

static calendar(t, options?): CalendarViewer

Defined in: src/viewer.ts:276

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ICalendarSettings>

Returns

CalendarViewer

---

canVisualize()

static canVisualize(viewerType, dataFrame): string | null

Defined in: src/viewer.ts:384

Parameters

Parameter	Type
viewerType	string
dataFrame	DataFrame

Returns

string | null

---

confusionMatrix()

static confusionMatrix(t, options?): ConfusionMatrix

Defined in: src/viewer.ts:244

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IConfusionMatrixSettings>

Returns

ConfusionMatrix

---

correlationPlot()

static correlationPlot(t, options?): Viewer<ICorrelationPlotSettings>

Defined in: src/viewer.ts:280

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ICorrelationPlotSettings>

Returns

Viewer<ICorrelationPlotSettings>

---

densityPlot()

static densityPlot(t, options?): DensityPlotViewer

Defined in: src/viewer.ts:284

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IDensityPlotSettings>

Returns

DensityPlotViewer

---

filters()

static filters(t, options?): Viewer<IFiltersSettings>

Defined in: src/viewer.ts:260

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IFiltersSettings>

Returns

Viewer<IFiltersSettings>

---

find()

static find(root): Widget<any> | null

Defined in: src/widgets/base.ts:265

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

Widget.find

---

form()

static form(t, options?): FormViewer

Defined in: src/viewer.ts:288

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IFormSettings>

Returns

FormViewer

---

fromRoot()

static fromRoot(root): Widget

Defined in: src/widgets/base.ts:374

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

Widget.fromRoot

---

fromType()

static fromType(viewerType, table, options?): Viewer

Defined in: src/viewer.ts:145

Creates a new viewer of the specified type.

Parameters

Parameter	Type	Default value	Description
viewerType	string	undefined	-
table	DataFrame	undefined	-
options	object | null	null	-

Returns

Viewer

---

getAll()

static getAll(): Widget<any>[]

Defined in: src/widgets/base.ts:260

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget.getAll

---

getViewerTypes()

static getViewerTypes(options?): string[]

Defined in: src/viewer.ts:152

Gets all available viewer types Core means the viewer is already loaded and all methods and properties are available synchronously.

Parameters

Parameter	Type
options?	{ core?: boolean; }
options.core?	boolean

Returns

string[]

---

grid()

static grid(t, options?): Grid

Defined in: src/viewer.ts:232

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IGridSettings>

Returns

Grid

---

heatMap()

static heatMap(t, options?): Grid

Defined in: src/viewer.ts:252

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IGridSettings>

Returns

Grid

---

histogram()

static histogram(t, options?): HistogramViewer

Defined in: src/viewer.ts:236

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IHistogramSettings>

Returns

HistogramViewer

---

lineChart()

static lineChart(t, options?): LineChartViewer

Defined in: src/viewer.ts:268

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ILineChartSettings>

Returns

LineChartViewer

---

markup()

static markup(t, options?): Viewer<IMarkupViewerSettings>

Defined in: src/viewer.ts:292

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IMarkupViewerSettings>

Returns

Viewer<IMarkupViewerSettings>

---

matrixPlot()

static matrixPlot(t, options?): MatrixPlot

Defined in: src/viewer.ts:296

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IMatrixPlotSettings>

Returns

MatrixPlot

---

network()

static network(t, options?): NetworkDiagramViewer

Defined in: src/viewer.ts:272

Parameters

Parameter	Type
t	DataFrame
options?	Partial<INetworkDiagramSettings>

Returns

NetworkDiagramViewer

---

pcPlot()

static pcPlot(t, options?): Viewer<IPcPlotSettings>

Defined in: src/viewer.ts:300

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPcPlotSettings>

Returns

Viewer<IPcPlotSettings>

---

pieChart()

static pieChart(t, options?): Viewer<IPieChartSettings>

Defined in: src/viewer.ts:304

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPieChartSettings>

Returns

Viewer<IPieChartSettings>

---

rocCurve()

static rocCurve(t, options?): RocCurve

Defined in: src/viewer.ts:248

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IRocCurveSettings>

Returns

RocCurve

---

scatterPlot()

static scatterPlot(t, options?): ScatterPlotViewer

Defined in: src/viewer.ts:264

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IScatterPlotSettings>

Returns

ScatterPlotViewer

---

scatterPlot3d()

static scatterPlot3d(t, options?): Viewer<IScatterPlot3dSettings>

Defined in: src/viewer.ts:308

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IScatterPlot3dSettings>

Returns

Viewer<IScatterPlot3dSettings>

---

statistics()

static statistics(t, options?): Viewer<IStatsViewerSettings>

Defined in: src/viewer.ts:312

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IStatsViewerSettings>

Returns

Viewer<IStatsViewerSettings>

---

tile()

static tile(t, options?): TileViewer

Defined in: src/viewer.ts:316

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITileViewerSettings>

Returns

TileViewer

---

treeMap()

static treeMap(t, options?): TreeMap

Defined in: src/viewer.ts:320

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITreeMapSettings>

Returns

TreeMap

---

trellisPlot()

static trellisPlot(t, options?): Viewer<ITrellisPlotSettings>

Defined in: src/viewer.ts:324

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITrellisPlotSettings>

Returns

Viewer<ITrellisPlotSettings>

---

wordCloud()

static wordCloud(t, options?): Viewer

Defined in: src/viewer.ts:329

Parameters

Parameter	Type
t	DataFrame
options?	any

Returns

Viewer

Deprecated