ScatterPlotViewer

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

2D scatter plot

Extends

• Viewer<IScatterPlotSettings>

Constructors

Constructor

new ScatterPlotViewer(dart): ScatterPlotViewer

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

Parameters

Parameter	Type
dart	any

Returns

ScatterPlotViewer

Overrides

Viewer.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	Viewer._functions	js-api/src/widgets/base.ts:218
_properties	protected	Property[]	[]	-	Viewer._properties	js-api/src/widgets/base.ts:217
_root	protected	HTMLElement	undefined	-	Viewer._root	js-api/src/u2core/component.ts:666
_u2	readonly	ComponentState	undefined	-	Viewer._u2	js-api/src/u2core/component.ts:119
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.	Viewer.componentMeta	js-api/src/u2core/component.ts:114
dart	public	any	undefined	-	Viewer.dart	js-api/src/widgets/base.ts:223
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	Viewer.factory	js-api/src/widgets/base.ts:215
isDetached	public	boolean	false	Whether detach has been called.	Viewer.isDetached	js-api/src/widgets/base.ts:225
props	public	IScatterPlotSettings & ObjectPropertyBag	undefined	Property bag over this widget's properties; read and write them by name.	Viewer.props	js-api/src/widgets/base.ts:220
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.	Viewer.specProps	js-api/src/u2core/component.ts:118
subs	public	Subscription[]	undefined	Subscriptions cancelled when the widget is detached.	Viewer.subs	js-api/src/widgets/base.ts:222
tags	public	any	undefined	Viewer tags: a string map persisted with the layout.	Viewer.tags	js-api/src/viewer.ts:123
temp	public	any	undefined	Contains auxiliary information	Viewer.temp	js-api/src/widgets/base.ts:212
CORE_VIEWER_TYPES	static	string[]	undefined	Viewer types that ship with the platform and are available synchronously.	Viewer.CORE_VIEWER_TYPES	js-api/src/viewer.ts:527
isRoot	static	boolean	false	A root has no owner by design (a dialog): built with none, it is not reported as owner-missing.	Viewer.isRoot	js-api/src/u2core/component.ts:81

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

Inherited from

Viewer.aiDescription

---

ambientAdoption

Get Signature

get protected ambientAdoption(): boolean

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

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

Returns

boolean

Inherited from

Viewer.ambientAdoption

---

canvas

Get Signature

get canvas(): HTMLCanvasElement

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

The main canvas.

Returns

HTMLCanvasElement

---

children

Get Signature

get children(): Widget<any>[]

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

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

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

Inherited from

Viewer.dataFrame

---

descriptor

Get Signature

get descriptor(): WidgetDescriptor

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

Descriptor of this widget.

Returns

WidgetDescriptor

Inherited from

Viewer.descriptor

---

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

Inherited from

Viewer.filter

---

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

Inherited from

Viewer.helpUrl

---

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

Inherited from

Viewer.immediateRendering

---

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

Inherited from

Viewer.isRenderPending

---

meta

Get Signature

get meta(): ViewerMetaHelper

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

Formula lines and annotation regions of this viewer.

Returns

ViewerMetaHelper

Inherited from

Viewer.meta

---

name

Get Signature

get name(): string | undefined

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

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

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

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

Inherited from

Viewer.onAfterDrawOverlay

---

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

Inherited from

Viewer.onAfterDrawScene

---

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

Inherited from

Viewer.onAfterLayout

---

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

Inherited from

Viewer.onBeforeDrawOverlay

---

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

Inherited from

Viewer.onBeforeDrawScene

---

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>

Inherited from

Viewer.onContextMenu

---

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>

Inherited from

Viewer.onDartPropertyChanged

---

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>

Inherited from

Viewer.onDataEvent

---

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>

Inherited from

Viewer.onDataFrameChanged

---

onDataRowClicked

Get Signature

get onDataRowClicked(): Observable<ViewerEvent>

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

current row clicked

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataRowClicked

---

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>

Inherited from

Viewer.onDataSelected

---

onDetached

Get Signature

get onDetached(): Observable<any>

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

Occurs when viewer is detached.

Returns

Observable<any>

Inherited from

Viewer.onDetached

---

onPointClicked

Get Signature

get onPointClicked(): Observable<EventData<RowDataArgs>>

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

Fires when a point is clicked; args.rowId is the row.

Returns

Observable<EventData<RowDataArgs>>

---

onPointDoubleClicked

Get Signature

get onPointDoubleClicked(): Observable<EventData<RowDataArgs>>

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

Fires when a point is double-clicked.

Returns

Observable<EventData<RowDataArgs>>

---

onPointsSelected

Get Signature

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

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

Fires after the user selects points (lasso or rectangle).

Returns

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

Inherited from

Viewer.onPropertyValueChanged

---

onResetView

Get Signature

get onResetView(): Observable<null>

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

Returns

Observable<null>

---

onResized

Get Signature

get onResized(): Observable<null>

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

Fires when the viewer is resized.

Returns

Observable<null>

Inherited from

Viewer.onResized

---

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>

Inherited from

Viewer.onTooltipCreated

---

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

Inherited from

Viewer.onViewerRendered

---

onViewportChanged

Get Signature

get onViewportChanged(): Observable<Rect>

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

Fires whenever the visible region changes (zoom, pan, reset).

Returns

Observable<Rect>

---

onZoomed

Get Signature

get onZoomed(): Observable<Rect>

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

Returns

Observable<Rect>

---

overlay

Get Signature

get overlay(): HTMLCanvasElement

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

The overlay canvas (selection, hover).

Returns

HTMLCanvasElement

---

parent

Get Signature

get parent(): Widget<any> | null

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

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

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

Inherited from

Viewer.propertyTarget

---

propertyTier

Get Signature

get propertyTier(): boolean

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

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

Returns

boolean

Inherited from

Viewer.propertyTier

---

root

Get Signature

get root(): HTMLElement

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

Visual root.

Returns

HTMLElement

Inherited from

Viewer.root

---

rootId

Get Signature

get rootId(): string

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

Stable element id, minted (u2-<n>) on first ask unless the root has one: the anchor of for, aria-* and data-u2-owner-id references.

Returns

string

Inherited from

Viewer.rootId

---

scope

Get Signature

get scope(): Scope

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

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. Lazy: counted and tracked only once it owns something, so a static control costs nothing.

Returns

Scope

Inherited from

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

Inherited from

Viewer.table

---

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

Inherited from

Viewer.tableView

---

type

Get Signature

get type(): ViewerType

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

Returns viewer type (see VIEWER constants)

Returns

ViewerType

Inherited from

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

Inherited from

Viewer.view

---

viewBox

Get Signature

get viewBox(): Rect

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

Plot area in canvas coordinates.

Returns

Rect

---

viewport

Get Signature

get viewport(): Rect

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

Visible region in world (data) coordinates; set it to zoom programmatically.

Returns

Rect

Set Signature

set viewport(viewport): void

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

Parameters

Parameter	Type
viewport	Rect

Returns

void

---

visible

Get Signature

get visible(): boolean

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

Hidden ⇔ the root carries the hidden attribute.

Returns

boolean

Set Signature

set visible(x): void

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

Parameters

Parameter	Type
x	boolean

Returns

void

Inherited from

Viewer.visible

---

xAxisBox

Get Signature

get xAxisBox(): Rect

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

X-axis area in canvas coordinates.

Returns

Rect

---

xAxisSlider

Get Signature

get xAxisSlider(): RangeSlider

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

The horizontal (X) axis range slider. Its isCustomRange flips to true once the X range is narrowed; drives whether the slider auto-hides.

Returns

RangeSlider

---

yAxisBox

Get Signature

get yAxisBox(): Rect

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

Y-axis area in canvas coordinates.

Returns

Rect

---

yAxisSlider

Get Signature

get yAxisSlider(): RangeSlider

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

The vertical (Y) axis range slider.

Returns

RangeSlider

Methods

_notifyPropertyChange()

protected _notifyPropertyChange(p): void

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

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

Viewer._notifyPropertyChange

---

_ownPropertyChanges()

protected _ownPropertyChanges(): ObservableLike<PropertyChange>

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

Returns

ObservableLike<PropertyChange>

Inherited from

Viewer._ownPropertyChanges

---

_scopeMinted()

protected _scopeMinted(_scope): void

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

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

Viewer._scopeMinted

---

_wireDartLifecycle()

protected _wireDartLifecycle(): void

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

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

Returns

void

Inherited from

Viewer._wireDartLifecycle

---

_wireJsLifecycle()

protected _wireJsLifecycle(): void

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

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

Returns

void

Inherited from

Viewer._wireJsLifecycle

---

_wireLifecycle()

protected _wireLifecycle(): void

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

Returns

void

Inherited from

Viewer._wireLifecycle

---

accessibleLabel()

protected accessibleLabel(): string | undefined

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

The accessible name: aria-label, then the aria-labelledby texts, then this control's own data-u2-part="label" element, then — for a root that is a button — its own text.

Returns

string | undefined

Inherited from

Viewer.accessibleLabel

---

addProperty()

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

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

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" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "blob" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "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

Viewer.addProperty

---

addStatusProvider()

addStatusProvider(name, provider): void

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

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

Viewer.addStatusProvider

---

apply()

apply(properties): Widget

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

Sets each key of properties as the property of that name; returns this widget.

Parameters

Parameter	Type
properties	object

Returns

Widget

Inherited from

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

Inherited from

Viewer.bindProps

---

bindStep()

bindStep(name): Signal<unknown> | BindSource | 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

Signal<unknown> | BindSource | null

Inherited from

Viewer.bindStep

---

close()

close(): void

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

Closes and detaches the viewer.

Returns

void

Inherited from

Viewer.close

---

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

Inherited from

Viewer.copyViewersLook

---

deriveName()

protected deriveName(x): void

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

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

Viewer.deriveName

---

detach()

detach(): void

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

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

Viewer.detach

---

disableAnnotationRegionDrawing()

disableAnnotationRegionDrawing(): void

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

Returns

void

---

dispose()

dispose(): void

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

Disposes the control; disposed by hand, it also leaves the page — a dead control left on show looks alive. One its owner disposes leaves the DOM to whoever holds it: a region swapping its content, a spec re-rendering.

Returns

void

Inherited from

Viewer.dispose

---

effect()

effect(fn): this

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

Runs fn now and on every change of the signals it reads, until this component is disposed. Called while a row of each() or an effect run is being built, it belongs on a control built there (input.effect(...)) — on a longer-lived one it piles up with every rebuild, and u2 warns.

Parameters

Parameter	Type
fn	() => void

Returns

this

Inherited from

Viewer.effect

---

enableAnnotationRegionDrawing()

enableAnnotationRegionDrawing(lassoMode?, onAfterDraw?): void

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

Parameters

Parameter	Type
lassoMode?	boolean
onAfterDraw?	(region) => void

Returns

void

---

fireEvent()

protected fireEvent(eventId, args?): void

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

Every matching listener runs inside one batch; a throwing one is reported to this component's scope and does not stop the rest.

Parameters

Parameter	Type
eventId	string
args?	unknown

Returns

void

Inherited from

Viewer.fireEvent

---

getDartProperties()

getDartProperties(): any[]

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

Dart handles of the properties that have one.

Returns

any[]

Inherited from

Viewer.getDartProperties

---

getFunctions()

getFunctions(): Func[]

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

Functions applicable to the underlying Dart viewer.

Returns

Func[]

Inherited from

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

Inherited from

Viewer.getInfo

---

getItems()

getItems(_opts?): IItemsState | undefined

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

Items of a collection-like control; undefined for other kinds. list holds the first ITEMS_CAP unless all.

Parameters

Parameter	Type
_opts?	{ all?: boolean; }
_opts.all?	boolean

Returns

IItemsState | undefined

Inherited from

Viewer.getItems

---

getMarkerColor()

getMarkerColor(rowIdx): number

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

Marker color of [rowIdx] as ARGB.

Parameters

Parameter	Type
rowIdx	number

Returns

number

---

getMarkerColors()

getMarkerColors(): Uint32Array

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

Marker colors of all rows as ARGB.

Returns

Uint32Array

---

getMarkerSize()

getMarkerSize(rowIdx): number

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

Marker size of [rowIdx], in pixels.

Parameters

Parameter	Type
rowIdx	number

Returns

number

---

getMarkerSizes()

getMarkerSizes(): Float32Array

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

Marker sizes of all rows, in pixels.

Returns

Float32Array

---

getMarkerType()

getMarkerType(rowIdx): string

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

Marker type of [rowIdx] (see MARKER_TYPE).

Parameters

Parameter	Type
rowIdx	number

Returns

string

---

getMarkerTypes()

getMarkerTypes(): Uint32Array

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

Marker type indexes of all rows.

Returns

Uint32Array

---

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

Inherited from

Viewer.getOptions

---

getProperties()

getProperties(): Property[]

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

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

Returns

Property[]

Inherited from

Viewer.getProperties

---

getRowTooltip()

getRowTooltip(rowIdx): HTMLDivElement

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

The tooltip element the plot shows for [rowIdx].

Parameters

Parameter	Type
rowIdx	number

Returns

HTMLDivElement

---

getState()

getState(): IControlState

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

The state block generic tests read (DG.U2.state). This base reads the DOM — kind, name, accessible name, aria-disabled, hidden, focus, aria-busy — plus getItems; a subclass adds what the DOM cannot say and spreads super.getState(). Synchronous, side-effect free, never cached.

Returns

IControlState

Inherited from

Viewer.getState

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

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

Returns the widget's runtime structure for automated testing and introspection; state is read off the DOM (kind, label, enabled, visible, focused …), then merged with what providers contribute.

Returns

IWidgetStatus

Inherited from

Viewer.getWidgetStatus

---

hitTest()

hitTest(x, y): number

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

Row hit test using canvas coords

Parameters

Parameter	Type
x	number
y	number

Returns

number

---

initDartObject()

initDartObject(dart): void

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

Parameters

Parameter	Type
dart	any

Returns

void

Inherited from

Viewer.initDartObject

---

invalidateCanvas()

invalidateCanvas(): void

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

Rerender plot

Returns

void

---

link()

link(name, source, twoWay): void

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

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

Viewer.link

---

on()

on(eventId, handler): () => void

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

Subscribes handler to onEvent(eventId); it gets the payload and this component. Owned by the ambient scope when there is one (the subscriber's), else by this component; runs as Scope.bind runs a handler. Answers the unsubscribe.

Parameters

Parameter	Type
eventId	string
handler	(arg, source) => void

Returns

() => void

Inherited from

Viewer.on

---

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>

Inherited from

Viewer.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

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

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

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Viewer.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

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

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

---

own()

own(dispose): this

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

Registers a cleanup that runs when this component is disposed.

Parameters

Parameter	Type
dispose	() => void

Returns

this

Inherited from

Viewer.own

---

pointToScreen()

pointToScreen(index): Point

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

32-bit integer with X in the hi 16 bits, and Y in the lo 16 bits

Parameters

Parameter	Type
index	number

Returns

Point

---

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>

Inherited from

Viewer.propertyChanges

---

registerFunction()

protected registerFunction(f): void

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

Parameters

Parameter	Type
f	FuncLike

Returns

void

Inherited from

Viewer.registerFunction

---

removeFromView()

removeFromView(): any

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

Removes the viewer from its view without disposing it.

Returns

any

Inherited from

Viewer.removeFromView

---

removeStatusProvider()

removeStatusProvider(name): void

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

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

Viewer.removeStatusProvider

---

render()

render(g): void

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

Renders the plot into [g].

Parameters

Parameter	Type
g	CanvasRenderingContext2D

Returns

void

---

revealItem()

revealItem(keyOrLabel): Promise<HTMLElement | null>

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

Brings the item into view and resolves to its element, or null when none matches: the exact key (data-u2-item) first, then the label, trimmed and case-insensitive. Several label matches reject, naming the candidates. This base searches the rendered [data-u2-item] elements under the root and in the popups it owns; a virtual or collapsible control overrides it to scroll or expand first.

Parameters

Parameter	Type
keyOrLabel	string

Returns

Promise<HTMLElement | null>

Inherited from

Viewer.revealItem

---

runInScope()

runInScope<T>(fn): T

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

Runs fn with this component's scope ambient: what it builds is owned by this component.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
fn	() => T

Returns

T

Deprecated

Use the owner verb build(fn) (OwnerVerbs.build): this.build(fn), dialog.build(fn).

Inherited from

Viewer.runInScope

---

screenToWorld()

screenToWorld(x, y): Point

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

Parameters

Parameter	Type
x	number
y	number

Returns

Point

---

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

Returns

void

Inherited from

Viewer.setOptions

---

sourceRowsChanged()

sourceRowsChanged(): void

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

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

Returns

void

Inherited from

Viewer.sourceRowsChanged

---

sub()

sub(subscription): void

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

Registers a subscription to an external event.

Parameters

Parameter	Type
subscription	Subscription

Returns

void

Inherited from

Viewer.sub

---

subscribe()

subscribe<T>(source, handler): () => void

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

Subscribes handler to source until this owner is disposed. See Scope.subscribe.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
source	ObservableLike<T>
handler	(value) => void

Returns

() => void

Inherited from

OwnerVerbs.subscribe

---

task()

task<R>(fn, options?): TaskRun

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

Async work owned here. See Scope.task.

Type Parameters

Type Parameter
R

Parameters

Parameter	Type
fn	(t) => R | PromiseLike<R>
options?	TaskOptions

Returns

TaskRun

Inherited from

OwnerVerbs.task

---

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

Inherited from

Viewer.toCompactLook

---

toDart()

toDart(): any

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

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

Returns

any

Inherited from

Viewer.toDart

---

worldToScreen()

worldToScreen(x, y): Point

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

Convert coords

Parameters

Parameter	Type
x	number
y	number

Returns

Point

---

zoom()

zoom(x1, y1, x2, y2): void

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

Zoom using world coords

Parameters

Parameter	Type
x1	number
y1	number
x2	number
y2	number

Returns

void

---

_isPlain()

protected static _isPlain(x): x is Record<string, unknown>

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

Parameters

Parameter	Type
x	unknown

Returns

x is Record<string, unknown>

Inherited from

Viewer._isPlain

---

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

Inherited from

Viewer.barChart

---

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

Inherited from

Viewer.boxPlot

---

build()

Call Signature

static build(builder, options?): Control

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

The function component component makes, under its old name.

Parameters

Parameter	Type
builder	(self) => BuiltRoot
options?	ControlBuildOptions

Returns

Control

Deprecated

Use component: one spelling, apart from an owner's build(fn).

Inherited from

Viewer.build

Call Signature

static build<R>(builder, options?): never

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

The function component component makes, under its old name.

Type Parameters

Type Parameter
R extends BuiltHandle

Parameters

Parameter	Type
builder	(self) => R
options?	ControlBuildOptions

Returns

never

Deprecated

Use component: one spelling, apart from an owner's build(fn).

Inherited from

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

Inherited from

Viewer.calendar

---

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

Inherited from

Viewer.canVisualize

---

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

Inherited from

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

Inherited from

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

Inherited from

Viewer.densityPlot

---

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>

Inherited from

Viewer.filters

---

find()

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

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

Viewer.find

---

forElement()

static forElement(el): Control | undefined

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

The nearest control owning el — the DOM → component door for tooling, automation and inspectors (the u2 counterpart of the platform's Widget.find): the nearest root at or above el, else, inside a popup portaled to the body, the popup's owner (data-u2-owner-id). Best-effort: the last control constructed on (or assigned) a root wins it. The root carries the control under Symbol.for('u2.control'), so every engine copy on the page answers alike.

Parameters

Parameter	Type
el	Element | null

Returns

Control | undefined

Inherited from

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

Inherited from

Viewer.form

---

fromRoot()

static fromRoot(root): Widget

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

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

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

Inherited from

Viewer.fromType

---

getAll()

static getAll(): Widget<any>[]

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

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

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

Inherited from

Viewer.getViewerTypes

---

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

Inherited from

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

Inherited from

Viewer.heatMap

---

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

Inherited from

Viewer.histogram

---

init()

static init(self, scope?): void

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

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

Viewer.init

---

is()

static is(x): x is Control

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

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

Parameters

Parameter	Type
x	unknown

Returns

x is Control

Inherited from

Viewer.is

---

jsonValue()

static jsonValue(x, depth?): JsonValue | undefined

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

The JSON-safe projection behind IControlState.value: a Date → its ISO string, an object with a string name (an entity, a column) → the name, arrays and sets element-wise, plain objects key-wise (depth 4), a signal → its current value; functions and elements → undefined; anything else → String(x).

Parameters

Parameter	Type	Default value
x	unknown	undefined
depth	number	0

Returns

JsonValue | undefined

Inherited from

Viewer.jsonValue

---

labelOf()

protected static labelOf(el): string | undefined

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

aria-label, else the joined texts of the aria-labelledby elements; undefined when neither names el.

Parameters

Parameter	Type
el	Element

Returns

string | undefined

Inherited from

Viewer.labelOf

---

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

Inherited from

Viewer.lineChart

---

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>

Inherited from

Viewer.markup

---

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

Inherited from

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

Inherited from

Viewer.network

---

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

Inherited from

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

Inherited from

Viewer.pieChart

---

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

Inherited from

Viewer.pivotTable

---

registerCleanup()

static registerCleanup(element, cleanup): void

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

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

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

Inherited from

Viewer.rocCurve

---

sameValue()

static sameValue(a, b): boolean

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

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

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

Inherited from

Viewer.scatterPlot

---

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>

Inherited from

Viewer.scatterPlot3d

---

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>

Inherited from

Viewer.statistics

---

text()

protected static text(el): string

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

The text the user reads: trimmed, single-spaced.

Parameters

Parameter	Type
el	Element

Returns

string

Inherited from

Viewer.text

---

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

Inherited from

Viewer.tile

---

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

Inherited from

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

Inherited from

Viewer.trellisPlot