Skip to main content

JsViewer

Defined in: src/viewer.ts:404

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

Constructors

Constructor

new JsViewer(): JsViewer

Defined in: src/viewer.ts:414

Returns

JsViewer

Constructs

JsViewer

Overrides

Viewer.constructor

Properties

PropertyModifierTypeDefault valueDescriptionOverridesInherited fromDefined in
_functionsprotectedFunc[][]--Viewer._functionssrc/widgets/base.ts:243
_propertiesprotectedProperty[][]--Viewer._propertiessrc/widgets/base.ts:242
_rootprotectedHTMLElementundefined--Viewer._rootsrc/widgets/base.ts:241
dartpublicanyundefined-Viewer.dart-src/viewer.ts:405
factorypublicFunc | nullnullConstructor function. No parameters, returns [Widget].-Viewer.factorysrc/widgets/base.ts:239
formulaFilterpublicstring | undefinedundefined---src/viewer.ts:411
isDetachedpublicbooleanfalse--Viewer.isDetachedsrc/widgets/base.ts:247
obspublicObservable<any>[]undefined---src/viewer.ts:408
propspublicObjectPropertyBagundefined-Viewer.props-src/viewer.ts:409
rowSourcepublicstring | undefinedundefined---src/viewer.ts:410
subspublicSubscription[]undefined-Viewer.subs-src/viewer.ts:407
tagspublicanyundefined--Viewer.tagssrc/viewer.ts:82
temppublicanyundefinedContains auxiliary information-Viewer.tempsrc/widgets/base.ts:236
CORE_VIEWER_TYPESstaticstring[]undefined--Viewer.CORE_VIEWER_TYPESsrc/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

Viewer.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
ParameterType
tDataFrame
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
ParameterType
fBitSet
Returns

void

Inherited from

TrellisPlotViewer.filter


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
ParameterType
sstring
Returns

void

Inherited from

Viewer.helpUrl


meta

Get Signature

get meta(): ViewerMetaHelper

Defined in: src/viewer.ts:198

Returns

ViewerMetaHelper

Inherited from

Viewer.meta


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

Inherited from

Viewer.onAfterDrawOverlay


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

Inherited from

Viewer.onAfterDrawScene


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

Inherited from

Viewer.onAfterLayout


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

Inherited from

Viewer.onBeforeDrawOverlay


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

Inherited from

Viewer.onBeforeDrawScene


onContextMenu

Get Signature

get onContextMenu(): Observable<Menu>

Defined in: src/viewer.ts:333

Returns

Observable<Menu>

Inherited from

Viewer.onContextMenu


onDartPropertyChanged

Get Signature

get onDartPropertyChanged(): Observable<null>

Defined in: src/viewer.ts:359

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


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>

Inherited from

Viewer.onDataFrameChanged


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:374

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


onResized

Get Signature

get onResized(): Observable<null>

Defined in: src/viewer.ts:115

Fires when the viewer is resized.

Returns

Observable<null>

Inherited from

Viewer.onResized


onTooltipCreated

Get Signature

get onTooltipCreated(): Observable<ViewerEvent>

Defined in: src/viewer.ts:106

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onTooltipCreated


onViewerRendered

Get Signature

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

Defined in: src/viewer.ts:127

Fires after the viewer is rendered.

Returns

Observable<EventData<any>>

Inherited from

Viewer.onViewerRendered


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:448

Visual root.

Returns

HTMLElement

Set Signature

set root(r): void

Defined in: src/viewer.ts:449

Visual root.

Parameters
ParameterType
rHTMLElement
Returns

void

Overrides

Viewer.root


table

Get Signature

get table(): DataFrame

Defined in: src/viewer.ts:210

Returns

DataFrame

Inherited from

Viewer.table


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

Inherited from

Viewer.tableView


type

Get Signature

get type(): string

Defined in: src/viewer.ts:206

Returns viewer type (see VIEWER constants)

Returns

string

Inherited from

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

Inherited from

Viewer.view

Methods

_obs()

protected _obs(observable): Observable<any>

Defined in: src/viewer.ts:475

Parameters

ParameterType
observableObservable<any>

Returns

Observable<any>


addRowSourceAndFormula()

addRowSourceAndFormula(): void

Defined in: src/viewer.ts:431

Returns

void


apply()

apply(properties): Widget

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

Parameters

ParameterTypeDescription
propertiesobject-

Returns

Widget

Inherited from

Viewer.apply


bool()

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

Defined in: src/viewer.ts:517

Registers a boolean property with the specified name and defaultValue

Parameters

ParameterTypeDefault value
propertyNamestringundefined
defaultValueboolean | nullnull
optionsobject & IProperty | nullnull

Returns

boolean


choices()

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

Defined in: src/viewer.ts:505

Type Parameters

Type Parameter
T extends string

Parameters

ParameterTypeDefault value
propertynamestringundefined
defaultValueTundefined
choicesT[]undefined
optionsobject & IProperty | nullnull

Returns

T


close()

close(): void

Defined in: src/viewer.ts:188

Closes and detaches the viewer.

Returns

void

Inherited from

Viewer.close


column()

protected column(dataPropertyName, options?): string

Defined in: src/viewer.ts:482

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

ParameterTypeDefault value
dataPropertyNamestringundefined
optionsobject & IProperty | nullnull

Returns

string


columnList()

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

Defined in: src/viewer.ts:486

Parameters

ParameterTypeDefault value
propertyNamestringundefined
defaultValuestring[] | nullnull
optionsobject & IProperty | nullnull

Returns

string[]


copyViewersLook()

copyViewersLook(other): void

Defined in: src/viewer.ts:376

Parameters

ParameterType
otherViewer

Returns

void

Inherited from

Viewer.copyViewersLook


dateTime()

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

Defined in: src/viewer.ts:522

Registers a datetime property with the specified name and defaultValue

Parameters

ParameterTypeDefault value
propertyNamestringundefined
defaultValueDayjs | nullnull
optionsobject & IProperty | nullnull

Returns

Dayjs


detach()

detach(): void

Defined in: src/viewer.ts:455

Gets called when this viewer is detached.

Returns

void

Overrides

Viewer.detach


float()

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

Defined in: src/viewer.ts:496

Registers a floating point property with the specified name and defaultValue

Parameters

ParameterTypeDefault value
propertyNamestringundefined
defaultValuenumber | nullnull
optionsobject & IProperty | nullnull

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:179

Returns

object

Inherited from

Viewer.getInfo


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

ParameterTypeDefault value
includeDefaultsbooleanfalse

Returns

object

NameTypeDefined in
idstringsrc/viewer.ts:175
lookobjectsrc/viewer.ts:175
typestringsrc/viewer.ts:175

Inherited from

Viewer.getOptions


getProperties()

getProperties(): Property[]

Defined in: src/viewer.ts:466

Returns all properties of this widget.

Returns

Property[]

Overrides

Viewer.getProperties


getProperty()

getProperty(name): Property | undefined

Defined in: src/viewer.ts:462

Gets property by name (case-sensitive).

Parameters

ParameterTypeDescription
namestring-

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:129

Parameters

ParameterType
dartany

Returns

void

Inherited from

Viewer.initDartObject


int()

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

Defined in: src/viewer.ts:491

Registers an integer property with the specified name and defaultValue

Parameters

ParameterTypeDefault value
propertyNamestringundefined
defaultValuenumber | nullnull
optionsobject & IProperty | nullnull

Returns

number


onEvent()

onEvent(eventId?): Observable<any>

Defined in: src/viewer.ts:338

Observes platform events with the specified eventId.

Parameters

ParameterTypeDefault value
eventIdstring | nullnull

Returns

Observable<any>

Inherited from

Viewer.onEvent


onFrameAttached()

onFrameAttached(dataFrame): void

Defined in: src/viewer.ts:437

Parameters

ParameterType
dataFrameDataFrame

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

ParameterTypeDescription
propertyProperty | nullor null, if multiple properties were changed.

Returns

void

Inherited from

Viewer.onPropertyChanged


onSourceRowsChanged()

onSourceRowsChanged(): void

Defined in: src/viewer.ts:446

Returns

void


onTableAttached()

onTableAttached(): void

Defined in: src/viewer.ts:452

Gets called when a table is attached to the viewer.

Returns

void


registerCleanup()

protected registerCleanup(cleanup): void

Defined in: src/viewer.ts:471

cleanup() will get called when the viewer is disposed

Parameters

ParameterType
cleanupFunction

Returns

void


removeFromView()

removeFromView(): any

Defined in: src/viewer.ts:380

Returns

any

Inherited from

Viewer.removeFromView


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

ParameterTypeDescription
map{[key: string]: any; type?: string; }-
map.type?string-

Returns

void

Inherited from

Viewer.setOptions


sourceRowsChanged()

sourceRowsChanged(): void

Defined in: src/viewer.ts:441

Returns

void

Overrides

Viewer.sourceRowsChanged


string()

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

Defined in: src/viewer.ts:501

Registers a string property with the specified name and defaultValue

Parameters

ParameterTypeDefault value
propertyNamestringundefined
defaultValuestring | nullnull
optionsobject & IProperty | nullnull

Returns

string


stringList()

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

Defined in: src/viewer.ts:512

Registers a string list property with the specified name and defaultValue

Parameters

ParameterTypeDefault value
propertyNamestringundefined
defaultValuestring[] | nullnull
optionsobject & IProperty | nullnull

Returns

string[]


sub()

sub(subscription): void

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

Registers a subscription to an external event.

Parameters

ParameterTypeDescription
subscriptionSubscription-

Returns

void

Inherited from

Viewer.sub


toCompactLook()

toCompactLook(): void

Defined in: src/viewer.ts:355

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:240

Parameters

ParameterType
tDataFrame
options?Partial<IBarChartSettings>

Returns

Viewer<IBarChartSettings>

Inherited from

Viewer.barChart


boxPlot()

static boxPlot(t, options?): BoxPlot

Defined in: src/viewer.ts:256

Parameters

ParameterType
tDataFrame
options?Partial<IBoxPlotSettings>

Returns

BoxPlot

Inherited from

Viewer.boxPlot


calendar()

static calendar(t, options?): CalendarViewer

Defined in: src/viewer.ts:276

Parameters

ParameterType
tDataFrame
options?Partial<ICalendarSettings>

Returns

CalendarViewer

Inherited from

Viewer.calendar


canVisualize()

static canVisualize(viewerType, dataFrame): string | null

Defined in: src/viewer.ts:384

Parameters

ParameterType
viewerTypestring
dataFrameDataFrame

Returns

string | null

Inherited from

Viewer.canVisualize


confusionMatrix()

static confusionMatrix(t, options?): ConfusionMatrix

Defined in: src/viewer.ts:244

Parameters

ParameterType
tDataFrame
options?Partial<IConfusionMatrixSettings>

Returns

ConfusionMatrix

Inherited from

Viewer.confusionMatrix


correlationPlot()

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

Defined in: src/viewer.ts:280

Parameters

ParameterType
tDataFrame
options?Partial<ICorrelationPlotSettings>

Returns

Viewer<ICorrelationPlotSettings>

Inherited from

Viewer.correlationPlot


densityPlot()

static densityPlot(t, options?): DensityPlotViewer

Defined in: src/viewer.ts:284

Parameters

ParameterType
tDataFrame
options?Partial<IDensityPlotSettings>

Returns

DensityPlotViewer

Inherited from

Viewer.densityPlot


filters()

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

Defined in: src/viewer.ts:260

Parameters

ParameterType
tDataFrame
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

ParameterType
rootElement

Returns

Widget<any> | null

Inherited from

Viewer.find


form()

static form(t, options?): FormViewer

Defined in: src/viewer.ts:288

Parameters

ParameterType
tDataFrame
options?Partial<IFormSettings>

Returns

FormViewer

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

ParameterType
rootHTMLElement

Returns

Widget

Inherited from

Viewer.fromRoot


fromType()

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

Defined in: src/viewer.ts:145

Creates a new viewer of the specified type.

Parameters

ParameterTypeDefault valueDescription
viewerTypestringundefined-
tableDataFrameundefined-
optionsobject | nullnull-

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:152

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

Parameters

ParameterType
options?{ core?: boolean; }
options.core?boolean

Returns

string[]

Inherited from

Viewer.getViewerTypes


grid()

static grid(t, options?): Grid

Defined in: src/viewer.ts:232

Parameters

ParameterType
tDataFrame
options?Partial<IGridSettings>

Returns

Grid

Inherited from

Viewer.grid


heatMap()

static heatMap(t, options?): Grid

Defined in: src/viewer.ts:252

Parameters

ParameterType
tDataFrame
options?Partial<IGridSettings>

Returns

Grid

Inherited from

Viewer.heatMap


histogram()

static histogram(t, options?): HistogramViewer

Defined in: src/viewer.ts:236

Parameters

ParameterType
tDataFrame
options?Partial<IHistogramSettings>

Returns

HistogramViewer

Inherited from

Viewer.histogram


lineChart()

static lineChart(t, options?): LineChartViewer

Defined in: src/viewer.ts:268

Parameters

ParameterType
tDataFrame
options?Partial<ILineChartSettings>

Returns

LineChartViewer

Inherited from

Viewer.lineChart


markup()

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

Defined in: src/viewer.ts:292

Parameters

ParameterType
tDataFrame
options?Partial<IMarkupViewerSettings>

Returns

Viewer<IMarkupViewerSettings>

Inherited from

Viewer.markup


matrixPlot()

static matrixPlot(t, options?): MatrixPlot

Defined in: src/viewer.ts:296

Parameters

ParameterType
tDataFrame
options?Partial<IMatrixPlotSettings>

Returns

MatrixPlot

Inherited from

Viewer.matrixPlot


network()

static network(t, options?): NetworkDiagramViewer

Defined in: src/viewer.ts:272

Parameters

ParameterType
tDataFrame
options?Partial<INetworkDiagramSettings>

Returns

NetworkDiagramViewer

Inherited from

Viewer.network


pcPlot()

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

Defined in: src/viewer.ts:300

Parameters

ParameterType
tDataFrame
options?Partial<IPcPlotSettings>

Returns

Viewer<IPcPlotSettings>

Inherited from

Viewer.pcPlot


pieChart()

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

Defined in: src/viewer.ts:304

Parameters

ParameterType
tDataFrame
options?Partial<IPieChartSettings>

Returns

Viewer<IPieChartSettings>

Inherited from

Viewer.pieChart


rocCurve()

static rocCurve(t, options?): RocCurve

Defined in: src/viewer.ts:248

Parameters

ParameterType
tDataFrame
options?Partial<IRocCurveSettings>

Returns

RocCurve

Inherited from

Viewer.rocCurve


scatterPlot()

static scatterPlot(t, options?): ScatterPlotViewer

Defined in: src/viewer.ts:264

Parameters

ParameterType
tDataFrame
options?Partial<IScatterPlotSettings>

Returns

ScatterPlotViewer

Inherited from

Viewer.scatterPlot


scatterPlot3d()

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

Defined in: src/viewer.ts:308

Parameters

ParameterType
tDataFrame
options?Partial<IScatterPlot3dSettings>

Returns

Viewer<IScatterPlot3dSettings>

Inherited from

Viewer.scatterPlot3d


statistics()

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

Defined in: src/viewer.ts:312

Parameters

ParameterType
tDataFrame
options?Partial<IStatsViewerSettings>

Returns

Viewer<IStatsViewerSettings>

Inherited from

Viewer.statistics


tile()

static tile(t, options?): TileViewer

Defined in: src/viewer.ts:316

Parameters

ParameterType
tDataFrame
options?Partial<ITileViewerSettings>

Returns

TileViewer

Inherited from

Viewer.tile


treeMap()

static treeMap(t, options?): TreeMap

Defined in: src/viewer.ts:320

Parameters

ParameterType
tDataFrame
options?Partial<ITreeMapSettings>

Returns

TreeMap

Inherited from

Viewer.treeMap


trellisPlot()

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

Defined in: src/viewer.ts:324

Parameters

ParameterType
tDataFrame
options?Partial<ITrellisPlotSettings>

Returns

Viewer<ITrellisPlotSettings>

Inherited from

Viewer.trellisPlot


wordCloud()

static wordCloud(t, options?): Viewer

Defined in: src/viewer.ts:329

Parameters

ParameterType
tDataFrame
options?any

Returns

Viewer

Deprecated

Inherited from

Viewer.wordCloud