Viewer<TSettings>

Defined in: js-api/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: js-api/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	js-api/src/widgets/base.ts:277
_properties	protected	Property[]	[]	-	Widget._properties	js-api/src/widgets/base.ts:276
_root	protected	HTMLElement	undefined	-	Widget._root	js-api/src/widgets/base.ts:275
dart	public	any	undefined	-	Widget.dart	js-api/src/widgets/base.ts:280
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	Widget.factory	js-api/src/widgets/base.ts:273
isDetached	public	boolean	false	-	Widget.isDetached	js-api/src/widgets/base.ts:281
props	public	TSettings & ObjectPropertyBag	undefined	-	Widget.props	js-api/src/widgets/base.ts:278
subs	public	Subscription[]	undefined	-	Widget.subs	js-api/src/widgets/base.ts:279
tags	public	any	undefined	-	-	js-api/src/viewer.ts:82
temp	public	any	undefined	Contains auxiliary information	Widget.temp	js-api/src/widgets/base.ts:270
CORE_VIEWER_TYPES	static	string[]	undefined	-	-	js-api/src/viewer.ts:405

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

Defined in: js-api/src/viewer.ts:109

AI briefing of the underlying Dart viewer.

Returns

string | null

Set Signature

set aiDescription(x): void

Defined in: js-api/src/viewer.ts:114

A short AI-facing briefing: what this widget is, what its functions do, and how the assistant should approach it (e.g. which getFunctions entries to call first). Shown to the AI assistant as part of the workspace context.

Parameters

Parameter	Type
x	string | null

Returns

void

Overrides

Widget.aiDescription

---

children

Get Signature

get children(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:362

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

Widget.children

---

dataFrame

Get Signature

get dataFrame(): DataFrame

Defined in: js-api/src/viewer.ts:242

Returns

DataFrame

Set Signature

set dataFrame(t): void

Defined in: js-api/src/viewer.ts:243

Parameters

Parameter	Type
t	DataFrame

Returns

void

---

descriptor

Get Signature

get descriptor(): WidgetDescriptor

Defined in: js-api/src/viewer.ts:100

Descriptor of this widget.

Returns

WidgetDescriptor

---

filter

Get Signature

get filter(): BitSet

Defined in: js-api/src/viewer.ts:93

combined filter of the viewer

Returns

BitSet

Set Signature

set filter(f): void

Defined in: js-api/src/viewer.ts:96

Parameters

Parameter	Type
f	BitSet

Returns

void

---

helpUrl

Get Signature

get helpUrl(): string

Defined in: js-api/src/viewer.ts:246

Help URL

Returns

string

Set Signature

set helpUrl(s): void

Defined in: js-api/src/viewer.ts:247

Parameters

Parameter	Type
s	string

Returns

void

---

meta

Get Signature

get meta(): ViewerMetaHelper

Defined in: js-api/src/viewer.ts:215

Returns

ViewerMetaHelper

---

onAfterDrawOverlay

Get Signature

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

Defined in: js-api/src/viewer.ts:142

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

Returns

Observable<EventData<any>>

---

onAfterDrawScene

Get Signature

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

Defined in: js-api/src/viewer.ts:138

Fires after rendering of the main canvas.

Returns

Observable<EventData<any>>

---

onAfterLayout

Get Signature

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

Defined in: js-api/src/viewer.ts:134

Fires after the viewer completes a layout pass.

Returns

Observable<EventData<any>>

---

onBeforeDrawOverlay

Get Signature

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

Defined in: js-api/src/viewer.ts:140

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

Returns

Observable<EventData<any>>

---

onBeforeDrawScene

Get Signature

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

Defined in: js-api/src/viewer.ts:136

Fires before rendering of the main canvas.

Returns

Observable<EventData<any>>

---

onContextMenu

Get Signature

get onContextMenu(): Observable<Menu>

Defined in: js-api/src/viewer.ts:350

Returns

Observable<Menu>

---

onDartPropertyChanged

Get Signature

get onDartPropertyChanged(): Observable<null>

Defined in: js-api/src/viewer.ts:376

Returns

Observable<null>

---

onDataEvent

Get Signature

get onDataEvent(): Observable<ViewerEvent>

Defined in: js-api/src/viewer.ts:122

Returns

Observable<ViewerEvent>

---

onDataFrameChanged

Get Signature

get onDataFrameChanged(): Observable<any>

Defined in: js-api/src/viewer.ts:130

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

Returns

Observable<any>

---

onDataRowClicked

Get Signature

get onDataRowClicked(): Observable<ViewerEvent>

Defined in: js-api/src/viewer.ts:126

Returns

Observable<ViewerEvent>

---

onDataSelected

Get Signature

get onDataSelected(): Observable<ViewerEvent>

Defined in: js-api/src/viewer.ts:124

Returns

Observable<ViewerEvent>

---

onDetached

Get Signature

get onDetached(): Observable<any>

Defined in: js-api/src/viewer.ts:391

Occurs when viewer is detached.

Returns

Observable<any>

---

onPropertyValueChanged

Get Signature

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

Defined in: js-api/src/viewer.ts:127

Returns

Observable<EventData<Property>>

---

onResized

Get Signature

get onResized(): Observable<null>

Defined in: js-api/src/viewer.ts:132

Fires when the viewer is resized.

Returns

Observable<null>

---

onTooltipCreated

Get Signature

get onTooltipCreated(): Observable<ViewerEvent>

Defined in: js-api/src/viewer.ts:123

Returns

Observable<ViewerEvent>

---

onViewerRendered

Get Signature

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

Defined in: js-api/src/viewer.ts:144

Fires after the viewer is rendered.

Returns

Observable<EventData<any>>

---

parent

Get Signature

get parent(): Widget<any> | null

Defined in: js-api/src/widgets/base.ts:359

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

Widget.parent

---

root

Get Signature

get root(): HTMLElement

Defined in: js-api/src/viewer.ts:211

Visual root.

Returns

HTMLElement

Overrides

Widget.root

---

table

Get Signature

get table(): DataFrame

Defined in: js-api/src/viewer.ts:227

Returns

DataFrame

---

tableView

Get Signature

get tableView(): TableView | null

Defined in: js-api/src/viewer.ts:237

Returns a view this viewer is associated with, or null

Returns

TableView | null

---

type

Get Signature

get type(): string

Defined in: js-api/src/viewer.ts:223

Returns viewer type (see VIEWER constants)

Returns

string

Overrides

Widget.type

---

view

Get Signature

get view(): View | null

Defined in: js-api/src/viewer.ts:232

Returns a view this viewer is associated with, or null

Returns

View | null

Methods

apply()

apply(properties): Widget

Defined in: js-api/src/widgets/base.ts:318

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

Widget.apply

---

close()

close(): void

Defined in: js-api/src/viewer.ts:205

Closes and detaches the viewer.

Returns

void

---

copyViewersLook()

copyViewersLook(other): void

Defined in: js-api/src/viewer.ts:393

Parameters

Parameter	Type
other	Viewer

Returns

void

---

detach()

detach(): void

Defined in: js-api/src/widgets/base.ts:371

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: js-api/src/widgets/base.ts:347

Returns

any[]

Inherited from

Widget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

Defined in: js-api/src/viewer.ts:106

Functions applicable to the underlying Dart viewer.

Returns

Func[]

Overrides

Widget.getFunctions

---

getInfo()

getInfo(): object

Defined in: js-api/src/viewer.ts:196

Returns

object

---

getOptions()

getOptions(includeDefaults?): object

Defined in: js-api/src/viewer.ts:192

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	js-api/src/viewer.ts:192
look	object	js-api/src/viewer.ts:192
type	string	js-api/src/viewer.ts:192

---

getProperties()

getProperties(): Property[]

Defined in: js-api/src/viewer.ts:200

Returns all properties of this widget.

Returns

Property[]

Overrides

Widget.getProperties

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: js-api/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: js-api/src/viewer.ts:146

Parameters

Parameter	Type
dart	any

Returns

void

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: js-api/src/viewer.ts:355

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: js-api/src/widgets/base.ts:353

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Widget.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

Defined in: js-api/src/widgets/base.ts:345

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: js-api/src/viewer.ts:397

Returns

any

---

setOptions()

setOptions(map): void

Defined in: js-api/src/viewer.ts:180

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: js-api/src/widgets/base.ts:351

Returns

void

Inherited from

Widget.sourceRowsChanged

---

sub()

sub(subscription): void

Defined in: js-api/src/widgets/base.ts:311

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

Widget.sub

---

toCompactLook()

toCompactLook(): void

Defined in: js-api/src/viewer.ts:372

Returns

void

---

toDart()

toDart(): any

Defined in: js-api/src/widgets/base.ts:303

Returns

any

Inherited from

Widget.toDart

---

barChart()

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

Defined in: js-api/src/viewer.ts:257

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IBarChartSettings>

Returns

Viewer<IBarChartSettings>

---

boxPlot()

static boxPlot(t, options?): BoxPlot

Defined in: js-api/src/viewer.ts:273

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IBoxPlotSettings>

Returns

BoxPlot

---

calendar()

static calendar(t, options?): CalendarViewer

Defined in: js-api/src/viewer.ts:293

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ICalendarSettings>

Returns

CalendarViewer

---

canVisualize()

static canVisualize(viewerType, dataFrame): string | null

Defined in: js-api/src/viewer.ts:401

Parameters

Parameter	Type
viewerType	string
dataFrame	DataFrame

Returns

string | null

---

confusionMatrix()

static confusionMatrix(t, options?): ConfusionMatrix

Defined in: js-api/src/viewer.ts:261

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IConfusionMatrixSettings>

Returns

ConfusionMatrix

---

correlationPlot()

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

Defined in: js-api/src/viewer.ts:297

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ICorrelationPlotSettings>

Returns

Viewer<ICorrelationPlotSettings>

---

densityPlot()

static densityPlot(t, options?): DensityPlotViewer

Defined in: js-api/src/viewer.ts:301

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IDensityPlotSettings>

Returns

DensityPlotViewer

---

filters()

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

Defined in: js-api/src/viewer.ts:277

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IFiltersSettings>

Returns

Viewer<IFiltersSettings>

---

find()

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

Defined in: js-api/src/widgets/base.ts:299

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: js-api/src/viewer.ts:305

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IFormSettings>

Returns

FormViewer

---

fromRoot()

static fromRoot(root): Widget

Defined in: js-api/src/widgets/base.ts:421

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: js-api/src/viewer.ts:162

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: js-api/src/widgets/base.ts:294

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget.getAll

---

getViewerTypes()

static getViewerTypes(options?): string[]

Defined in: js-api/src/viewer.ts:169

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: js-api/src/viewer.ts:249

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IGridSettings>

Returns

Grid

---

heatMap()

static heatMap(t, options?): Grid

Defined in: js-api/src/viewer.ts:269

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IGridSettings>

Returns

Grid

---

histogram()

static histogram(t, options?): HistogramViewer

Defined in: js-api/src/viewer.ts:253

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IHistogramSettings>

Returns

HistogramViewer

---

lineChart()

static lineChart(t, options?): LineChartViewer

Defined in: js-api/src/viewer.ts:285

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ILineChartSettings>

Returns

LineChartViewer

---

markup()

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

Defined in: js-api/src/viewer.ts:309

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IMarkupViewerSettings>

Returns

Viewer<IMarkupViewerSettings>

---

matrixPlot()

static matrixPlot(t, options?): MatrixPlot

Defined in: js-api/src/viewer.ts:313

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IMatrixPlotSettings>

Returns

MatrixPlot

---

network()

static network(t, options?): NetworkDiagramViewer

Defined in: js-api/src/viewer.ts:289

Parameters

Parameter	Type
t	DataFrame
options?	Partial<INetworkDiagramSettings>

Returns

NetworkDiagramViewer

---

pcPlot()

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

Defined in: js-api/src/viewer.ts:317

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPcPlotSettings>

Returns

Viewer<IPcPlotSettings>

---

pieChart()

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

Defined in: js-api/src/viewer.ts:321

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPieChartSettings>

Returns

Viewer<IPieChartSettings>

---

rocCurve()

static rocCurve(t, options?): RocCurve

Defined in: js-api/src/viewer.ts:265

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IRocCurveSettings>

Returns

RocCurve

---

scatterPlot()

static scatterPlot(t, options?): ScatterPlotViewer

Defined in: js-api/src/viewer.ts:281

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IScatterPlotSettings>

Returns

ScatterPlotViewer

---

scatterPlot3d()

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

Defined in: js-api/src/viewer.ts:325

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IScatterPlot3dSettings>

Returns

Viewer<IScatterPlot3dSettings>

---

statistics()

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

Defined in: js-api/src/viewer.ts:329

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IStatsViewerSettings>

Returns

Viewer<IStatsViewerSettings>

---

tile()

static tile(t, options?): TileViewer

Defined in: js-api/src/viewer.ts:333

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITileViewerSettings>

Returns

TileViewer

---

treeMap()

static treeMap(t, options?): TreeMap

Defined in: js-api/src/viewer.ts:337

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITreeMapSettings>

Returns

TreeMap

---

trellisPlot()

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

Defined in: js-api/src/viewer.ts:341

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITrellisPlotSettings>

Returns

Viewer<ITrellisPlotSettings>

---

wordCloud()

static wordCloud(t, options?): Viewer

Defined in: js-api/src/viewer.ts:346

Parameters

Parameter	Type
t	DataFrame
options?	any

Returns

Viewer

Deprecated