ColumnList

Defined in: js-api/src/dataframe/column-list.ts:27

Columns in a [DataFrame].

Constructors

Constructor

new ColumnList(dart): ColumnList

Defined in: js-api/src/dataframe/column-list.ts:30

Parameters

Parameter	Type
`dart`	`any`

Returns

ColumnList

Accessors

all

Get Signature

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

Defined in: js-api/src/dataframe/column-list.ts:86

Returns all columns.

Returns

Iterable<Column<any, any>>

boolean

Get Signature

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

Defined in: js-api/src/dataframe/column-list.ts:110

Returns

Iterable<Column<any, any>>

categorical

Get Signature

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

Defined in: js-api/src/dataframe/column-list.ts:92

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

Returns

Iterable<Column<any, any>>

dataFrame

Get Signature

get dataFrame(): DataFrame

Defined in: js-api/src/dataframe/column-list.ts:34

Returns

DataFrame

dateTime

Get Signature

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

Defined in: js-api/src/dataframe/column-list.ts:102

Returns

Iterable<Column<any, any>>

length

Get Signature

get length(): number

Defined in: js-api/src/dataframe/column-list.ts:37

Number of columns.

Returns

number

numerical

Get Signature

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

Defined in: js-api/src/dataframe/column-list.ts:98

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

Returns

Iterable<Column<any, any>>

numericalNoDateTime

Get Signature

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

Defined in: js-api/src/dataframe/column-list.ts:106

Returns

Iterable<Column<any, any>>

selected

Get Signature

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

Defined in: js-api/src/dataframe/column-list.ts:114

Returns

Iterable<Column<any, any>>

Methods

_getNewCalculated()

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

Defined in: js-api/src/dataframe/column-list.ts:184

Parameters

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

Returns

Promise<Column<any, any>>

[iterator]()

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

Defined in: js-api/src/dataframe/column-list.ts:276

Iterates over all columns.

Returns

IterableIterator<Column<any, any>>

add()

add(column, notify?): Column

Defined in: js-api/src/dataframe/column-list.ts:143

Adds a column, and optionally notifies the parent dataframe.

Parameters

Parameter	Type	Default value	Description
`column`	`Column`	`undefined`	-
`notify`	`boolean`	`true`	whether DataFrame's `changed` event should be fired

Returns

Column

addNew()

addNew(name, type): Column

Defined in: js-api/src/dataframe/column-list.ts:169

Adds an empty column of the specified type.

Parameters

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

Returns

Column

addNewBool()

addNewBool(name): Column<boolean>

Defined in: js-api/src/dataframe/column-list.ts:221

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>

addNewBytes()

addNewBytes(name): Column<Uint8Array<ArrayBufferLike>>

Defined in: js-api/src/dataframe/column-list.ts:226

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<ArrayBufferLike>>

addNewCalculated()

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

Defined in: js-api/src/dataframe/column-list.ts:180

Adds calculated column.

Parameters

Parameter	Type	Default value	Description
`name`	`string`	`undefined`	-
`expression`	`string`	`undefined`	-
`type`	`"string"` \| `"bigint"` \| `"object"` \| `"auto"` \| `"bool"` \| `"int"` \| `"double"` \| `"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>>

addNewDateTime()

addNewDateTime(name): DateTimeColumn

Defined in: js-api/src/dataframe/column-list.ts:216

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

addNewFloat()

addNewFloat(name): Column<number>

Defined in: js-api/src/dataframe/column-list.ts:196

Creates and adds a float column

Parameters

Parameter	Type
`name`	`string`

Returns

Column<number>

addNewInt()

addNewInt(name): Column<number>

Defined in: js-api/src/dataframe/column-list.ts:193

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>

addNewQnum()

addNewQnum(name, options?): Column<number>

Defined in: js-api/src/dataframe/column-list.ts:203

Creates and adds a qualified number column. If [options] is provided, populates the column by combining a qualifier column (string values: '<', '>', '', '=') with a numeric value column at each row. https://dev.datagrok.ai/script/samples/javascript/data-frame/modification/add-columns

Parameters

Parameter	Type
`name`	`string`
`options?`	`QnumColumnCreationOptions`

Returns

Column<number>

addNewString()

addNewString(name): Column<string>

Defined in: js-api/src/dataframe/column-list.ts:189

Creates and adds a string column.

Parameters

Parameter	Type
`name`	`string`

Returns

Column<string>

addNewVirtual()

addNewVirtual(name, getValue, type?, setValue?): Column

Defined in: js-api/src/dataframe/column-list.ts:238

Creates and adds a virtual column.

Parameters

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

Returns

Column

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

byIndex()

byIndex(index): Column

Defined in: js-api/src/dataframe/column-list.ts:46

Column by index

Parameters

Parameter	Type
`index`	`number`

Returns

Column

byName()

byName(name): Column

Defined in: js-api/src/dataframe/column-list.ts:40

Column with the corresponding name (case-insensitive).

Parameters

Parameter	Type
`name`	`string`

Returns

Column

byNames()

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

Defined in: js-api/src/dataframe/column-list.ts:43

Maps names to columns.

Parameters

Parameter	Type
`names`	`string`[]

Returns

Column<any, any>[]

bySemType()

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

Defined in: js-api/src/dataframe/column-list.ts:49

First column of [semType], or null.

Parameters

Parameter	Type
`semType`	`string`

Returns

Column<any, any> | null

bySemTypeAll()

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

Defined in: js-api/src/dataframe/column-list.ts:55

All columns of [semType], or empty list.

Parameters

Parameter	Type
`semType`	`string`

Returns

Column<any, any>[]

bySemTypesExact()

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

Defined in: js-api/src/dataframe/column-list.ts:60

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

Parameters

Parameter	Type
`semTypes`	`string`[]

Returns

Column<any, any>[] | null

byTags()

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

Defined in: js-api/src/dataframe/column-list.ts:74

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>>

contains()

contains(columnName): boolean

Defined in: js-api/src/dataframe/column-list.ts:257

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

Parameters

Parameter	Type
`columnName`	`string`

Returns

boolean

firstWhere()

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

Defined in: js-api/src/dataframe/column-list.ts:79

Returns the first column that satisfies the specified criteria.

Parameters

Parameter	Type
`predicate`	(`col`) => `boolean`

Returns

Column<any, any> | undefined

getOrCreate()

getOrCreate(name, type): Column

Defined in: js-api/src/dataframe/column-list.ts:152

Returns a column with the specified name and type, or creates a new column if it does not exist.

Parameters

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

Returns

Column

See

COLUMN_TYPE

getUnusedName()

getUnusedName(name, choices?): string

Defined in: js-api/src/dataframe/column-list.ts:271

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

insert()

insert(column, index?, notify?): Column

Defined in: js-api/src/dataframe/column-list.ts:163

Inserts a column, and optionally notifies the parent dataframe.

Parameters

Parameter	Type	Default value	Description
`column`	`Column`	`undefined`	column to insert
`index`	`number` \| `null`	`null`	-
`notify`	`boolean`	`true`	whether DataFrame's `changed` event should be fired

Returns

Column

names()

names(): string[]

Defined in: js-api/src/dataframe/column-list.ts:119

Array containing column names.

Returns

string[]

remove()

remove(column, notify?): ColumnList

Defined in: js-api/src/dataframe/column-list.ts:246

Removes column by name (case-insensitive).

Parameters

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

Returns

ColumnList

replace()

replace(columnToReplace, newColumn, notify?): Column

Defined in: js-api/src/dataframe/column-list.ts:263

Replaces the column with the new column.

Parameters

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

Returns

Column

setOrder()

setOrder(columnNames): void

Defined in: js-api/src/dataframe/column-list.ts:124

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

toList()

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

Defined in: js-api/src/dataframe/column-list.ts:129

Creates an array of columns.

Returns

Column<any, any>[]

toMap()

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

Defined in: js-api/src/dataframe/column-list.ts:134

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

Returns

Map<string, Column<any, any>>

toString()

toString(): string

Defined in: js-api/src/dataframe/column-list.ts:281

Returns

string

Constructors​

Constructor​

Parameters​

Returns​

Accessors​

all​

Get Signature​

Returns​

boolean​

Get Signature​

Returns​

categorical​

Get Signature​

Returns​

dataFrame​

Get Signature​

Returns​

dateTime​

Get Signature​

Returns​

length​

Get Signature​

Returns​

numerical​

Get Signature​

Returns​

numericalNoDateTime​

Get Signature​

Returns​

selected​

Get Signature​

Returns​

Methods​

_getNewCalculated()​

Parameters​

Returns​

[iterator]()​

Returns​

add()​

Parameters​

Returns​

addNew()​

Parameters​

Returns​

addNewBool()​

Parameters​

Returns​

addNewBytes()​

Parameters​

Returns​

addNewCalculated()​

Parameters​

Returns​

addNewDateTime()​

Parameters​

Returns​

addNewFloat()​

Parameters​

Returns​

addNewInt()​

Parameters​

Returns​

addNewQnum()​

Parameters​

Returns​

addNewString()​

Parameters​

Returns​

addNewVirtual()​

Parameters​

Returns​

byIndex()​

Parameters​

Returns​

byName()​

Parameters​

Returns​

byNames()​

Parameters​

Returns​

Constructors

Constructor

Parameters

Returns

Accessors

all

Get Signature

Returns

boolean

Get Signature

Returns

categorical

Get Signature

Returns

dataFrame

Get Signature

Returns

dateTime

Get Signature

Returns

length

Get Signature

Returns

numerical

Get Signature

Returns

numericalNoDateTime

Get Signature

Returns

selected

Get Signature

Returns

Methods

_getNewCalculated()

Parameters

Returns

[iterator]()

Returns

add()

Parameters

Returns

addNew()

Parameters

Returns

addNewBool()

Parameters

Returns

addNewBytes()

Parameters

Returns

addNewCalculated()

Parameters

Returns

addNewDateTime()

Parameters

Returns

addNewFloat()

Parameters

Returns

addNewInt()

Parameters

Returns

addNewQnum()

Parameters

Returns

addNewString()

Parameters

Returns

addNewVirtual()

Parameters

Returns

byIndex()

Parameters

Returns

byName()

Parameters

Returns

byNames()

Parameters

Returns