CorrelationPlot

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

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

• Viewer<ICorrelationPlotSettings>

Constructors

Constructor

new CorrelationPlot(dart): CorrelationPlot

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

Parameters

Parameter	Type
dart	any

Returns

CorrelationPlot

Overrides

Viewer.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	Viewer._functions	js-api/src/widgets/base.ts:277
_properties	protected	Property[]	[]	-	Viewer._properties	js-api/src/widgets/base.ts:276
_root	protected	HTMLElement	undefined	-	Viewer._root	js-api/src/widgets/base.ts:275
dart	public	any	undefined	-	Viewer.dart	js-api/src/widgets/base.ts:280
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	Viewer.factory	js-api/src/widgets/base.ts:273
isDetached	public	boolean	false	-	Viewer.isDetached	js-api/src/widgets/base.ts:281
props	public	ICorrelationPlotSettings & ObjectPropertyBag	undefined	-	Viewer.props	js-api/src/widgets/base.ts:278
subs	public	Subscription[]	undefined	-	Viewer.subs	js-api/src/widgets/base.ts:279
tags	public	any	undefined	-	Viewer.tags	js-api/src/viewer.ts:84
temp	public	any	undefined	Contains auxiliary information	Viewer.temp	js-api/src/widgets/base.ts:270
CORE_VIEWER_TYPES	static	string[]	undefined	-	Viewer.CORE_VIEWER_TYPES	js-api/src/viewer.ts:407

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

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

AI briefing of the underlying Dart viewer.

Returns

string | null

Set Signature

set aiDescription(x): void

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

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

Inherited from

Viewer.aiDescription

---

children

Get Signature

get children(): Widget<any>[]

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

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

Viewer.children

---

dataFrame

Get Signature

get dataFrame(): DataFrame

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

Returns

DataFrame

Set Signature

set dataFrame(t): void

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

Parameters

Parameter	Type
t	DataFrame

Returns

void

Inherited from

Viewer.dataFrame

---

descriptor

Get Signature

get descriptor(): WidgetDescriptor

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

Descriptor of this widget.

Returns

WidgetDescriptor

Inherited from

Viewer.descriptor

---

filter

Get Signature

get filter(): BitSet

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

combined filter of the viewer

Returns

BitSet

Set Signature

set filter(f): void

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

Parameters

Parameter	Type
f	BitSet

Returns

void

Inherited from

Viewer.filter

---

helpUrl

Get Signature

get helpUrl(): string

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

Help URL

Returns

string

Set Signature

set helpUrl(s): void

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

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

Viewer.helpUrl

---

meta

Get Signature

get meta(): ViewerMetaHelper

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

Returns

ViewerMetaHelper

Inherited from

Viewer.meta

---

onAfterDrawOverlay

Get Signature

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

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

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

Returns

Observable<EventData<any>>

Inherited from

Viewer.onAfterDrawOverlay

---

onAfterDrawScene

Get Signature

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

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

Fires after rendering of the main canvas.

Returns

Observable<EventData<any>>

Inherited from

Viewer.onAfterDrawScene

---

onAfterLayout

Get Signature

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

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

Fires after the viewer completes a layout pass.

Returns

Observable<EventData<any>>

Inherited from

Viewer.onAfterLayout

---

onBeforeDrawOverlay

Get Signature

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

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

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

Returns

Observable<EventData<any>>

Inherited from

Viewer.onBeforeDrawOverlay

---

onBeforeDrawScene

Get Signature

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

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

Fires before rendering of the main canvas.

Returns

Observable<EventData<any>>

Inherited from

Viewer.onBeforeDrawScene

---

onContextMenu

Get Signature

get onContextMenu(): Observable<Menu>

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

Returns

Observable<Menu>

Inherited from

Viewer.onContextMenu

---

onCorrCellClicked

Get Signature

get onCorrCellClicked(): Observable<EventData<CorrPlotCellArgs>>

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

Returns

Observable<EventData<CorrPlotCellArgs>>

---

onDartPropertyChanged

Get Signature

get onDartPropertyChanged(): Observable<null>

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

Returns

Observable<null>

Inherited from

Viewer.onDartPropertyChanged

---

onDataEvent

Get Signature

get onDataEvent(): Observable<ViewerEvent>

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

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataEvent

---

onDataFrameChanged

Get Signature

get onDataFrameChanged(): Observable<any>

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

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

Returns

Observable<any>

Inherited from

Viewer.onDataFrameChanged

---

onDataRowClicked

Get Signature

get onDataRowClicked(): Observable<ViewerEvent>

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

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataRowClicked

---

onDataSelected

Get Signature

get onDataSelected(): Observable<ViewerEvent>

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

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataSelected

---

onDetached

Get Signature

get onDetached(): Observable<any>

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

Occurs when viewer is detached.

Returns

Observable<any>

Inherited from

Viewer.onDetached

---

onPropertyValueChanged

Get Signature

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

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

Returns

Observable<EventData<Property>>

Inherited from

Viewer.onPropertyValueChanged

---

onResized

Get Signature

get onResized(): Observable<null>

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

Fires when the viewer is resized.

Returns

Observable<null>

Inherited from

Viewer.onResized

---

onTooltipCreated

Get Signature

get onTooltipCreated(): Observable<ViewerEvent>

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

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onTooltipCreated

---

onViewerRendered

Get Signature

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

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

Fires after the viewer is rendered.

Returns

Observable<EventData<any>>

Inherited from

Viewer.onViewerRendered

---

parent

Get Signature

get parent(): Widget<any> | null

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

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

Viewer.parent

---

root

Get Signature

get root(): HTMLElement

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

Visual root.

Returns

HTMLElement

Inherited from

Viewer.root

---

table

Get Signature

get table(): DataFrame

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

Returns

DataFrame

Inherited from

Viewer.table

---

tableView

Get Signature

get tableView(): TableView | null

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

Returns a view this viewer is associated with, or null

Returns

TableView | null

Inherited from

Viewer.tableView

---

type

Get Signature

get type(): string

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

Returns viewer type (see VIEWER constants)

Returns

string

Inherited from

Viewer.type

---

view

Get Signature

get view(): View | null

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

Returns a view this viewer is associated with, or null

Returns

View | null

Inherited from

Viewer.view

Methods

apply()

apply(properties): Widget

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

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

Viewer.apply

---

close()

close(): void

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

Closes and detaches the viewer.

Returns

void

Inherited from

Viewer.close

---

copyViewersLook()

copyViewersLook(other): void

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

Parameters

Parameter	Type
other	Viewer

Returns

void

Inherited from

Viewer.copyViewersLook

---

detach()

detach(): void

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

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

Viewer.detach

---

getCorrelation()

getCorrelation(c1, c2): number

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

Correlation coefficient between columns [c1] and [c2], honoring the viewer's correlationType (Pearson/Spearman) and combined row filter.

Parameters

Parameter	Type
c1	Column
c2	Column

Returns

number

---

getDartProperties()

getDartProperties(): any[]

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

Returns

any[]

Inherited from

Viewer.getDartProperties

---

getFunctions()

getFunctions(): Func[]

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

Functions applicable to the underlying Dart viewer.

Returns

Func[]

Inherited from

Viewer.getFunctions

---

getInfo()

getInfo(): object

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

Returns

object

Inherited from

Viewer.getInfo

---

getOptions()

getOptions(includeDefaults?): object

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

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

Inherited from

Viewer.getOptions

---

getProperties()

getProperties(): Property[]

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

Returns all properties of this widget.

Returns

Property[]

Inherited from

Viewer.getProperties

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

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

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

Returns

IWidgetStatus

Inherited from

Viewer.getWidgetStatus

---

initDartObject()

initDartObject(dart): void

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

Parameters

Parameter	Type
dart	any

Returns

void

Inherited from

Viewer.initDartObject

---

onEvent()

onEvent(eventId?): Observable<any>

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

Observes platform events with the specified eventId.

Parameters

Parameter	Type	Default value
eventId	string | null	null

Returns

Observable<any>

Inherited from

Viewer.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

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

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Viewer.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

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

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

Viewer.onPropertyChanged

---

removeFromView()

removeFromView(): any

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

Returns

any

Inherited from

Viewer.removeFromView

---

setOptions()

setOptions(map): void

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

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

Inherited from

Viewer.setOptions

---

sourceRowsChanged()

sourceRowsChanged(): void

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

Returns

void

Inherited from

Viewer.sourceRowsChanged

---

sub()

sub(subscription): void

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

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

Viewer.sub

---

toCompactLook()

toCompactLook(): void

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

Returns

void

Inherited from

Viewer.toCompactLook

---

toDart()

toDart(): any

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

Returns

any

Inherited from

Viewer.toDart

---

barChart()

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

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IBarChartSettings>

Returns

Viewer<IBarChartSettings>

Inherited from

Viewer.barChart

---

boxPlot()

static boxPlot(t, options?): BoxPlot

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IBoxPlotSettings>

Returns

BoxPlot

Inherited from

Viewer.boxPlot

---

calendar()

static calendar(t, options?): CalendarViewer

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ICalendarSettings>

Returns

CalendarViewer

Inherited from

Viewer.calendar

---

canVisualize()

static canVisualize(viewerType, dataFrame): string | null

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

Parameters

Parameter	Type
viewerType	string
dataFrame	DataFrame

Returns

string | null

Inherited from

Viewer.canVisualize

---

confusionMatrix()

static confusionMatrix(t, options?): ConfusionMatrix

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IConfusionMatrixSettings>

Returns

ConfusionMatrix

Inherited from

Viewer.confusionMatrix

---

correlationPlot()

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

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ICorrelationPlotSettings>

Returns

Viewer<ICorrelationPlotSettings>

Inherited from

Viewer.correlationPlot

---

densityPlot()

static densityPlot(t, options?): DensityPlotViewer

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IDensityPlotSettings>

Returns

DensityPlotViewer

Inherited from

Viewer.densityPlot

---

filters()

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

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IFiltersSettings>

Returns

Viewer<IFiltersSettings>

Inherited from

Viewer.filters

---

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

Viewer.find

---

form()

static form(t, options?): FormViewer

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IFormSettings>

Returns

FormViewer

Inherited from

Viewer.form

---

fromRoot()

static fromRoot(root): Widget

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

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

Viewer.fromRoot

---

fromType()

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

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

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

Inherited from

Viewer.fromType

---

getAll()

static getAll(): Widget<any>[]

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

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Viewer.getAll

---

getViewerTypes()

static getViewerTypes(options?): string[]

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

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[]

Inherited from

Viewer.getViewerTypes

---

grid()

static grid(t, options?): Grid

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IGridSettings>

Returns

Grid

Inherited from

Viewer.grid

---

heatMap()

static heatMap(t, options?): Grid

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IGridSettings>

Returns

Grid

Inherited from

Viewer.heatMap

---

histogram()

static histogram(t, options?): HistogramViewer

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IHistogramSettings>

Returns

HistogramViewer

Inherited from

Viewer.histogram

---

lineChart()

static lineChart(t, options?): LineChartViewer

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ILineChartSettings>

Returns

LineChartViewer

Inherited from

Viewer.lineChart

---

markup()

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

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IMarkupViewerSettings>

Returns

Viewer<IMarkupViewerSettings>

Inherited from

Viewer.markup

---

matrixPlot()

static matrixPlot(t, options?): MatrixPlot

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IMatrixPlotSettings>

Returns

MatrixPlot

Inherited from

Viewer.matrixPlot

---

network()

static network(t, options?): NetworkDiagramViewer

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<INetworkDiagramSettings>

Returns

NetworkDiagramViewer

Inherited from

Viewer.network

---

pcPlot()

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

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPcPlotSettings>

Returns

Viewer<IPcPlotSettings>

Inherited from

Viewer.pcPlot

---

pieChart()

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

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPieChartSettings>

Returns

Viewer<IPieChartSettings>

Inherited from

Viewer.pieChart

---

registerCleanup()

static registerCleanup(element, cleanup): void

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

Registers a cleanup function to run when [element] is killed — i.e. when its host view or pane closes. Also marks the element so the kill-walk can find it.

Parameters

Parameter	Type
element	Element
cleanup	Function

Returns

void

Inherited from

Viewer.registerCleanup

---

rocCurve()

static rocCurve(t, options?): RocCurve

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IRocCurveSettings>

Returns

RocCurve

Inherited from

Viewer.rocCurve

---

scatterPlot()

static scatterPlot(t, options?): ScatterPlotViewer

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IScatterPlotSettings>

Returns

ScatterPlotViewer

Inherited from

Viewer.scatterPlot

---

scatterPlot3d()

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

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IScatterPlot3dSettings>

Returns

Viewer<IScatterPlot3dSettings>

Inherited from

Viewer.scatterPlot3d

---

statistics()

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

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IStatsViewerSettings>

Returns

Viewer<IStatsViewerSettings>

Inherited from

Viewer.statistics

---

tile()

static tile(t, options?): TileViewer

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITileViewerSettings>

Returns

TileViewer

Inherited from

Viewer.tile

---

treeMap()

static treeMap(t, options?): TreeMap

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITreeMapSettings>

Returns

TreeMap

Inherited from

Viewer.treeMap

---

trellisPlot()

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

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITrellisPlotSettings>

Returns

Viewer<ITrellisPlotSettings>

Inherited from

Viewer.trellisPlot

---

wordCloud()

static wordCloud(t, options?): Viewer

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

Parameters

Parameter	Type
t	DataFrame
options?	any

Returns

Viewer

Deprecated

Inherited from

Viewer.wordCloud