ColumnMetaHelper
Defined in: js-api/src/dataframe/column-helpers.ts:178
Constructors
Constructor
new ColumnMetaHelper(
column):ColumnMetaHelper
Defined in: js-api/src/dataframe/column-helpers.ts:184
Parameters
| Parameter | Type |
|---|---|
column | Column |
Returns
ColumnMetaHelper
Accessors
allowColorPicking
Get Signature
get allowColorPicking():
boolean
Defined in: js-api/src/dataframe/column-helpers.ts:273
Returns
boolean
Set Signature
set allowColorPicking(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:274
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
autoChoices
Get Signature
get autoChoices():
boolean
Defined in: js-api/src/dataframe/column-helpers.ts:250
When set to 'true', switches the cell editor to a combo box that only allows to choose values from a list of already existing values in the column. Applicable for string columns only. See also choices.
Returns
boolean
Set Signature
set autoChoices(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:252
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
cellRenderer
Get Signature
get cellRenderer():
string|null
Defined in: js-api/src/dataframe/column-helpers.ts:237
Specifies the units of the dataframe column.
Returns
string | null
Set Signature
set cellRenderer(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:238
Parameters
| Parameter | Type |
|---|---|
x | string | null |
Returns
void
choices
Get Signature
get choices():
string[] |null
Defined in: js-api/src/dataframe/column-helpers.ts:243
When set, switches the cell editor to a combo box that only allows to choose specified values. Applicable for string columns only. See also autoChoices.
Returns
string[] | null
Set Signature
set choices(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:244
Parameters
| Parameter | Type |
|---|---|
x | string[] | null |
Returns
void
colors
Get Signature
get colors():
ColumnColorHelper
Defined in: js-api/src/dataframe/column-helpers.ts:194
Returns
description
Get Signature
get description():
string|null
Defined in: js-api/src/dataframe/column-helpers.ts:218
Column description (usually shown in tooltips)
Returns
string | null
Set Signature
set description(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:219
Parameters
| Parameter | Type |
|---|---|
x | string | null |
Returns
void
dialogs
Get Signature
get dialogs():
ColumnDialogHelper
Defined in: js-api/src/dataframe/column-helpers.ts:188
Returns
format
Get Signature
get format():
string|null
Defined in: js-api/src/dataframe/column-helpers.ts:222
Specifies the data format of the dataframe column. See also [GridColumn.format]
Returns
string | null
Set Signature
set format(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:223
Parameters
| Parameter | Type |
|---|---|
x | string | null |
Returns
void
formula
Get Signature
get formula():
string|null
Defined in: js-api/src/dataframe/column-helpers.ts:229
When set, uses the formula to calculate the column values.
Returns
string | null
Set Signature
set formula(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:230
Parameters
| Parameter | Type |
|---|---|
x | string | null |
Returns
void
friendlyName
Get Signature
get friendlyName():
string|null
Defined in: js-api/src/dataframe/column-helpers.ts:214
Specifies the name to be shown in the UI
Returns
string | null
Set Signature
set friendlyName(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:215
Parameters
| Parameter | Type |
|---|---|
x | string | null |
Returns
void
includeInBinaryExport
Get Signature
get includeInBinaryExport():
boolean
Defined in: js-api/src/dataframe/column-helpers.ts:265
Specifies whether the column is exported as part of the binary file. Defaults to true.
Returns
boolean
Set Signature
set includeInBinaryExport(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:266
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
includeInCsvExport
Get Signature
get includeInCsvExport():
boolean
Defined in: js-api/src/dataframe/column-helpers.ts:261
Specifies whether the column is exported as part of the CSV file. Defaults to true.
Returns
boolean
Set Signature
set includeInCsvExport(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:262
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
linkClickBehavior
Get Signature
get linkClickBehavior():
LINK_CLICK_BEHAVIOR
Defined in: js-api/src/dataframe/column-helpers.ts:255
Specifies the behavior of link click (open in new tab, open in context panel, custom). Open in new tab is used by default.
Returns
Set Signature
set linkClickBehavior(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:258
Parameters
| Parameter | Type |
|---|---|
x | LINK_CLICK_BEHAVIOR |
Returns
void
markers
Get Signature
get markers():
ColumnMarkerHelper
Defined in: js-api/src/dataframe/column-helpers.ts:200
Returns
multiValueSeparator
Get Signature
get multiValueSeparator():
string
Defined in: js-api/src/dataframe/column-helpers.ts:270
When specified, column filter treats the split strings as separate values. See also: https://datagrok.ai/help/visualize/viewers/filters#column-tags
Returns
string
Set Signature
set multiValueSeparator(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:271
Parameters
| Parameter | Type |
|---|---|
x | string |
Returns
void
sourcePrecision
Get Signature
get sourcePrecision():
number|null
Defined in: js-api/src/dataframe/column-helpers.ts:226
Returns the maximum amount of significant digits detected in the column.
Returns
number | null
units
Get Signature
get units():
string|null
Defined in: js-api/src/dataframe/column-helpers.ts:233
Specifies the units of the dataframe column.
Returns
string | null
Set Signature
set units(
x):void
Defined in: js-api/src/dataframe/column-helpers.ts:234
Parameters
| Parameter | Type |
|---|---|
x | string | null |
Returns
void