Grid
Defined in: js-api/src/grid.ts:941
Base class for controls that have a visual root and a set of properties.
Extends
Constructors
Constructor
new Grid(
dart):Grid
Defined in: js-api/src/grid.ts:953
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
Grid
Overrides
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 | IGridSettings & 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 |
CONFLICT_CELL_COLOR | readonly | 4294959282 | 0xFFFFE0B2 | - | - | js-api/src/grid.ts:948 |
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:537 |
DIRTY_CELL_COLOR | readonly | 4294964173 | 0xFFFFF3CD | Background of a cell with an unsaved edit. Canvas ARGB ints, matching the platform's own in-grid editing — cell backgrounds are painted on the canvas, so they are not CSS-token territory. The amber and the orange have no Color equivalent; the red is the platform's own grid warning. | - | js-api/src/grid.ts:946 |
INVALID_CELL_COLOR | readonly | number | Color.gridWarningBackground | - | - | js-api/src/grid.ts:947 |
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
ambientAdoption
Get Signature
get
protectedambientAdoption():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
canvas
Get Signature
get canvas():
HTMLCanvasElement
Defined in: js-api/src/grid.ts:1171
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
colHeaderBox
Get Signature
get colHeaderBox():
Rect
Defined in: js-api/src/grid.ts:1292
Column labels box
Returns
colHeaderHeight
Get Signature
get colHeaderHeight():
number
Defined in: js-api/src/grid.ts:1284
Column labels height
Returns
number
columns
Get Signature
get columns():
GridColumnList
Defined in: js-api/src/grid.ts:1137
Grid columns.
Returns
dataFrame
Get Signature
get dataFrame():
DataFrame
Defined in: js-api/src/viewer.ts:333
Returns
Set Signature
set dataFrame(
t):void
Defined in: js-api/src/viewer.ts:334
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
Returns
void
Inherited from
descriptor
Get Signature
get descriptor():
WidgetDescriptor
Defined in: js-api/src/viewer.ts:141
Descriptor of this widget.
Returns
Inherited from
editor
Get Signature
get editor():
IFrameEditor|null
Defined in: js-api/src/grid.ts:974
The editing engine attached through attachEditor, or null.
Returns
IFrameEditor | null
filter
Get Signature
get filter():
BitSet
Defined in: js-api/src/viewer.ts:134
combined filter of the viewer
Returns
Set Signature
set filter(
f):void
Defined in: js-api/src/viewer.ts:137
Parameters
| Parameter | Type |
|---|---|
f | BitSet |
Returns
void
Inherited from
helpUrl
Get Signature
get helpUrl():
string
Defined in: js-api/src/viewer.ts:337
Help URL
Returns
string
Set Signature
set helpUrl(
s):void
Defined in: js-api/src/viewer.ts:338
Parameters
| Parameter | Type |
|---|---|
s | string |
Returns
void
Inherited from
horzScroll
Get Signature
get horzScroll():
RangeSlider
Defined in: js-api/src/grid.ts:1279
Horizontal scroll bar
Returns
immediateRendering
Get Signature
get immediateRendering():
boolean
Defined in: js-api/src/viewer.ts:343
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:344
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
Inherited from
isRenderPending
Get Signature
get isRenderPending():
boolean
Defined in: js-api/src/viewer.ts:348
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
meta
Get Signature
get meta():
ViewerMetaHelper
Defined in: js-api/src/viewer.ts:306
Formula lines and annotation regions of this viewer.
Returns
Inherited from
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
onAfterDrawContent
Get Signature
get onAfterDrawContent():
Observable<EventData<any>>
Defined in: js-api/src/grid.ts:1344
Fires after the cell content is drawn.
Returns
Observable<EventData<any>>
onAfterDrawOverlay
Get Signature
get onAfterDrawOverlay():
Observable<EventData<any>>
Defined in: js-api/src/grid.ts:1340
Fires after the overlay is drawn — draw on top of the grid here.
Returns
Observable<EventData<any>>
Overrides
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
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
onBeforeDrawContent
Get Signature
get onBeforeDrawContent():
Observable<EventData<any>>
Defined in: js-api/src/grid.ts:1342
Fires before the cell content is drawn.
Returns
Observable<EventData<any>>
onBeforeDrawOverlay
Get Signature
get onBeforeDrawOverlay():
Observable<EventData<any>>
Defined in: js-api/src/grid.ts:1338
Fires before the overlay (interactive layer) is drawn; preventDefault() to draw it yourself.
Returns
Observable<EventData<any>>
Overrides
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
onCellClick
Get Signature
get onCellClick():
Observable<GridCell<any>>
Defined in: js-api/src/grid.ts:1327
Fires when a cell is clicked.
Returns
Observable<GridCell<any>>
onCellDoubleClick
Get Signature
get onCellDoubleClick():
Observable<GridCell<any>>
Defined in: js-api/src/grid.ts:1329
Fires when a cell is double-clicked.
Returns
Observable<GridCell<any>>
onCellKeyDown
Get Signature
get onCellKeyDown():
Observable<GridCell<any>>
Defined in: js-api/src/grid.ts:1333
Fires on key-down while a cell has focus.
Returns
Observable<GridCell<any>>
onCellMouseDown
Get Signature
get onCellMouseDown():
Observable<GridCell<any>>
Defined in: js-api/src/grid.ts:1331
Fires on mouse-down over a cell, before the click is processed.
Returns
Observable<GridCell<any>>
onCellMouseEnter
Get Signature
get onCellMouseEnter():
Observable<GridCell<any>>
Defined in: js-api/src/grid.ts:1322
Fires when the mouse enters a cell.
Returns
Observable<GridCell<any>>
onCellMouseLeave
Get Signature
get onCellMouseLeave():
Observable<GridCell<any>>
Defined in: js-api/src/grid.ts:1324
Fires when the mouse leaves a cell.
Returns
Observable<GridCell<any>>
onCellRender
Get Signature
get onCellRender():
Observable<GridCellRenderArgs>
Defined in: js-api/src/grid.ts:1159
Occurs before the grid cell is rendered. Call args.preventDefault() to suppress the standard
rendering and draw your own via args.g within args.bounds.
Sample: https://public.datagrok.ai/js/samples/grid/events/custom-cell-rendering-indexes
See also onCellRendered.
Returns
Observable<GridCellRenderArgs>
onCellRendered
Get Signature
get onCellRendered():
Observable<GridCellRenderArgs>
Defined in: js-api/src/grid.ts:1166
Occurs after the grid cell has been rendered. See also onCellRender.
Returns
Observable<GridCellRenderArgs>
onCellValueEdited
Get Signature
get onCellValueEdited():
Observable<GridCell<any>>
Defined in: js-api/src/grid.ts:1318
Fires after the user edits a cell value; emits the edited GridCell.
Returns
Observable<GridCell<any>>
onColumnResized
Get Signature
get onColumnResized():
Observable<any>
Defined in: js-api/src/grid.ts:1305
Sample: https://public.datagrok.ai/js/samples/grid/resize/resize-events
Returns
Observable<any>
onContextMenu
Get Signature
get onContextMenu():
Observable<Menu>
Defined in: js-api/src/viewer.ts:476
Fires when the viewer builds its context menu; add items to the emitted Menu.
Returns
Observable<Menu>
Inherited from
onCurrentCellChanged
Get Signature
get onCurrentCellChanged():
Observable<GridCell<any>>
Defined in: js-api/src/grid.ts:1320
Fires when the current (focused) grid cell changes.
Returns
Observable<GridCell<any>>
onDartPropertyChanged
Get Signature
get onDartPropertyChanged():
Observable<null>
Defined in: js-api/src/viewer.ts:504
Low-level stream of property changes on the Dart side; prefer onPropertyValueChanged.
Returns
Observable<null>
Inherited from
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
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
onDataRowClicked
Get Signature
get onDataRowClicked():
Observable<ViewerEvent>
Defined in: js-api/src/viewer.ts:167
current row clicked
Returns
Observable<ViewerEvent>
Inherited from
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
onDetached
Get Signature
get onDetached():
Observable<any>
Defined in: js-api/src/viewer.ts:519
Occurs when viewer is detached.
Returns
Observable<any>
Inherited from
onGridCellLinkClicked
Get Signature
get onGridCellLinkClicked():
Observable<EventData<GridCellArgs>>
Defined in: js-api/src/grid.ts:1348
Fires when a link inside a cell of this grid is clicked; args.gridCell and args.link.
Returns
Observable<EventData<GridCellArgs>>
onPinnedRowsChanged
Get Signature
get onPinnedRowsChanged():
Observable<any>
Defined in: js-api/src/grid.ts:1315
Fires when rows are pinned or unpinned.
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>>
Inherited from
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
onRowEnter
Get Signature
get onRowEnter():
Observable<GridCell<any>>
Defined in: js-api/src/grid.ts:1335
Fires when the mouse enters a row.
Returns
Observable<GridCell<any>>
onRowsResized
Get Signature
get onRowsResized():
Observable<any>
Defined in: js-api/src/grid.ts:1310
Sample: https://public.datagrok.ai/js/samples/grid/resize/resize-events
Returns
Observable<any>
onRowsSorted
Get Signature
get onRowsSorted():
Observable<any>
Defined in: js-api/src/grid.ts:1313
Sample: https://public.datagrok.ai/js/samples/grid/order/order-rows
Returns
Observable<any>
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
onTooltipCreating
Get Signature
get onTooltipCreating():
Observable<GridTooltipArgs>
Defined in: js-api/src/grid.ts:1346
Fires before a cell tooltip is shown; preventDefault() to suppress it or supply your own.
Returns
Observable<GridTooltipArgs>
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
overlay
Get Signature
get overlay():
HTMLCanvasElement
Defined in: js-api/src/grid.ts:1176
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
pinnedRows
Get Signature
get pinnedRows():
Iterable<number>
Defined in: js-api/src/grid.ts:1242
Pinned rows.
Returns
Iterable<number>
propertyTarget
Get Signature
get propertyTarget():
unknown
Defined in: js-api/src/viewer.ts:255
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
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
root
Get Signature
get root():
HTMLElement
Defined in: js-api/src/viewer.ts:301
Visual root.
Returns
HTMLElement
Inherited from
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
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
Inherited from
sortByColumns
Get Signature
get sortByColumns():
Column<any,any>[]
Defined in: js-api/src/grid.ts:1181
List of columns the grid is sorted by.
Returns
Column<any, any>[]
sortTypes
Get Signature
get sortTypes():
boolean[]
Defined in: js-api/src/grid.ts:1184
Sort directions for [sortByColumns]: true = ascending order, false = descending order.
Returns
boolean[]
table
Get Signature
get table():
DataFrame
Defined in: js-api/src/viewer.ts:318
The DataFrame this viewer is attached to. Same as dataFrame.
Returns
Inherited from
tableView
Get Signature
get tableView():
TableView|null
Defined in: js-api/src/viewer.ts:328
Returns a view this viewer is associated with, or null
Returns
TableView | null
Inherited from
type
Get Signature
get type():
ViewerType
Defined in: js-api/src/viewer.ts:313
Returns viewer type (see VIEWER constants)
Returns
Inherited from
vertScroll
Get Signature
get vertScroll():
RangeSlider
Defined in: js-api/src/grid.ts:1268
Vertical scroll bar. Sample: https://public.datagrok.ai/js/samples/grid/navigate/scroll-bars
Returns
view
Get Signature
get view():
View|null
Defined in: js-api/src/viewer.ts:323
Returns a view this viewer is associated with, or null
Returns
View | null
Inherited from
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
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
_ownPropertyChanges()
protected_ownPropertyChanges():ObservableLike<PropertyChange>
Defined in: js-api/src/widgets/base.ts:365
Returns
ObservableLike<PropertyChange>
Inherited from
_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
_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
_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
_wireLifecycle()
protected_wireLifecycle():void
Defined in: js-api/src/viewer.ts:267
Returns
void
Inherited from
accessibleLabel()
protectedaccessibleLabel():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
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
addStatusProvider()
addStatusProvider(
name,provider):void
Defined in: js-api/src/widgets/base.ts:467
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
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
Inherited from
attachEditor()
attachEditor(
editor):void
Defined in: js-api/src/grid.ts:992
Makes this grid the host of [editor] (replacing any previous one): in-grid
edits are reported to it, its state paints the cells (amber pending, red
invalid, orange conflict, the message as the tooltip), every ~ service
column is hidden and locked, and editability follows
editor.writableColumns / editor.isSaving per column and
editor.canEdit per cell. The grid never writes the editing state itself —
the editor is its single writer.
const editor = await DG.DomainFrameEditor.attach(df, grok.dapi.domains.table('grit.issue'));
const grid = DG.Grid.create(df);
DG.DomainObjectHandler.decorateGrid(grid, 'grit.issue', df);
grid.attachEditor(editor);
Parameters
| Parameter | Type |
|---|---|
editor | IFrameEditor |
Returns
void
autoSize()
autoSize(
maxWidth,maxHeight,minWidth?,minHeight?,autoSizeOnDataChange?):void
Defined in: js-api/src/grid.ts:1356
Resizes the grid to fit the content
Parameters
| Parameter | Type |
|---|---|
maxWidth | number |
maxHeight | number |
minWidth? | number |
minHeight? | number |
autoSizeOnDataChange? | boolean |
Returns
void
bindProps()
bindProps():
BindProp[]
Defined in: js-api/src/viewer.ts:287
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
bindStep()
bindStep(
name):Signal<unknown> |BindSource|null
Defined in: js-api/src/viewer.ts:274
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
cell()
Call Signature
cell(
gridRow,columnName):GridCell
Defined in: js-api/src/grid.ts:1148
Returns the grid cell at the specified position; both argument orders are accepted, the (row, column) one matches DataFrame.cell.
Parameters
| Parameter | Type |
|---|---|
gridRow | number |
columnName | string |
Returns
Call Signature
cell(
columnName,gridRow):GridCell
Defined in: js-api/src/grid.ts:1149
Returns the grid cell at the specified position; both argument orders are accepted, the (row, column) one matches DataFrame.cell.
Parameters
| Parameter | Type |
|---|---|
columnName | string |
gridRow | number |
Returns
close()
close():
void
Defined in: js-api/src/viewer.ts:296
Closes and detaches the viewer.
Returns
void
Inherited from
col()
col(
name):GridColumn<any> |null
Defined in: js-api/src/grid.ts:1142
Returns a column with the specified name.
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
GridColumn<any> | null
copyViewersLook()
copyViewersLook(
other):void
Defined in: js-api/src/viewer.ts:522
Copies all settings (the look) from [other] into this viewer.
Parameters
| Parameter | Type |
|---|---|
other | Viewer |
Returns
void
Inherited from
deriveName()
protectedderiveName(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
detach()
detach():
void
Defined in: js-api/src/grid.ts:1103
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
Overrides
detachEditor()
detachEditor():
void
Defined in: js-api/src/grid.ts:1094
Releases the editor's subscriptions; the grid keeps its frame and columns.
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
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
fireEvent()
protectedfireEvent(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
getDartProperties()
getDartProperties():
any[]
Defined in: js-api/src/widgets/base.ts:296
Dart handles of the properties that have one.
Returns
any[]
Inherited from
getFunctions()
getFunctions():
Func[]
Defined in: js-api/src/viewer.ts:144
Functions applicable to the underlying Dart viewer.
Returns
Func[]
Inherited from
getInfo()
getInfo():
object
Defined in: js-api/src/viewer.ts:244
Viewer internals exposed for diagnostics and tests (canvas, overlay, and more), keyed by name.
Returns
object
Inherited from
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
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<IGridSettings> | js-api/src/viewer.ts:229 |
type | ViewerType | js-api/src/viewer.ts:229 |
Inherited from
getProperties()
getProperties():
Property[]
Defined in: js-api/src/viewer.ts:249
All properties of this viewer, including the data-bound ones.
Returns
Property[]
Inherited from
getRowOrder()
getRowOrder():
Int32Array
Defined in: js-api/src/grid.ts:1229
Returns the order of rows in the table.
Returns
Int32Array
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
Inherited from
getVisibleCells()
getVisibleCells(
column?):Iterable<GridCell<any>>
Defined in: js-api/src/grid.ts:1351
Returns currently visible cells
Parameters
| Parameter | Type | Default value |
|---|---|---|
column | GridColumn<any> | null | null |
Returns
Iterable<GridCell<any>>
getWidgetStatus()
getWidgetStatus():
IWidgetStatus
Defined in: js-api/src/widgets/base.ts:431
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
Inherited from
gridRowToTable()
gridRowToTable(
gridRow):number
Defined in: js-api/src/grid.ts:1276
Converts grid row index to table index. See also tableRowToGrid
Parameters
| Parameter | Type |
|---|---|
gridRow | number |
Returns
number
hitTest()
hitTest(
x,y):GridCell<any> |null
Defined in: js-api/src/grid.ts:1206
Returns a grid cell at the specified position, or null if there is none. Sample: https://public.datagrok.ai/js/samples/grid/advanced/hit-test
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
Returns
GridCell<any> | null
initDartObject()
initDartObject(
dart):void
Defined in: js-api/src/viewer.ts:188
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
void
Inherited from
invalidate()
invalidate():
void
Defined in: js-api/src/grid.ts:1263
Causes the grid to repaint. Sample: https://public.datagrok.ai/js/samples/grid/advanced/invalidate
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
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
onCellPrepare()
onCellPrepare(
callback):StreamSubscription
Defined in: js-api/src/grid.ts:1189
Sample: https://public.datagrok.ai/js/samples/grid/events/custom-cell-prepare
Parameters
| Parameter | Type |
|---|---|
callback | (cell) => any |
Returns
onCellTooltip()
onCellTooltip(
callback):StreamSubscription
Defined in: js-api/src/grid.ts:1198
Sample: https://public.datagrok.ai/js/samples/grid/events/custom-cell-tooltip
Parameters
| Parameter | Type |
|---|---|
callback | (cell, x, y) => any |
Returns
onEvent()
onEvent(
eventId?):Observable<any>
Defined in: js-api/src/viewer.ts:481
Observes platform events with the specified eventId.
Parameters
| Parameter | Type | Default value |
|---|---|---|
eventId | string | null | null |
Returns
Observable<any>
Inherited from
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
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
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
propertyChanges()
protectedpropertyChanges():ObservableLike<PropertyChange>
Defined in: js-api/src/viewer.ts:257
What refreshes the property tier's cached signals from outside: null where nothing announces a change (one-way).
Returns
ObservableLike<PropertyChange>
Inherited from
registerFunction()
protectedregisterFunction(f):void
Defined in: js-api/src/u2core/component.ts:616
Parameters
| Parameter | Type |
|---|---|
f | FuncLike |
Returns
void
Inherited from
removeFromView()
removeFromView():
any
Defined in: js-api/src/viewer.ts:527
Removes the viewer from its view without disposing it.
Returns
any
Inherited from
removeStatusProvider()
removeStatusProvider(
name):void
Defined in: js-api/src/widgets/base.ts:476
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
render()
render(
g,bounds):void
Defined in: js-api/src/grid.ts:1367
Renders the content of this grid to the specified canvas and bounds.
Parameters
| Parameter | Type |
|---|---|
g | CanvasRenderingContext2D |
bounds | Rect |
Returns
void
resetRowHeight()
resetRowHeight():
void
Defined in: js-api/src/grid.ts:1289
Resets rows height
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
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
runPostponedComputations()
runPostponedComputations():
void
Defined in: js-api/src/grid.ts:1298
Forces the grid to execute calculations that were postponed before the next rendering (such as recalculating layout). Call it in case the client code changes column widths and needs to access the new recalculated layout.
Returns
void
scrollToCell()
scrollToCell(
column,row):void
Defined in: js-api/src/grid.ts:1249
Returns a grid cell at the specified position. Sample: https://public.datagrok.ai/js/samples/grid/navigate/scroll-to-cell
Parameters
| Parameter | Type |
|---|---|
column | string | Column<any, any> |
row | number |
Returns
void
scrollToPixels()
scrollToPixels(
x,y):void
Defined in: js-api/src/grid.ts:1256
Scrolls the grid to the specified position. Sample: https://public.datagrok.ai/js/samples/grid/navigate/scroll-to-pixels
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
Returns
void
setColumnsWidthType()
setColumnsWidthType(
type,columns?):void
Defined in: js-api/src/grid.ts:1362
Applies a column-width policy (Minimal / Compact / Optimal / Maximal) to the given columns,
or to all columns when columns is omitted. Same as Grid's right-click menu → "Column Sizing".
Parameters
| Parameter | Type |
|---|---|
type | ColumnWidthType |
columns? | GridColumn<any>[] |
Returns
void
setMarkerOpacity()
setMarkerOpacity(
opacity):void
Defined in: js-api/src/viewer.ts:239
Sets the opacity (0..100) of the markers: the alpha channel of the viewer's marker colors
(scatter plot: filtered, selected, filtered out, missing value and whisker colors; line chart: markerColor).
The box plot and the 3D scatter plot set their own markerOpacity; other viewers have no markers.
To set the alpha of any other color, use DG.Color.setAlpha.
Sample: https://public.datagrok.ai/js/samples/ui/viewers/types/scatter-plot
Parameters
| Parameter | Type |
|---|---|
opacity | number |
Returns
void
Inherited from
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
setRowOrder()
setRowOrder(
indexes):Grid
Defined in: js-api/src/grid.ts:1236
Sets the order or rows in the table. Sample: https://public.datagrok.ai/js/samples/grid/order/order-rows Also,
Parameters
| Parameter | Type |
|---|---|
indexes | number[] |
Returns
Grid
See
sortIndexes
sort()
sort(
columns,orders?):Grid
Defined in: js-api/src/grid.ts:1213
Sorts rows by the specified [columns] (names or objects). Specify sort directions via the [orders] array (true = ascending, false = descending); when [orders] is omitted, sorts in ascending order.
Parameters
| Parameter | Type | Default value |
|---|---|---|
columns | string[] | Column<any, any>[] | undefined |
orders | boolean[] | null | null |
Returns
Grid
sortIndexes()
sortIndexes(
indexComparer):Grid
Defined in: js-api/src/grid.ts:1221
Sorts the rows, using the specified comparer that accepts indexes. Sample: https://public.datagrok.ai/js/samples/grid/order/order-rows-by-comparer Also,
Parameters
| Parameter | Type |
|---|---|
indexComparer | (a, b) => number |
Returns
Grid
See
setRowOrder
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
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
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
tableRowToGrid()
tableRowToGrid(
tableRow):number
Defined in: js-api/src/grid.ts:1273
Converts table row index to grid index. See also gridRowToTable
Parameters
| Parameter | Type |
|---|---|
tableRow | number |
Returns
number
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
Inherited from
toCompactLook()
toCompactLook():
void
Defined in: js-api/src/viewer.ts:499
Switches the viewer to the compact look used inside a trellis plot.
Returns
void
Inherited from
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
_isPlain()
protectedstatic_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
barChart()
staticbarChart(t,options?):BarChartViewer
Defined in: js-api/src/viewer.ts:361
Creates a bar chart.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IBarChartSettings> |
Returns
Inherited from
boxPlot()
staticboxPlot(t,options?):BoxPlot
Defined in: js-api/src/viewer.ts:381
Creates a box plot.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IBoxPlotSettings> |
Returns
Inherited from
build()
Call Signature
staticbuild(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
Deprecated
Use component: one spelling, apart from an owner's build(fn).
Inherited from
Call Signature
staticbuild<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
calendar()
staticcalendar(t,options?):CalendarViewer
Defined in: js-api/src/viewer.ts:406
Creates a calendar.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<ICalendarSettings> |
Returns
Inherited from
canVisualize()
staticcanVisualize(viewerType,dataFrame):string|null
Defined in: js-api/src/viewer.ts:532
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
confusionMatrix()
staticconfusionMatrix(t,options?):ConfusionMatrix
Defined in: js-api/src/viewer.ts:366
Creates a confusion matrix.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IConfusionMatrixSettings> |
Returns
Inherited from
correlationPlot()
staticcorrelationPlot(t,options?):CorrelationPlot
Defined in: js-api/src/viewer.ts:411
Creates a correlation plot.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<ICorrelationPlotSettings> |
Returns
Inherited from
create()
staticcreate(table):Grid
Defined in: js-api/src/grid.ts:958
Creates a new grid.
Parameters
| Parameter | Type |
|---|---|
table | { dart: any; } |
table.dart | any |
Returns
Grid
densityPlot()
staticdensityPlot(t,options?):DensityPlotViewer
Defined in: js-api/src/viewer.ts:416
Creates a density plot.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IDensityPlotSettings> |
Returns
Inherited from
filters()
staticfilters(t,options?):Viewer<IFiltersSettings>
Defined in: js-api/src/viewer.ts:386
Creates a filter panel.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IFiltersSettings> |
Returns
Inherited from
find()
staticfind(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
forElement()
staticforElement(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
form()
staticform(t,options?):FormViewer
Defined in: js-api/src/viewer.ts:421
Creates a form viewer.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IFormSettings> |
Returns
Inherited from
fromProperties()
staticfromProperties(items,props):Grid
Defined in: js-api/src/grid.ts:964
Creates a new grid from a list of items (rows) and their properties (columns). Rows added to the grid's table later read as empty until edited, which creates a plain object item for them.
Parameters
| Parameter | Type |
|---|---|
items | any[] |
props | Property[] |
Returns
Grid
fromRoot()
staticfromRoot(root):Widget
Defined in: js-api/src/widgets/base.ts:482
Creates a new widget from the root element.
Parameters
| Parameter | Type |
|---|---|
root | HTMLElement |
Returns
Inherited from
fromType()
staticfromType<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
getAll()
staticgetAll():Widget<any>[]
Defined in: js-api/src/widgets/base.ts:238
Returns all currently active widgets.
Returns
Widget<any>[]
Inherited from
getViewerTypes()
staticgetViewerTypes(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
Inherited from
grid()
staticgrid(t,options?):Grid
Defined in: js-api/src/viewer.ts:351
Creates a Grid for the table.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IGridSettings> |
Returns
Grid
Inherited from
heatMap()
staticheatMap(t,options?):Grid
Defined in: js-api/src/viewer.ts:376
Creates a heat map (a Grid in heat-map mode).
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IGridSettings> |
Returns
Grid
Inherited from
histogram()
statichistogram(t,options?):HistogramViewer
Defined in: js-api/src/viewer.ts:356
Creates a histogram.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IHistogramSettings> |
Returns
Inherited from
init()
staticinit(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
is()
staticis(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
jsonValue()
staticjsonValue(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
labelOf()
protectedstaticlabelOf(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
lineChart()
staticlineChart(t,options?):LineChartViewer
Defined in: js-api/src/viewer.ts:396
Creates a line chart.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<ILineChartSettings> |
Returns
Inherited from
markup()
staticmarkup(t,options?):Viewer<IMarkupViewerSettings>
Defined in: js-api/src/viewer.ts:426
Creates a markup viewer.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IMarkupViewerSettings> |
Returns
Inherited from
matrixPlot()
staticmatrixPlot(t,options?):MatrixPlot
Defined in: js-api/src/viewer.ts:431
Creates a matrix plot.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IMatrixPlotSettings> |
Returns
Inherited from
network()
staticnetwork(t,options?):NetworkDiagramViewer
Defined in: js-api/src/viewer.ts:401
Creates a network diagram.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<INetworkDiagramSettings> |
Returns
Inherited from
pcPlot()
staticpcPlot(t,options?):PcPlot
Defined in: js-api/src/viewer.ts:436
Creates a parallel-coordinates plot.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IPcPlotSettings> |
Returns
Inherited from
pieChart()
staticpieChart(t,options?):PieChartViewer
Defined in: js-api/src/viewer.ts:441
Creates a pie chart.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IPieChartSettings> |
Returns
Inherited from
pivotTable()
staticpivotTable(t,options?):PivotViewer
Defined in: js-api/src/viewer.ts:471
Creates a pivot table.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IPivotViewerSettings> |
Returns
Inherited from
registerCleanup()
staticregisterCleanup(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
rocCurve()
staticrocCurve(t,options?):RocCurve
Defined in: js-api/src/viewer.ts:371
Creates a ROC curve.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IRocCurveSettings> |
Returns
Inherited from
sameValue()
staticsameValue(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
scatterPlot()
staticscatterPlot(t,options?):ScatterPlotViewer
Defined in: js-api/src/viewer.ts:391
Creates a scatter plot.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IScatterPlotSettings> |
Returns
Inherited from
scatterPlot3d()
staticscatterPlot3d(t,options?):Viewer<IScatterPlot3dSettings>
Defined in: js-api/src/viewer.ts:446
Creates a 3D scatter plot.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IScatterPlot3dSettings> |
Returns
Viewer<IScatterPlot3dSettings>
Inherited from
statistics()
staticstatistics(t,options?):Viewer<IStatsViewerSettings>
Defined in: js-api/src/viewer.ts:451
Creates a statistics viewer.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<IStatsViewerSettings> |
Returns
Inherited from
text()
protectedstatictext(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
tile()
statictile(t,options?):TileViewer
Defined in: js-api/src/viewer.ts:456
Creates a tile viewer.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<ITileViewerSettings> |
Returns
Inherited from
treeMap()
statictreeMap(t,options?):TreeMap
Defined in: js-api/src/viewer.ts:461
Creates a tree map.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<ITreeMapSettings> |
Returns
Inherited from
trellisPlot()
statictrellisPlot(t,options?):TrellisPlotViewer
Defined in: js-api/src/viewer.ts:466
Creates a trellis plot.
Parameters
| Parameter | Type |
|---|---|
t | DataFrame |
options? | Partial<ITrellisPlotSettings> |