ColumnMetaHelper

Constructors

new ColumnMetaHelper()

new ColumnMetaHelper(column): ColumnMetaHelper

Parameters

Parameter	Type
column	Column<any, any>

Returns

ColumnMetaHelper

Source

src/dataframe.ts:2607

Properties

Property	Modifier	Type
_colors	private	undefined | ColumnColorHelper
_dialogs	private	undefined | ColumnDialogHelper
_markers	private	undefined | ColumnMarkerHelper
column	private	Column<any, any>

Accessors

allowColorPicking

get allowColorPicking(): boolean

set allowColorPicking(x): void

Parameters

Parameter	Type
x	boolean

Returns

boolean

Source

src/dataframe.ts:2696

---

autoChoices

get autoChoices(): boolean

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.

set autoChoices(x): void

Parameters

Parameter	Type
x	boolean

Returns

boolean

Source

src/dataframe.ts:2673

---

cellRenderer

get cellRenderer(): null | string

Specifies the units of the dataframe column.

set cellRenderer(x): void

Parameters

Parameter	Type
x	null | string

Returns

null | string

Source

src/dataframe.ts:2660

---

choices

get choices(): null | string[]

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.

set choices(x): void

Parameters

Parameter	Type
x	null | string[]

Returns

null | string[]

Source

src/dataframe.ts:2666

---

colors

get colors(): ColumnColorHelper

Returns

ColumnColorHelper

Source

src/dataframe.ts:2617

---

description

get description(): null | string

Column description (usually shown in tooltips)

set description(x): void

Parameters

Parameter	Type
x	null | string

Returns

null | string

Source

src/dataframe.ts:2641

---

dialogs

get dialogs(): ColumnDialogHelper

Returns

ColumnDialogHelper

Source

src/dataframe.ts:2611

---

format

get format(): null | string

Specifies the data format of the dataframe column. See also [GridColumn.format]

set format(x): void

Parameters

Parameter	Type
x	null | string

Returns

null | string

Source

src/dataframe.ts:2645

---

formula

get formula(): null | string

When set, uses the formula to calculate the column values.

set formula(x): void

Parameters

Parameter	Type
x	null | string

Returns

null | string

Source

src/dataframe.ts:2652

---

friendlyName

get friendlyName(): null | string

Specifies the name to be shown in the UI

set friendlyName(x): void

Parameters

Parameter	Type
x	null | string

Returns

null | string

Source

src/dataframe.ts:2637

---

includeInBinaryExport

get includeInBinaryExport(): boolean

Specifies whether the column is exported as part of the binary file. Defaults to true.

set includeInBinaryExport(x): void

Parameters

Parameter	Type
x	boolean

Returns

boolean

Source

src/dataframe.ts:2688

---

includeInCsvExport

get includeInCsvExport(): boolean

Specifies whether the column is exported as part of the CSV file. Defaults to true.

set includeInCsvExport(x): void

Parameters

Parameter	Type
x	boolean

Returns

boolean

Source

src/dataframe.ts:2684

---

linkClickBehavior

get linkClickBehavior(): LINK_CLICK_BEHAVIOR

Specifies the behavior of link click (open in new tab, open in context panel, custom). Open in new tab is used by default.

set linkClickBehavior(x): void

Parameters

Parameter	Type
x	LINK_CLICK_BEHAVIOR

Returns

LINK_CLICK_BEHAVIOR

Source

src/dataframe.ts:2678

---

markers

get markers(): ColumnMarkerHelper

Returns

ColumnMarkerHelper

Source

src/dataframe.ts:2623

---

multiValueSeparator

get multiValueSeparator(): string

When specified, column filter treats the split strings as separate values. See also: https://datagrok.ai/help/visualize/viewers/filters#column-tags

set multiValueSeparator(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/dataframe.ts:2693

---

sourcePrecision

get sourcePrecision(): null | number

Returns the maximum amount of significant digits detected in the column.

Returns

null | number

Source

src/dataframe.ts:2649

---

units

get units(): null | string

Specifies the units of the dataframe column.

set units(x): void

Parameters

Parameter	Type
x	null | string

Returns

null | string

Source

src/dataframe.ts:2656

Methods

setNonNullTag()

private setNonNullTag(key, value): void

Parameters

Parameter	Type
key	string
value	null | string

Returns

void

Source

src/dataframe.ts:2629