ColumnList

Columns in a [DataFrame].

Constructors

new ColumnList()

new ColumnList(dart): ColumnList

Parameters

Parameter	Type
dart	any

Returns

ColumnList

Source

src/dataframe.ts:1224

Properties

Property	Modifier	Type
dart	private	any

Accessors

all

get all(): Iterable <Column<any, any>>

Returns all columns.

Returns

Iterable <Column<any, any>>

Source

src/dataframe.ts:1280

---

boolean

get boolean(): Iterable <Column<any, any>>

Returns

Iterable <Column<any, any>>

Source

src/dataframe.ts:1304

---

categorical

get categorical(): Iterable <Column<any, any>>

Finds categorical columns. Sample: https://public.datagrok.ai/js/samples/data-frame/find-columns

Returns

Iterable <Column<any, any>>

Source

src/dataframe.ts:1286

---

dataFrame

get dataFrame(): DataFrame

Returns

DataFrame

Source

src/dataframe.ts:1228

---

dateTime

get dateTime(): Iterable <Column<any, any>>

Returns

Iterable <Column<any, any>>

Source

src/dataframe.ts:1296

---

length

get length(): number

Number of columns.

Returns

number

Source

src/dataframe.ts:1231

---

numerical

get numerical(): Iterable <Column<any, any>>

Finds numerical columns. Sample: https://public.datagrok.ai/js/samples/data-frame/find-columns

Returns

Iterable <Column<any, any>>

Source

src/dataframe.ts:1292

---

numericalNoDateTime

get numericalNoDateTime(): Iterable <Column<any, any>>

Returns

Iterable <Column<any, any>>

Source

src/dataframe.ts:1300

---

selected

get selected(): Iterable <Column<any, any>>

Returns

Iterable <Column<any, any>>

Source

src/dataframe.ts:1308

Methods

[iterator]()

[iterator](): IterableIterator <Column<any, any>>

Iterates over all columns.

Returns

IterableIterator <Column<any, any>>

Source

src/dataframe.ts:1465

---

_getNewCalculated()

_getNewCalculated(name, expression, type, treatAsString): Promise <Column<any, any>>

Parameters

Parameter	Type	Default value
name	string	undefined
expression	string	undefined
type	"string" | "bigint" | "object" | "auto" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe"	'auto'
treatAsString	boolean	false

Returns

Promise <Column<any, any>>

Source

src/dataframe.ts:1379

---

add()

add(column, notify): Column<any, any>

Adds a column, and optionally notifies the parent dataframe.

Parameters

Parameter	Type	Default value	Description
column	Column<any, any>	undefined
notify	boolean	true	whether DataFrame's changed event should be fired

Returns

Column<any, any>

Source

src/dataframe.ts:1339

---

addNew()

addNew(name, type): Column<any, any>

Adds an empty column of the specified type.

Parameters

Parameter	Type	Description
name	string
type	"string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe"

Returns

Column<any, any>

Source

src/dataframe.ts:1364

---

addNewBool()

addNewBool(name): Column<boolean, boolean>

Creates and adds a boolean column https://dev.datagrok.ai/script/samples/javascript/data-frame/modification/add-columns

Parameters

Parameter	Type
name	string

Returns

Column<boolean, boolean>

Source

src/dataframe.ts:1406

---

addNewBytes()

addNewBytes(name): Column<Uint8Array, Uint8Array>

Creates and adds a byte array column https://dev.datagrok.ai/script/samples/javascript/data-frame/modification/add-columns

Parameters

Parameter	Type
name	string

Returns

Column<Uint8Array, Uint8Array>

Source

src/dataframe.ts:1411

---

addNewCalculated()

addNewCalculated(name, expression, type, treatAsString, subscribeOnChanges): Promise <Column<any, any>>

Adds calculated column.

Parameters

Parameter	Type	Default value	Description
name	string	undefined
expression	string	undefined
type	"string" | "bigint" | "object" | "auto" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe"	'auto'
treatAsString	boolean	false	if true, [expression] is not evaluated as formula and is treated as a regular string value instead
subscribeOnChanges	boolean	true	if true, the column will be recalculated when the source columns change

Returns

Promise <Column<any, any>>

Source

src/dataframe.ts:1375

---

addNewDateTime()

addNewDateTime(name): DateTimeColumn

Creates and adds a datetime column https://dev.datagrok.ai/script/samples/javascript/data-frame/modification/add-columns

Parameters

Parameter	Type
name	string

Returns

DateTimeColumn

Source

src/dataframe.ts:1401

---

addNewFloat()

addNewFloat(name): Column<number, number>

Creates and adds a float column

Parameters

Parameter	Type
name	string

Returns

Column<number, number>

Source

src/dataframe.ts:1391

---

addNewInt()

addNewInt(name): Column<number, number>

Creates and adds an integer column https://dev.datagrok.ai/script/samples/javascript/data-frame/modification/add-columns

Parameters

Parameter	Type
name	string

Returns

Column<number, number>

Source

src/dataframe.ts:1388

---

addNewQnum()

addNewQnum(name): Column<number, number>

Creates and adds a qualified number column https://dev.datagrok.ai/script/samples/javascript/data-frame/modification/add-columns

Parameters

Parameter	Type
name	string

Returns

Column<number, number>

Source

src/dataframe.ts:1396

---

addNewString()

addNewString(name): Column<string, string>

Creates and adds a string column.

Parameters

Parameter	Type
name	string

Returns

Column<string, string>

Source

src/dataframe.ts:1384

---

addNewVirtual()

addNewVirtual(name, getValue, type, setValue): Column<any, any>

Creates and adds a virtual column.

Parameters

Parameter	Type	Default value	Description
name	string	undefined
getValue	(ind) => any	undefined	value constructor function that accepts int index and returns value
type	TYPE	TYPE.OBJECT	column type
setValue	null | IndexSetter	null	function that gets invoked when a column cell value is set

Returns

Column<any, any>

https://dev.datagrok.ai/script/samples/javascript/data-frame/advanced/virtual-int-column https://dev.datagrok.ai/script/samples/javascript/data-frame/advanced/virtual-columns

Source

src/dataframe.ts:1423

---

byIndex()

byIndex(index): Column<any, any>

Column by index

Parameters

Parameter	Type
index	number

Returns

Column<any, any>

Source

src/dataframe.ts:1240

---

byName()

byName(name): Column<any, any>

Column with the corresponding name (case-insensitive).

Parameters

Parameter	Type
name	string

Returns

Column<any, any>

Source

src/dataframe.ts:1234

---

byNames()

byNames(names): Column<any, any>[]

Maps names to columns.

Parameters

Parameter	Type
names	string[]

Returns

Column<any, any>[]

Source

src/dataframe.ts:1237

---

bySemType()

bySemType(semType): null | Column<any, any>

First column of [semType], or null.

Parameters

Parameter	Type
semType	string

Returns

null | Column<any, any>

Source

src/dataframe.ts:1243

---

bySemTypeAll()

bySemTypeAll(semType): Column<any, any>[]

All columns of [semType], or empty list.

Parameters

Parameter	Type
semType	string

Returns

Column<any, any>[]

Source

src/dataframe.ts:1249

---

bySemTypesExact()

bySemTypesExact(semTypes): null | Column<any, any>[]

Finds columns by the corresponding semTypes, or null, if any of the sem types could not be found.

Parameters

Parameter	Type
semTypes	string[]

Returns

null | Column<any, any>[]

Source

src/dataframe.ts:1254

---

byTags()

byTags(tags): Iterable <Column<any, any>>

Finds columns by specified tags and values: {'tag': 'value'}. Pass null or undefined to match any value of a tag. Sample: https://public.datagrok.ai/js/samples/data-frame/find-columns

Parameters

Parameter	Type
tags	object

Returns

Iterable <Column<any, any>>

Source

src/dataframe.ts:1268

---

contains()

contains(columnName): boolean

Checks whether this list contains a column with the specified name. The check is case-insensitive.

Parameters

Parameter	Type
columnName	string

Returns

boolean

Source

src/dataframe.ts:1443

---

firstWhere()

firstWhere(predicate): undefined | Column<any, any>

Returns the first column that satisfies the specified criteria.

Parameters

Parameter	Type
predicate	(col) => boolean

Returns

undefined | Column<any, any>

Source

src/dataframe.ts:1273

---

getOrCreate()

getOrCreate(name, type): Column<any, any>

Parameters

Parameter	Type
name	string
type	"string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe"

Returns

Column<any, any>

Source

src/dataframe.ts:1344

---

getUnusedName()

getUnusedName(name, choices?): string

Returns a name that does not exist in column list. If column list does not contain column with [name], returns [name]. Otherwise, tries [choices], and if the names are taken already, returns a string in a form of 'name (i)'.

Parameters

Parameter	Type
name	string
choices?	string[]

Returns

string

Source

src/dataframe.ts:1460

---

insert()

insert(column, index, notify): Column<any, any>

Inserts a column, and optionally notifies the parent dataframe.

Parameters

Parameter	Type	Default value	Description
column	Column<any, any>	undefined
index	null | number	null
notify	boolean	true	whether DataFrame's changed event should be fired

Returns

Column<any, any>

Source

src/dataframe.ts:1355

---

names()

names(): string[]

Array containing column names.

Returns

string[]

Source

src/dataframe.ts:1313

---

remove()

remove(column, notify): ColumnList

Removes column by name (case-insensitive).

Parameters

Parameter	Type	Default value
column	string | number | Column<any, any>	undefined
notify	boolean	true

Returns

ColumnList

Source

src/dataframe.ts:1431

---

replace()

replace(columnToReplace, newColumn, notify): Column<any, any>

Replaces the column with the new column.

Parameters

Parameter	Type	Default value	Description
columnToReplace	string | Column<any, any>	undefined
newColumn	Column<any, any>	undefined
notify	boolean	true

Returns

Column<any, any>

Source

src/dataframe.ts:1452

---

setOrder()

setOrder(columnNames): void

Sets column order. Sample: https://public.datagrok.ai/js/samples/data-frame/columns-ordering

Parameters

Parameter	Type	Description
columnNames	string[]	Order of columns.

Returns

void

Source

src/dataframe.ts:1318

---

toList()

toList(): Column<any, any>[]

Creates an array of columns.

Returns

Column<any, any>[]

Source

src/dataframe.ts:1323

---

toMap()

toMap(): Map<string, Column<any, any>>

Returns a name->column map. Use it when you need to access columns frequently.

Returns

Map<string, Column<any, any>>

Source

src/dataframe.ts:1328

---

toString()

toString(): string

Returns

string

Source

src/dataframe.ts:1470