Grid

Defined in: src/grid.ts:925

High-performance, flexible spreadsheet control

Extends

• Viewer<IGridSettings>

Constructors

Constructor

new Grid(dart): Grid

Defined in: src/grid.ts:927

Parameters

Parameter	Type
dart	any

Returns

Grid

Overrides

Viewer.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	Viewer._functions	src/widgets/base.ts:243
_properties	protected	Property[]	[]	-	Viewer._properties	src/widgets/base.ts:242
_root	protected	HTMLElement	undefined	-	Viewer._root	src/widgets/base.ts:241
dart	public	any	undefined	-	Viewer.dart	src/widgets/base.ts:246
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	Viewer.factory	src/widgets/base.ts:239
isDetached	public	boolean	false	-	Viewer.isDetached	src/widgets/base.ts:247
props	public	IGridSettings & ObjectPropertyBag	undefined	-	Viewer.props	src/widgets/base.ts:244
subs	public	Subscription[]	undefined	-	Viewer.subs	src/widgets/base.ts:245
tags	public	any	undefined	-	Viewer.tags	src/viewer.ts:82
temp	public	any	undefined	Contains auxiliary information	Viewer.temp	src/widgets/base.ts:236
CORE_VIEWER_TYPES	static	string[]	undefined	-	Viewer.CORE_VIEWER_TYPES	src/viewer.ts:363

Accessors

canvas

Get Signature

get canvas(): HTMLCanvasElement

Defined in: src/grid.ts:980

Returns

HTMLCanvasElement

---

children

Get Signature

get children(): Widget<any>[]

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

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

Viewer.children

---

colHeaderBox

Get Signature

get colHeaderBox(): Rect

Defined in: src/grid.ts:1102

Column labels box

Returns

Rect

---

colHeaderHeight

Get Signature

get colHeaderHeight(): number

Defined in: src/grid.ts:1094

Column labels height

Returns

number

---

columns

Get Signature

get columns(): GridColumnList

Defined in: src/grid.ts:948

Grid columns.

Returns

GridColumnList

---

dataFrame

Get Signature

get dataFrame(): DataFrame

Defined in: src/viewer.ts:208

Returns

DataFrame

Set Signature

set dataFrame(t): void

Defined in: src/viewer.ts:209

Parameters

Parameter	Type
t	DataFrame

Returns

void

Inherited from

Viewer.dataFrame

---

descriptor

Get Signature

get descriptor(): WidgetDescriptor

Defined in: src/viewer.ts:100

Descriptor of this widget.

Returns

WidgetDescriptor

Inherited from

Viewer.descriptor

---

filter

Get Signature

get filter(): BitSet

Defined in: src/viewer.ts:93

combined filter of the viewer

Returns

BitSet

Set Signature

set filter(f): void

Defined in: src/viewer.ts:96

Parameters

Parameter	Type
f	BitSet

Returns

void

Inherited from

Viewer.filter

---

helpUrl

Get Signature

get helpUrl(): string

Defined in: src/viewer.ts:212

Help URL

Returns

string

Set Signature

set helpUrl(s): void

Defined in: src/viewer.ts:213

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

Viewer.helpUrl

---

horzScroll

Get Signature

get horzScroll(): RangeSlider

Defined in: src/grid.ts:1089

Horizontal scroll bar

Returns

RangeSlider

---

meta

Get Signature

get meta(): ViewerMetaHelper

Defined in: src/viewer.ts:181

Returns

ViewerMetaHelper

Inherited from

Viewer.meta

---

onAfterDrawContent

Get Signature

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

Defined in: src/grid.ts:1140

Returns

Observable<EventData<any>>

---

onAfterDrawOverlay

Get Signature

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

Defined in: src/grid.ts:1138

Returns

Observable<EventData<any>>

---

onBeforeDrawContent

Get Signature

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

Defined in: src/grid.ts:1139

Returns

Observable<EventData<any>>

---

onBeforeDrawOverlay

Get Signature

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

Defined in: src/grid.ts:1137

Returns

Observable<EventData<any>>

---

onCellClick

Get Signature

get onCellClick(): Observable<GridCell<any>>

Defined in: src/grid.ts:1131

Returns

Observable<GridCell<any>>

---

onCellDoubleClick

Get Signature

get onCellDoubleClick(): Observable<GridCell<any>>

Defined in: src/grid.ts:1132

Returns

Observable<GridCell<any>>

---

onCellKeyDown

Get Signature

get onCellKeyDown(): Observable<GridCell<any>>

Defined in: src/grid.ts:1134

Returns

Observable<GridCell<any>>

---

onCellMouseDown

Get Signature

get onCellMouseDown(): Observable<GridCell<any>>

Defined in: src/grid.ts:1133

Returns

Observable<GridCell<any>>

---

onCellMouseEnter

Get Signature

get onCellMouseEnter(): Observable<GridCell<any>>

Defined in: src/grid.ts:1128

Returns

Observable<GridCell<any>>

---

onCellMouseLeave

Get Signature

get onCellMouseLeave(): Observable<GridCell<any>>

Defined in: src/grid.ts:1129

Returns

Observable<GridCell<any>>

---

onCellRender

Get Signature

get onCellRender(): Observable<GridCellRenderArgs>

Defined in: src/grid.ts:968

Occurs after the grid cell has been rendered. Do args.preventDefault() to prevent standard rendering. Sample: https://public.datagrok.ai/js/samples/grid/custom-cell-rendering-indexes See also onCellRendered.

Returns

Observable<GridCellRenderArgs>

---

onCellRendered

Get Signature

get onCellRendered(): Observable<GridCellRenderArgs>

Defined in: src/grid.ts:975

Occurs after the grid cell has been rendered. See also onCellRender.

Returns

Observable<GridCellRenderArgs>

---

onCellValueEdited

Get Signature

get onCellValueEdited(): Observable<GridCell<any>>

Defined in: src/grid.ts:1126

Returns

Observable<GridCell<any>>

---

onColumnResized

Get Signature

get onColumnResized(): Observable<any>

Defined in: src/grid.ts:1115

Sample: https://public.datagrok.ai/js/samples/grid/resize-events

Returns

Observable<any>

---

onContextMenu

Get Signature

get onContextMenu(): Observable<Menu>

Defined in: src/viewer.ts:308

Returns

Observable<Menu>

Inherited from

Viewer.onContextMenu

---

onCurrentCellChanged

Get Signature

get onCurrentCellChanged(): Observable<GridCell<any>>

Defined in: src/grid.ts:1127

Returns

Observable<GridCell<any>>

---

onDartPropertyChanged

Get Signature

get onDartPropertyChanged(): Observable<null>

Defined in: src/viewer.ts:334

Returns

Observable<null>

Inherited from

Viewer.onDartPropertyChanged

---

onDataEvent

Get Signature

get onDataEvent(): Observable<ViewerEvent>

Defined in: src/viewer.ts:105

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataEvent

---

onDataRowClicked

Get Signature

get onDataRowClicked(): Observable<ViewerEvent>

Defined in: src/viewer.ts:109

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataRowClicked

---

onDataSelected

Get Signature

get onDataSelected(): Observable<ViewerEvent>

Defined in: src/viewer.ts:107

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onDataSelected

---

onDetached

Get Signature

get onDetached(): Observable<any>

Defined in: src/viewer.ts:349

Occurs when viewer is detached.

Returns

Observable<any>

Inherited from

Viewer.onDetached

---

onGridCellLinkClicked

Get Signature

get onGridCellLinkClicked(): Observable<EventData<GridCellArgs>>

Defined in: src/grid.ts:1142

Returns

Observable<EventData<GridCellArgs>>

---

onPinnedRowsChanged

Get Signature

get onPinnedRowsChanged(): Observable<any>

Defined in: src/grid.ts:1124

Returns

Observable<any>

---

onPropertyValueChanged

Get Signature

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

Defined in: src/viewer.ts:110

Returns

Observable<EventData<Property>>

Inherited from

Viewer.onPropertyValueChanged

---

onRowEnter

Get Signature

get onRowEnter(): Observable<GridCell<any>>

Defined in: src/grid.ts:1135

Returns

Observable<GridCell<any>>

---

onRowsResized

Get Signature

get onRowsResized(): Observable<any>

Defined in: src/grid.ts:1120

Sample: https://public.datagrok.ai/js/samples/grid/resize-events

Returns

Observable<any>

---

onRowsSorted

Get Signature

get onRowsSorted(): Observable<any>

Defined in: src/grid.ts:1123

Sample: https://public.datagrok.ai/js/samples/grid/order-rows

Returns

Observable<any>

---

onTooltipCreated

Get Signature

get onTooltipCreated(): Observable<ViewerEvent>

Defined in: src/viewer.ts:106

Returns

Observable<ViewerEvent>

Inherited from

Viewer.onTooltipCreated

---

onTooltipCreating

Get Signature

get onTooltipCreating(): Observable<GridTooltipArgs>

Defined in: src/grid.ts:1141

Returns

Observable<GridTooltipArgs>

---

overlay

Get Signature

get overlay(): HTMLCanvasElement

Defined in: src/grid.ts:985

Returns

HTMLCanvasElement

---

parent

Get Signature

get parent(): Widget<any> | null

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

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

Viewer.parent

---

pinnedRows

Get Signature

get pinnedRows(): Iterable<number>

Defined in: src/grid.ts:1052

Pinned rows.

Returns

Iterable<number>

---

root

Get Signature

get root(): HTMLElement

Defined in: src/viewer.ts:177

Visual root.

Returns

HTMLElement

Inherited from

Viewer.root

---

sortByColumns

Get Signature

get sortByColumns(): Column<any, any>[]

Defined in: src/grid.ts:990

List of columns the grid is sorted by.

Returns

Column<any, any>[]

---

sortTypes

Get Signature

get sortTypes(): boolean[]

Defined in: src/grid.ts:993

Sort directions for [sortByColumns]: true = ascending order, false = descending order.

Returns

boolean[]

---

table

Get Signature

get table(): DataFrame

Defined in: src/viewer.ts:193

Returns

DataFrame

Inherited from

Viewer.table

---

tableView

Get Signature

get tableView(): TableView | null

Defined in: src/viewer.ts:203

Returns a view this viewer is associated with, or null

Returns

TableView | null

Inherited from

Viewer.tableView

---

type

Get Signature

get type(): string

Defined in: src/viewer.ts:189

Returns viewer type (see VIEWER constants)

Returns

string

Inherited from

Viewer.type

---

vertScroll

Get Signature

get vertScroll(): RangeSlider

Defined in: src/grid.ts:1078

Vertical scroll bar. Sample: https://public.datagrok.ai/js/samples/grid/scroll-bars

Returns

RangeSlider

---

view

Get Signature

get view(): View | null

Defined in: src/viewer.ts:198

Returns a view this viewer is associated with, or null

Returns

View | null

Inherited from

Viewer.view

Methods

apply()

apply(properties): Widget

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

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

Viewer.apply

---

autoSize()

autoSize(maxWidth, maxHeight, minWidth?, minHeight?, autoSizeOnDataChange?): void

Defined in: src/grid.ts:1150

Resizes the grid to fit the content

Parameters

Parameter	Type
maxWidth	number
maxHeight	number
minWidth?	number
minHeight?	number
autoSizeOnDataChange?	boolean

Returns

void

---

cell()

cell(columnName, gridRow): GridCell

Defined in: src/grid.ts:960

Returns a grid cell at the specified position.

Parameters

Parameter	Type
columnName	string
gridRow	number

Returns

GridCell

---

close()

close(): void

Defined in: src/viewer.ts:171

Closes and detaches the viewer.

Returns

void

Inherited from

Viewer.close

---

col()

col(name): GridColumn<any> | null

Defined in: src/grid.ts:955

Returns a column with the specified name.

Parameters

Parameter	Type	Description
name	string	-

Returns

GridColumn<any> | null

---

copyViewersLook()

copyViewersLook(other): void

Defined in: src/viewer.ts:351

Parameters

Parameter	Type
other	Viewer

Returns

void

Inherited from

Viewer.copyViewersLook

---

detach()

detach(): void

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

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

---

getDartProperties()

getDartProperties(): any[]

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

Returns

any[]

Inherited from

Viewer.getDartProperties

---

getFunctions()

getFunctions(): Func[]

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

Functions that are applicable to this particular widget. Used in the UI to display context actions, and for the AI integrations.

Returns

Func[]

Inherited from

Viewer.getFunctions

---

getInfo()

getInfo(): object

Defined in: src/viewer.ts:162

Returns

object

Inherited from

Viewer.getInfo

---

getOptions()

getOptions(includeDefaults?): object

Defined in: src/viewer.ts:158

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	src/viewer.ts:158
look	object	src/viewer.ts:158
type	string	src/viewer.ts:158

Inherited from

Viewer.getOptions

---

getProperties()

getProperties(): Property[]

Defined in: src/viewer.ts:166

Returns all properties of this widget.

Returns

Property[]

Inherited from

Viewer.getProperties

---

getRowOrder()

getRowOrder(): Int32Array

Defined in: src/grid.ts:1038

Returns the order of rows in the table.

Returns

Int32Array

---

getVisibleCells()

getVisibleCells(column?): Iterable<GridCell<any>>

Defined in: src/grid.ts:1145

Returns currently visible cells

Parameters

Parameter	Type	Default value
column	GridColumn<any> | null	null

Returns

Iterable<GridCell<any>>

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: src/viewer.ts:103

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

Returns

IWidgetStatus

Inherited from

Viewer.getWidgetStatus

---

gridRowToTable()

gridRowToTable(gridRow): number

Defined in: src/grid.ts:1086

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: src/grid.ts:1015

Returns a grid cell at the specified position, or null if there is none. Sample: https://public.datagrok.ai/js/samples/grid/hit-test

Parameters

Parameter	Type
x	number
y	number

Returns

GridCell<any> | null

---

initDartObject()

initDartObject(dart): void

Defined in: src/viewer.ts:112

Parameters

Parameter	Type
dart	any

Returns

void

Inherited from

Viewer.initDartObject

---

invalidate()

invalidate(): void

Defined in: src/grid.ts:1073

Causes the grid to repaint. Sample: https://public.datagrok.ai/js/samples/grid/advanced/invalidate

Returns

void

---

onCellPrepare()

onCellPrepare(callback): StreamSubscription

Defined in: src/grid.ts:998

Sample: https://public.datagrok.ai/js/samples/grid/custom-cell-prepare

Parameters

Parameter	Type
callback	(cell) => any

Returns

StreamSubscription

---

onCellTooltip()

onCellTooltip(callback): StreamSubscription

Defined in: src/grid.ts:1007

Sample: https://public.datagrok.ai/js/samples/grid/custom-cell-tooltip

Parameters

Parameter	Type
callback	(cell, x, y) => any

Returns

StreamSubscription

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: src/viewer.ts:313

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: src/widgets/base.ts:311

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Viewer.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

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

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

---

removeFromView()

removeFromView(): any

Defined in: src/viewer.ts:355

Returns

any

Inherited from

Viewer.removeFromView

---

render()

render(g, bounds): void

Defined in: src/grid.ts:1161

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: src/grid.ts:1099

Resets rows height

Returns

void

---

runPostponedComputations()

runPostponedComputations(): void

Defined in: src/grid.ts:1108

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: src/grid.ts:1059

Returns a grid cell at the specified position. Sample: https://public.datagrok.ai/js/samples/grid/scroll-to-cell

Parameters

Parameter	Type
column	string | Column<any, any>
row	number

Returns

void

---

scrollToPixels()

scrollToPixels(x, y): void

Defined in: src/grid.ts:1066

Scrolls the grid to the specified position. Sample: https://public.datagrok.ai/js/samples/grid/scroll-to-pixels

Parameters

Parameter	Type
x	number
y	number

Returns

void

---

setColumnsWidthType()

setColumnsWidthType(type, columns?): void

Defined in: src/grid.ts:1156

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

---

setOptions()

setOptions(map): void

Defined in: src/viewer.ts:146

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

Parameters

Parameter	Type	Description
map	{[key: string]: any; type?: string; }	-
map.type?	string	-

Returns

void

Inherited from

Viewer.setOptions

---

setRowOrder()

setRowOrder(indexes): Grid

Defined in: src/grid.ts:1045

Sets the order or rows in the table. Sample: https://public.datagrok.ai/js/samples/grid/order-rows Also,

Parameters

Parameter	Type
indexes	number[]

Returns

Grid

See

sortIndexes

---

sort()

sort(columns, orders?): Grid

Defined in: src/grid.ts:1022

Sorts rows by the specified [columnIds]. Specify sort directions via [asc] array (true = ascending, false = descending) If [asc] is not specified, 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: src/grid.ts:1030

Sorts the rows, using the specified comparer that accepts indexes. Sample: https://public.datagrok.ai/js/samples/grid/order-rows-by-comparer Also,

Parameters

Parameter	Type
indexComparer	(a, b) => number

Returns

Grid

See

setRowOrder

---

sourceRowsChanged()

sourceRowsChanged(): void

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

Returns

void

Inherited from

Viewer.sourceRowsChanged

---

sub()

sub(subscription): void

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

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

Viewer.sub

---

tableRowToGrid()

tableRowToGrid(tableRow): number

Defined in: src/grid.ts:1083

Converts table row index to grid index. See also gridRowToTable

Parameters

Parameter	Type
tableRow	number

Returns

number

---

toCompactLook()

toCompactLook(): void

Defined in: src/viewer.ts:330

Returns

void

Inherited from

Viewer.toCompactLook

---

toDart()

toDart(): any

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

Returns

any

Inherited from

Viewer.toDart

---

barChart()

static barChart(t, options?): Viewer<IBarChartSettings>

Defined in: src/viewer.ts:223

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IBarChartSettings>

Returns

Viewer<IBarChartSettings>

Inherited from

Viewer.barChart

---

boxPlot()

static boxPlot(t, options?): BoxPlot

Defined in: src/viewer.ts:231

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IBoxPlotSettings>

Returns

BoxPlot

Inherited from

Viewer.boxPlot

---

calendar()

static calendar(t, options?): Viewer<ICalendarSettings>

Defined in: src/viewer.ts:251

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ICalendarSettings>

Returns

Viewer<ICalendarSettings>

Inherited from

Viewer.calendar

---

canVisualize()

static canVisualize(viewerType, dataFrame): string | null

Defined in: src/viewer.ts:359

Parameters

Parameter	Type
viewerType	string
dataFrame	DataFrame

Returns

string | null

Inherited from

Viewer.canVisualize

---

correlationPlot()

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

Defined in: src/viewer.ts:255

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ICorrelationPlotSettings>

Returns

Viewer<ICorrelationPlotSettings>

Inherited from

Viewer.correlationPlot

---

create()

static create(table): Grid

Defined in: src/grid.ts:932

Creates a new grid.

Parameters

Parameter	Type
table	{ dart: any; }
table.dart	any

Returns

Grid

---

densityPlot()

static densityPlot(t, options?): DensityPlotViewer

Defined in: src/viewer.ts:259

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IDensityPlotSettings>

Returns

DensityPlotViewer

Inherited from

Viewer.densityPlot

---

filters()

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

Defined in: src/viewer.ts:235

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IFiltersSettings>

Returns

Viewer<IFiltersSettings>

Inherited from

Viewer.filters

---

find()

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

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

Viewer.find

---

form()

static form(t, options?): Viewer<IFormSettings>

Defined in: src/viewer.ts:263

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IFormSettings>

Returns

Viewer<IFormSettings>

Inherited from

Viewer.form

---

fromProperties()

static fromProperties(items, props): Grid

Defined in: src/grid.ts:937

Creates a new grid from a list of items (rows) and their properties (columns)

Parameters

Parameter	Type
items	any[]
props	Property[]

Returns

Grid

---

fromRoot()

static fromRoot(root): Widget

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

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

Viewer.fromRoot

---

fromType()

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

Defined in: src/viewer.ts:128

Creates a new viewer of the specified type.

Parameters

Parameter	Type	Default value	Description
viewerType	string	undefined	-
table	DataFrame	undefined	-
options	object | null	null	-

Returns

Viewer

Inherited from

Viewer.fromType

---

getAll()

static getAll(): Widget<any>[]

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

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Viewer.getAll

---

getViewerTypes()

static getViewerTypes(options?): string[]

Defined in: src/viewer.ts:135

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

string[]

Inherited from

Viewer.getViewerTypes

---

grid()

static grid(t, options?): Grid

Defined in: src/viewer.ts:215

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IGridSettings>

Returns

Grid

Inherited from

Viewer.grid

---

heatMap()

static heatMap(t, options?): Grid

Defined in: src/viewer.ts:227

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IGridSettings>

Returns

Grid

Inherited from

Viewer.heatMap

---

histogram()

static histogram(t, options?): HistogramViewer

Defined in: src/viewer.ts:219

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IHistogramSettings>

Returns

HistogramViewer

Inherited from

Viewer.histogram

---

lineChart()

static lineChart(t, options?): LineChartViewer

Defined in: src/viewer.ts:243

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ILineChartSettings>

Returns

LineChartViewer

Inherited from

Viewer.lineChart

---

markup()

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

Defined in: src/viewer.ts:267

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IMarkupViewerSettings>

Returns

Viewer<IMarkupViewerSettings>

Inherited from

Viewer.markup

---

matrixPlot()

static matrixPlot(t, options?): Viewer<IMatrixPlotSettings>

Defined in: src/viewer.ts:271

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IMatrixPlotSettings>

Returns

Viewer<IMatrixPlotSettings>

Inherited from

Viewer.matrixPlot

---

network()

static network(t, options?): Viewer<INetworkDiagramSettings>

Defined in: src/viewer.ts:247

Parameters

Parameter	Type
t	DataFrame
options?	Partial<INetworkDiagramSettings>

Returns

Viewer<INetworkDiagramSettings>

Inherited from

Viewer.network

---

pcPlot()

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

Defined in: src/viewer.ts:275

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPcPlotSettings>

Returns

Viewer<IPcPlotSettings>

Inherited from

Viewer.pcPlot

---

pieChart()

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

Defined in: src/viewer.ts:279

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IPieChartSettings>

Returns

Viewer<IPieChartSettings>

Inherited from

Viewer.pieChart

---

scatterPlot()

static scatterPlot(t, options?): ScatterPlotViewer

Defined in: src/viewer.ts:239

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IScatterPlotSettings>

Returns

ScatterPlotViewer

Inherited from

Viewer.scatterPlot

---

scatterPlot3d()

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

Defined in: src/viewer.ts:283

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IScatterPlot3dSettings>

Returns

Viewer<IScatterPlot3dSettings>

Inherited from

Viewer.scatterPlot3d

---

statistics()

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

Defined in: src/viewer.ts:287

Parameters

Parameter	Type
t	DataFrame
options?	Partial<IStatsViewerSettings>

Returns

Viewer<IStatsViewerSettings>

Inherited from

Viewer.statistics

---

tile()

static tile(t, options?): Viewer<ITileViewerSettings>

Defined in: src/viewer.ts:291

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITileViewerSettings>

Returns

Viewer<ITileViewerSettings>

Inherited from

Viewer.tile

---

treeMap()

static treeMap(t, options?): Viewer<ITreeMapSettings>

Defined in: src/viewer.ts:295

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITreeMapSettings>

Returns

Viewer<ITreeMapSettings>

Inherited from

Viewer.treeMap

---

trellisPlot()

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

Defined in: src/viewer.ts:299

Parameters

Parameter	Type
t	DataFrame
options?	Partial<ITrellisPlotSettings>

Returns

Viewer<ITrellisPlotSettings>

Inherited from

Viewer.trellisPlot

---

wordCloud()

static wordCloud(t, options?): Viewer

Defined in: src/viewer.ts:304

Parameters

Parameter	Type
t	DataFrame
options?	any

Returns

Viewer

Deprecated

Inherited from

Viewer.wordCloud