JsViewer

Defined in: src/viewer.ts:379

Subclass JsViewer to implement a DataFrame-bound Datagrok viewer in JavaScript. See an example on github: https://github.com/datagrok-ai/labs/tree/master/packages/Leaflet

Extends

• Viewer

Constructors

Constructor

new JsViewer(): JsViewer

Defined in: src/viewer.ts:389

Returns

JsViewer

Constructs

JsViewer

Overrides

Viewer.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
_functions	protected	Func[]	[]	-	-	Viewer._functions	src/widgets/base.ts:243
_properties	protected	Property[]	[]	-	-	Viewer._properties	src/widgets/base.ts:242
_root	protected	HTMLElement	undefined	-	-	Viewer._root	src/widgets/base.ts:241
dart	public	any	undefined	-	Viewer.dart	-	src/viewer.ts:380
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	-	Viewer.factory	src/widgets/base.ts:239
formulaFilter	public	string | undefined	undefined	-	-	-	src/viewer.ts:386
isDetached	public	boolean	false	-	-	Viewer.isDetached	src/widgets/base.ts:247
obs	public	Observable<any>[]	undefined	-	-	-	src/viewer.ts:383
props	public	ObjectPropertyBag	undefined	-	Viewer.props	-	src/viewer.ts:384
rowSource	public	string | undefined	undefined	-	-	-	src/viewer.ts:385
subs	public	Subscription[]	undefined	-	Viewer.subs	-	src/viewer.ts:382
tags	public	any	undefined	-	-	Viewer.tags	src/viewer.ts:82
temp	public	any	undefined	Contains auxiliary information	-	Viewer.temp	src/widgets/base.ts:236
CORE_VIEWER_TYPES	static	string[]	undefined	-	-	Viewer.CORE_VIEWER_TYPES	src/viewer.ts:363

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

Viewer.children

---

dataFrame

Get Signature

get dataFrame(): DataFrame

Defined in: src/viewer.ts:208

Returns

DataFrame

Set Signature

set dataFrame(t): void

Defined in: src/viewer.ts:209

Parameters

Parameter	Type
t	DataFrame

Returns

void

Inherited from

Viewer.dataFrame

---

descriptor

Get Signature

get descriptor(): WidgetDescriptor

Defined in: src/viewer.ts:100

Descriptor of this widget.

Returns

WidgetDescriptor

Inherited from

Viewer.descriptor

---

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

Inherited from

TrellisPlotViewer.filter

---

helpUrl

Get Signature

get helpUrl(): string

Defined in: src/viewer.ts:212

Help URL

Returns

string

Set Signature

set helpUrl(s): void

Defined in: src/viewer.ts:213

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

Viewer.helpUrl

---

meta

Get Signature

get meta(): ViewerMetaHelper

Defined in: src/viewer.ts:181

Returns

ViewerMetaHelper

Inherited from

Viewer.meta

---

onContextMenu

Get Signature

get onContextMenu(): Observable<Menu>

Defined in: src/viewer.ts:308

Returns

Observable<Menu>

Inherited from

Viewer.onContextMenu

---

onDartPropertyChanged

Get Signature

get onDartPropertyChanged(): Observable<null>

Defined in: src/viewer.ts:334

Returns

Observable<null>

Inherited from

Viewer.onDartPropertyChanged

---

onDataEvent

Get Signature

get onDataEvent(): Observable<ViewerEvent>

Defined in: src/viewer.ts:105

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataEvent

---

onDataRowClicked

Get Signature

get onDataRowClicked(): Observable<ViewerEvent>

Defined in: src/viewer.ts:109

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataRowClicked

---

onDataSelected

Get Signature

get onDataSelected(): Observable<ViewerEvent>

Defined in: src/viewer.ts:107

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataSelected

---

onDetached

Get Signature

get onDetached(): Observable<any>

Defined in: src/viewer.ts:349

Occurs when viewer is detached.

Returns

Observable<any>

Inherited from

Viewer.onDetached

---

onPropertyValueChanged

Get Signature

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

Defined in: src/viewer.ts:110

Returns

Observable<EventData<Property>>

Inherited from

Viewer.onPropertyValueChanged

---

onTooltipCreated

Get Signature

get onTooltipCreated(): Observable<ViewerEvent>

Defined in: src/viewer.ts:106

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onTooltipCreated

---

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

Viewer.parent

---

root

Get Signature

get root(): HTMLElement

Defined in: src/viewer.ts:423

Visual root.

Returns

HTMLElement

Set Signature

set root(r): void

Defined in: src/viewer.ts:424

Visual root.

Parameters

Parameter	Type
r	HTMLElement

Returns

void

Overrides

Viewer.root

---

table

Get Signature

get table(): DataFrame

Defined in: src/viewer.ts:193

Returns

DataFrame

Inherited from

Viewer.table

---

tableView

Get Signature

get tableView(): TableView | null

Defined in: src/viewer.ts:203

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: src/viewer.ts:189

Returns viewer type (see VIEWER constants)

Returns

string

Inherited from

Viewer.type

---

view

Get Signature

get view(): View | null

Defined in: src/viewer.ts:198

Returns a view this viewer is associated with, or null

Returns

View | null

Inherited from

Viewer.view

Methods

_obs()

protected _obs(observable): Observable<any>

Defined in: src/viewer.ts:450

Parameters

Parameter	Type
observable	Observable<any>

Returns

Observable<any>

---

addRowSourceAndFormula()

addRowSourceAndFormula(): void

Defined in: src/viewer.ts:406

Returns

void

---

apply()

apply(properties): Widget

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

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

Viewer.apply

---

bool()

protected bool(propertyName, defaultValue?, options?): boolean

Defined in: src/viewer.ts:492

Registers a boolean property with the specified name and defaultValue

Parameters

Parameter	Type	Default value
propertyName	string	undefined
defaultValue	boolean | null	null
options	object & IProperty | null	null

Returns

boolean

---

choices()

protected choices<T>(propertyname, defaultValue, choices, options?): T

Defined in: src/viewer.ts:480

Type Parameters

Type Parameter
T extends string

Parameters

Parameter	Type	Default value
propertyname	string	undefined
defaultValue	T	undefined
choices	T[]	undefined
options	object & IProperty | null	null

Returns

T

---

close()

close(): void

Defined in: src/viewer.ts:171

Closes and detaches the viewer.

Returns

void

Inherited from

Viewer.close

---

column()

protected column(dataPropertyName, options?): string

Defined in: src/viewer.ts:457

Returns the column bound to the specified data property. Note that "ColumnName" suffix (this determines whether this is a data property) should be omitted.

Parameters

Parameter	Type	Default value
dataPropertyName	string	undefined
options	object & IProperty | null	null

Returns

string

---

columnList()

protected columnList(propertyName, defaultValue?, options?): string[]

Defined in: src/viewer.ts:461

Parameters

Parameter	Type	Default value
propertyName	string	undefined
defaultValue	string[] | null	null
options	object & IProperty | null	null

Returns

string[]

---

copyViewersLook()

copyViewersLook(other): void

Defined in: src/viewer.ts:351

Parameters

Parameter	Type
other	Viewer

Returns

void

Inherited from

Viewer.copyViewersLook

---

dateTime()

protected dateTime(propertyName, defaultValue?, options?): Dayjs

Defined in: src/viewer.ts:497

Registers a datetime property with the specified name and defaultValue

Parameters

Parameter	Type	Default value
propertyName	string	undefined
defaultValue	Dayjs | null	null
options	object & IProperty | null	null

Returns

Dayjs

---

detach()

detach(): void

Defined in: src/viewer.ts:430

Gets called when this viewer is detached.

Returns

void

Overrides

Viewer.detach

---

float()

protected float(propertyName, defaultValue?, options?): number

Defined in: src/viewer.ts:471

Registers a floating point property with the specified name and defaultValue

Parameters

Parameter	Type	Default value
propertyName	string	undefined
defaultValue	number | null	null
options	object & IProperty | null	null

Returns

number

---

getDartProperties()

getDartProperties(): any[]

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

Returns

any[]

Inherited from

Viewer.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

Viewer.getFunctions

---

getInfo()

getInfo(): object

Defined in: src/viewer.ts:162

Returns

object

Inherited from

Viewer.getInfo

---

getOptions()

getOptions(includeDefaults?): object

Defined in: src/viewer.ts:158

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

Inherited from

Viewer.getOptions

---

getProperties()

getProperties(): Property[]

Defined in: src/viewer.ts:441

Returns all properties of this widget.

Returns

Property[]

Overrides

Viewer.getProperties

---

getProperty()

getProperty(name): Property | undefined

Defined in: src/viewer.ts:437

Gets property by name (case-sensitive).

Parameters

Parameter	Type	Description
name	string	-

Returns

Property | undefined

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: src/viewer.ts:103

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

Returns

IWidgetStatus

Inherited from

Viewer.getWidgetStatus

---

initDartObject()

initDartObject(dart): void

Defined in: src/viewer.ts:112

Parameters

Parameter	Type
dart	any

Returns

void

Inherited from

Viewer.initDartObject

---

int()

protected int(propertyName, defaultValue?, options?): number

Defined in: src/viewer.ts:466

Registers an integer property with the specified name and defaultValue

Parameters

Parameter	Type	Default value
propertyName	string	undefined
defaultValue	number | null	null
options	object & IProperty | null	null

Returns

number

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: src/viewer.ts:313

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: src/viewer.ts:412

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Overrides

Viewer.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

Viewer.onPropertyChanged

---

onSourceRowsChanged()

onSourceRowsChanged(): void

Defined in: src/viewer.ts:421

Returns

void

---

onTableAttached()

onTableAttached(): void

Defined in: src/viewer.ts:427

Gets called when a table is attached to the viewer.

Returns

void

---

registerCleanup()

protected registerCleanup(cleanup): void

Defined in: src/viewer.ts:446

cleanup() will get called when the viewer is disposed

Parameters

Parameter	Type
cleanup	Function

Returns

void

---

removeFromView()

removeFromView(): any

Defined in: src/viewer.ts:355

Returns

any

Inherited from

Viewer.removeFromView

---

setOptions()

setOptions(map): void

Defined in: src/viewer.ts:146

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: src/viewer.ts:416

Returns

void

Overrides

Viewer.sourceRowsChanged

---

string()

protected string(propertyName, defaultValue?, options?): string

Defined in: src/viewer.ts:476

Registers a string property with the specified name and defaultValue

Parameters

Parameter	Type	Default value
propertyName	string	undefined
defaultValue	string | null	null
options	object & IProperty | null	null

Returns

string

---

stringList()

protected stringList(propertyName, defaultValue?, options?): string[]

Defined in: src/viewer.ts:487

Registers a string list property with the specified name and defaultValue

Parameters

Parameter	Type	Default value
propertyName	string	undefined
defaultValue	string[] | null	null
options	object & IProperty | null	null

Returns

string[]

---

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

Viewer.sub

---

toCompactLook()

toCompactLook(): void

Defined in: src/viewer.ts:330

Returns

void

Inherited from

Viewer.toCompactLook

---

toDart()

toDart(): any

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

Returns

any

Inherited from

Viewer.toDart

---

barChart()

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

Defined in: src/viewer.ts:223

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IBarChartSettings>

Returns

Viewer<IBarChartSettings>

Inherited from

Viewer.barChart

---

boxPlot()

static boxPlot(t, options?): BoxPlot

Defined in: src/viewer.ts:231

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IBoxPlotSettings>

Returns

BoxPlot

Inherited from

Viewer.boxPlot

---

calendar()

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

Defined in: src/viewer.ts:251

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ICalendarSettings>

Returns

Viewer<ICalendarSettings>

Inherited from

Viewer.calendar

---

canVisualize()

static canVisualize(viewerType, dataFrame): string | null

Defined in: src/viewer.ts:359

Parameters

Parameter	Type
viewerType	string
dataFrame	DataFrame

Returns

string | null

Inherited from

Viewer.canVisualize

---

correlationPlot()

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

Defined in: src/viewer.ts:255

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ICorrelationPlotSettings>

Returns

Viewer<ICorrelationPlotSettings>

Inherited from

Viewer.correlationPlot

---

densityPlot()

static densityPlot(t, options?): DensityPlotViewer

Defined in: src/viewer.ts:259

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IDensityPlotSettings>

Returns

DensityPlotViewer

Inherited from

Viewer.densityPlot

---

filters()

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

Defined in: src/viewer.ts:235

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IFiltersSettings>

Returns

Viewer<IFiltersSettings>

Inherited from

Viewer.filters

---

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

Viewer.find

---

form()

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

Defined in: src/viewer.ts:263

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IFormSettings>

Returns

Viewer<IFormSettings>

Inherited from

Viewer.form

---

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

Viewer.fromRoot

---

fromType()

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

Defined in: src/viewer.ts:128

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: src/widgets/base.ts:260

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Viewer.getAll

---

getViewerTypes()

static getViewerTypes(options?): string[]

Defined in: src/viewer.ts:135

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: src/viewer.ts:215

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IGridSettings>

Returns

Grid

Inherited from

Viewer.grid

---

heatMap()

static heatMap(t, options?): Grid

Defined in: src/viewer.ts:227

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IGridSettings>

Returns

Grid

Inherited from

Viewer.heatMap

---

histogram()

static histogram(t, options?): HistogramViewer

Defined in: src/viewer.ts:219

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IHistogramSettings>

Returns

HistogramViewer

Inherited from

Viewer.histogram

---

lineChart()

static lineChart(t, options?): LineChartViewer

Defined in: src/viewer.ts:243

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ILineChartSettings>

Returns

LineChartViewer

Inherited from

Viewer.lineChart

---

markup()

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

Defined in: src/viewer.ts:267

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IMarkupViewerSettings>

Returns

Viewer<IMarkupViewerSettings>

Inherited from

Viewer.markup

---

matrixPlot()

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

Defined in: src/viewer.ts:271

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IMatrixPlotSettings>

Returns

Viewer<IMatrixPlotSettings>

Inherited from

Viewer.matrixPlot

---

network()

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

Defined in: src/viewer.ts:247

Parameters

Parameter	Type
t	DataFrame
options?	Partial<INetworkDiagramSettings>

Returns

Viewer<INetworkDiagramSettings>

Inherited from

Viewer.network

---

pcPlot()

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

Defined in: src/viewer.ts:275

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPcPlotSettings>

Returns

Viewer<IPcPlotSettings>

Inherited from

Viewer.pcPlot

---

pieChart()

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

Defined in: src/viewer.ts:279

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPieChartSettings>

Returns

Viewer<IPieChartSettings>

Inherited from

Viewer.pieChart

---

scatterPlot()

static scatterPlot(t, options?): ScatterPlotViewer

Defined in: src/viewer.ts:239

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IScatterPlotSettings>

Returns

ScatterPlotViewer

Inherited from

Viewer.scatterPlot

---

scatterPlot3d()

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

Defined in: src/viewer.ts:283

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IScatterPlot3dSettings>

Returns

Viewer<IScatterPlot3dSettings>

Inherited from

Viewer.scatterPlot3d

---

statistics()

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

Defined in: src/viewer.ts:287

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IStatsViewerSettings>

Returns

Viewer<IStatsViewerSettings>

Inherited from

Viewer.statistics

---

tile()

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

Defined in: src/viewer.ts:291

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITileViewerSettings>

Returns

Viewer<ITileViewerSettings>

Inherited from

Viewer.tile

---

treeMap()

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

Defined in: src/viewer.ts:295

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITreeMapSettings>

Returns

Viewer<ITreeMapSettings>

Inherited from

Viewer.treeMap

---

trellisPlot()

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

Defined in: src/viewer.ts:299

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITrellisPlotSettings>

Returns

Viewer<ITrellisPlotSettings>

Inherited from

Viewer.trellisPlot

---

wordCloud()

static wordCloud(t, options?): Viewer

Defined in: src/viewer.ts:304

Parameters

Parameter	Type
t	DataFrame
options?	any

Returns

Viewer

Deprecated

Inherited from

Viewer.wordCloud