Grid

High-performance, flexible spreadsheet control

Extends

• Viewer <IGridSettings>

Constructors

new Grid()

new Grid(dart): Grid

Parameters

Parameter	Type
dart	any

Returns

Grid

Overrides

Viewer . constructor

Source

src/grid.ts:910

Properties

Property	Modifier	Type	Default value	Description	Inherited from
_functions	protected	Func[]	[]	-	Viewer._functions
_properties	protected	Property[]	[]	-	Viewer._properties
_root	protected	HTMLElement	undefined	-	Viewer._root
dart	public	any	undefined	-	Viewer.dart
factory	public	null | Func	null	Constructor function. No parameters, returns [Widget].	Viewer.factory
isDetached	public	boolean	false	-	Viewer.isDetached
props	public	IGridSettings & ObjectPropertyBag	undefined	-	Viewer.props
subs	public	Subscription[]	undefined	-	Viewer.subs
tags	public	any	undefined	-	Viewer.tags
temp	public	any	undefined	Contains auxiliary information	Viewer.temp
CORE_VIEWER_TYPES	static	string[]	...	-	Viewer.CORE_VIEWER_TYPES

Accessors

canvas

get canvas(): HTMLCanvasElement

Returns

HTMLCanvasElement

Source

src/grid.ts:963

---

children

get children(): Widget<any>[]

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Source

src/widgets.ts:293

---

colHeaderBox

get colHeaderBox(): Rect

Column labels box

Returns

Rect

Source

src/grid.ts:1085

---

colHeaderHeight

get colHeaderHeight(): number

Column labels height

Returns

number

Source

src/grid.ts:1077

---

columns

get columns(): GridColumnList

Grid columns.

Returns

GridColumnList

Source

src/grid.ts:931

---

dataFrame

get dataFrame(): DataFrame

set dataFrame(t): void

Parameters

Parameter	Type
t	DataFrame

Returns

DataFrame

Source

src/viewer.ts:203

---

descriptor

get descriptor(): WidgetDescriptor

Descriptor of this widget.

Returns

WidgetDescriptor

Source

src/viewer.ts:98

---

filter

get filter(): BitSet

combined filter of the viewer

set filter(f): void

Parameters

Parameter	Type
f	BitSet

Returns

BitSet

Source

src/viewer.ts:90

---

helpUrl

get helpUrl(): string

Help URL

set helpUrl(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/viewer.ts:207

---

horzScroll

get horzScroll(): RangeSlider

Horizontal scroll bar

Returns

RangeSlider

Source

src/grid.ts:1072

---

meta

get meta(): ViewerMetaHelper

Returns

ViewerMetaHelper

Source

src/viewer.ts:176

---

onAfterDrawContent

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

Returns

Observable <EventData<any>>

Source

src/grid.ts:1123

---

onAfterDrawOverlay

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

Returns

Observable <EventData<any>>

Source

src/grid.ts:1121

---

onBeforeDrawContent

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

Returns

Observable <EventData<any>>

Source

src/grid.ts:1122

---

onBeforeDrawOverlay

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

Returns

Observable <EventData<any>>

Source

src/grid.ts:1120

---

onCellClick

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

Returns

Observable <GridCell<any>>

Source

src/grid.ts:1114

---

onCellDoubleClick

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

Returns

Observable <GridCell<any>>

Source

src/grid.ts:1115

---

onCellKeyDown

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

Returns

Observable <GridCell<any>>

Source

src/grid.ts:1117

---

onCellMouseDown

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

Returns

Observable <GridCell<any>>

Source

src/grid.ts:1116

---

onCellMouseEnter

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

Returns

Observable <GridCell<any>>

Source

src/grid.ts:1111

---

onCellMouseLeave

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

Returns

Observable <GridCell<any>>

Source

src/grid.ts:1112

---

onCellRender

get onCellRender(): Observable <GridCellRenderArgs>

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>

Source

src/grid.ts:951

---

onCellRendered

get onCellRendered(): Observable <GridCellRenderArgs>

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

Returns

Observable <GridCellRenderArgs>

Source

src/grid.ts:958

---

onCellValueEdited

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

Returns

Observable <GridCell<any>>

Source

src/grid.ts:1109

---

onColumnResized

get onColumnResized(): Observable<any>

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

Returns

Observable<any>

Source

src/grid.ts:1098

---

onContextMenu

get onContextMenu(): Observable <Menu>

Returns

Observable <Menu>

Source

src/viewer.ts:303

---

onCurrentCellChanged

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

Returns

Observable <GridCell<any>>

Source

src/grid.ts:1110

---

onDartPropertyChanged

get onDartPropertyChanged(): Observable<null>

Returns

Observable<null>

Source

src/viewer.ts:329

---

onDataEvent

get onDataEvent(): Observable <ViewerEvent>

Returns

Observable <ViewerEvent>

Source

src/viewer.ts:100

---

onDataRowClicked

get onDataRowClicked(): Observable <ViewerEvent>

Returns

Observable <ViewerEvent>

Source

src/viewer.ts:104

---

onDataSelected

get onDataSelected(): Observable <ViewerEvent>

Returns

Observable <ViewerEvent>

Source

src/viewer.ts:102

---

onDetached

get onDetached(): Observable<any>

Occurs when viewer is detached.

Returns

Observable<any>

Source

src/viewer.ts:344

---

onGridCellLinkClicked

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

Returns

Observable <EventData <GridCellArgs>>

Source

src/grid.ts:1125

---

onPinnedRowsChanged

get onPinnedRowsChanged(): Observable<any>

Returns

Observable<any>

Source

src/grid.ts:1107

---

onPropertyValueChanged

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

Returns

Observable <EventData <Property>>

Source

src/viewer.ts:105

---

onRowEnter

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

Returns

Observable <GridCell<any>>

Source

src/grid.ts:1118

---

onRowsResized

get onRowsResized(): Observable<any>

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

Returns

Observable<any>

Source

src/grid.ts:1103

---

onRowsSorted

get onRowsSorted(): Observable<any>

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

Returns

Observable<any>

Source

src/grid.ts:1106

---

onTooltipCreated

get onTooltipCreated(): Observable <ViewerEvent>

Returns

Observable <ViewerEvent>

Source

src/viewer.ts:101

---

onTooltipCreating

get onTooltipCreating(): Observable <GridTooltipArgs>

Returns

Observable <GridTooltipArgs>

Source

src/grid.ts:1124

---

overlay

get overlay(): HTMLCanvasElement

Returns

HTMLCanvasElement

Source

src/grid.ts:968

---

parent

get parent(): null | Widget<any>

Parent widget up the DOM tree, or null.

Returns

null | Widget<any>

Source

src/widgets.ts:290

---

pinnedRows

get pinnedRows(): Iterable<number>

Pinned rows.

Returns

Iterable<number>

Source

src/grid.ts:1035

---

root

get root(): HTMLElement

Visual root.

Returns

HTMLElement

Source

src/viewer.ts:172

---

sortByColumns

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

List of columns the grid is sorted by.

Returns

Column<any, any>[]

Source

src/grid.ts:973

---

sortTypes

get sortTypes(): boolean[]

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

Returns

boolean[]

Source

src/grid.ts:976

---

table

get table(): DataFrame

Returns

DataFrame

Source

src/viewer.ts:188

---

tableView

get tableView(): null | TableView

Returns a view this viewer is associated with, or null

Returns

null | TableView

Source

src/viewer.ts:198

---

type

get type(): string

Returns viewer type (see VIEWER constants)

Returns

string

Source

src/viewer.ts:184

---

vertScroll

get vertScroll(): RangeSlider

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

Returns

RangeSlider

Source

src/grid.ts:1061

---

view

get view(): null | View

Returns a view this viewer is associated with, or null

Returns

null | View

Source

src/viewer.ts:193

Methods

addProperty()

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

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" | "view" | "blob" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "element" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	undefined
defaultValue	any	null
options	null | object & IProperty	null

Returns

any

Inherited from

Viewer . addProperty

See

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

Source

src/widgets.ts:318

---

apply()

apply(properties): Widget<any>

Parameters

Parameter	Type	Description
properties	object

Returns

Widget<any>

Inherited from

Viewer . apply

Source

src/widgets.ts:257

---

autoSize()

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

Resizes the grid to fit the content

Parameters

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

Returns

void

Source

src/grid.ts:1133

---

cell()

cell(columnName, gridRow): GridCell<any>

Returns a grid cell at the specified position.

Parameters

Parameter	Type
columnName	string
gridRow	number

Returns

GridCell<any>

Source

src/grid.ts:943

---

close()

close(): void

Closes and detaches the viewer.

Returns

void

Inherited from

Viewer . close

Source

src/viewer.ts:166

---

col()

col(name): null | GridColumn<any>

Returns a column with the specified name.

Parameters

Parameter	Type	Description
name	string

Returns

null | GridColumn<any>

Source

src/grid.ts:938

---

copyViewersLook()

copyViewersLook(other): void

Parameters

Parameter	Type
other	Viewer<any>

Returns

void

Inherited from

Viewer . copyViewersLook

Source

src/viewer.ts:346

---

detach()

detach(): void

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

Source

src/widgets.ts:302

---

getDartProperties()

getDartProperties(): any[]

Returns

any[]

Inherited from

Viewer . getDartProperties

Source

src/widgets.ts:278

---

getFunctions()

getFunctions(): Func[]

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

Source

src/widgets.ts:272

---

getInfo()

getInfo(): object

Returns

object

Inherited from

Viewer . getInfo

Source

src/viewer.ts:157

---

getOptions()

getOptions(includeDefaults): object

Gets the serialized viewer options. [includeDefaults] flag specifies whether the properties with the default values should be returned. Not including default properties makes it more clean and efficient for serialization purposes.

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

Parameters

Parameter	Type	Default value
includeDefaults	boolean	false

Returns

object

Member	Type
id	string
look	object
type	string

Inherited from

Viewer . getOptions

Source

src/viewer.ts:153

---

getProperties()

getProperties(): Property[]

Returns all properties of this widget.

Returns

Property[]

Inherited from

Viewer . getProperties

Source

src/viewer.ts:161

---

getRowOrder()

getRowOrder(): Int32Array

Returns the order of rows in the table.

Returns

Int32Array

Source

src/grid.ts:1021

---

getVisibleCells()

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

Returns currently visible cells

Parameters

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

Returns

Iterable <GridCell<any>>

Source

src/grid.ts:1128

---

gridRowToTable()

gridRowToTable(gridRow): number

Converts grid row index to table index. See also tableRowToGrid

Parameters

Parameter	Type
gridRow	number

Returns

number

Source

src/grid.ts:1069

---

hitTest()

hitTest(x, y): null | GridCell<any>

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

null | GridCell<any>

Source

src/grid.ts:998

---

initDartObject()

initDartObject(dart): void

Parameters

Parameter	Type
dart	any

Returns

void

Inherited from

Viewer . initDartObject

Source

src/viewer.ts:107

---

invalidate()

invalidate(): void

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

Returns

void

Source

src/grid.ts:1056

---

onCellPrepare()

onCellPrepare(callback): StreamSubscription

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

Parameters

Parameter	Type
callback	(cell) => any

Returns

StreamSubscription

Source

src/grid.ts:981

---

onCellTooltip()

onCellTooltip(callback): StreamSubscription

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

Parameters

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

Returns

StreamSubscription

Source

src/grid.ts:990

---

onEvent()

onEvent(eventId): Observable<any>

Observes platform events with the specified eventId.

Parameters

Parameter	Type	Default value
eventId	null | string	null

Returns

Observable<any>

Inherited from

Viewer . onEvent

Source

src/viewer.ts:308

---

onFrameAttached()

onFrameAttached(dataFrame): void

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Viewer . onFrameAttached

Source

src/widgets.ts:284

---

onPropertyChanged()

onPropertyChanged(property): void

Gets called when viewer's property is changed.

Parameters

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

Returns

void

Inherited from

Viewer . onPropertyChanged

Source

src/widgets.ts:276

---

removeFromView()

removeFromView(): any

Returns

any

Inherited from

Viewer . removeFromView

Source

src/viewer.ts:350

---

render()

render(g, bounds): void

Renders the content of this grid to the specified canvas and bounds.

Parameters

Parameter	Type
g	CanvasRenderingContext2D
bounds	Rect

Returns

void

Source

src/grid.ts:1138

---

resetRowHeight()

resetRowHeight(): void

Resets rows height

Returns

void

Source

src/grid.ts:1082

---

runPostponedComputations()

runPostponedComputations(): void

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

Source

src/grid.ts:1091

---

scrollToCell()

scrollToCell(column, row): void

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

Source

src/grid.ts:1042

---

scrollToPixels()

scrollToPixels(x, y): void

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

Source

src/grid.ts:1049

---

setOptions()

setOptions(map): void

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

Parameters

Parameter	Type	Description
map	object
map.type?	string	-

Returns

void

Inherited from

Viewer . setOptions

Source

src/viewer.ts:141

---

setRowOrder()

setRowOrder(indexes): Grid

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

Source

src/grid.ts:1028

---

sort()

sort(columns, orders): Grid

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	null | boolean[]	null

Returns

Grid

Source

src/grid.ts:1005

---

sortIndexes()

sortIndexes(indexComparer): Grid

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

Source

src/grid.ts:1013

---

sourceRowsChanged()

sourceRowsChanged(): void

Returns

void

Inherited from

Viewer . sourceRowsChanged

Source

src/widgets.ts:282

---

sub()

sub(subscription): void

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription

Returns

void

Inherited from

Viewer . sub

Source

src/widgets.ts:250

---

tableRowToGrid()

tableRowToGrid(tableRow): number

Converts table row index to grid index. See also gridRowToTable

Parameters

Parameter	Type
tableRow	number

Returns

number

Source

src/grid.ts:1066

---

toCompactLook()

toCompactLook(): void

Returns

void

Inherited from

Viewer . toCompactLook

Source

src/viewer.ts:325

---

toDart()

toDart(): any

Returns

any

Inherited from

Viewer . toDart

Source

src/widgets.ts:242

---

barChart()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IBarChartSettings>

Returns

Viewer <IBarChartSettings>

Inherited from

Viewer . barChart

Source

src/viewer.ts:218

---

boxPlot()

static boxPlot(t, options?): BoxPlot

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IBoxPlotSettings>

Returns

BoxPlot

Inherited from

Viewer . boxPlot

Source

src/viewer.ts:226

---

calendar()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <ICalendarSettings>

Returns

Viewer <ICalendarSettings>

Inherited from

Viewer . calendar

Source

src/viewer.ts:246

---

canVisualize()

static canVisualize(viewerType, dataFrame): null | string

Parameters

Parameter	Type
viewerType	string
dataFrame	DataFrame

Returns

null | string

Inherited from

Viewer . canVisualize

Source

src/viewer.ts:354

---

correlationPlot()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <ICorrelationPlotSettings>

Returns

Viewer <ICorrelationPlotSettings>

Inherited from

Viewer . correlationPlot

Source

src/viewer.ts:250

---

create()

static create(table): Grid

Creates a new grid.

Parameters

Parameter	Type
table	object
table.dart	any

Returns

Grid

Source

src/grid.ts:915

---

densityPlot()

static densityPlot(t, options?): Viewer <IDensityPlotSettings>

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IDensityPlotSettings>

Returns

Viewer <IDensityPlotSettings>

Inherited from

Viewer . densityPlot

Source

src/viewer.ts:254

---

filters()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IFiltersSettings>

Returns

Viewer <IFiltersSettings>

Inherited from

Viewer . filters

Source

src/viewer.ts:230

---

find()

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

null | Widget<any>

Inherited from

Viewer . find

Source

src/widgets.ts:238

---

form()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IFormSettings>

Returns

Viewer <IFormSettings>

Inherited from

Viewer . form

Source

src/viewer.ts:258

---

fromProperties()

static fromProperties(items, props): Grid

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

Parameters

Parameter	Type
items	any[]
props	Property[]

Returns

Grid

Source

src/grid.ts:920

---

fromRoot()

static fromRoot(root): Widget<any>

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget<any>

Inherited from

Viewer . fromRoot

Source

src/widgets.ts:341

---

fromType()

static fromType(viewerType, table, options): Viewer<any>

Creates a new viewer of the specified type.

Parameters

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

Returns

Viewer<any>

Inherited from

Viewer . fromType

Source

src/viewer.ts:123

---

getAll()

static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Viewer . getAll

Source

src/widgets.ts:233

---

getViewerTypes()

static getViewerTypes(options?): string[]

Gets all available viewer types Core means the viewer is already loaded and all methods and properties are available synchronously.

Parameters

Parameter	Type
options?	object
options.core?	boolean

Returns

string[]

Inherited from

Viewer . getViewerTypes

Source

src/viewer.ts:130

---

grid()

static grid(t, options?): Grid

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IGridSettings>

Returns

Grid

Inherited from

Viewer . grid

Source

src/viewer.ts:210

---

heatMap()

static heatMap(t, options?): Grid

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IGridSettings>

Returns

Grid

Inherited from

Viewer . heatMap

Source

src/viewer.ts:222

---

histogram()

static histogram(t, options?): HistogramViewer

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IHistogramSettings>

Returns

HistogramViewer

Inherited from

Viewer . histogram

Source

src/viewer.ts:214

---

lineChart()

static lineChart(t, options?): LineChartViewer

Parameters

Parameter	Type
t	DataFrame
options?	Partial <ILineChartSettings>

Returns

LineChartViewer

Inherited from

Viewer . lineChart

Source

src/viewer.ts:238

---

markup()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IMarkupViewerSettings>

Returns

Viewer <IMarkupViewerSettings>

Inherited from

Viewer . markup

Source

src/viewer.ts:262

---

matrixPlot()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IMatrixPlotSettings>

Returns

Viewer <IMatrixPlotSettings>

Inherited from

Viewer . matrixPlot

Source

src/viewer.ts:266

---

network()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <INetworkDiagramSettings>

Returns

Viewer <INetworkDiagramSettings>

Inherited from

Viewer . network

Source

src/viewer.ts:242

---

pcPlot()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IPcPlotSettings>

Returns

Viewer <IPcPlotSettings>

Inherited from

Viewer . pcPlot

Source

src/viewer.ts:270

---

pieChart()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IPieChartSettings>

Returns

Viewer <IPieChartSettings>

Inherited from

Viewer . pieChart

Source

src/viewer.ts:274

---

scatterPlot()

static scatterPlot(t, options?): ScatterPlotViewer

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IScatterPlotSettings>

Returns

ScatterPlotViewer

Inherited from

Viewer . scatterPlot

Source

src/viewer.ts:234

---

scatterPlot3d()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IScatterPlot3dSettings>

Returns

Viewer <IScatterPlot3dSettings>

Inherited from

Viewer . scatterPlot3d

Source

src/viewer.ts:278

---

statistics()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <IStatsViewerSettings>

Returns

Viewer <IStatsViewerSettings>

Inherited from

Viewer . statistics

Source

src/viewer.ts:282

---

tile()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <ITileViewerSettings>

Returns

Viewer <ITileViewerSettings>

Inherited from

Viewer . tile

Source

src/viewer.ts:286

---

treeMap()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <ITreeMapSettings>

Returns

Viewer <ITreeMapSettings>

Inherited from

Viewer . treeMap

Source

src/viewer.ts:290

---

trellisPlot()

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

Parameters

Parameter	Type
t	DataFrame
options?	Partial <ITrellisPlotSettings>

Returns

Viewer <ITrellisPlotSettings>

Inherited from

Viewer . trellisPlot

Source

src/viewer.ts:294

---

wordCloud()

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

Parameters

Parameter	Type
t	DataFrame
options?	any

Returns

Viewer<any>

Inherited from

Viewer . wordCloud

Deprecated

Source

src/viewer.ts:299