DataFrame

DataFrame is a high-performance, easy to use tabular structure with strongly-typed columns of different types.

In the API, the terms "Table" and "DataFrame" are used interchangeably.

Usage samples: https://public.datagrok.ai/js/samples/data-frame/manipulate Usage details: https://datagrok.ai/help/develop/advanced/data-frame Implementation details: https://datagrok.ai/help/develop/admin/architecture#in-memory-database

Constructors

new DataFrame()

new DataFrame(dart): DataFrame

Parameters

Parameter	Type
dart	any

Returns

DataFrame

Source

src/dataframe/data-frame.ts:58

Properties

Property	Modifier	Type
_dialogs	private	undefined | DataFrameDialogHelper
_meta	public	undefined | DataFrameMetaHelper
_plot	private	undefined | DataFramePlotHelper
columns	public	ColumnList
dart	readonly	any
filter	public	BitSet
rows	public	RowList
tags	public	any
temp	public	any

Accessors

currentCell

get currentCell(): Cell

Current cell. Sample: https://public.datagrok.ai/js/samples/data-frame/events/current-elements

set currentCell(cell): void

Current cell. Sample: https://public.datagrok.ai/js/samples/data-frame/events/current-elements

Parameters

Parameter	Type
cell	Cell

Returns

Cell

Source

src/dataframe/data-frame.ts:321

---

currentCol

get currentCol(): Column<any, any>

Current column. Sample: https://public.datagrok.ai/js/samples/data-frame/events/current-elements

set currentCol(col): void

Current column. Sample: https://public.datagrok.ai/js/samples/data-frame/events/current-elements

Parameters

Parameter	Type
col	Column<any, any>

Returns

Column<any, any>

Source

src/dataframe/data-frame.ts:309

---

currentRow

get currentRow(): Row

Current row. Sample: https://public.datagrok.ai/js/samples/data-frame/events/current-elements

set currentRow(row): void

Parameters

Parameter	Type
row	Row

Returns

Row

Source

src/dataframe/data-frame.ts:296

---

currentRowIdx

get currentRowIdx(): number

Index of the current row.

set currentRowIdx(idx): void

Parameters

Parameter	Type
idx	number

Returns

number

Source

src/dataframe/data-frame.ts:300

---

dialogs

get dialogs(): DataFrameDialogHelper

Returns

DataFrameDialogHelper

Source

src/dataframe/data-frame.ts:149

---

id

get id(): string

Id of the dataframe.

set id(id): void

Parameters

Parameter	Type
id	string

Returns

string

Source

src/dataframe/data-frame.ts:495

---

meta

get meta(): DataFrameMetaHelper

A helper to conveniently access certain metadata properties stored in tags

Returns

DataFrameMetaHelper

Source

src/dataframe/data-frame.ts:136

---

mouseOverRowIdx

get mouseOverRowIdx(): number

Index of the mouse-over row.

set mouseOverRowIdx(idx): void

Parameters

Parameter	Type
idx	number

Returns

number

Source

src/dataframe/data-frame.ts:304

---

name

get name(): string

Name of the dataframe.

set name(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/dataframe/data-frame.ts:166

---

onColumnNameChanged

get onColumnNameChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:440

---

onColumnSelectionChanged

get onColumnSelectionChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:443

---

onColumnsAdded

get onColumnsAdded(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:449

---

onColumnsChanged

get onColumnsChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:446

---

onColumnsRemoved

get onColumnsRemoved(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:452

---

onCurrentCellChanged

get onCurrentCellChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/current-elements

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:428

---

onCurrentColChanged

get onCurrentColChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/current-elements

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:422

---

onCurrentRowChanged

get onCurrentRowChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/current-elements

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:416

---

onDataChanged

get onDataChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:473

---

onFilterChanged

get onFilterChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:482

---

onMetadataChanged

get onMetadataChanged(): Observable <EventData <MapChangeArgs<string, string>>>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable <EventData <MapChangeArgs<string, string>>>

Source

src/dataframe/data-frame.ts:437

---

onMouseOverColChanged

get onMouseOverColChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:425

---

onMouseOverRowChanged

get onMouseOverRowChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:419

---

onMouseOverRowGroupChanged

get onMouseOverRowGroupChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:431

---

onNameChanged

get onNameChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:434

---

onRowsAdded

get onRowsAdded(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:455

---

onRowsFiltered

get onRowsFiltered(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:461

---

onRowsFiltering

get onRowsFiltering(): Observable<any>

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:464

---

onRowsRemoved

get onRowsRemoved(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:458

---

onSelectionChanged

get onSelectionChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:479

---

onSemanticTypeDetected

get onSemanticTypeDetected(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/advanced/semantic-type-detection

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:470

---

onSemanticTypeDetecting

get onSemanticTypeDetecting(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/advanced/semantic-type-detection

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:467

---

onValuesChanged

get onValuesChanged(): Observable<any>

Sample: https://public.datagrok.ai/js/samples/data-frame/events/events

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:413

---

plot

get plot(): DataFramePlotHelper

A helper for creating plots for this dataframe

Returns

DataFramePlotHelper

Source

src/dataframe/data-frame.ts:143

---

rowCount

get rowCount(): number

Returns number of rows in the table.

Returns

number

Source

src/dataframe/data-frame.ts:156

---

selection

get selection(): BitSet

Returns a BitSet with selected rows.

Returns

BitSet

Source

src/dataframe/data-frame.ts:161

Methods

_event()

_event(event): Observable<any>

Parameters

Parameter	Type
event	string

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:404

---

_exportReopen()

_exportReopen(): DataFrame

Returns

DataFrame

Source

src/dataframe/data-frame.ts:511

---

append()

append(t2, inPlace, columnsToAppend): DataFrame

Appends two tables ('union' in SQL).

Parameters

Parameter	Type	Default value	Description
t2	DataFrame	undefined
inPlace	boolean	false	whether to create a new table, or modify 'this' one.
columnsToAppend	null | string[]	null

Returns

DataFrame

Source

src/dataframe/data-frame.ts:396

---

appendMerge()

appendMerge(t): void

Parameters

Parameter	Type
t	DataFrame

Returns

void

Source

src/dataframe/data-frame.ts:400

---

cell()

cell(idx, name): Cell

Returns a Cell with the specified row and column.

Parameters

Parameter	Type	Description
idx	number	Row index.
name	string	Column name.

Returns

Cell

Source

src/dataframe/data-frame.ts:223

---

changeColumnType()

changeColumnType(column, newType, format): Column<any, any>

Converts a column with the specified name to [newType], removes the original column from its dataframe and adds the new column to it.

Parameters

Parameter	Type	Default value	Description
column	string | Column<any, any>	undefined
newType	"string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe"	undefined
format	null | string	null	number format

Returns

Column<any, any>

See

COLUMN_TYPE

Source

src/dataframe/data-frame.ts:337

---

clone()

clone(rowMask, columnIds, saveSelection, saveTags): DataFrame

Creates a new dataframe from the specified row mask and a list of columns.

Parameters

Parameter	Type	Default value	Description
rowMask	null | BitSet	null	Rows to include.
columnIds	null | string[]	null	Columns to include.
saveSelection	boolean	false	Whether selection should be saved.
saveTags	boolean	true	Whether tags should be copied to the new dataframe.

Returns

DataFrame

Source

src/dataframe/data-frame.ts:290

---

col()

col(nameOrIndex): null | Column<any, any>

Returns a Column with the specified name.

Parameters

Parameter	Type	Description
nameOrIndex	string | number	Column name.

Returns

null | Column<any, any>

Source

src/dataframe/data-frame.ts:210

---

fireValuesChanged()

fireValuesChanged(): void

Returns

void

Source

src/dataframe/data-frame.ts:484

---

get()

get(name, idx): any

Returns idx-th value of the specified columns.

Parameters

Parameter	Type	Description
name	string	Column name.
idx	number	Row index.

Returns

any

Source

src/dataframe/data-frame.ts:195

---

getCol()

getCol(name): Column<any, any>

Same as col, but throws Error if column is not found

Parameters

Parameter	Type	Description
name	string	Column name.

Returns

Column<any, any>

Source

src/dataframe/data-frame.ts:230

---

getDensity()

getDensity(xBins, yBins, xColName, yColName): Int32Array

Parameters

Parameter	Type
xBins	number
yBins	number
xColName	string
yColName	string

Returns

Int32Array

Source

src/dataframe/data-frame.ts:503

---

getSortedOrder()

getSortedOrder(sortByColumnIds, sortOrders, rowMask): Int32Array

Returns [Int32Array] that contains sorted order, or null for unsorted (original) order. See also Column.getSortedOrder. Sample: https://public.datagrok.ai/js/samples/data-frame/sorting/sorted-order

Parameters

Parameter	Type	Default value	Description
sortByColumnIds	ColumnId[]	undefined	Collection of [Column]s to use as keys for sorting.
sortOrders	null | boolean[]	null	List of sort orders for [sortByCols]. True == ascending.
rowMask	null | BitSet	null	Mask of the rows to sort. Result array will contain [rowIndexes.length] elements.

Returns

Int32Array

Source

src/dataframe/data-frame.ts:350

---

getTableInfo()

getTableInfo(): TableInfo

Returns

TableInfo

Source

src/dataframe/data-frame.ts:507

---

getTag()

getTag(tag): null | string

Returns the value of the specified tag, or null if it does not exist.

Parameters

Parameter	Type
tag	string

Returns

null | string

Source

src/dataframe/data-frame.ts:171

---

groupBy()

groupBy(columnNames): GroupByBuilder

Begins building a query, using the specified columns as keys.

Parameters

Parameter	Type	Default value	Description
columnNames	string[]	[]	Names of the columns to be used as keys.

Returns

GroupByBuilder

Source

src/dataframe/data-frame.ts:358

---

join()

join(t2, keyColumns1, keyColumns2, valueColumns1, valueColumns2, joinType, inPlace): DataFrame

Merges two tables by the specified key columns.

Parameters

Parameter	Type	Default value	Description
t2	DataFrame	undefined	a table to join
keyColumns1	string[]	undefined	key column names from the first table
keyColumns2	string[]	undefined	key column names from the second table
valueColumns1	null | string[]	null	column names to copy from the first table. Pass null to add all columns, an empty array [] to not add any columns, or an array with column names to add them specifically.
valueColumns2	null | string[]	null	column names to copy from the second table
joinType	"left" | "right" | "inner" | "outer"	JOIN_TYPE.INNER	inner, outer, left, or right. See [DG.JOIN_TYPE]
inPlace	boolean	false	merges content in-place into the source table

Returns

DataFrame

Sample: https://public.datagrok.ai/js/samples/data-frame/join-link/join-tables

Source

src/dataframe/data-frame.ts:385

---

onEvent()

onEvent(event): Observable<any>

Parameters

Parameter	Type
event	string

Returns

Observable<any>

Source

src/dataframe/data-frame.ts:408

---

row()

row(rowIndex): Row

Returns i-th row. NOTE: Do not use in performance-critical paths, consider accessing values via the Column instance.

Parameters

Parameter	Type
rowIndex	number

Returns

Row

Source

src/dataframe/data-frame.ts:188

---

set()

set(name, idx, value): void

Sets idx-th value of the specified columns.

Parameters

Parameter	Type	Description
name	string	Column name.
idx	number	Row index.
value	any	Value.

Returns

void

Source

src/dataframe/data-frame.ts:203

---

setTag()

setTag(tag, value): DataFrame

Sets a tag to the specified value.

Parameters

Parameter	Type	Description
tag	string	Key.
value	string	Value.

Returns

DataFrame

Source

src/dataframe/data-frame.ts:178

---

toArrow()

toArrow(): Uint8Array

Exports dataframe to Arrow IPC format.

Returns

Uint8Array

Source

src/dataframe/data-frame.ts:280

---

toByteArray()

toByteArray(): Uint8Array

Exports dataframe to binary

Returns

Uint8Array

Source

src/dataframe/data-frame.ts:269

---

toCsv()

toCsv(options?, grid?): string

Exports the content to comma-separated-values format.

Parameters

Parameter	Type	Description
options?	CsvExportOptions	options for the export
grid?	Grid	if specified, takes visible columns, column and row order from the grid.

Returns

string

Source

src/dataframe/data-frame.ts:241

---

toCsvEx()

toCsvEx(options?, grid?): Promise<string>

Exports the content to comma-separated-values format asynchronously with converting the molblock columns to smiles if specified.

Parameters

Parameter	Type	Description
options?	CsvExportOptions	options for the export
grid?	Grid	if specified, takes visible columns, column and row order from the grid.

Returns

Promise<string>

Source

src/dataframe/data-frame.ts:250

---

toJson()

toJson(): any[]

Converts the contents to array of objects, with column names as keys. Keep in mind that the internal DataFrame format is far more efficient than JSON, so use it only as a convenience for working with relatively small datasets.

Returns

any[]

Source

src/dataframe/data-frame.ts:257

---

toParquet()

toParquet(compress): Uint8Array

Exports dataframe to Parquet format.

Parameters

Parameter	Type	Default value	Description
compress	boolean	false	If true, applies GZIP compression.

Returns

Uint8Array

Source

src/dataframe/data-frame.ts:275

---

toString()

toString(): string

Returns

string

Source

src/dataframe/data-frame.ts:489

---

unpivot()

unpivot(copyColumnNames, mergeColumnNames, categoryColumnName, valueColumnName): DataFrame

Unpivots the table (converts from 'wide' representation with many columns to 'tall and skinny').

Parameters

Parameter	Type	Default value	Description
copyColumnNames	string[]	undefined	columns to copy
mergeColumnNames	string[]	undefined	columns to merge. Column name will become a value in the [categoryColumnName] column, and column value will become a value in the [valueColumnName] column.
categoryColumnName	string	'Category'	-
valueColumnName	string	'Value'	-

Returns

DataFrame

Source

src/dataframe/data-frame.ts:368

---

create()

static create(rowCount, name?): DataFrame

Creates a DataFrame with the specified number of rows and no columns.

Parameters

Parameter	Type	Default value
rowCount	number	0
name?	string	undefined

Returns

DataFrame

Source

src/dataframe/data-frame.ts:68

---

fromByteArray()

static fromByteArray(byteArray): DataFrame

Parameters

Parameter	Type
byteArray	Uint8Array

Returns

DataFrame

Source

src/dataframe/data-frame.ts:75

---

fromColumns()

static fromColumns(columns): DataFrame

Creates a DataFrame from the specified columns. All columns should be of the same length.

Parameters

Parameter	Type
columns	Column<any, any>[]

Returns

DataFrame

Source

src/dataframe/data-frame.ts:80

---

fromCsv()

static fromCsv(csv, options?): DataFrame

Constructs DataFrame from a comma-separated values string

Parameters

Parameter	Type	Description
csv	string	The content of the comma-separated values file. https://dev.datagrok.ai/script/samples/javascript/data-frame/construction/create-from-csv
options?	CsvImportOptions	-

Returns

DataFrame

Source

src/dataframe/data-frame.ts:123

---

fromJson()

static fromJson(json): DataFrame

Constructs DataFrame from the specified JSON string.

Parameters

Parameter	Type	Description
json	string	JSON document. https://dev.datagrok.ai/script/samples/javascript/data-frame/construction/create-from-json

Returns

DataFrame

Source

src/dataframe/data-frame.ts:131

---

fromObjects()

static fromObjects(list): undefined | DataFrame

Creates a [DataFrame] from a list of objects by using object keys as column names, and object values as values.

NOTE: The implementation converts the values to strings first and then parses it, so do not use this method in performance-critical paths (for instance when the number of objects could be big), consider using fromColumns instead.

Parameters

Parameter	Type	Description
list	object[]	List of objects. https://dev.datagrok.ai/script/samples/javascript/data-frame/construction/create-from-objects

Returns

undefined | DataFrame

Source

src/dataframe/data-frame.ts:102

---

fromProperties()

static fromProperties(properties, rows): DataFrame

Creates a DataFrame from the specified properties with the specified row count.

Parameters

Parameter	Type	Default value
properties	Property[]	undefined
rows	number	0

Returns

DataFrame

Source

src/dataframe/data-frame.ts:85