Class: ObjectColumn
dg.ObjectColumn
Strongly-typed column. Use get and set to access elements by index.
Hierarchy
Column
<any
>↳
ObjectColumn
Constructors
constructor
• new ObjectColumn(dart
)
Parameters
Name | Type |
---|---|
dart | any |
Inherited from
Defined in
Properties
dart
• dart: any
Inherited from
Defined in
tags
• tags: any
Inherited from
Defined in
temp
• temp: any
Inherited from
Defined in
Accessors
categories
• get
categories(): string
[]
Returns all unique strings in a sorted order. Applicable to string column only.
Returns
string
[]
Inherited from
Column.categories
Defined in
colors
• get
colors(): ColumnColorHelper
Returns
Inherited from
Column.colors
Defined in
dataFrame
• get
dataFrame(): DataFrame
Parent table
Returns
Inherited from
Column.dataFrame
Defined in
dialogs
• get
dialogs(): ColumnDialogHelper
Returns
Inherited from
Column.dialogs
Defined in
isVirtual
• get
isVirtual(): boolean
Is this column virtual
Returns
boolean
Inherited from
Column.isVirtual
Defined in
layoutColumnId
• get
layoutColumnId(): string
Layout column ID
Returns
string
Inherited from
Column.layoutColumnId
Defined in
• set
layoutColumnId(s
): void
Parameters
Name | Type |
---|---|
s | string |
Returns
void
Inherited from
Column.layoutColumnId
Defined in
length
• get
length(): number
Number of elements
Returns
number
Inherited from
Column.length
Defined in
markers
• get
markers(): ColumnMarkerHelper
Returns
Inherited from
Column.markers
Defined in
max
• get
max(): number
Column's maximum value. The result is cached.
Returns
number
Inherited from
Column.max
Defined in
meta
• get
meta(): ColumnMetaHelper
Returns
Inherited from
Column.meta
Defined in
min
• get
min(): number
Column's minimum value. The result is cached.
Returns
number
Inherited from
Column.min
Defined in
name
• get
name(): string
Returns
string
Inherited from
Column.name
Defined in
• set
name(s
): void
Parameters
Name | Type |
---|---|
s | string |
Returns
void
Inherited from
Column.name
Defined in
semType
• get
semType(): string
Semantic type
Returns
string
Inherited from
Column.semType
Defined in
• set
semType(s
): void
Parameters
Name | Type |
---|---|
s | string |
Returns
void
Inherited from
Column.semType
Defined in
stats
• get
stats(): Stats
Basic descriptive statistics. The result is cached.
Returns
Inherited from
Column.stats
Defined in
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"
Inherited from
Column.type
Defined in
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
Inherited from
Column.valueComparer
Defined in
• set
valueComparer(cmp
): void
Parameters
Name | Type |
---|---|
cmp | null | Comparer |
Returns
void
Inherited from
Column.valueComparer
Defined in
version
• get
version(): number
Version of the column. Increases each time the column was changed
Returns
number
Inherited from
Column.version
Defined in
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
Inherited from
Defined in
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
>>
Inherited from
Defined in
clone
▸ clone(mask?
): Column
<any
>
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
<any
>
Inherited from
Defined in
compact
▸ compact(): any
Compacts the internal column representation. Currently, it only affects string columns where values were modified.
Returns
any
Inherited from
Defined in
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
>
Inherited from
Defined in
get
▸ get(row
): any
Gets [i]-th value.
Parameters
Name | Type |
---|---|
row | number |
Returns
any
Overrides
Defined in
getCategory
▸ getCategory(categoryIndex
): string
Returns i-th category. Applicable to string column only.
Parameters
Name | Type |
---|---|
categoryIndex | number |
Returns
string
Inherited from
Defined in
getCategoryOrder
▸ getCategoryOrder(): string
[]
Gets order of categories
Returns
string
[]
Inherited from
Defined in
getNumber
▸ getNumber(i
): number
Returns i-th value as number
Parameters
Name | Type |
---|---|
i | number |
Returns
number
Inherited from
Defined in
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
Inherited from
Defined in
getSortedOrder
▸ getSortedOrder(): Int32Array
Returns an array of indexes sorted using [valueComparer].
Returns
Int32Array
Inherited from
Defined in
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
Inherited from
Defined in
getTag
▸ getTag(tag
): string
Gets the value of the specified tag.
Parameters
Name | Type |
---|---|
tag | string |
Returns
string
Inherited from
Defined in
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
>
Inherited from
Defined in
isNone
▸ isNone(i
): boolean
Returns whether i-th value is missing.
Parameters
Name | Type | Description |
---|---|---|
i | number | Row index. |
Returns
boolean
Inherited from
Defined in
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
Inherited from
Defined in
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
Inherited from
Defined in
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 | any | undefined | |
notify | boolean | true | whether DataFrame's changed event should be fired |
Returns
void
Inherited from
Defined in
setCategoryOrder
▸ setCategoryOrder(order
): void
Sets order of categories
Parameters
Name | Type |
---|---|
order | string [] |
Returns
void
Inherited from
Defined in
setRawData
▸ setRawData(rawData
, notify?
): void
Parameters
Name | Type | Default value |
---|---|---|
rawData | Int32Array | Uint32Array | Float32Array | Float64Array | undefined |
notify | boolean | true |
Returns
void
Inherited from
Defined in
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
Inherited from
Defined in
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
>
. *
Inherited from
Defined in
toList
▸ toList(): any
[]
Copies column values to an array. Avoid using this method for performance-critical routines; consider using getRawData
Returns
any
[]
Inherited from
Defined in
toString
▸ toString(): string
Returns
string
- string representation of this column
Inherited from
Defined in
values
▸ values(): Generator
<any
, void
, unknown
>
An iterator over all values in this column.
Returns
Generator
<any
, void
, unknown
>
Inherited from
Defined in
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
>
Inherited from
Defined in
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
Inherited from
Defined in
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
>
Inherited from
Defined in
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
>
Inherited from
Defined in
fromBigInt64Array
▸ Static
fromBigInt64Array(name
, array
): Column
<any
>
Creates BigIntColumn from BigInt64Array / BigUint64Array
Parameters
Name | Type |
---|---|
name | string |
array | BigInt64Array | BigUint64Array |
Returns
Column
<any
>
Inherited from
Defined in
fromBitSet
▸ Static
fromBitSet(name
, bitset
): Column
<boolean
>
Creates a {Column} from the bitset.
Parameters
Name | Type |
---|---|
name | string |
bitset | BitSet |
Returns
Column
<boolean
>
Inherited from
Defined in
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
>
Inherited from
Defined in
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
>
Inherited from
Defined in
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
>
Inherited from
Defined in
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
>
Inherited from
Defined in
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
>
Inherited from
Defined in
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
>
Inherited from
Defined in
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
>
Inherited from
Defined in
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
>
Inherited from
Defined in
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
>