Viewer<TSettings>

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

Base class for controls that have a visual root and a set of properties.

Extends

• Widget<TSettings>

Extended by

• FormViewer
• Grid
• JsViewer
• FilterGroup
• LineChartViewer
• ScatterPlotViewer
• DensityPlotViewer
• HistogramViewer
• BarChartViewer
• PieChartViewer
• PcPlot
• BoxPlot
• CorrelationPlot
• TreeMap
• MatrixPlot
• TileViewer
• ConfusionMatrix
• RocCurve
• CalendarViewer
• PivotViewer
• NetworkDiagramViewer
• TrellisPlotViewer

Type Parameters

Type Parameter	Default type
TSettings	any

Constructors

Constructor

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

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

Parameters

Parameter	Type
dart	any
root?	HTMLElement

Returns

Viewer<TSettings>

Overrides

Widget.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	Widget._functions	js-api/src/widgets/base.ts:207
_properties	protected	Property[]	[]	-	Widget._properties	js-api/src/widgets/base.ts:206
_root	protected	HTMLElement	undefined	-	Widget._root	js-api/src/u2core/component.ts:445
_u2	readonly	ComponentState	undefined	-	Widget._u2	js-api/src/u2core/component.ts:82
componentMeta?	public	ComponentMetaBase	undefined	The registry metadata of the tag that built this component, stamped by the spec renderer — the single source the introspection surface below is generated from.	Widget.componentMeta	js-api/src/u2core/component.ts:77
dart	public	any	undefined	-	Widget.dart	js-api/src/widgets/base.ts:212
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	Widget.factory	js-api/src/widgets/base.ts:204
isDetached	public	boolean	false	Whether detach has been called.	Widget.isDetached	js-api/src/widgets/base.ts:214
props	public	TSettings & ObjectPropertyBag	undefined	Property bag over this widget's properties; read and write them by name.	Widget.props	js-api/src/widgets/base.ts:209
specProps?	public	Record<string, unknown>	undefined	The props the registry's create was handed, stamped alongside componentMeta: the last resort of the property read below, for a component that keeps a prop under another name or not at all (a create wrapping a bare element). Construction-time values — a live one always wins.	Widget.specProps	js-api/src/u2core/component.ts:81
subs	public	Subscription[]	undefined	Subscriptions cancelled when the widget is detached.	Widget.subs	js-api/src/widgets/base.ts:211
tags	public	any	undefined	Viewer tags: a string map persisted with the layout.	-	js-api/src/viewer.ts:123
temp	public	any	undefined	Contains auxiliary information	Widget.temp	js-api/src/widgets/base.ts:201
CORE_VIEWER_TYPES	static	string[]	undefined	Viewer types that ship with the platform and are available synchronously.	-	js-api/src/viewer.ts:527

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

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

AI briefing of the underlying Dart viewer.

Returns

string | null

Set Signature

set aiDescription(x): void

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

A short AI-facing briefing, seeded from the registry's usage or description.

Parameters

Parameter	Type
x	string | null

Returns

void

Overrides

ColumnGrid.aiDescription

---

ambientAdoption

Get Signature

get protected ambientAdoption(): boolean

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

A widget wrapper minted inside somebody's effect scope must not be auto-disposed with it.

Returns

boolean

Inherited from

Widget.ambientAdoption

---

children

Get Signature

get children(): Widget<any>[]

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

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

Widget.children

---

dataFrame

Get Signature

get dataFrame(): DataFrame

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

Returns

DataFrame

Set Signature

set dataFrame(t): void

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

Parameters

Parameter	Type
t	DataFrame

Returns

void

---

descriptor

Get Signature

get descriptor(): WidgetDescriptor

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

Descriptor of this widget.

Returns

WidgetDescriptor

---

filter

Get Signature

get filter(): BitSet

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

combined filter of the viewer

Returns

BitSet

Set Signature

set filter(f): void

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

Parameters

Parameter	Type
f	BitSet

Returns

void

---

helpUrl

Get Signature

get helpUrl(): string

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

Help URL

Returns

string

Set Signature

set helpUrl(s): void

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

Parameters

Parameter	Type
s	string

Returns

void

---

immediateRendering

Get Signature

get immediateRendering(): boolean

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

Repaints as soon as the current task completes instead of on the next animation frame or after the render delay; property sets within one task still coalesce into one repaint. For automated tests: a property set is painted once the test yields one macrotask.

Returns

boolean

Set Signature

set immediateRendering(x): void

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

Parameters

Parameter	Type
x	boolean

Returns

void

---

isRenderPending

Get Signature

get isRenderPending(): boolean

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

True while a change is on its way to the canvas: a debounced refresh is armed, or a repaint is requested and not yet done. A test waits on this instead of a timeout.

Returns

boolean

---

meta

Get Signature

get meta(): ViewerMetaHelper

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

Formula lines and annotation regions of this viewer.

Returns

ViewerMetaHelper

---

name

Get Signature

get name(): string | undefined

Defined in: js-api/src/u2core/component.ts:469

A named control carries its name in the DOM: data-u2-name is the stable automation id selectors, tutorials and agents address the control by — the same attribute the spec renderer stamps on named nodes, so hand-built and spec-built UI share one selector vocabulary. Derived names (an input's label fallback) never stamp — see Component.deriveName.

Returns

string | undefined

Set Signature

set name(x): void

Defined in: js-api/src/u2core/component.ts:473

Unique within a spec: the anchor for selection, patches and automation. An accessor pair (not a field), so a platform descendant's own name accessors override it legally (TS2611).

Parameters

Parameter	Type
x	string | undefined

Returns

void

Inherited from

Widget.name

---

onAfterDrawOverlay

Get Signature

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

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

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

Returns

Observable<EventData<any>>

---

onAfterDrawScene

Get Signature

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

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

Fires after rendering of the main canvas.

Returns

Observable<EventData<any>>

---

onAfterLayout

Get Signature

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

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

Fires after the viewer completes a layout pass.

Returns

Observable<EventData<any>>

---

onBeforeDrawOverlay

Get Signature

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

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

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

Returns

Observable<EventData<any>>

---

onBeforeDrawScene

Get Signature

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

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

Fires before rendering of the main canvas.

Returns

Observable<EventData<any>>

---

onContextMenu

Get Signature

get onContextMenu(): Observable<Menu>

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

Fires when the viewer builds its context menu; add items to the emitted Menu.

Returns

Observable<Menu>

---

onDartPropertyChanged

Get Signature

get onDartPropertyChanged(): Observable<null>

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

Low-level stream of property changes on the Dart side; prefer onPropertyValueChanged.

Returns

Observable<null>

---

onDataEvent

Get Signature

get onDataEvent(): Observable<ViewerEvent>

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

All data events of this viewer (selection, row click, tooltip); filter by e.type.

Returns

Observable<ViewerEvent>

---

onDataFrameChanged

Get Signature

get onDataFrameChanged(): Observable<any>

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

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

Returns

Observable<any>

---

onDataRowClicked

Get Signature

get onDataRowClicked(): Observable<ViewerEvent>

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

current row clicked

Returns

Observable<ViewerEvent>

---

onDataSelected

Get Signature

get onDataSelected(): Observable<ViewerEvent>

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

Fires when the user selects data in the viewer.

Returns

Observable<ViewerEvent>

---

onDetached

Get Signature

get onDetached(): Observable<any>

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

Occurs when viewer is detached.

Returns

Observable<any>

---

onPropertyValueChanged

Get Signature

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

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

Fires after any viewer property changes; args.property is the property.

Returns

Observable<EventData<Property>>

---

onResized

Get Signature

get onResized(): Observable<null>

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

Fires when the viewer is resized.

Returns

Observable<null>

---

onTooltipCreated

Get Signature

get onTooltipCreated(): Observable<ViewerEvent>

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

Fires when the viewer shows a data tooltip.

Returns

Observable<ViewerEvent>

---

onViewerRendered

Get Signature

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

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

Fires after the viewer is rendered.

Returns

Observable<EventData<any>>

---

parent

Get Signature

get parent(): Widget<any> | null

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

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

Widget.parent

---

propertyTarget

Get Signature

get propertyTarget(): unknown

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

A viewer's property lives on its look, which the props bag is over. Read per call: a viewer's look is settable.

Returns

unknown

Overrides

Widget.propertyTarget

---

propertyTier

Get Signature

get propertyTier(): boolean

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

Every property getProperties declares is a bind step, read and written on propertyTarget.

Returns

boolean

Inherited from

Widget.propertyTier

---

root

Get Signature

get root(): HTMLElement

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

Visual root.

Returns

HTMLElement

Overrides

Widget.root

---

scope

Get Signature

get scope(): Scope

Defined in: js-api/src/u2core/component.ts:53

Minted on first use; assigned before _scopeMinted fires, so the hook's own this.scope.own(...) reads the stored scope instead of re-entering the mint.

Returns

Scope

Inherited from

Widget.scope

---

table

Get Signature

get table(): DataFrame

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

The DataFrame this viewer is attached to. Same as dataFrame.

Returns

DataFrame

---

tableView

Get Signature

get tableView(): TableView | null

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

Returns a view this viewer is associated with, or null

Returns

TableView | null

---

type

Get Signature

get type(): ViewerType

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

Returns viewer type (see VIEWER constants)

Returns

ViewerType

Overrides

Widget.type

---

view

Get Signature

get view(): View | null

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

Returns a view this viewer is associated with, or null

Returns

View | null

Methods

_notifyPropertyChange()

protected _notifyPropertyChange(p): void

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

Notifies the property tier. Called from both the addProperty setter (overrides that skip super would otherwise lose props.x = writes) and onPropertyChanged (direct calls); the double notify collapses into one microtask refresh.

Parameters

Parameter	Type
p	Property | null

Returns

void

Inherited from

Widget._notifyPropertyChange

---

_ownPropertyChanges()

protected _ownPropertyChanges(): ObservableLike<PropertyChange>

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

Returns

ObservableLike<PropertyChange>

Inherited from

Widget._ownPropertyChanges

---

_scopeMinted()

protected _scopeMinted(_scope): void

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

First-mint hook: a platform descendant wires its lifecycle here. Never fired for a scope provided to init — that path runs inside the constructor chain.

Parameters

Parameter	Type
_scope	Scope

Returns

void

Inherited from

Widget._scopeMinted

---

_wireDartLifecycle()

protected _wireDartLifecycle(): void

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

Dart-owned lifecycle: the platform kill disposes the scope, and disposing the scope kills the widget through the kill-walk.

Returns

void

Inherited from

Widget._wireDartLifecycle

---

_wireJsLifecycle()

protected _wireJsLifecycle(): void

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

JS-owned lifecycle: disposing the scope detaches the widget, and vice versa.

Returns

void

Inherited from

Widget._wireJsLifecycle

---

_wireLifecycle()

protected _wireLifecycle(): void

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

Returns

void

Overrides

Widget._wireLifecycle

---

addProperty()

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

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

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

Parameters

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

Returns

any

See

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

options.get/options.set override how the property reads/writes (instead of the default fieldName field access); the change notification (onPropertyChanged) always fires on write, and a {get}-only options yields a custom read with the default fieldName write.

Inherited from

Widget.addProperty

---

addStatusProvider()

addStatusProvider(name, provider): void

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

Adds live parts, hit areas and readings to this widget's status. Providers run in registration order on every read; an existing name is replaced in place, and later providers override earlier entries. Coordinates use the widget's own hit-area system. Detaching the widget removes all providers. A subclass that overrides getWidgetStatus composes with super.getWidgetStatus().

Parameters

Parameter	Type	Description
name	string	Stable name of the component contributing the status.
provider	StatusProvider	Computes the contribution each time the status is requested.

Returns

void

Example

widget.addStatusProvider('selection', () => ({values: {'selected rows': table.selection.trueCount}}));
console.log(widget.getWidgetStatus().values?.['selected rows']);
widget.removeStatusProvider('selection');
see samples/grid/custom-renderer-status

Inherited from

Widget.addStatusProvider

---

apply()

apply(properties): Widget

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

Parameters

Parameter	Type
properties	object

Returns

Widget

Inherited from

Widget.apply

---

bindProps()

bindProps(): BindProp[]

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

The signal-backed subset of the meta props — what a binding picker offers on a named node — plus, under propertyTier, every declared property. Allocates no signal.

Returns

BindProp[]

Overrides

Widget.bindProps

---

bindStep()

bindStep(name): BindSource | Signal<unknown> | null

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

One binding step (DD5): a meta-declared prop's same-named Signal member — a named node is a bind source, generated off componentMeta the way getProperties is — then, under propertyTier, a cached signal over the declared property. '' answers the default binding: the component's own value signal, where one exists.

Parameters

Parameter	Type
name	string

Returns

BindSource | Signal<unknown> | null

Overrides

Widget.bindStep

---

close()

close(): void

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

Closes and detaches the viewer.

Returns

void

---

copyViewersLook()

copyViewersLook(other): void

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

Copies all settings (the look) from [other] into this viewer.

Parameters

Parameter	Type
other	Viewer

Returns

void

---

deriveName()

protected deriveName(x): void

Defined in: js-api/src/u2core/component.ts:72

Sets the introspection/form key without claiming an automation id — the label-fallback path: a caption is not a stable identity, so it never reaches data-u2-name.

Parameters

Parameter	Type
x	string | undefined

Returns

void

Inherited from

Widget.deriveName

---

detach()

detach(): void

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

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

---

dispose()

dispose(): void

Defined in: js-api/src/u2core/component.ts:147

On a never-engaged wrapper the getter mints here and _scopeMinted wires the lifecycle (own(kill) + the platform cleanup for Dart-owned), so dispose still kills it; re-entry from the kill cleanup is a no-op via the scope's disposed flag.

Returns

void

Inherited from

Widget.dispose

---

effect()

effect(fn): this

Defined in: js-api/src/u2core/component.ts:134

Parameters

Parameter	Type
fn	() => void

Returns

this

Inherited from

Widget.effect

---

fireEvent()

protected fireEvent(eventId, args?): void

Defined in: js-api/src/u2core/component.ts:435

Parameters

Parameter	Type
eventId	string
args?	unknown

Returns

void

Inherited from

Widget.fireEvent

---

getDartProperties()

getDartProperties(): any[]

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

Dart handles of the properties that have one.

Returns

any[]

Inherited from

Widget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

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

Functions applicable to the underlying Dart viewer.

Returns

Func[]

Overrides

Widget.getFunctions

---

getInfo()

getInfo(): object

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

Viewer internals exposed for diagnostics and tests (canvas, overlay, and more), keyed by name.

Returns

object

---

getOptions()

getOptions(includeDefaults?): object

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

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:229
look	ViewerOptions<TSettings>	js-api/src/viewer.ts:229
type	ViewerType	js-api/src/viewer.ts:229

---

getProperties()

getProperties(): Property[]

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

All properties of this viewer, including the data-bound ones.

Returns

Property[]

Overrides

Widget.getProperties

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

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

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

Returns

IWidgetStatus

Inherited from

Widget.getWidgetStatus

---

initDartObject()

initDartObject(dart): void

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

Parameters

Parameter	Type
dart	any

Returns

void

---

link()

link(name, source, twoWay): void

Defined in: js-api/src/u2core/component.ts:268

Keeps this component's name step and source equal, echo-suppressed by value; the reverse direction only where twoWay. A component that took source as its own signal needs no link and gets none; a read-only step cannot follow anything and gets none either.

Parameters

Parameter	Type
name	string
source	Signal<unknown>
twoWay	boolean

Returns

void

Inherited from

Widget.link

---

onEvent()

onEvent(eventId?): Observable<any>

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

Observes platform events with the specified eventId.

Parameters

Parameter	Type	Default value
eventId	string | null	null

Returns

Observable<any>

Overrides

Widget.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

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

Called when a DataFrame is attached; override to bind data.

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Widget.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

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

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

Widget.onPropertyChanged

---

own()

own(dispose): this

Defined in: js-api/src/u2core/component.ts:139

Parameters

Parameter	Type
dispose	() => void

Returns

this

Inherited from

Widget.own

---

propertyChanges()

protected propertyChanges(): ObservableLike<PropertyChange>

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

What refreshes the property tier's cached signals from outside: null where nothing announces a change (one-way).

Returns

ObservableLike<PropertyChange>

Overrides

Widget.propertyChanges

---

registerFunction()

protected registerFunction(f): void

Defined in: js-api/src/u2core/component.ts:431

Parameters

Parameter	Type
f	FuncLike

Returns

void

Inherited from

Widget.registerFunction

---

removeFromView()

removeFromView(): any

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

Removes the viewer from its view without disposing it.

Returns

any

---

removeStatusProvider()

removeStatusProvider(name): void

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

Removes the status contribution registered under name; an absent name is a no-op.

Parameters

Parameter	Type	Description
name	string	The name passed to addStatusProvider.

Returns

void

Example

widget.removeStatusProvider('selection');
see samples/grid/custom-renderer-status

Inherited from

Widget.removeStatusProvider

---

runInScope()

runInScope<T>(fn): T

Defined in: js-api/src/u2core/component.ts:130

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
fn	() => T

Returns

T

Inherited from

Widget.runInScope

---

setOptions()

setOptions(map): void

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

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

Parameters

Parameter	Type
map	{ [K in string | number | symbol]?: any } & object & object

Returns

void

---

sourceRowsChanged()

sourceRowsChanged(): void

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

Called when the rows the widget shows change; override to refresh.

Returns

void

Inherited from

Widget.sourceRowsChanged

---

sub()

sub(subscription): void

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

Registers a subscription to an external event.

Parameters

Parameter	Type
subscription	Subscription

Returns

void

Inherited from

Widget.sub

---

toCompactLook()

toCompactLook(): void

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

Switches the viewer to the compact look used inside a trellis plot.

Returns

void

---

toDart()

toDart(): any

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

The Dart handle of this widget, created on first use.

Returns

any

Inherited from

Widget.toDart

---

barChart()

static barChart(t, options?): BarChartViewer

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

Creates a bar chart.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IBarChartSettings>

Returns

BarChartViewer

---

boxPlot()

static boxPlot(t, options?): BoxPlot

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

Creates a box plot.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IBoxPlotSettings>

Returns

BoxPlot

---

build()

static build(builder): Control

Defined in: js-api/src/u2core/component.ts:529

Builds a control out of plain elements: builder runs with the new control's scope ambient, so signal bindings and nested components inside it are owned by the result. The ambient scope only spans the synchronous part of builder — components constructed after an await inside it are adopted by nobody and must be disposed by hand, or constructed before the first await.

Parameters

Parameter	Type
builder	() => HTMLElement | (string | HTMLElement | Control)[]

Returns

Control

Inherited from

Widget.build

---

calendar()

static calendar(t, options?): CalendarViewer

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

Creates a calendar.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ICalendarSettings>

Returns

CalendarViewer

---

canVisualize()

static canVisualize(viewerType, dataFrame): string | null

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

Returns null when a viewer of [viewerType] can show [dataFrame], or the reason it cannot.

Parameters

Parameter	Type
viewerType	string
dataFrame	DataFrame

Returns

string | null

---

confusionMatrix()

static confusionMatrix(t, options?): ConfusionMatrix

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

Creates a confusion matrix.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IConfusionMatrixSettings>

Returns

ConfusionMatrix

---

correlationPlot()

static correlationPlot(t, options?): CorrelationPlot

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

Creates a correlation plot.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ICorrelationPlotSettings>

Returns

CorrelationPlot

---

densityPlot()

static densityPlot(t, options?): DensityPlotViewer

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

Creates a density plot.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IDensityPlotSettings>

Returns

DensityPlotViewer

---

filters()

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

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

Creates a filter panel.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IFiltersSettings>

Returns

Viewer<IFiltersSettings>

---

find()

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

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

Widget.find

---

forElement()

static forElement(el): Control | undefined

Defined in: js-api/src/u2core/component.ts:489

The nearest control owning el — the DOM → component door for tooling, automation and inspectors (the u2 counterpart of the platform's Widget.find). Best-effort: the last control constructed on (or assigned) a root wins it.

Parameters

Parameter	Type
el	Element | null

Returns

Control | undefined

Inherited from

Widget.forElement

---

form()

static form(t, options?): FormViewer

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

Creates a form viewer.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IFormSettings>

Returns

FormViewer

---

fromRoot()

static fromRoot(root): Widget

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

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

Widget.fromRoot

---

fromType()

static fromType<T>(viewerType, table, options?): ViewerClass<T>

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

Creates a new viewer of the specified type. A known VIEWER type (enum member or its literal) returns that viewer's class; a type only known at runtime returns Viewer. Sample: https://public.datagrok.ai/js/samples/ui/viewers/create-viewers-dynamically

Type Parameters

Type Parameter
T extends ViewerType

Parameters

Parameter	Type	Default value
viewerType	T	undefined
table	DataFrame	undefined
options	object | null	null

Returns

ViewerClass<T>

---

getAll()

static getAll(): Widget<any>[]

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

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget.getAll

---

getViewerTypes()

static getViewerTypes(options?): ViewerType[]

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

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

ViewerType[]

---

grid()

static grid(t, options?): Grid

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

Creates a Grid for the table.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IGridSettings>

Returns

Grid

---

heatMap()

static heatMap(t, options?): Grid

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

Creates a heat map (a Grid in heat-map mode).

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IGridSettings>

Returns

Grid

---

histogram()

static histogram(t, options?): HistogramViewer

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

Creates a histogram.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IHistogramSettings>

Returns

HistogramViewer

---

init()

static init(self, scope?): void

Defined in: js-api/src/u2core/component.ts:89

Per-instance state, for a constructed component and for an adopted platform object alike.

Parameters

Parameter	Type
self	Component
scope?	Scope

Returns

void

Inherited from

Widget.init

---

is()

static is(x): x is Control

Defined in: js-api/src/u2core/component.ts:498

Structural probe by methods only — never .scope: the accessor mints.

Parameters

Parameter	Type
x	unknown

Returns

x is Control

Inherited from

Widget.is

---

lineChart()

static lineChart(t, options?): LineChartViewer

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

Creates a line chart.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ILineChartSettings>

Returns

LineChartViewer

---

markup()

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

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

Creates a markup viewer.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IMarkupViewerSettings>

Returns

Viewer<IMarkupViewerSettings>

---

matrixPlot()

static matrixPlot(t, options?): MatrixPlot

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

Creates a matrix plot.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IMatrixPlotSettings>

Returns

MatrixPlot

---

network()

static network(t, options?): NetworkDiagramViewer

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

Creates a network diagram.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<INetworkDiagramSettings>

Returns

NetworkDiagramViewer

---

pcPlot()

static pcPlot(t, options?): PcPlot

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

Creates a parallel-coordinates plot.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPcPlotSettings>

Returns

PcPlot

---

pieChart()

static pieChart(t, options?): PieChartViewer

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

Creates a pie chart.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPieChartSettings>

Returns

PieChartViewer

---

pivotTable()

static pivotTable(t, options?): PivotViewer

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

Creates a pivot table.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPivotViewerSettings>

Returns

PivotViewer

---

registerCleanup()

static registerCleanup(element, cleanup): void

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

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	Callback

Returns

void

Inherited from

Widget.registerCleanup

---

rocCurve()

static rocCurve(t, options?): RocCurve

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

Creates a ROC curve.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IRocCurveSettings>

Returns

RocCurve

---

sameValue()

static sameValue(a, b): boolean

Defined in: js-api/src/u2core/component.ts:111

The equality the property tier and link suppress echoes by: Object.is, arrays element-wise, plain objects key-wise (recursive), everything else by identity.

Parameters

Parameter	Type
a	unknown
b	unknown

Returns

boolean

Inherited from

Widget.sameValue

---

scatterPlot()

static scatterPlot(t, options?): ScatterPlotViewer

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

Creates a scatter plot.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IScatterPlotSettings>

Returns

ScatterPlotViewer

---

scatterPlot3d()

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

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

Creates a 3D scatter plot.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IScatterPlot3dSettings>

Returns

Viewer<IScatterPlot3dSettings>

---

statistics()

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

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

Creates a statistics viewer.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IStatsViewerSettings>

Returns

Viewer<IStatsViewerSettings>

---

tile()

static tile(t, options?): TileViewer

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

Creates a tile viewer.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITileViewerSettings>

Returns

TileViewer

---

treeMap()

static treeMap(t, options?): TreeMap

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

Creates a tree map.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITreeMapSettings>

Returns

TreeMap

---

trellisPlot()

static trellisPlot(t, options?): TrellisPlotViewer

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

Creates a trellis plot.

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITrellisPlotSettings>

Returns

TrellisPlotViewer