BigIntColumn
Defined in: js-api/src/dataframe/column.ts:473
Strongly-typed column. Use get and set to access elements by index.
Extends
Column<BigInt>
Constructors
Constructor
new BigIntColumn(
dart):BigIntColumn
Defined in: js-api/src/dataframe/column.ts:32
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
BigIntColumn
Inherited from
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
dart | public | any | - | Column.dart | js-api/src/dataframe/column.ts:25 |
tags | public | MapBag<string> | Metadata as string key-value pairs; persisted with the column. | Column.tags | js-api/src/dataframe/column.ts:29 |
temp | public | any | Auxiliary data that is not persisted (a MapBag: indexed access plus the map methods; typed any so it can be cast to a package's own shape). | Column.temp | js-api/src/dataframe/column.ts:27 |
Accessors
categories
Get Signature
get categories():
string[]
Defined in: js-api/src/dataframe/column.ts:374
Returns all unique strings in a sorted order. Applicable to string column only.
Returns
string[]
Inherited from
colors
Get Signature
get colors():
any
Defined in: js-api/src/dataframe/column.ts:233
Deprecated
Use meta.colors (ColumnMetaHelper.colors). Removed in 1.30.
Returns
any
Inherited from
dataFrame
Get Signature
get dataFrame():
DataFrame
Defined in: js-api/src/dataframe/column.ts:191
Parent table
Returns
Inherited from
dialogs
Get Signature
get dialogs():
any
Defined in: js-api/src/dataframe/column.ts:228
Deprecated
Use meta.dialogs (ColumnMetaHelper.dialogs). Removed in 1.30.
Returns
any
Inherited from
isCategorical
Get Signature
get isCategorical():
boolean
Defined in: js-api/src/dataframe/column.ts:171
Is the column categorical (string, boolean)
Returns
boolean
Inherited from
isEmpty
Get Signature
get isEmpty():
boolean
Defined in: js-api/src/dataframe/column.ts:338
Returns whether all values in the columns are empty.
Returns
boolean
Inherited from
isNumerical
Get Signature
get isNumerical():
boolean
Defined in: js-api/src/dataframe/column.ts:166
Is the column numerical (float, int, bigint, qnum)
Returns
boolean
Inherited from
isVirtual
Get Signature
get isVirtual():
boolean
Defined in: js-api/src/dataframe/column.ts:181
Is this column virtual
Returns
boolean
Inherited from
layoutColumnId
Get Signature
get layoutColumnId():
string
Defined in: js-api/src/dataframe/column.ts:205
Layout column ID
Returns
string
Set Signature
set layoutColumnId(
s):void
Defined in: js-api/src/dataframe/column.ts:209
Parameters
| Parameter | Type |
|---|---|
s | string |
Returns
void
Inherited from
length
Get Signature
get length():
number
Defined in: js-api/src/dataframe/column.ts:186
Number of elements
Returns
number
Inherited from
markers
Get Signature
get markers():
any
Defined in: js-api/src/dataframe/column.ts:238
Deprecated
Use meta.markers (ColumnMetaHelper.markers). Removed in 1.29.
Returns
any
Inherited from
max
Get Signature
get max():
number
Defined in: js-api/src/dataframe/column.ts:403
Column's maximum value. The result is cached.
Returns
number
Inherited from
meta
Get Signature
get meta():
ColumnMetaHelper
Defined in: js-api/src/dataframe/column.ts:38
Returns
Inherited from
min
Get Signature
get min():
number
Defined in: js-api/src/dataframe/column.ts:400
Column's minimum value. The result is cached.
Returns
number
Inherited from
name
Get Signature
get name():
string
Defined in: js-api/src/dataframe/column.ts:214
Returns
string
Set Signature
set name(
s):void
Defined in: js-api/src/dataframe/column.ts:218
Parameters
| Parameter | Type |
|---|---|
s | string |
Returns
void
Inherited from
semType
Get Signature
get semType():
string
Defined in: js-api/src/dataframe/column.ts:196
Semantic type
Returns
string
Set Signature
set semType(
s):void
Defined in: js-api/src/dataframe/column.ts:200
Parameters
| Parameter | Type |
|---|---|
s | string |
Returns
void
Inherited from
stats
Get Signature
get stats():
Stats
Defined in: js-api/src/dataframe/column.ts:413
Basic descriptive statistics. The result is cached.
Returns
Inherited from
type
Get Signature
get type():
"string"|"bigint"|"object"|"bool"|"int"|"double"|"byte_array"|"datetime"|"qnum"|"dataframe"
Defined in: js-api/src/dataframe/column.ts:176
Column data type.
Returns
"string" | "bigint" | "object" | "bool" | "int" | "double" | "byte_array" | "datetime" | "qnum" | "dataframe"
Inherited from
valueComparer
Get Signature
get valueComparer():
Comparer|null
Defined in: js-api/src/dataframe/column.ts:396
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
Comparer | null
Set Signature
set valueComparer(
cmp):void
Defined in: js-api/src/dataframe/column.ts:397
Parameters
| Parameter | Type |
|---|---|
cmp | Comparer | null |
Returns
void
Inherited from
version
Get Signature
get version():
number
Defined in: js-api/src/dataframe/column.ts:223
Version of the column. Increases each time the column was changed
Returns
number
Inherited from
Methods
aggregate()
aggregate(
type):any
Defined in: js-api/src/dataframe/column.ts:451
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
| Parameter | Type |
|---|---|
type | ColumnAggregationType |
Returns
any
Inherited from
applyFormula()
applyFormula(
formula,type?,treatAsString?):Promise<Column<any,any> |null>
Defined in: js-api/src/dataframe/column.ts:427
Applies the specified formula to a calculated column. Returns a new column object, if applied successfully, and null otherwise.
Parameters
| Parameter | Type | Default value |
|---|---|---|
formula | string | undefined |
type | "string" | "bigint" | "object" | "bool" | "int" | "double" | "byte_array" | "datetime" | "qnum" | "dataframe" | null | null |
treatAsString | boolean | false |
Returns
Promise<Column<any, any> | null>
Inherited from
asDoubleList()
asDoubleList():
Float32Array
Defined in: js-api/src/dataframe/column.ts:457
Returns
Float32Array
typed array of float values representing the column. Does not guarantee to perform a copy of the underlying data.
Inherited from
clone()
clone(
mask?):Column<BigInt>
Defined in: js-api/src/dataframe/column.ts:261
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
| Parameter | Type |
|---|---|
mask? | BitSet |
Returns
Column<BigInt>
Inherited from
compact()
compact():
any
Defined in: js-api/src/dataframe/column.ts:363
Compacts the internal column representation. Currently, it only affects string columns where values were modified.
Returns
any
Inherited from
convertTo()
convertTo(
newType,format?):Column
Defined in: js-api/src/dataframe/column.ts:436
Creates and returns a new column by converting [column] to the specified [newType].
Parameters
| Parameter | Type | Default value |
|---|---|---|
newType | string | undefined |
format | string | null | null |
Returns
Inherited from
fireValuesChanged()
fireValuesChanged():
void
Defined in: js-api/src/dataframe/column.ts:323
Call this method after setting elements without notifications via set
Returns
void
Inherited from
get()
get(
row):BigInt|null
Defined in: js-api/src/dataframe/column.ts:477
Gets [i]-th value.
Parameters
| Parameter | Type |
|---|---|
row | number |
Returns
BigInt | null
Overrides
getCategory()
getCategory(
categoryIndex):string
Defined in: js-api/src/dataframe/column.ts:379
Returns i-th category. Applicable to string column only.
Parameters
| Parameter | Type |
|---|---|
categoryIndex | number |
Returns
string
Inherited from
getCategoryOrder()
getCategoryOrder():
string[]
Defined in: js-api/src/dataframe/column.ts:389
Gets order of categories
Returns
string[]
Inherited from
getNumber()
getNumber(
i):number
Defined in: js-api/src/dataframe/column.ts:309
Returns i-th value as number. None if isNone(i)