Class: Column<T>

dg.Column

Strongly-typed column. Use get and set to access elements by index.

Type parameters

Name	Type
T	any

Hierarchy

• Column

  ↳ BigIntColumn

  ↳ DateTimeColumn

  ↳ ObjectColumn

  ↳ DataFrameColumn

Constructors

constructor

• new Column<T>(dart)

Type parameters

Name	Type
T	any

Parameters

Name	Type
dart	any

Defined in

src/dataframe.ts:603

Properties

_dialogs

• Private _dialogs: undefined | ColumnDialogHelper

Defined in

src/dataframe.ts:600

---

_meta

• Private _meta: undefined | ColumnMetaHelper

Defined in

src/dataframe.ts:601

---

dart

• dart: any

Defined in

src/dataframe.ts:597

---

tags

• tags: any

Defined in

src/dataframe.ts:599

---

temp

• temp: any

Defined in

src/dataframe.ts:598

Accessors

categories

• get categories(): string[]

Returns all unique strings in a sorted order. Applicable to string column only.

Returns

string[]

Defined in

src/dataframe.ts:969

---

colors

• get colors(): ColumnColorHelper

Returns

ColumnColorHelper

Defined in

src/dataframe.ts:824

---

dataFrame

• get dataFrame(): DataFrame

Parent table

Returns

DataFrame

Defined in

src/dataframe.ts:778

---

dialogs

• get dialogs(): ColumnDialogHelper

Returns

ColumnDialogHelper

Defined in

src/dataframe.ts:817

---

isVirtual

• get isVirtual(): boolean

Is this column virtual

Returns

boolean

Defined in

src/dataframe.ts:766

---

layoutColumnId

• get layoutColumnId(): string

Layout column ID

Returns

string

Defined in

src/dataframe.ts:794

• set layoutColumnId(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/dataframe.ts:798

---

length

• get length(): number

Number of elements

Returns

number

Defined in

src/dataframe.ts:772

---

markers

• get markers(): ColumnMarkerHelper

Returns

ColumnMarkerHelper

Defined in

src/dataframe.ts:829

---

max

• get max(): number

Column's maximum value. The result is cached.

Returns

number

Defined in

src/dataframe.ts:998

---

meta

• get meta(): ColumnMetaHelper

Returns

ColumnMetaHelper

Defined in

src/dataframe.ts:609

---

min

• get min(): number

Column's minimum value. The result is cached.

Returns

number

Defined in

src/dataframe.ts:995

---

name

• get name(): string

Returns

string

Defined in

src/dataframe.ts:803

• set name(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/dataframe.ts:807

---

semType

• get semType(): string

Semantic type

Returns

string

Defined in

src/dataframe.ts:784

• set semType(s): void

Parameters

Name	Type
s	string

Returns

void

Defined in

src/dataframe.ts:788

---

stats

• get stats(): Stats

Basic descriptive statistics. The result is cached.

Returns

Stats

Defined in

src/dataframe.ts:1008

---

type

• get type(): "string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe"

Column data type.

Returns

"string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe"

Defined in

src/dataframe.ts:760

---

valueComparer

• get valueComparer(): null | Comparer

Value comparison function to be used for sorting. Null means default sorting. Sample: https://public.datagrok.ai/js/samples/data-frame/sorting/custom-comparer

Returns

null | Comparer

Defined in

src/dataframe.ts:991

• set valueComparer(cmp): void

Parameters

Name	Type
cmp	null | Comparer

Returns

void

Defined in

src/dataframe.ts:992

---

version

• get version(): number

Version of the column. Increases each time the column was changed

Returns

number

Defined in

src/dataframe.ts:813

Methods

aggregate

▸ aggregate(type): any

Aggregates a column using the [type] function, which corresponds to

• [DG.AGG] for int, bigint, float, qnum columns,
• [DG.STR_AGG] and [DG.STAT_COUNTS] for string columns,
• [DG.STAT_COUNTS], [DG.AGG.MIN], [DG.AGG.MAX], [DG.AGG.AVG] for datetime columns,
• [DG.AGG.TOTAL_COUNT] and [DG.AGG.MISSING_VALUE_COUNT] for virtual columns.

Parameters

Name	Type
type	string

Returns

any

Defined in

src/dataframe.ts:1043

---

applyFormula

▸ applyFormula(formula, type?, treatAsString?): Promise<null | Column<any>>

Applies the specified formula to a calculated column. Returns a new column object, if applied successfully, and null otherwise.

Parameters

Name	Type	Default value
formula	string	undefined
type	null | "string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe"	null
treatAsString	boolean	false

Returns

Promise<null | Column<any>>

Defined in

src/dataframe.ts:1019

---

clone

▸ clone(mask?): Column<T>

Performs deep cloning, optionally taking mask of the rows to be included. Note that the cloned colum is not added to this column's dataframe.

Parameters

Name	Type
mask?	BitSet

Returns

Column<T>

Defined in

src/dataframe.ts:854

---

compact

▸ compact(): any

Compacts the internal column representation. Currently, it only affects string columns where values were modified.

Returns

any

Defined in

src/dataframe.ts:958

---

convertTo

▸ convertTo(newType, format?): Column<any>

Creates and returns a new column by converting [column] to the specified [newType].

Parameters

Name	Type	Default value
newType	string	undefined
format	null | string	null

Returns

Column<any>

Defined in

src/dataframe.ts:1028

---

get

▸ get(row): null | T

Gets i-th value

Parameters

Name	Type	Description
row	number	row index

Returns

null | T

• or null if isNone(i)

Defined in

src/dataframe.ts:892

---

getCategory

▸ getCategory(categoryIndex): string

Returns i-th category. Applicable to string column only.

Parameters

Name	Type
categoryIndex	number

Returns

string

Defined in

src/dataframe.ts:974

---

getCategoryOrder

▸ getCategoryOrder(): string[]

Gets order of categories

Returns

string[]

Defined in

src/dataframe.ts:984

---

getNumber

▸ getNumber(i): number

Returns i-th value as number

Parameters

Name	Type
i	number

Returns

number

Defined in

src/dataframe.ts:907

---

getRawData

▸ getRawData(): Int32Array | Uint32Array | Float32Array | Float64Array

FOR EXPERT USE ONLY!

Returns the raw buffer containing data. Sample: https://public.datagrok.ai/js/samples/data-frame/performance/access Return type depends on the column type: {Int32Array} for ints, INT_NULL represents null. {Float32Array} for floats, FLOAT_NULL represents null. {Float64Array} for qnums, FLOAT_NULL represents null. {Float64Array} for datetime, in microseconds since epoch, FLOAT_NULL represents null. {Int32Array} for strings indexes of categories. {Uint32Array} bit array.

Returns

Int32Array | Uint32Array | Float32Array | Float64Array

Defined in

src/dataframe.ts:868

---

getSortedOrder

▸ getSortedOrder(): Int32Array

Returns an array of indexes sorted using [valueComparer].

Returns

Int32Array

Defined in

src/dataframe.ts:987

---

getString

▸ getString(i): string

Returns i-th value as string, taking into account value format defined for the column. An empty string is returned if there is no value.

Parameters

Name	Type
i	number

Returns

string

Defined in

src/dataframe.ts:900

---

getTag

▸ getTag(tag): string

Gets the value of the specified tag.

Parameters

Name	Type
tag	string

Returns

string

Defined in

src/dataframe.ts:943

---

init

▸ init(valueInitializer): Column<any>

Initializes all values in the column to [columnInitializer].

Parameters

Name	Type	Description
valueInitializer	string | number | boolean | (ind: number) => any	value, or a function that returns value by index

Returns

Column<any>

Defined in

src/dataframe.ts:838

---

isNone

▸ isNone(i): boolean

Returns whether i-th value is missing.

Parameters

Name	Type	Description
i	number	Row index.

Returns

boolean

Defined in

src/dataframe.ts:936

---

matches

▸ matches(filter): boolean

Checks whether the column passes the specified [filter]. [filter] can be either specific data [type] such as 'int' or 'string', more broadly - 'numerical', or 'categorical', or null for any columns.

Parameters

Name	Type
filter	null | "string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "categorical" | "numerical"

Returns

boolean

Defined in

src/dataframe.ts:1003

---

scale

▸ scale(idx): number

Linearly maps idx-th value to the [0,1] interval, where 0 represents column minimum, and 1 represents maximum.

Parameters

Name	Type
idx	number

Returns

number

Defined in

src/dataframe.ts:881

---

set

▸ set(i, value, notify?): void

Sets [i]-th value to [x], and optionally notifies the dataframe about this change.

Parameters

Name	Type	Default value	Description
i	number	undefined
value	null | T	undefined
notify	boolean	true	whether DataFrame's changed event should be fired

Returns

void

Defined in

src/dataframe.ts:929

---

setCategoryOrder

▸ setCategoryOrder(order): void

Sets order of categories

Parameters

Name	Type
order	string[]

Returns

void

Defined in

src/dataframe.ts:979

---

setRawData

▸ setRawData(rawData, notify?): void

Parameters

Name	Type	Default value
rawData	Int32Array | Uint32Array | Float32Array | Float64Array	undefined
notify	boolean	true

Returns

void

Defined in

src/dataframe.ts:885

---

setString

▸ setString(i, str, notify?): boolean

Attempts to set i-th value by converting a provided string to the corresponding strongly-typed value. Returns true if text was successfully parsed and set, otherwise false. Examples: dateColumn.setString('April 1, 2020'); intColumn.setString('42');

Parameters

Name	Type	Default value	Description
i	number	undefined
str	string	undefined
notify	boolean	true	whether DataFrame's changed event should be fired

Returns

boolean

Defined in

src/dataframe.ts:919

---

setTag

▸ setTag(tag, value): Column<any>

Sets a tag to the specified value.

Parameters

Name	Type	Description
tag	string	Key.
value	string	Value.

Returns

Column<any>

. *

Defined in

src/dataframe.ts:951

---

toList

▸ toList(): any[]

Copies column values to an array. Avoid using this method for performance-critical routines; consider using getRawData

Returns

any[]

Defined in

src/dataframe.ts:964

---

toString

▸ toString(): string

Returns

string

• string representation of this column

Defined in

src/dataframe.ts:1033

---

values

▸ values(): Generator<null | T, void, unknown>

An iterator over all values in this column.

Returns

Generator<null | T, void, unknown>

Defined in

src/dataframe.ts:1011

---

bool

▸ Static bool(name, length?): Column<boolean>

Creates a boolean column with the specified name and length.

Parameters

Name	Type	Default value
name	string	undefined
length	number	0

Returns

Column<boolean>

Defined in

src/dataframe.ts:716

---

dataFrame

▸ Static dataFrame(name, length?): Column<DataFrame>

Creates a column containing dataframes with the specified name and length.

Parameters

Name	Type	Default value
name	string	undefined
length	number	0

Returns

Column<DataFrame>

Defined in

src/dataframe.ts:732

---

dateTime

▸ Static dateTime(name, length?): Column<any>

Creates a datetime column with the specified name and length.

Parameters

Name	Type	Default value
name	string	undefined
length	number	0

Returns

Column<any>

Defined in

src/dataframe.ts:724

---

float

▸ Static float(name, length?): Column<number>

Creates a floating point column with the specified name and length.

Parameters

Name	Type	Default value
name	string	undefined
length	number	0

Returns

Column<number>

Defined in

src/dataframe.ts:700

---

fromBigInt64Array

▸ Static fromBigInt64Array(name, array): Column<any>

Creates BigIntColumn from BigInt64Array / BigUint64Array

Parameters

Name	Type
name	string
array	BigInt64Array | BigUint64Array

Returns

Column<any>

Defined in

src/dataframe.ts:653

---

fromBitSet

▸ Static fromBitSet(name, bitset): Column<boolean>

Creates a {Column} from the bitset.

Parameters

Name	Type
name	string
bitset	BitSet

Returns

Column<boolean>

Defined in

src/dataframe.ts:684

---

fromFloat32Array

▸ Static fromFloat32Array(name, array, length?): Column<number>

[array] will be not be copied and will be used as column's storage

Parameters

Name	Type	Default value
name	string	undefined
array	Float32Array	undefined
length	null | number	null

Returns

Column<number>

Defined in

src/dataframe.ts:648

---

fromIndexes

▸ Static fromIndexes(name, categories, indexes): Column<any>

Crates a Column of string type from categories and indexes

Parameters

Name	Type
name	string
categories	string[]
indexes	Int32Array

Returns

Column<any>

Defined in

src/dataframe.ts:676

---

fromInt32Array

▸ Static fromInt32Array(name, array, length?): Column<number>

[array] will be not be copied and will be used as column's storage

Parameters

Name	Type	Default value
name	string	undefined
array	Int32Array	undefined
length	null | number	null

Returns

Column<number>

Defined in

src/dataframe.ts:643

---

fromList

▸ Static fromList(type, name, list): Column<any>

Creates a Column from the list of values.

Parameters

Name	Type
type	"string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe"
name	string
list	any[]

Returns

Column<any>

Defined in

src/dataframe.ts:664

---

fromStrings

▸ Static fromStrings(name, list): Column<any>

Creates a Column from the list of string values Please note that method performs type promotion if all listed values are numeric

Parameters

Name	Type	Description
name	string	Column name
list	string[]	List of column values https://dev.datagrok.ai/script/samples/javascript/data-frame/construction/create-from-columns https://dev.datagrok.ai/script/samples/javascript/data-frame/construction/create-from-arrays

Returns

Column<any>

Defined in

src/dataframe.ts:625

---

fromType

▸ Static fromType(type, name?, length?): Column<any>

Creates a Column with explicitly specified type

Parameters

Name	Type	Default value	Description
type	"string" | "bigint" | "object" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe"	undefined	column type code COLUMN_TYPE
name?	null | string	undefined	Column name
length	number	0	Column length (should match row count of the data frame ) create {@see COLUMN_TYPE}

Returns

Column<any>

Defined in

src/dataframe.ts:638

---

int

▸ Static int(name, length?): Column<number>

Creates an integer column with the specified name and length.

Parameters

Name	Type	Default value
name	string	undefined
length	number	0

Returns

Column<number>

Defined in

src/dataframe.ts:692

---

qnum

▸ Static qnum(name, length?, values?, exact?): Column<number>

Creates a qualified number column with the specified name and length. Initialized values with [values], if it is specified; strips out the qualifier part if [exact] is true.

Parameters

Name	Type	Default value	Description
name	string	undefined
length	number	0
values	number[]	[]
exact	boolean	true	if true, strips out qualifier from [values].

Returns

Column<number>

Defined in

src/dataframe.ts:745

---

string

▸ Static string(name, length?): Column<string>

Creates a string column with the specified name and length.

Parameters

Name	Type	Default value
name	string	undefined
length	number	0

Returns

Column<string>

Defined in

src/dataframe.ts:708