Viewer<TSettings>

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

Type parameters

Type parameter	Value
`TSettings`	`any`

Constructors

new Viewer()

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

Parameters

Parameter	Type
`dart`	`any`
`root`?	`HTMLElement`

Returns

Viewer<TSettings>

Overrides

Widget . constructor

Constructs

Viewer

Source

src/viewer.ts:83

Properties

Property	Modifier	Type	Default value	Description	Inherited from
`_filter`	`private`	`null` \| `BitSet`	`null`	-	-
`_functions`	`protected`	`Func`[]	`[]`	-	`Widget`.`_functions`
`_meta`	`private`	`undefined` \| `ViewerMetaHelper`	`undefined`	-	-
`_properties`	`protected`	`Property`[]	`[]`	-	`Widget`.`_properties`
`_root`	`protected`	`HTMLElement`	`undefined`	-	`Widget`.`_root`
`dart`	`public`	`any`	`undefined`	-	`Widget`.`dart`
`factory`	`public`	`null` \| `Func`	`null`	Constructor function. No parameters, returns [Widget].	`Widget`.`factory`
`isDetached`	`public`	`boolean`	`false`	-	`Widget`.`isDetached`
`props`	`public`	`TSettings` & `ObjectPropertyBag`	`undefined`	-	`Widget`.`props`
`subs`	`public`	`Subscription`[]	`undefined`	-	`Widget`.`subs`
`tags`	`public`	`any`	`undefined`	-	-
`temp`	`public`	`any`	`undefined`	Contains auxiliary information	`Widget`.`temp`
`CORE_VIEWER_TYPES`	`static`	`string`[]	`...`	-	-

Accessors

children

get children(): Widget<any>[]

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Source

src/widgets/base.ts:284

dataFrame

get dataFrame(): DataFrame

set dataFrame(t): void

Parameters

Parameter	Type
`t`	`DataFrame`

Returns

DataFrame

Source

src/viewer.ts:202

descriptor

get descriptor(): WidgetDescriptor

Descriptor of this widget.

Returns

WidgetDescriptor

Source

src/viewer.ts:97

filter

get filter(): BitSet

combined filter of the viewer

set filter(f): void

Parameters

Parameter	Type
`f`	`BitSet`

Returns

BitSet

Source

src/viewer.ts:90

helpUrl

get helpUrl(): string

Help URL

set helpUrl(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/viewer.ts:206

onContextMenu

get onContextMenu(): Observable <Menu>

Returns

Observable <Menu>

Source

src/viewer.ts:302

onDartPropertyChanged

get onDartPropertyChanged(): Observable<null>

Returns

Observable<null>

Source

src/viewer.ts:328

onDataEvent

get onDataEvent(): Observable <ViewerEvent>

Returns

Observable <ViewerEvent>

Source

src/viewer.ts:99

onDataRowClicked

get onDataRowClicked(): Observable <ViewerEvent>

Returns

Observable <ViewerEvent>

Source

src/viewer.ts:103

onDataSelected

get onDataSelected(): Observable <ViewerEvent>

Returns

Observable <ViewerEvent>

Source

src/viewer.ts:101

onDetached

get onDetached(): Observable<any>

Occurs when viewer is detached.

Returns

Observable<any>

Source

src/viewer.ts:343

onPropertyValueChanged

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

Returns

Observable <EventData <Property>>

Source

src/viewer.ts:104

onTooltipCreated

get onTooltipCreated(): Observable <ViewerEvent>

Returns

Observable <ViewerEvent>

Source

src/viewer.ts:100

parent

get parent(): null | Widget<any>

Parent widget up the DOM tree, or null.

Returns

null | Widget<any>

Source

src/widgets/base.ts:281

root

get root(): HTMLElement

Visual root.

Returns

HTMLElement

Source

src/viewer.ts:171

table

get table(): DataFrame

Returns

DataFrame

Source

src/viewer.ts:187

tableView

get tableView(): null | TableView

Returns a view this viewer is associated with, or null

Returns

null | TableView

Source

src/viewer.ts:197

type

get type(): string

Returns viewer type (see VIEWER constants)

Returns

string

Source

src/viewer.ts:183

view

get view(): null | View

Returns a view this viewer is associated with, or null

Returns

null | View

Source

src/viewer.ts:192

Methods

addProperty()

private addProperty(propertyName, propertyType, defaultValue, options): any

Registers an property with the specified type, name, and defaultValue.

Parameters

Parameter	Type	Default value
`propertyName`	`string`	`undefined`
`propertyType`	`"string"` \| `"bigint"` \| `"object"` \| `"map"` \| `"file"` \| `"view"` \| `"blob"` \| `"int"` \| `"double"` \| `"bool"` \| `"byte_array"` \| `"datetime"` \| `"qnum"` \| `"dataframe"` \| `"num"` \| `"string_list"` \| `"dataframe_list"` \| `"cell"` \| `"column"` \| `"column_list"` \| `"graphics"` \| `"tablerowfiltercall"` \| `"colfiltercall"` \| `"bitset"` \| `"dynamic"` \| `"viewer"` \| `"list"` \| `"semantic_value"` \| `"func"` \| `"funccall"` \| `"property"` \| `"categorical"` \| `"numerical"` \| `"GridCellRenderArgs"` \| `"element"` \| `"TableView"` \| `"User"` \| `"Menu"` \| `"Project"` \| `"event_data"` \| `"progressindicator"` \| `"Credentials"` \| `"ScriptEnvironment"` \| `"Notebook"`	`undefined`
`defaultValue`	`any`	`null`
`options`	`null` \| `object` & `IProperty`	`null`

Returns

any

Inherited from

Widget . addProperty

See

Registered property gets added to properties. Returns default value, thus allowing to combine registering a property with the initialization

Source

src/widgets/base.ts:309

apply()

apply(properties): Widget<any>

Parameters

Parameter	Type	Description
`properties`	`object`

close()

close(): void

Closes and detaches the viewer.

Returns

void

Source

src/viewer.ts:165

copyViewersLook()

copyViewersLook(other): void

Parameters

Parameter	Type
`other`	`Viewer`<`any`>

Returns

void

Source

src/viewer.ts:345

detach()

detach(): void

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

Source

src/widgets/base.ts:293

getDartProperties()

getDartProperties(): any[]

Returns

any[]

Inherited from

Widget . getDartProperties

Source

src/widgets/base.ts:269

getFunctions()

getFunctions(): Func[]

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

Source

src/widgets/base.ts:263

getInfo()

getInfo(): object

Returns

object

Source

src/viewer.ts:156

getOptions()

getOptions(includeDefaults): object

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.

Parameters

Parameter	Type	Default value
`includeDefaults`	`boolean`	`false`

Returns

object

Member	Type
`id`	`string`
`look`	`object`
`type`	`string`

Source

src/viewer.ts:152

getProperties()

getProperties(): Property[]

Returns all properties of this widget.

Returns

Property[]

Overrides

Widget . getProperties

Source

src/viewer.ts:160

initDartObject()

initDartObject(dart): void

Parameters

Parameter	Type
`dart`	`any`

Returns

void

Source

src/viewer.ts:106

onEvent()

onEvent(eventId): Observable<any>

Observes platform events with the specified eventId.

Parameters

Parameter	Type	Default value
`eventId`	`null` \| `string`	`null`

Returns

Observable<any>

Source

src/viewer.ts:307

onFrameAttached()

onFrameAttached(dataFrame): void

Parameters

Parameter	Type
`dataFrame`	`DataFrame`

Returns

void

Inherited from

Widget . onFrameAttached

Source

src/widgets/base.ts:275

onPropertyChanged()

onPropertyChanged(property): void

Gets called when viewer's property is changed.

Parameters

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

Returns

void

Inherited from

Widget . onPropertyChanged

Source

src/widgets/base.ts:267

removeFromView()

removeFromView(): any

Returns

any

Source

src/viewer.ts:349

setOptions()

setOptions(map): void

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

Parameters

Parameter	Type	Description
`map`	`object`
`map.type`?	`string`	-

Returns

void

Source

src/viewer.ts:140

sourceRowsChanged()

sourceRowsChanged(): void

Returns

void

Inherited from

Widget . sourceRowsChanged

Source

src/widgets/base.ts:273

sub()

sub(subscription): void

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
`subscription`	`Subscription`

Returns

void

Inherited from

Widget . sub

Source

src/widgets/base.ts:241

toCompactLook()

toCompactLook(): void

Returns

void

Source

src/viewer.ts:324

toDart()

toDart(): any

Returns

any

Inherited from

Widget . toDart

Source

src/widgets/base.ts:233

barChart()

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

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IBarChartSettings`>

Returns

Viewer <IBarChartSettings>

Source

src/viewer.ts:217

boxPlot()

static boxPlot(t, options?): BoxPlot

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IBoxPlotSettings`>

Returns

BoxPlot

Source

src/viewer.ts:225

calendar()

static calendar(t, options?): Viewer <ICalendarSettings>

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`ICalendarSettings`>

Returns

Viewer <ICalendarSettings>

Source

src/viewer.ts:245

canVisualize()

static canVisualize(viewerType, dataFrame): null | string

Parameters

Parameter	Type
`viewerType`	`string`
`dataFrame`	`DataFrame`

Returns

null | string

Source

src/viewer.ts:353

correlationPlot()

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

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`ICorrelationPlotSettings`>

Returns

Viewer <ICorrelationPlotSettings>

Source

src/viewer.ts:249

densityPlot()

static densityPlot(t, options?): Viewer <IDensityPlotSettings>

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IDensityPlotSettings`>

Returns

Viewer <IDensityPlotSettings>

Source

src/viewer.ts:253

filters()

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

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IFiltersSettings`>

Returns

Viewer <IFiltersSettings>

Source

src/viewer.ts:229

find()

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
`root`	`Element`

Returns

null | Widget<any>

Inherited from

Widget . find

Source

src/widgets/base.ts:229

form()

static form(t, options?): Viewer <IFormSettings>

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IFormSettings`>

Returns

Viewer <IFormSettings>

Source

src/viewer.ts:257

fromRoot()

static fromRoot(root): Widget<any>

Creates a new widget from the root element.

Parameters

Parameter	Type
`root`	`HTMLElement`

Returns

Widget<any>

Inherited from

Widget . fromRoot

Source

src/widgets/base.ts:332

fromType()

static fromType(viewerType, table, options): Viewer<any>

Creates a new viewer of the specified type.

Parameters

Parameter	Type	Default value
`viewerType`	`string`	`undefined`
`table`	`DataFrame`	`undefined`
`options`	`null` \| `object`	`null`

Returns

Viewer<any>

Source

src/viewer.ts:122

getAll()

static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget . getAll

Source

src/widgets/base.ts:224

getViewerTypes()

static getViewerTypes(options?): string[]

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

Parameters

Parameter	Type
`options`?	`object`
`options.core`?	`boolean`

Returns

string[]

Source

src/viewer.ts:129

grid()

static grid(t, options?): Grid

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IGridSettings`>

Returns

Grid

Source

src/viewer.ts:209

heatMap()

static heatMap(t, options?): Grid

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IGridSettings`>

Returns

Grid

Source

src/viewer.ts:221

histogram()

static histogram(t, options?): HistogramViewer

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IHistogramSettings`>

Returns

HistogramViewer

Source

src/viewer.ts:213

lineChart()

static lineChart(t, options?): LineChartViewer

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`ILineChartSettings`>

Returns

LineChartViewer

Source

src/viewer.ts:237

markup()

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

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IMarkupViewerSettings`>

Returns

Viewer <IMarkupViewerSettings>

Source

src/viewer.ts:261

matrixPlot()

static matrixPlot(t, options?): Viewer <IMatrixPlotSettings>

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IMatrixPlotSettings`>

Returns

Viewer <IMatrixPlotSettings>

Source

src/viewer.ts:265

network()

static network(t, options?): Viewer <INetworkDiagramSettings>

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`INetworkDiagramSettings`>

Returns

Viewer <INetworkDiagramSettings>

Source

src/viewer.ts:241

pcPlot()

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

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IPcPlotSettings`>

Returns

Viewer <IPcPlotSettings>

Source

src/viewer.ts:269

pieChart()

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

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IPieChartSettings`>

Returns

Viewer <IPieChartSettings>

Source

src/viewer.ts:273

scatterPlot()

static scatterPlot(t, options?): ScatterPlotViewer

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IScatterPlotSettings`>

Returns

ScatterPlotViewer

Source

src/viewer.ts:233

scatterPlot3d()

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

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IScatterPlot3dSettings`>

Returns

Viewer <IScatterPlot3dSettings>

Source

src/viewer.ts:277

statistics()

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

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`IStatsViewerSettings`>

Returns

Viewer <IStatsViewerSettings>

Source

src/viewer.ts:281

tile()

static tile(t, options?): Viewer <ITileViewerSettings>

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`ITileViewerSettings`>

Returns

Viewer <ITileViewerSettings>

Source

src/viewer.ts:285

treeMap()

static treeMap(t, options?): Viewer <ITreeMapSettings>

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`ITreeMapSettings`>

Returns

Viewer <ITreeMapSettings>

Source

src/viewer.ts:289

trellisPlot()

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

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`Partial` <`ITrellisPlotSettings`>

Returns

Viewer <ITrellisPlotSettings>

Source

src/viewer.ts:293

wordCloud()

static wordCloud(t, options?): Viewer<any>

Parameters

Parameter	Type
`t`	`DataFrame`
`options`?	`any`

Returns

Viewer<any>

Deprecated

Source

src/viewer.ts:298

Viewer<TSettings>

See​

Example​

Extends​

Extended by​

Type parameters​

Constructors​

new Viewer()​

Parameters​

Returns​

Overrides​

Constructs​

Source​

Properties​

Accessors​

children​

Returns​

Source​

dataFrame​

Parameters​

Returns​

Source​

descriptor​

Returns​

Source​

filter​

Parameters​

Returns​

Source​

helpUrl​

Parameters​

Returns​

Source​

meta​

Returns​

Source​

onContextMenu​

Returns​

Source​

onDartPropertyChanged​

Returns​

Source​

onDataEvent​

Returns​

Source​

onDataRowClicked​

Returns​

Source​

onDataSelected​

Returns​

Source​

onDetached​

Returns​

Source​

onPropertyValueChanged​

Returns​

Source​

onTooltipCreated​

Returns​

Source​

parent​

Returns​

Source​

root​

Returns​

Source​

table​

Returns​

Source​

tableView​

Returns​

Source​

type​

Returns​

Source​

view​

Returns​

Source​

Methods​

addProperty()​

See

Example

Extends

Extended by

Type parameters

Constructors

new Viewer()

Parameters

Returns

Overrides

Constructs

Source

Properties

Accessors

children

Returns

Source

dataFrame

Parameters

Returns

Source

descriptor

Returns

Source

filter

Parameters

Returns

Source

helpUrl

Parameters

Returns

Source

meta

Returns

Source

onContextMenu

Returns

Source

onDartPropertyChanged

Returns

Source

onDataEvent

Returns

Source

onDataRowClicked

Returns

Source

onDataSelected

Returns

Source

onDetached

Returns

Source

onPropertyValueChanged

Returns

Source

onTooltipCreated

Returns

Source

parent

Returns

Source

root

Returns

Source

table

Returns

Source

tableView

Returns

Source

type

Returns

Source

view

Returns

Source

Methods

addProperty()

Parameters