Class: JsViewer

dg.JsViewer

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

Hierarchy

• Viewer

  ↳ JsViewer

Constructors

constructor

• new JsViewer()

Constructs

JsViewer

Overrides

Viewer.constructor

Defined in

src/viewer.ts:347

Properties

_properties

• Protected _properties: Property[]

Inherited from

Viewer._properties

Defined in

src/widgets.ts:178

---

_root

• Protected _root: HTMLElement

Inherited from

Viewer._root

Defined in

src/widgets.ts:177

---

dart

• dart: any

Overrides

Viewer.dart

Defined in

src/viewer.ts:338

---

factory

• factory: null | Func = null

Constructor function. No parameters, returns [Widget].

Inherited from

Viewer.factory

Defined in

src/widgets.ts:175

---

filter

• filter: BitSet

Inherited from

Viewer.filter

Defined in

src/viewer.ts:70

---

formulaFilter

• formulaFilter: undefined | string

Defined in

src/viewer.ts:344

---

isDetached

• isDetached: boolean = false

Inherited from

Viewer.isDetached

Defined in

src/widgets.ts:182

---

obs

• obs: Observable<any>[]

Defined in

src/viewer.ts:341

---

props

• props: ObjectPropertyBag

Overrides

Viewer.props

Defined in

src/viewer.ts:342

---

rowSource

• rowSource: undefined | string

Defined in

src/viewer.ts:343

---

subs

• subs: Subscription[]

Overrides

Viewer.subs

Defined in

src/viewer.ts:340

---

tags

• tags: any

Inherited from

Viewer.tags

Defined in

src/viewer.ts:68

---

temp

• temp: any

Contains auxiliary information

Inherited from

Viewer.temp

Defined in

src/widgets.ts:172

Accessors

dataFrame

• get dataFrame(): DataFrame

Returns

DataFrame

Inherited from

Viewer.dataFrame

Defined in

src/viewer.ts:175

• set dataFrame(t): void

Parameters

Name	Type
t	DataFrame

Returns

void

Inherited from

Viewer.dataFrame

Defined in

src/viewer.ts:179

---

helpUrl

• get helpUrl(): string

Returns

string

Inherited from

Viewer.helpUrl

Defined in

src/viewer.ts:183

• set helpUrl(s): void

Parameters

Name	Type
s	string

Returns

void

Inherited from

Viewer.helpUrl

Defined in

src/viewer.ts:187

---

meta

• get meta(): ViewerMetaHelper

Returns

ViewerMetaHelper

Inherited from

Viewer.meta

Defined in

src/viewer.ts:148

---

onContextMenu

• get onContextMenu(): Observable<Menu>

Returns

Observable<Menu>

Inherited from

Viewer.onContextMenu

Defined in

src/viewer.ts:284

---

onDartPropertyChanged

• get onDartPropertyChanged(): Observable<null>

Returns

Observable<null>

Inherited from

Viewer.onDartPropertyChanged

Defined in

src/viewer.ts:310

---

onDataEvent

• get onDataEvent(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataEvent

Defined in

src/viewer.ts:78

---

onDataHovered

• get onDataHovered(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataHovered

Defined in

src/viewer.ts:79

---

onDataRowClicked

• get onDataRowClicked(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataRowClicked

Defined in

src/viewer.ts:82

---

onDataSelected

• get onDataSelected(): Observable<ViewerEvent>

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataSelected

Defined in

src/viewer.ts:80

---

root

• get root(): HTMLElement

Visual root.

Returns

HTMLElement

Overrides

Viewer.root

Defined in

src/viewer.ts:381

• set root(r): void

Parameters

Name	Type
r	HTMLElement

Returns

void

Overrides

Viewer.root

Defined in

src/viewer.ts:382

---

table

• get table(): DataFrame

Returns

DataFrame

Inherited from

Viewer.table

Defined in

src/viewer.ts:160

---

tableView

• get tableView(): null | TableView

Returns a view this viewer is associated with, or null

Returns

null | TableView

Inherited from

Viewer.tableView

Defined in

src/viewer.ts:170

---

type

• get type(): string

Returns viewer type (see VIEWER constants)

Returns

string

Inherited from

Viewer.type

Defined in

src/viewer.ts:156

---

view

• get view(): null | View

Returns a view this viewer is associated with, or null

Returns

null | View

Inherited from

Viewer.view

Defined in

src/viewer.ts:165

Methods

_obs

▸ Protected _obs(observable): Observable<any>

Parameters

Name	Type
observable	Observable<any>

Returns

Observable<any>

Defined in

src/viewer.ts:408

---

addProperty

▸ Private addProperty(propertyName, propertyType, defaultValue?, options?): any

Registers an property with the specified type, name, and defaultValue. Registered property gets added to {@see properties}. Returns default value, thus allowing to combine registering a property with the initialization

Parameters

Name	Type	Default value
propertyName	string	undefined
propertyType	"string" | "bigint" | "object" | "map" | "file" | "view" | "element" | "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" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	undefined
defaultValue	any	null
options	null | { [key: string]: any; } & PropertyOptions	null

Returns

any

Inherited from

Viewer.addProperty

Defined in

src/widgets.ts:280

---

addRowSourceAndFormula

▸ addRowSourceAndFormula(): void

Returns

void

Defined in

src/viewer.ts:364

---

apply

▸ apply(properties): Widget<any>

Parameters

Name	Type
properties	object

Returns

Widget<any>

Inherited from

Viewer.apply

Defined in

src/widgets.ts:230

---

bool

▸ Protected bool(propertyName, defaultValue?, options?): boolean

Registers a boolean property with the specified name and defaultValue

Parameters

Name	Type	Default value
propertyName	string	undefined
defaultValue	null | boolean	null
options	null | { [key: string]: any; } & PropertyOptions	null

Returns

boolean

Defined in

src/viewer.ts:444

---

close

▸ close(): void

Closes and detaches the viewer.

Returns

void

Inherited from

Viewer.close

Defined in

src/viewer.ts:138

---

column

▸ Protected column(dataPropertyName, options?): string

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

Name	Type	Default value
dataPropertyName	string	undefined
options	null | { [key: string]: any; } & PropertyOptions	null

Returns

string

Defined in

src/viewer.ts:415

---

columnList

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

Parameters

Name	Type	Default value
propertyName	string	undefined
defaultValue	null | string[]	null
options	null | { [key: string]: any; } & PropertyOptions	null

Returns

string[]

Defined in

src/viewer.ts:419

---

copyViewersLook

▸ copyViewersLook(other): void

Parameters

Name	Type
other	Viewer<any>

Returns

void

Inherited from

Viewer.copyViewersLook

Defined in

src/viewer.ts:324

---

dateTime

▸ Protected dateTime(propertyName, defaultValue?, options?): Dayjs

Registers a datetime property with the specified name and defaultValue

Parameters

Name	Type	Default value
propertyName	string	undefined
defaultValue	null | Dayjs	null
options	null | { [key: string]: any; } & PropertyOptions	null

Returns

Dayjs

Defined in

src/viewer.ts:449

---

detach

▸ detach(): void

Gets called when this viewer is detached.

Returns

void

Overrides

Viewer.detach

Defined in

src/viewer.ts:388

---

float

▸ Protected float(propertyName, defaultValue?, options?): number

Registers a floating point property with the specified name and defaultValue

Parameters

Name	Type	Default value
propertyName	string	undefined
defaultValue	null | number	null
options	null | { [key: string]: any; } & PropertyOptions	null

Returns

number

Defined in

src/viewer.ts:429

---

getDartProperties

▸ getDartProperties(): any[]

Returns

any[]

Inherited from

Viewer.getDartProperties

Defined in

src/widgets.ts:246

---

getInfo

▸ getInfo(): Object

Returns

Object

Inherited from

Viewer.getInfo

Defined in

src/viewer.ts:129

---

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.

See also setOptions Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/scatter-plot

Parameters

Name	Type	Default value
includeDefaults	boolean	false

Returns

Object

Name	Type
id	string
look	{ [key: string]: any; }
type	string

Inherited from

Viewer.getOptions

Defined in

src/viewer.ts:125

---

getProperties

▸ getProperties(): Property[]

Returns

Property[]

Overrides

Viewer.getProperties

Defined in

src/viewer.ts:399

---

getProperty

▸ getProperty(name): undefined | Property

Gets property by name (case-sensitive).

Parameters

Name	Type
name	string

Returns

undefined | Property

Defined in

src/viewer.ts:395

---

initDartObject

▸ initDartObject(dart): void

Parameters

Name	Type
dart	any

Returns

void

Inherited from

Viewer.initDartObject

Defined in

src/viewer.ts:84

---

int

▸ Protected int(propertyName, defaultValue?, options?): number

Registers an integer property with the specified name and defaultValue

Parameters

Name	Type	Default value
propertyName	string	undefined
defaultValue	null | number	null
options	null | { [key: string]: any; } & PropertyOptions	null

Returns

number

Defined in

src/viewer.ts:424

---

onEvent

▸ onEvent(eventId?): Observable<any>

Observes platform events with the specified eventId.

Parameters

Name	Type	Default value
eventId	null | string	null

Returns

Observable<any>

Inherited from

Viewer.onEvent

Defined in

src/viewer.ts:289

---

onFrameAttached

▸ onFrameAttached(dataFrame): void

Parameters

Name	Type
dataFrame	DataFrame

Returns

void

Overrides

Viewer.onFrameAttached

Defined in

src/viewer.ts:370

---

onPropertyChanged

▸ onPropertyChanged(property): void

Gets called when viewer's property is changed.

Parameters

Name	Type	Description
property	null | Property	or null, if multiple properties were changed.

Returns

void

Inherited from

Viewer.onPropertyChanged

Defined in

src/widgets.ts:244

---

onSourceRowsChanged

▸ onSourceRowsChanged(): void

Returns

void

Defined in

src/viewer.ts:379

---

onTableAttached

▸ onTableAttached(): void

Gets called when a table is attached to the viewer.

Returns

void

Defined in

src/viewer.ts:385

---

registerCleanup

▸ Protected registerCleanup(cleanup): void

cleanup() will get called when the viewer is disposed

Parameters

Name	Type
cleanup	Function

Returns

void

Defined in

src/viewer.ts:404

---

removeFromView

▸ removeFromView(): any

Returns

any

Inherited from

Viewer.removeFromView

Defined in

src/viewer.ts:328

---

setOptions

▸ setOptions(map): void

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

Parameters

Name	Type
map	Object
map.type?	string

Returns

void

Inherited from

Viewer.setOptions

Defined in

src/viewer.ts:113

---

sourceRowsChanged

▸ sourceRowsChanged(): void

Returns

void

Overrides

Viewer.sourceRowsChanged

Defined in

src/viewer.ts:374

---

string

▸ Protected string(propertyName, defaultValue?, options?): string

Registers a string property with the specified name and defaultValue

Parameters

Name	Type	Default value
propertyName	string	undefined
defaultValue	null | string	null
options	null | { [key: string]: any; } & PropertyOptions	null

Returns

string

Defined in

src/viewer.ts:434

---

stringList

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

Registers a string list property with the specified name and defaultValue

Parameters

Name	Type	Default value
propertyName	string	undefined
defaultValue	null | string[]	null
options	null | { [key: string]: any; } & PropertyOptions	null

Returns

string[]

Defined in

src/viewer.ts:439

---

sub

▸ sub(subscription): void

Registers a subscription to an external event.

Parameters

Name	Type
subscription	Subscription

Returns

void

Inherited from

Viewer.sub

Defined in

src/widgets.ts:223

---

toCompactLook

▸ toCompactLook(): void

Returns

void

Inherited from

Viewer.toCompactLook

Defined in

src/viewer.ts:306

---

toDart

▸ toDart(): any

Returns

any

Inherited from

Viewer.toDart

Defined in

src/widgets.ts:215

---

barChart

▸ Static barChart(t, options?): Viewer<IBarChartLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IBarChartLookSettings>

Inherited from

Viewer.barChart

Defined in

src/viewer.ts:199

---

boxPlot

▸ Static boxPlot(t, options?): Viewer<IBoxPlotLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IBoxPlotLookSettings>

Inherited from

Viewer.boxPlot

Defined in

src/viewer.ts:207

---

calendar

▸ Static calendar(t, options?): Viewer<ICalendarLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<ICalendarLookSettings>

Inherited from

Viewer.calendar

Defined in

src/viewer.ts:227

---

correlationPlot

▸ Static correlationPlot(t, options?): Viewer<ICorrelationPlotLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<ICorrelationPlotLookSettings>

Inherited from

Viewer.correlationPlot

Defined in

src/viewer.ts:231

---

densityPlot

▸ Static densityPlot(t, options?): Viewer<IDensityPlotLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IDensityPlotLookSettings>

Inherited from

Viewer.densityPlot

Defined in

src/viewer.ts:235

---

filters

▸ Static filters(t, options?): Viewer<IFiltersLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IFiltersLookSettings>

Inherited from

Viewer.filters

Defined in

src/viewer.ts:211

---

find

▸ Static find(root): null | Widget<any>

Finds existing widget from its visual root.

Parameters

Name	Type
root	Element

Returns

null | Widget<any>

Inherited from

Viewer.find

Defined in

src/widgets.ts:211

---

form

▸ Static form(t, options?): Viewer<IFormLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IFormLookSettings>

Inherited from

Viewer.form

Defined in

src/viewer.ts:239

---

fromRoot

▸ Static fromRoot(root): Widget<any>

Creates a new widget from the root element.

Parameters

Name	Type
root	HTMLElement

Returns

Widget<any>

Inherited from

Viewer.fromRoot

Defined in

src/widgets.ts:303

---

fromType

▸ Static fromType(viewerType, table, options?): Viewer<any>

Creates a new viewer of the specified type.

Parameters

Name	Type	Default value
viewerType	string	undefined
table	DataFrame	undefined
options	null | object	null

Returns

Viewer<any>

Inherited from

Viewer.fromType

Defined in

src/viewer.ts:100

---

getAll

▸ Static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Viewer.getAll

Defined in

src/widgets.ts:206

---

getViewerTypes

▸ Static getViewerTypes(): string[]

Returns

string[]

Inherited from

Viewer.getViewerTypes

Defined in

src/viewer.ts:104

---

grid

▸ Static grid(t, options?): Grid

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Grid

Inherited from

Viewer.grid

Defined in

src/viewer.ts:191

---

heatMap

▸ Static heatMap(t, options?): Viewer<IGridLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IGridLookSettings>

Inherited from

Viewer.heatMap

Defined in

src/viewer.ts:203

---

histogram

▸ Static histogram(t, options?): Viewer<IHistogramLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IHistogramLookSettings>

Inherited from

Viewer.histogram

Defined in

src/viewer.ts:195

---

lineChart

▸ Static lineChart(t, options?): Viewer<ILineChartLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<ILineChartLookSettings>

Inherited from

Viewer.lineChart

Defined in

src/viewer.ts:219

---

markup

▸ Static markup(t, options?): Viewer<IMarkupViewerLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IMarkupViewerLookSettings>

Inherited from

Viewer.markup

Defined in

src/viewer.ts:243

---

matrixPlot

▸ Static matrixPlot(t, options?): Viewer<IMatrixPlotLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IMatrixPlotLookSettings>

Inherited from

Viewer.matrixPlot

Defined in

src/viewer.ts:247

---

network

▸ Static network(t, options?): Viewer<INetworkDiagramLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<INetworkDiagramLookSettings>

Inherited from

Viewer.network

Defined in

src/viewer.ts:223

---

pcPlot

▸ Static pcPlot(t, options?): Viewer<IPcPlotLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IPcPlotLookSettings>

Inherited from

Viewer.pcPlot

Defined in

src/viewer.ts:251

---

pieChart

▸ Static pieChart(t, options?): Viewer<IPieChartLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IPieChartLookSettings>

Inherited from

Viewer.pieChart

Defined in

src/viewer.ts:255

---

scatterPlot

▸ Static scatterPlot(t, options?): ScatterPlotViewer

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

ScatterPlotViewer

Inherited from

Viewer.scatterPlot

Defined in

src/viewer.ts:215

---

scatterPlot3d

▸ Static scatterPlot3d(t, options?): Viewer<IScatterPlot3dLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IScatterPlot3dLookSettings>

Inherited from

Viewer.scatterPlot3d

Defined in

src/viewer.ts:259

---

statistics

▸ Static statistics(t, options?): Viewer<IStatsViewerLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<IStatsViewerLookSettings>

Inherited from

Viewer.statistics

Defined in

src/viewer.ts:263

---

tile

▸ Static tile(t, options?): Viewer<ITileViewerLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<ITileViewerLookSettings>

Inherited from

Viewer.tile

Defined in

src/viewer.ts:267

---

treeMap

▸ Static treeMap(t, options?): Viewer<ITreeMapLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<ITreeMapLookSettings>

Inherited from

Viewer.treeMap

Defined in

src/viewer.ts:271

---

trellisPlot

▸ Static trellisPlot(t, options?): Viewer<ITrellisPlotLookSettings>

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<ITrellisPlotLookSettings>

Inherited from

Viewer.trellisPlot

Defined in

src/viewer.ts:275

---

wordCloud

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

Deprecated

Parameters

Name	Type	Default value
t	DataFrame	undefined
options	null | object	null

Returns

Viewer<any>

Inherited from

Viewer.wordCloud

Defined in

src/viewer.ts:280